Preference

Returns a list of languages in use by the system.

In the interests of brevity and sanity a full list is not provided. Add entries that you want to use to the array using ISO 639-1 two-letter language codes, which you can find at: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes. Be aware that deleting entries that are in use by your content objects will cause errors.

Provide a list of timezone offsets.

URL-encode and escape a query string for use in a URL.

Trims, checks for UTF-8 compliance, rawurlencodes and then escapes with htmlspecialchars(). If you wish to use the data on a landing page you must decode it with htmlspecialchars_decode() followed by rawurldecode() in that order. But really, if you are using any characters that need to be encoded in the first place you should probably just stop.

Check that a string is comprised solely of alphanumeric characters.

Accented regional characters are rejected. This method is designed to be used to check database identifiers or object property names.

Check that a string is comprised solely of alphanumeric characters and underscores.

Accented regional characters are rejected. This method is designed to be used to check database identifiers or object property names.

Check that a string is comprised solely of alphabetical characters.

Tolerates vanilla ASCII only. Accented regional characters are rejected. This method is designed to be used to check database identifiers or object property names.

Check if the character encoding of text is UTF-8.

All strings received from external sources must be passed through this function, particularly prior to storage in the database.

Cast to string, check UTF-8 encoding and strip trailing whitespace and control characters.

Removes trailing whitespace and control characters (ASCII <= 32 / UTF-8 points 0-32 inclusive), checks for UTF-8 character set and casts input to a string. Note that the data returned by this function still requires escaping at the point of use; it is not database or XSS safe.

As the input is cast to a string do NOT apply this function to non-string types (int, float, bool, object, resource, null, array, etc).

Constructor.

Converts the preference object to an array suitable for insert/update calls to the database.

Note that the output is not XSS escaped and should not be sent to display.

Update the preference object from an external data source (eg. form submission).

The preference object will conduct its own internal data type validation and range checks.

Read out the site preferences into an array.

Set the number of objects to display in a single admin page view.

Return site author

Set the name of the site author. Used to population page meta author tag.

Return cache life.

Set life of items in cache (seconds).

Items that expire will be rebuilt and re-written to the cache the next time the page is requested.

Return the value of the site closed preference.

Open our close the site.

Return date format.

Set the date format, used to convert timestamps to human readable form.

See the PHP manual for date formatting templates: http://php.net/manual/en/function.date.php

Return default language.

Set the default language for this Tuskfish installation.

Return site description.

Set the site description. Used in meta description tag.

Return site email.

Set the admin email address for the site.

Used in RSS feeds to populate the managingEditor and webmaster tags.

Return enableCache.

Enable or disable the cache.

Return gallery pagination.

Set number of objects to display on the gallery page.

Return minimum search length.

Set the minimum length of search terms (characters).

Search terms less than this number of characters will be discarded. It is usually best to allow a minimum length of 3 characters; this allows searching for common acronyms without returning massive numbers of hits.

Return number of elements in a pagination control.

Set the default number of page slots to display in pagination elements.

Can be overridden manually in PaginationControl.

Return the number of items to include in a RSS feed.

Set number of items to display in RSS feeds.

Number of items to include in a search page view.

Set number of results to display on a search page view.

Return server timezone.

Set the server timezone.

Return session life (minutes).

Set the life of an idle session.

User will be logged out after being idle for this many minutes.

Return session name.

Set the name (prefix) used to identify Tuskfish sessions.

If you change it, use something unpredictable.

Return site copyright.

Set the site meta copyright.

Used to populate the dcterms.rights meta tag in the theme. Can be overridden in the theme.html file.

Return site name.

Set the title of the page.

Used to populate the meta title tag. Usually each page / object will specify a title, but if none is set this value will be used as the default. The title can be manually overriden on each page using the Metadata object (see comments at the bottom of controller scripts).

Return site timezone.

Set the site timezone.

This is normally the timezone for your principal target audience.

Number of items to display on a single user-side page.

Set the number of objects to display in a single page view on the public facing side of the site.