1. class
  2. Tfish
  3. \
  4. Content
  5. \
  6. Model
  7. \
  8. Search

Search

class Search

Model for searching content objects.

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(Database $database, CriteriaFactory $criteriaFactory, Preference $preference)

Constructor.

array
search(array $params)

Search content objects.

int
adminLimit()

Return admin-side pagination limit.

string
dateFormat()

Return the template for formatting dates from preferences.

array
getObjects(array $params)

Get objects matching filtering criteria.

int
limit()

Return search results pagination limit.

int
minSearchLength()

Return minimum length (characters) of search terms.

int
onlineStatus()

Return onlineStatus.

setOnlineStatus(int $onlineStatus)

Set onlineStatus.

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 50
__construct(Database $database, CriteriaFactory $criteriaFactory, Preference $preference)

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.

Search content objects.

Parameters

array $params Filtering criteria (keywords, limit, offset etc).

Return Value

array

at line 83
int adminLimit()

Return admin-side pagination limit.

Return Value

int Number of items to display in one page view.

at line 91
string dateFormat()

Return the template for formatting dates from preferences.

Return Value

string

at line 101
array getObjects(array $params)

Get objects matching filtering criteria.

Parameters

array $params Filtering criteria such as keywords, limit, offset etc.

Return Value

array

at line 114
int limit()

Return search results pagination limit.

Return Value

int Number of items to display in one page of search results.

at line 126
int minSearchLength()

Return minimum length (characters) of search terms.

Shorter search tersm will be discarded.

Return Value

int

at line 136
int onlineStatus()

Return onlineStatus.

Return Value

int Retrieve all content (0) or only online content (1).

at line 146
setOnlineStatus(int $onlineStatus)

Set onlineStatus.

Parameters

int $onlineStatus Retrieve all content (0) or only online content (1).