Admin
class Admin implements Listable
ViewModel for admin interface operations.
Traits
Methods
Returns a list of template names used by specific content types.
Sets the sort type (ascending or descending) for the primary order column of a result set.
Sets the sort type (ascending or descending) for the secondary order column of a result set.
URL-encode and escape a query string for use in a URL.
Check that a string is comprised solely of alphanumeric characters.
Check that a string is comprised solely of alphanumeric characters and underscores.
Check that a string is comprised solely of alphabetical characters.
Cast to string, check UTF-8 encoding and strip trailing whitespace and control characters.
Validate a cross-site request forgery token from a form submission.
Constructor.
Cancel action and redirect to admin page.
Display delete confirmation form.
Delete content object and display result.
Display the admin summary table.
Toggle a content object online or offline.
Count content objects meeting filter criteria.
Returns the template for formatting the date from preferences.
Return extra parameters to be included in pagination control links.
Get content objects matching cached filter criteria.
Return admin-side pagination limit.
Return options for tag select box control.
Return options for type select box control.
Return options for tag online status select box control.
Return the action for this page.
Return the backUrl.
Return content count.
Return content list.
Return ID.
Set ID.
Return content title.
Set title of content object.
Return online status.
Set online status.
Return the response message (success or failure) for an action.
Return start.
Set start ID.
Return ID of tag filter.
Set tag ID.
Return type.
Set type.
Details
in ContentTypes at line 36
array
listTemplates()
Returns a list of template names used by specific content types.
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.
in Listable at line 46
setOrder(string $field)
Sets the primary column to order query results by.
in Listable at line 56
setOrderType(string $orderType)
Sets the sort type (ascending or descending) for the primary order column of a result set.
in Listable at line 66
setSecondaryOrder(string $field)
Sets the secondary column to order query results by.
in Listable at line 76
setSecondaryOrderType(string $orderType)
Sets the sort type (ascending or descending) for the secondary order column of a result set.
in Listable at line 88
string
pageTitle()
Return title of this page.
in Listable at line 98
setPageTitle(string $pageTitle)
Set the title of this page.
in Listable at line 118
setTemplate(string $template)
Set the template used by this page.
in Listable at line 135
string
theme()
Return the theme used by this page.
in Listable at line 147
setTheme(string $theme)
Set (change) the theme.
You must ensure that the new theme directory contains the HTML template files that you need.
in Listable at line 164
array
metadata()
Return page-specific metadata overrides.
in Listable at line 174
setMetadata(array $metadata)
Set page-specific overrides of the site metadata.
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.
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.
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.
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.
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.
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).
in ValidateToken at line 40
boolean
validateToken(string $token)
Validate a cross-site request forgery token from a form submission.
Forms contain a hidden field with a random token taken from the user's session. This token is used to validate that a form submission did indeed originate from the user, by comparing the value against that stored in the user's session. If they do not match then the request could be a forgery and the form submission should be rejected.
at line 69
__construct(object $model)
Constructor.
at line 85
displayCancel()
Cancel action and redirect to admin page.
at line 94
displayConfirmDelete()
Display delete confirmation form.
at line 105
displayDelete()
Delete content object and display result.
at line 127
displayTable()
Display the admin summary table.
Table a list of content and links to view, edit and delete items.
at line 138
displayToggle()
Toggle a content object online or offline.
at line 149
countContent()
Count content objects meeting filter criteria.
at line 165
string
dateFormat()
Returns the template for formatting the date from preferences.
at line 175
array
extraParams()
Return extra parameters to be included in pagination control links.
at line 192
listContent()
Get content objects matching cached filter criteria.
Result is cached as $contentList property.
at line 216
int
limit()
Return admin-side pagination limit.
at line 227
array
tagOptions(string $zeroOption = TFISH_SELECT_TAGS)
Return options for tag select box control.
at line 252
array
typeOptions(string $zeroOption = TFISH_SELECT_TYPE)
Return options for type select box control.
at line 265
array
statusOptions(string $defaultOption = TFISH_SELECT_STATUS)
Return options for tag online status select box control.
at line 281
string
action()
Return the action for this page.
The action is usually embedded in the form, to control handling on submission (next page load).
at line 293
string
backUrl()
Return the backUrl.
If the cancel button is clicked, the user will be redirected to the backUrl.
at line 303
int
contentCount()
Return content count.
at line 313
array
contentList()
Return content list.
at line 323
int
id()
Return ID.
at line 333
setId(int $id)
Set ID.
at line 341
string
contentTitle()
Return content title.
at line 349
setContentTitle()
Set title of content object.
at line 359
int
onlineStatus()
Return online status.
at line 369
setOnlineStatus(int $onlineStatus)
Set online status.
at line 379
string
response()
Return the response message (success or failure) for an action.
at line 389
int
start()
Return start.
at line 401
setStart(int $start)
Set start ID.
First record to return from result set.
at line 411
int
tag()
Return ID of tag filter.
at line 421
setTag(int $tag)
Set tag ID.
at line 431
string
type()
Return type.
at line 443
setType(string $type)
Set type.
Filter list by content type.