Textpattern PHP Cross Reference Content Management Systems

Summary: /textpattern/vendors/Textpattern/Skin/CommonInterface.php - 221 lines - 6977 bytes - Source - Print

Description: Common Interface

Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

CommonInterface:: (18 methods):
getEvent()
getMimeTypes()
setNames()
setName()
setBase()
getEditing()
setEditing()
getMessage()
import()
export()
createRow()
updateRow()
getField()
deleteRows()
countRows()
getRow()
getRows()
getInstalled()

Interface: CommonInterface


getEvent()  line: 37
$event property getter.

return: string $this->event Class related textpack string (usually the event name).
getMimeTypes()  line: 45
$mimeTypes property getter.

return: $this->mimeTypes The asset related mimeTypes array.
setNames($names = null)  line: 53
$names property setter/sanitizer.

return: object $this  The current object (chainable).
param: array $names Multiple skin or template names to work with related methods.
setName($name = null)  line: 62
$name property setter.

return: object $this The current object (chainable).
param: array $name Single skin or template name to work with related methods.
setBase($name line: 73
$base property setter.

param: object $this The current object (chainable).
getEditing()  line: 81
Get the current 'skin_editing' or '{asset}_last_saved' pref value.

return: mixed Skin/template name | false on error.
setEditing()  line: 89
Set the 'skin_editing' or '{asset}_last_saved' pref value
to the $name property value.

return: bool false on error.
getMessage()  line: 98
Get the $results property value as a message to display in the admin tabs.

return: mixed Message or array containing the message
import($sync = false, $override = false)  line: 107
Import/Override (and clean) multiple skins (and their related $assets)
or multiple templates from the $names (+ $skin) property value(s).
Merges results in the related property.

return: object $this     The current object (chainable).
param: bool $sync     Whether to removes extra skin template rows or not;
param: bool $override Whether to insert or update the skins.
export($sync = false, $override = false)  line: 119
Export (and clean) multiple skins (and their related $assets)
or multiple templates from the $names (+ $skin) property value(s).
Merges results in the related property.

return: object $this The current object (chainable).
param: bool $sync Whether to removes extra skin template files or not;
createRow($set = null, $debug = false)  line: 130
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: 141
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: 154
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: 167
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: 178
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: 188
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: 201
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
getInstalled()  line: 214
$installed property getter.

return: array $this->installed.

title

Body