class Admin

Model for admin interface operations.

Traits

Provides definition of permitted content object types.
Taglink
Provides methods for validating UTF-8 character encoding and string composition.

Methods

array
listTemplates()

Returns a list of template names used by specific content types.

array
listTypes()

Returns a whitelist of permitted content object types.

string
encodeEscapeUrl(string $url)

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

bool
isAlnum(string $alnum)

Check that a string is comprised solely of alphanumeric characters.

bool
isAlnumUnderscore(string $alnumUnderscore)

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

bool
isAlpha(string $alpha)

Check that a string is comprised solely of alphabetical characters.

bool
isUtf8(string $text)

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

string
trimString(mixed $text)

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

__construct(Database $database, CriteriaFactory $criteriaFactory, Preference $preference, FileHandler $fileHandler, Cache $cache)

Constructor.

bool
delete(int $id)

Delete content object.

array
getObjects(array $params)

Get content objects.

bool
toggleOnlineStatus(int $id)

Toggle a content object online or offline.

int
getCount(array $params)

Count the number of content objects that match the filter criteria.

array
getOptions(array $params, array $columns = [])

Return a list of options to build a select box.

array
getTagsForObject(int $id)

Get tags associated with a content object.

int
adminlimit()

Return the admin-side pagination limit.

string
dateFormat()

Returns the template for formatting the date from preferences.

string
getTitle(int $id)

Return the title of a given content object.

Details

in ContentTypes at line 36
array listTemplates()

Returns a list of template names used by specific content types.

Return Value

array Array of type-template key values.

in ContentTypes at line 62
array listTypes()

Returns a whitelist of permitted content object types.

Use this whitelist when dynamically instantiating content objects. If you create additional types of content object (which must be descendants of the TfContentObject class) you must add them to the whitelist below. Otherwise their use will be denied in many parts of the Tuskfish system.

Return Value

array Array of whitelisted (permitted) content object types.

in ValidateString at line 41
string encodeEscapeUrl(string $url)

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.

Parameters

string $url Unescaped input URL.

Return Value

string Encoded and escaped URL.

in ValidateString at line 59
bool isAlnum(string $alnum)

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.

Parameters

string $alnum Input to be tested.

Return Value

bool True if valid alphanumerical string, false otherwise.

in ValidateString at line 77
bool isAlnumUnderscore(string $alnumUnderscore)

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.

Parameters

string $alnumUnderscore Input to be tested.

Return Value

bool True if valid alphanumerical or underscore string, false otherwise.

in ValidateString at line 95
bool isAlpha(string $alpha)

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.

Parameters

string $alpha Input to be tested.

Return Value

bool True if valid alphabetical string, false otherwise.

in ValidateString at line 113
bool isUtf8(string $text)

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.

Parameters

string $text Input string to check.

Return Value

bool True if string is UTF-8 encoded otherwise false.

in ValidateString at line 131
string trimString(mixed $text)

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).

Parameters

mixed $text Input to be trimmed.

Return Value

string Trimmed and UTF-8 validated string.

at line 58
__construct(Database $database, CriteriaFactory $criteriaFactory, Preference $preference, FileHandler $fileHandler, Cache $cache)

Constructor.

Parameters

Database $database Instance of the Tuskfish database class.
CriteriaFactory $criteriaFactory Instance of the criteria factory class.
Preference $preference Instance of the Tuskfish site preferences class.
FileHandler $fileHandler Instance of the Tuskfish filehandler class.
Cache $cache Instance of the Tuskfish cache class.

at line 80
bool delete(int $id)

Delete content object.

Parameters

int $id ID of content object.

Return Value

bool True on success, false on failure.

at line 134
array getObjects(array $params)

Get content objects.

Parameters

array $params Filter criteria.

Return Value

array Array of content objects.

at line 148
bool toggleOnlineStatus(int $id)

Toggle a content object online or offline.

Parameters

int $id ID of content object.

Return Value

bool True on success, false on failure.

at line 167
int getCount(array $params)

Count the number of content objects that match the filter criteria.

Parameters

array $params Filter criteria.

Return Value

int Count.

at line 191
array getOptions(array $params, array $columns = [])

Return a list of options to build a select box.

Parameters

array $params Filter criteria.
array $columns Columns to select to build the options.

Return Value

array

at line 236
array getTagsForObject(int $id)

Get tags associated with a content object.

Parameters

int $id ID of content object.

Return Value

array Tag IDs and titles as key-value pairs.

at line 282
int adminlimit()

Return the admin-side pagination limit.

Return Value

int Number of items to display on one page of the admin summary table.

at line 290
string dateFormat()

Returns the template for formatting the date from preferences.

Return Value

string

at line 343
string getTitle(int $id)

Return the title of a given content object.

Parameters

int $id ID of content object.

Return Value

string Title of content object.