class AdminSearch implements Listable

ViewModel for conducting admin-side free text searches on content objects.

Traits

Provides definition of permitted content object types.
Provides standard implementation for common parts of the Listable interface (excepting pagination and setMetadata()).
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.

setOrder(string $field)

Sets the primary column to order query results by.

from Listable
setOrderType(string $orderType)

Sets the sort type (ascending or descending) for the primary order column of a result set.

from Listable
setSecondaryOrder(string $field)

Sets the secondary column to order query results by.

from Listable
setSecondaryOrderType(string $orderType)

Sets the sort type (ascending or descending) for the secondary order column of a result set.

from Listable
string
pageTitle()

Return title of this page.

from Listable
setPageTitle(string $pageTitle)

Set the title of this page.

from Listable
template()

Return the template object required by this page.

from Listable
setTemplate(string $template)

Set the template used by this page.

from Listable
string
theme()

Return the theme used by this page.

from Listable
setTheme(string $theme)

Set (change) the theme.

from Listable
array
metadata()

Return page-specific metadata overrides.

from Listable
setMetadata(array $metadata)

Set page-specific overrides of the site metadata.

from Listable
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(object $model)

Constructor.

displayForm()

Display the search form.

search()

Search.

string
dateFormat()

Returns the template for formatting the date from preferences.

int
limit()

Return admin-side pagination limit.

string
urlEdit(int $id)

Return URL to edit a content object.

int
contentCount()

Return content count.

array
searchResults()

Return search results.

int
start()

Return start.

setStart(int $start)

Set the starting position in the set of available object.

string
action()

Return the action for this page.

setAction(string $action)

Set action.

array
searchTerms()

Return search terms.

string
searchTermsForForm()

Return search terms for display in form.

setSearchTerms(string $searchTerms)

Set search terms.

array
escapedSearchTerms()

Return search terms XSS escaped for display.

string
searchType()

Return search type.

setSearchType(string $searchType)

Set search type.

array
extraParams()

Return extra parameters to be included in pagination control links.

int
onlineStatus()

Return onlineStatus

int
tag()

Return tag ID.

setTag(int $tag)

Set tag ID.

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 Listable at line 46
setOrder(string $field)

Sets the primary column to order query results by.

Parameters

string $field Name of the primary column to order the 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.

Parameters

string $orderType Ascending (ASC) or descending (DESC) order.

in Listable at line 66
setSecondaryOrder(string $field)

Sets the secondary column to order query results by.

Parameters

string $field Name of the secondary column to order the 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.

Parameters

string $orderType Ascending (ASC) or descending (DESC) order.

in Listable at line 88
string pageTitle()

Return title of this page.

Return Value

string

in Listable at line 98
setPageTitle(string $pageTitle)

Set the title of this page.

Parameters

string $pageTitle Title of this page.

in Listable at line 108
Template template()

Return the template object required by this page.

Return Value

Template

in Listable at line 118
setTemplate(string $template)

Set the template used by this page.

Parameters

string $template Name of template (alphanumeric and underscore characters only).

in Listable at line 135
string theme()

Return the theme used by this page.

Return Value

string

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.

Parameters

string $theme Name of theme directory (alphanumeric and underscores only).

in Listable at line 164
array metadata()

Return page-specific metadata overrides.

Return Value

array

in Listable at line 174
setMetadata(array $metadata)

Set page-specific overrides of the site metadata.

Parameters

array $metadata Array of metadata as key => value pairs.

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 68
__construct(object $model)

Constructor.

Parameters

object $model Instance of a model class.

at line 87
displayForm()

Display the search form.

Search.

Search results are cached in the property $searchResults.

at line 114
string dateFormat()

Returns the template for formatting the date from preferences.

Return Value

string

at line 124
int limit()

Return admin-side pagination limit.

Return Value

int

at line 135
string urlEdit(int $id)

Return URL to edit a content object.

Parameters

int $id ID of content object.

Return Value

string URL of edit link.

at line 147
int contentCount()

Return content count.

Return Value

int

at line 157
array searchResults()

Return search results.

Return Value

array

at line 167
int start()

Return start.

Return Value

int

at line 177
setStart(int $start)

Set the starting position in the set of available object.

Parameters

int $start ID of first object to view in the set of available records.

at line 189
string action()

Return the action for this page.

The action is usually embedded in the form, to control handling on submission (next page load).

Return Value

string

at line 199
setAction(string $action)

Set action.

Parameters

string $action Action is embedded in the form, to control handling on submission (next page load)

at line 209
array searchTerms()

Return search terms.

Return Value

array

at line 219
string searchTermsForForm()

Return search terms for display in form.

Return Value

string

at line 229
setSearchTerms(string $searchTerms)

Set search terms.

Parameters

string $searchTerms Search terms (keywords).

at line 268
array escapedSearchTerms()

Return search terms XSS escaped for display.

Return Value

array

at line 278
string searchType()

Return search type.

Return Value

string Options are: "AND", "OR", "exact".

at line 288
setSearchType(string $searchType)

Set search type.

Parameters

string $searchType Options are: "AND", "OR", "exact".

at line 298
array extraParams()

Return extra parameters to be included in pagination control links.

Return Value

array

at line 322
int onlineStatus()

Return onlineStatus

Return Value

int Both online and offline content (0).

at line 332
int tag()

Return tag ID.

Return Value

int

at line 342
setTag(int $tag)

Set tag ID.

Parameters

int $tag ID of tag.