Tfish\Content\Controller\Admin

class Admin

Controller for displaying the content administration interface.

Traits

ValidateString

Provides methods for validating UTF-8 character encoding and string composition.

Methods

string

encodeEscapeUrl(string $url)

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

from ValidateString

bool

isAlnum(string $alnum)

Check that a string is comprised solely of alphanumeric characters.

from ValidateString

bool

isAlnumUnderscore(string $alnumUnderscore)

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

from ValidateString

bool

isAlpha(string $alpha)

Check that a string is comprised solely of alphabetical characters.

from ValidateString

bool

isUtf8(string $text)

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

from ValidateString

string

trimString(mixed $text)

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

from ValidateString

__construct(object $model, object $viewModel)

Constructor.

array

cancel()

Cancel the delete content action.

array

confirmDelete()

Display the confirm delete content page.

array

delete()

Delete a content object.

array

display()

Display the summary table of content objects.

array

toggle()

Toggle a content objectg online or offline.

Details

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 45
`__construct(object $model, object $viewModel)`

Constructor.

Parameters

object	$model	Instance of a model class.
object	$viewModel	Instance of a viewModel class.