citripio / toolbelt

1.3.6 2020-03-20 16:15 UTC

MIT

• Alfredo Re

Published on Packagist.org on 2020-03-20 16:16 UTC

README

Helpers for contentor websites in PHP

Development

Follow these steps in order to publish a new version.

Remember to always push your commits first, and then create the new version number tag:

git commit -m "Some meaningful comment"
git push
git tag -a 1.0.0 -m "Version 1.0.0"
git push --tags

After a few seconds, the new version will show up on Github and Packagist

Installation

Add this to your composer.json

{
    "require": {
        "citripio/toolbelt": "^1.0"
    }
}

Then:

require_once "./vendor/autoload.php";

$utils = new Citripio\Toolbelt();

Methods

get_content_part($content, $tag)

Receives a string and parses it for the given <tag></tag> name.

include_utms()

Useful for redirects.

Receives a URL and returns it appending the current utm_source and utm_campaign GET parameters, if present. Doesn't add an extra ? to the URL if it already has one.

save_user_token_and_session_in_cookies()

Receives no arguments. Useful for normalizing the cookie's name.

save_content_list_timestamps_in_cookies()

Receives a collection of contents[] containing a created_at_timestamp key. Saves a id => timestamp list to cookies, returning that same list.

retrieve_saved_timestamp_for_content_id()

The opposite of save_content_list_timestamps_in_cookies.

Receives a content list and an ID. Returns the timestamp for that ID.

generate_content_md5()

Receives a string or integer. Generates a MD5 hash using always the same salt.

get_verse_code()

Receives a string and parses it for <verse_code>

get_verse()

Receives a string and parses it for <verse>

get_explanation()

Receives a string and parses it for <explanation>

get_prayer_intro()

Receives a string and parses it for <prayer_intro>

get_prayer()

Receives a string and parses it for <prayer>

substring_words($text, $length)

Receives a string and an integer. Performs a substr() keeping whole words and adding "..." in case the result doesn't end with "." or ","