Docs

Change Log Setup Requirements Getting Started
Built In - Create Built In - Show
Creating Pages Creating APIs The Data Object Custom CSS / JS New Functions

Built In Functions

Create

Used to prepare data for use on the server or for a database

$Create->JSON($Response)

Accepts: Array

This method takes an array as its sole parameter, sets the HTTP Header to be application/json, encodes the array into JSON, and then exits with the response. You will typically use this at the end of an API call. When a user submits a form to update their profile name, you process the new name into the database. If that action was successful, return a response status "true", and a message for your javascript to interpret. You can see a working version of this in the Samples area.

Example

$response = [];
$response['status'] = true;
$response['message'] = 'API was successful!';
$Create->JSON($response);

Response

{
    "status":true,
    "message":"API was successful!"
}
$Create->Redirect($Destination);

Accepts: String

Use this to redirect your users with ease. Its a very basic function.

$Create->Redirect('/profile/');
$Create->Number(
    $Number,
    $Type = 'integer'
);

Accepts: String, Integer

This uses a regex to remove all non-numeric characters. There is a separate Float method for decimals. You can use this method to return the value as an integer or as a string. This is useful for cleaning user input. Don't use this for currency or you'll get strange results.

$Create->Number('000-111-2222');            // int 1112222
$Create->Number('012-345-6789', 'string');  // string '0123456789'
$Create->Number('2.0.5');                   // int 205
$Create->Number('$100,000,000');            // int 100000000
$Create->Float(
    $Number,
    $DecimalPlace,
    $Commas = false
);

Accepts: String, Integer

This uses a regex to remove all non-numeric characters except for periods. You can use this to process monetary amounts. If you need commas, it will return as a string. If you don't, it will return as a float type.

WARNING! This will round your decimal numbers if you shorten the number of available decimal places.

$Create->Float('$1000.00', 2, false); // float 1000.00
$Create->Float('$1000.00', 0, false); // float 1000
$Create->Float('$1000.00', 2, true);  // string '1,000.00'
$Create->Float('100.129', 2, false);  // float 100.13
$Create->PhoneNumber($PhoneNumber);

Accepts: String, Integer

This uses a regex to remove all non-numeric characters to create a numeric phone number string. This is helpful for storing in the database in a consistent manner. It also checks to make sure the phone number is between 10 and 13 characters. To show the phone number on the client side, you can use the $Show->PhoneNumber method. This will format the phone number in a consistent manner.

$Create->PhoneNumber('012-345-6789');      // string '0123456789'
$Create->PhoneNumber('+1 (012) 345-6789'); // string '10123456789'
$Create->PhoneNumber('+155 012.345.6789'); // string '1550123456789'
$Create->URL($URL);

Accepts: String

This uses a regex to remove all non-alphanumeric and replaces spaces with a dash. This is useful for automatically generating URLs for blog posts or other dynamic content to reference from a database.

$Create->URL('My New Blog Post');               // 'my-new-blog-post'
$Create->URL('Celestial Is $$ #)$*% Awesome');  // 'celestial-is-awesome'
$Create->URL('   Lots   Of    Spaces');         // 'lots-of-spaces'
$Create->Random($Length = 60);

Accepts: Integer

This will create a random string of letters and numbers. This can be used to generate safe API keys, or file names for server storage. It can generate any length you need. The default length is 60 characters.

$Create->Random();    // 60 character long string
$Create->Random(12);  // 12 character long string
$Create->Random(100); // 100 character long string
$Create->Secure($ValueToEncrypt);

Accepts: string, integer

This encrypts any value for safe storage or transmission. You can use this to store secure communication on your database. To decrypt the message, you can use the $Show->Secure method. When you initially set up the framework, you can enter in an encryption key (recommended 60 characters), and also a 16 character long cipher initialization vector.

echo $Create->Secure('Hello World'); // 'wLutBXhXdGntGeI='
echo $Create->Secure('This is a secure transmission!'); // '3LaoGjceUCb+VfVz+TrA+n+Ju3cq0UgG1058Z85a'
$Create->MonetaryNumber($Amount);

Accepts: string, integer

This uses the previous float method to create a valid monetary amount (i.e. 10.00) and multiplies it by 100 to turn the float into an integer. This is how Stripe and other monetary systems store money in the database.

$10 becomes 1000.

$Create->MonetaryNumber('1,000.50'); // 100050
$Create->MonetaryNumber('25.125'); // 2513
$Create->MonetaryNumber('$25,000'); // 2500000
$Create->Mail(
    $To,
    $Subject,
    $EmailTemplate,
    $EmailContent = [],
    $Type = "mail"
);

This method makes it super easy to send out an email using either your built in PHP mail() function, or the Mailgun API. With Mailgun, you get 1000 free emails a month. Super handy for testing.

Enter in the address of who you are mailing, the subject, point to the mail template, build an array of custom dynamic values, and away you go! The mailing template automatically points to the project-files/emails folder and will append .html to the end so you only need to reference the name.

Example 1: No custom values.

By default, the method will use these dynamic values: __SITETITLE__, __YEAR__, and __SITEURL__. These are pulled from the values entered in through the framework-setup file.

$Create->Mail(
    "cool-new-user@website.com",  // to
    "Welcome to Celestial",       // subject
    "newsletter"                  // email template
);

	<!doctype html>
	<html>
	<head><!-- email stuff here --></head>
	<body>
	<p>Thanks for contacting us at __SITETITLE__</p>

	<p><a href="__SITEURL__/blog">Check out our blog</a></p>

	<p>© __SITETITLE __YEAR__</p>
	</body>
	</html>

The included email template is based off of the excellent leemunroe/responsive-html-email-template. This email template has been tested on all major email clients.

Example 2: Custom Dynamic Values

You can enter in custom values through an array structured like so:

$EmailContent = [
    ["__NAME__", $_POST['name']],
    ["__EMAIL__", $_POST['email']],
    ["__MESSAGE__", $_POST['message']],
];

$Create->Mail(
    "cool-new-user@website.com",   // to
    "Welcome to Celestial",        // subject
    "marketing/cool-email",        // email template
    $EmailContent,                 // dynamic values
    "mailgun"                      // email client
);

You can then insert those dynamic values into your email and they will be replaced before being sent out to the recipient.

Hello, __NAME__! Welcome to __SITETITLE__.
Hello, Catsuki! Welcome to Celestial.
$Create->Recaptcha($RecaptchaPostRequest);

Accepts: string

Recaptcha is used on every <form> by default. No setup necessary! Except for the API key. All you need to do is call this method on your API and it will do everything for you. You can store the response in a variable and save it in your database or return it to the client side for testing. If captcha fails, the form is not submitted, and you can use custom error messaging to redirect the suspected bot to another page.

$Create->Recaptcha('recaptcha_response');
$Create->FormValidation(
    $Post,
    $Type = "string",
    $Required = true
);

Accepts: all

This is a handy method for quickly scaling up a form system. It can auto-validate several different types of data very quickly! You can also set whether form fields are required or not. You first define the empty $formValues array and then call the function on each $_POST value you want to validate.

All Options:

  • string
  • password (forces string to be eight characters or longer)
  • phone
  • email
  • number
  • float
  • money
  • date

Use the $_POST key (the name attribute on the html input fields) as the reference when you are storing these values. If any of the required fields fail, it will return that field value back as a JSON response, and you use that to find where the error happened on the page.

$formValues = [];
$formValues['name']    = $Create->FormValidation('form_name');
$formValues['email']   = $Create->FormValidation('form_email', 'email');
$formValues['message'] = $Create->FormValidation('form_message');
$formValues['phone']   = $Create->FormValidation('form_phone', 'phone', false); // Not required
$formValues['date']    = date('M d, Y g:i a');

If you want to save this information in your database, set the $formValues key to be the column name for the data you are entering. The connections to your database are secured through PDO by default.

$db->insert(
    'contact_us_form',
    $formValues
);

Easy peasy.

Top
JSON Redirect Number Float PhoneNumber URL Random Secure MonetaryNumber Mail Recaptcha FormValidation