| Textpattern | PHP Cross Reference | Content Management Systems |
Description: Common Base Extended by Skin and AssetBase.
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Functions that are not part of a class:
| __construct() line: 130 |
| Constructor |
| getTable() line: 139 |
| Get the class related Database table name return: string Table name. |
| setEvent() line: 150 |
| $event property setter. return: $this The current object (chainable). |
| getEvent() line: 163 |
| $event property getter. return: string $this->event Class related textpack string (usually the event name). |
| getNamePattern() line: 174 |
| $namePattern property getter return: string self::$namePattern Skin/templates directory/files name(s) pattern. |
| getMimeTypes() line: 185 |
| $mimeTypes property getter. return: $this->mimeTypes The asset related mimeTypes array. |
| isExportable($name = null) line: 196 |
| Whether a $name property related value is a valid directory name or not. return: bool FALSE on error. |
| sanitize($text) line: 207 |
| Sanitizes a string for use in a theme template's name. Just runs sanitizeForPage() followed by sanitizeForFile(), then limits the number of characters to 63. return: string param: string $text The string |
| setNames($names = null) line: 224 |
| $names property setter/sanitizer. return: object $this The current class object (chainable). param: array $names Multiple skin or template names to work with related methods. |
| getNames() line: 248 |
| $names property getter. return: array Skin or template sanitized names. |
| setName($name = null) line: 259 |
| $name property setter. return: object $this The current class object (chainable). param: array $name Single skin or template name to work with related methods. |
| getName() line: 275 |
| $name property getter. return: string Sanitized skin or template name. |
| getInfos($safe = false) line: 286 |
| $infos property getter/parser. return: mixed The $infos property value or the related SET clause. param: bool $safe Whether to get the property value |
| setBase($name) line: 309 |
| $base property setter. param: object $this The current object (chainable). |
| getBase() line: 322 |
| $base property getter. return: string Sanitized skin or template base name. |
| getSyncPref($name) line: 333 |
| Get the 'synchronize' preference value. return: bool param: string $name Pref name. |
| switchSyncPref($name) line: 353 |
| Switch the 'synchronize' preference value and its related global variable. return: bool FALSE on error. param: string $name Pref name. |
| mergeResult($txtItem, $list, $status = null) line: 376 |
| Merge a result into the $results property array. return: object $this The current class object (chainable). param: string $txtItem Textpack related item. param: mixed $list A name or an array of names associated with the result param: string $status 'success'|'warning'|'error'. |
| getResults($status = null) line: 400 |
| $results property getter. return: array Associative array of status textpack related items param: array $status Array of results related status ('success', 'warning', 'error') to filter the output. |
| getMessage() line: 423 |
| Get the $results property value as a message to display in the admin tabs. return: mixed Message or array containing the message |
| getExtension() line: 471 |
| $extension property getter. return: string static::$extension. |
| getFiles($names = null, $maxDepth = null) line: 482 |
| Get files from the $dir property value related directory. return: object Collection of file objects. param: array $names Optional filenames to filter the result. param: int $maxDepth Optional RecursiveIteratorIterator related property value (default = -1 infinite). |
| createRow($set = null, $debug = false) line: 502 |
| Insert a row into the $table property value related table. return: bool FALSE on error. param: string $set Optional SET clause. param: bool $debug Dump query |
| updateRow($set = null, $where = null, $debug = false) line: 524 |
| Update the $table property value related table. return: bool FALSE on error. param: string $set Optional SET clause. param: string $where Optional WHERE clause. param: bool $debug Dump query |
| getField($thing = null, $where = null, $debug = false) line: 563 |
| Get a row field from the $table property value related table. return: mixed The Field or FALSE on error. param: string $thing Optional SELECT clause. param: string $where Optional WHERE clause. param: bool $debug Dump query |
| deleteRows($where = null, $debug = false) line: 602 |
| Delete rows from the $table property value related table. return: bool FALSE on error. param: string $where Optional WHERE clause. param: bool $debug Dump query |
| countRows($where = null, $debug = false) line: 637 |
| Count rows in the $table property value related table. return: mixed Number of rows or FALSE on error param: string $where The where clause. param: bool $debug Dump query |
| getRow($things = null, $where = null, $debug = false) line: 650 |
| Get a row from the $table property value related table as an associative array. return: bool Array. param: string $things Optional SELECT clause. param: string $where Optional WHERE clause. param: bool $debug Dump query |
| getRows($things = null, $where = null, $debug = false) line: 689 |
| Get rows from the $table property value related table as an associative array. return: array (Empty on error) param: string $thing Optional SELECT clause. param: string $where Optional WHERE clause (default: "name = '".doSlash($this->getName())."'") param: bool $debug Dump query |
| getDefault() line: 740 |
| Get the skin name used by the default section. return: mixed Skin name or FALSE on error. |
| setInstalled() line: 751 |
| $installed property setter. param: array $this->installed. |
| getInstalled() line: 779 |
| $installed property getter. return: array $this->installed. |
| isInstalled($name = null) line: 790 |
| Whether a skin/template is installed or not. return: bool param: string $name Skin name (default: $this->getName()). |
| isDirEmpty($path) line: 822 |
| Whether a directory is empty or not. return: mixed NULL if the directory is not readable (or does not exist), param: string $path The directory path |
title