PHP Helper Functions

by Stephen Ginn at Crema Design Studio

This repo contains a collection of reusable PHP helper functions.

Installation

You can install the package via composer:

composer config repositories.crema/helpers git https://github.com/cremadesign/helpers
composer require crema/helpers:@dev

Add the composer autoloader to your PHP file:

require_once '../vendor/autoload.php';

Usage

User Data

$udata = new UData();
$udata->getData();
print $udata;

Arrays and Strings

Get Ordinal ("st", "nd", "rd") for a number

echo ordinal(2);

Return a random array item

$array = ["one", "two", "three", "four"];
echo random($array);

Sends back a web-safe slug from a string

echo slugify("Lorem#Ipsum &$ Dolar Sit Amet!");

Search

Search a string for a query

echo contains($query, $string);

Use a switch statement to check if a string contains a word

$hs = new Haystack("yourwebsite.com");

switch ($hs) {
	case $hs->contains('.test'):
		echo "this is a local site";
	break;
	case $hs->contains('.com'):
		echo "this is a live site";
	break;
	default:
		echo "we don't know what this site is";
}

Find item in object

header('Content-Type: application/json');
$data = findItem($obj, $query);
print json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);

File Related

Delete directory

removeDir("cache");

Delete directories

removeDirs([
	"cache",
	"api/.cached"
]);

Debugging

Log PHP messages to file

logger("This is a test");

Log message to browser console

Warning: This function probably should not be used, since it breaks the gulp autorefresh.

echo console("This is a test");

Print JSON array to screen

$products = json_decode(file_get_contents("https://dummyjson.com/products/1"), true);
printJSON($products);

Print JSON file to screen

echo printData("filename.json");

Dreamhost API

Installation

• Follow the installation steps above.
• Add a file named credentials.json outside your public web folder with the following info:

{
	"userid": "DH_USER_ID",
	"apikey": "DH_API_KEY",
	"ip": "DEFAULT_HOST_IP"
}

Usage

Add the composer autoloader to your PHP file:

use Crema\DreamhostApi;

$credentials = json_decode(file_get_contents("../credentials.json"));
$account = $credentials->dreamhost;
$dreamhost = new DreamhostApi($account);

Get Records

$response = $dreamhost->getRecords("thor.website.com");
printJSON($response);

Get Domains

$response = $dreamhost->getDomains();
printJSON($response);

Add Record

$response = $dreamhost->addRecord("thor.website.com", $account->ip);
printJSON($response);

Add Records

$response = $dreamhost->addRecords("thor.website.com", $account->ip);
printJSON($response);

Send Email

1. Add a file named credentials.json outside your public web folder with the following info:

{
	"email": {
		"username": "email@example.com",
		"password": "INSERT_PASSWORD_HERE",
		"host": "secure.hostname.com",
		"port": 465
	},
	"sender": {
		"name": "Sender Name",
		"email": "sending@example.com"
	},
	"recipient": {
		"name": "Recipient Name",
		"email": "recipient@example.com"
	}
}

2. Load the credentials and emailer within your PHP file:

$credentials = json_decode(file_get_contents("../credentials.json"));
$emailer = new Emailer($credentials->email, $credentials->sender, $recipient);

3. Send the email using one of the methods below:

   • Send with Response

   $emailSent = $emailer->sendEmail([
   	'subject' => "Instagram App: New Client Added",
   	'body' => parsify($mjml)
   ]);
   
   $alertClass = $emailSent ? 'alert-success' : 'alert-danger';
   echo "Alert Class: $alertClass<br>";
   echo $emailSent ? 'Your message has been sent' : 'Your message has not been sent';

   • Send with Callbacks

   $emailer->sendEmail([
   		'subject' => "Instagram App: New Account Invite",
   		'body' => parsify($mjml)
   	],
   	function($mail) use (&$response) {
   		$response->class = 'alert-success';
   		$response->msg = 'Your app invite was sent!';
   	}, 
   	function($errorInfo) use (&$response) {
   		$response->class = 'alert-danger';
   		$response->msg = 'Your app invite failed to send!';
   	}
   );