Textpattern PHP Cross Reference Content Management Systems

Summary: /textpattern/vendors/Textpattern/Skin/Skin.php - 1595 lines - 51200 bytes - Source - Print

Description: Skin

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

Defines 1 class

Skin:: (44 methods):
__construct()
__toString()
mergeResults()
setDirPath()
getDirPath()
setAssets()
getAssets()
setInfos()
getSubdirPath()
getFilename()
getFilePath()
getFileContents()
parseInfos()
getSections()
updateSections()
getEditing()
setEditing()
createFile()
setUploaded()
getUploaded()
mergeInstalled()
removeInstalled()
getTableData()
create()
update()
duplicate()
import()
export()
delete()
deleteFiles()
admin()
render()
getList()
getSearchBlock()
getCreateBlock()
getImportForm()
getPaginator()
getSearchFilter()
getCreateButton()
getContentBlock()
getFootBlock()
getMultiEditCheckbox()
getMultiEditForm()
getEditForm()

Class: Skin


__construct()  line: 79
{@inheritdoc}

__toString()  line: 88
No description
mergeResults($asset, $status line: 93
No description
setDirPath($path = null)  line: 100
$dirPath property setter.

return: string $this->dirPath
param: string $path          Path (default: get_pref('path_to_site').DS.get_pref('skin_dir')).
getDirPath()  line: 117
$dirPath property getter

return: string $this->dirPath
setAssets($pages = null, $forms = null, $styles = null)  line: 130
$assets property setter.

return: object $this   The current class object (chainable)
param: array   $pages  Page names to work with;
param: array   $forms  Form names to work with;
param: array   $styles CSS names to work with.
getAssets()  line: 154
$assets property getter.

return: array $this->$assets
setInfos($name,$title = null,$version = null,$description = null,$author = null,$author_uri = null)  line: 167
$infos and $name properties setter.

return: object $this        The current class object (chainable).
param: string $name        Skin name;
param: string $title       Skin title;
param: string $version     Skin version;
param: string $description Skin description;
param: string $author      Skin author;
param: string $author_uri  Skin author URL;
getSubdirPath($name = null)  line: 196
Get a $dir property value related subdirectory path.

return: string       The Path
param: string  $name Directory(/skin) name (default: $this->getName()).
getFilename()  line: 210
$file property getter.

return: string self::$filename.
getFilePath()  line: 221
Get the $file property value related path.

return: string Path.
getFileContents()  line: 232
Get and complete the skin related file contents.

return: array Associative array of JSON fields and their related values / fallback values.
parseInfos($infos line: 247
Parse a skin related infos.

return: array $infos Associative array of fields and their related values / fallback values.
getSections($skin = null)  line: 266
$sections property getter.

param: array Section names.
updateSections($set = null, $where = null, $dev = false)  line: 286
Update the txp_section table.

return: bool          FALSE on error.
param: string $set   The SET clause (default: "skin = '".doSlash($this->getName())."'")
param: string $where The WHERE clause (default: "skin = '".doSlash($this->getBase())."'")
getEditing()  line: 309
{@inheritdoc}

setEditing($name = null)  line: 328
{@inheritdoc}

createFile($pathname = null, $contents = null)  line: 346
Create a file in the $dir property value related directory.

return: bool             Written octets number or FALSE on error.
param: string $pathname The file related path (default: $this->getName().DS.self::getFilename()).
param: mixed  $contents The file related contents as as a string or
setUploaded()  line: 376
$uploaded property setter.

return: object $this The current class object (chainable).
getUploaded($expanded = true)  line: 404
{@inheritdoc}

mergeInstalled($skins line: 425
$installed property merger.

param: array $this->installed.
removeInstalled($names line: 438
$installed property remover.

return: array $this->installed.
getTableData($criteria, $sortSQL, $offset, $limit line: 454
{@inheritdoc}

create()  line: 483
Create/CreateFrom a single skin (and its related assets)
Merges results in the related property.

return: object $this The current object (chainable).
update()  line: 541
Update a single skin (and its related dependencies)
Merges results in the related property.

return: object $this The current object (chainable).
duplicate()  line: 617
Duplicate multiple skins (and their related $assets)
Merges results in the related property.

return: object $this The current object (chainable).
import($sync = false, $override = false)  line: 702
{@inheritdoc}

export($sync = false, $override = false)  line: 769
{@inheritdoc}

delete($sync = false)  line: 846
Delete multiple skins (and their related $assets + directories if empty)
Merges results in the related property.

return: object $this The current object (chainable).
deleteFiles($names = null)  line: 929
Delete Files from the $dir property value related directory.

return: bool   0 on error.
param: string $names directory/file names.
admin()  line: 960
Control the admin tab.

render($step line: 1064
Render (echo) the $step related admin tab.

param: string $step
getList($message = '')  line: 1081
{@inheritdoc}

getSearchBlock($search line: 1156
Get the admin related search form wrapped in its div.

return: HTML
param: object $search Textpattern\Search\Filter class object.
getCreateBlock()  line: 1177
Get the .txp-control-panel div.

return: HTML div containing the 'Create' button and the import form.
getImportForm()  line: 1195
Get the skin import form.

return: HTML The form or a message if no new skin directory is found.
getPaginator()  line: 1238
Get the class related Admin\Paginator instance.

return: object Admin\Paginator instance.
getSearchFilter($methods line: 1249
Get the class related Search\Filter instance.

return: object          Search\Filter instance.
param: array  $methods Available search methods.
getCreateButton()  line: 1261
Get the button to create a new skin.

return: HTML Link.
getContentBlock($data line: 1274
Get the Admin\Table $content block.

return: HTML        Skin list.
param: array $data compact('offset', 'limit', 'total', 'criteria', 'crit', 'search_method', 'page', 'sort', 'dir')
getFootBlock($data line: 1438
Get the Admin\Table $foot block.

return: HTML        Multi-edit form, pagination and navigation form.
param: array $data compact('limit', 'numPages', 'total', 'crit', 'search_method', 'page', 'sort', 'dir')
getMultiEditCheckbox($label line: 1453
Get a multi-edit checkbox.

return: HTML
param: string $label The textpack related string to use.
getMultiEditForm($page, $sort, $dir, $crit, $search_method line: 1467
Render a multi-edit form widget.

return: HTML
param: int    $page          The current page number
param: string $sort          The current sorting value
param: string $dir           The current sorting direction
param: string $crit          The current search criteria
param: string $search_method The current search method
getEditForm($message = '')  line: 1499
Get the edit form.

return: HTML
param: mixed $message

title

Body