XenForo Reference Guide for Developer
Back to top  

Model for styles

Models don't share that much, so most implementations will be adding methods onto this class. This class simply provides helper methods for common actions.

package XenForo_Styles

 Methods

Constructor.

__construct() 
Inherited

Use create() statically unless you know what you're doing.

inherited_from \XenForo_Model::__construct()

Adds a join to the set of fetch options.

addFetchOptionJoin(array $fetchOptions, integer $join) 
Inherited

Join should be one of the constants.

inherited_from \XenForo_Model::addFetchOptionJoin()

Parameters

$fetchOptions

array

$join

integer

Adds the equivalent of a limit clause using position-based limits.

addPositionLimit(string $table, integer $limit, integer $offset, string $column) : string
Inherited

It no limit value is specified, nothing will be returned.

This must be added within a WHERE clause. If a clause is required, it will begin with "AND", so ensure there is a condition before it.

inherited_from \XenForo_Model::addPositionLimit()

Parameters

$table

string

Name of the table alias to prefix. May be blank for no table reference.

$limit

integer

Number of records to limit to; ignored if <= 0

$offset

integer

Offset from the start of the records. 0+

$column

string

Name of the column that is storing the position

Returns

stringPosition limit clause if needed

Ensures that a valid cut-off operator is passed.

assertValidCutOffOperator(string $operator) 
Inherited
inherited_from \XenForo_Model::assertValidCutOffOperator()

Parameters

$operator

string

Counts the number of customized templates in each non-master style

countCustomTemplatesPerStyle(array $styles) : array

Parameters

$styles

array

Array of styles

Returns

arrayThe $styles array including a templateCount key

Returns the total number of templates in the master style

countMasterTemplates() : integer

Returns

integer

Factory method to get the named model.

create(string $class) : \XenForo_Model
InheritedStatic

The class must exist or be autoloadable or an exception will be thrown.

inherited_from \XenForo_Model::create()

Parameters

$class

string

Class to load

Returns

\XenForo_Model

Fetches results from the database with each row keyed according to preference.

fetchAllKeyed(string $sql, string $key, mixed $bind, string $nullPrefix) : array
Inherited

The 'key' parameter provides the column name with which to key the result. For example, calling fetchAllKeyed('SELECT item_id, title, date FROM table', 'item_id') would result in an array keyed by item_id: [$itemId] => array('item_id' => $itemId, 'title' => $title, 'date' => $date)

Note that the specified key must exist in the query result, or it will be ignored.

inherited_from \XenForo_Model::fetchAllKeyed()

Parameters

$sql

string

SQL to execute

$key

string

Column with which to key the results array

$bind

mixed

Parameters for the SQL

$nullPrefix

string

If the key is null, prefix the counter with this

Returns

array

Gets all children of a style ID, no matter how many levels below.

getAllChildStyleIds(integer $styleId) : array

Parameters

$styleId

integer

Returns

arrayArray of style IDs

Internal handler to get call child style IDs.

getAllChildStyleIdsFromTree(integer $parentId, array $styleTree) : array

Parameters

$parentId

integer

Parent style ID

$styleTree

array

Tree of styles ([parent id][] => style id)

Returns

array

Gets information about all styles, not including the master style.

getAllStyles() : array

Returns

arrayFormat: [style id] => (array) style info

Gets a list of styles in the form of a flattened tree.

getAllStylesAsFlattenedTree(integer $baseDepth) : array

The return is an array containing all styles and their related info. Each style additionally includes a "depth" element that repesents the depth from the (implicit) master. Children of the master have a depth 0, unless $baseDepth is overridden.

Parameters

$baseDepth

integer

Starting depth value.

Returns

arrayFormat: [style id] => (array) style info, including depth

Gets a list of SQL conditions in the format for a clause.

getConditionsForClause(array $sqlConditions) : string
Inherited

This always returns a value that can be used in a clause such as WHERE.

inherited_from \XenForo_Model::getConditionsForClause()

Parameters

$sqlConditions

array

Returns

string

Gets the specified field from a content type, if specified for that type.

getContentTypeField(string $contentType, string $fieldName) : string | false
Inherited
inherited_from \XenForo_Model::getContentTypeField()

Parameters

$contentType

string

$fieldName

string

Returns

stringfalse

Gets the value of the specified field for each content type that has that field.

getContentTypesWithField(string $fieldName) : array
Inherited
inherited_from \XenForo_Model::getContentTypesWithField()

Parameters

$fieldName

string

Returns

arrayFormat: [content type] => field value

Gets a list of child style IDs that are direct children of the specified style.

getDirectChildStyleIds(integer $styleId) : array

Parameters

$styleId

integer

Returns

arrayArray of style IDs

Gets the specified model object from the cache.

getModelFromCache(string $class) : \XenForo_Model
Inherited

If it does not exist, it will be instantiated.

inherited_from \XenForo_Model::getModelFromCache()

Parameters

$class

string

Name of the class to load

Returns

\XenForo_Model

Gets the order by clause for an SQL query.

getOrderByClause(array $choices, array $fetchOptions, string $defaultOrderSql) : string
Inherited
inherited_from \XenForo_Model::getOrderByClause()

Parameters

$choices

array

$fetchOptions

array

$defaultOrderSql

string

Returns

stringOrder by clause or empty string

Gets the base parent list for a style.

getStyleBaseParentList(integer $styleId) : array

This list starts with the parent of the given style ID, then works up the tree, eventually ending with 0.

Parameters

$styleId

integer

Returns

arrayList of parent style IDs (including 0)

Gets style information by ID.

getStyleById(integer $id, boolean $fetchMaster) : array | false

Information about the master style can be fetched using an ID of 0 if $fetchMaster is true.

Parameters

$id

integer

Style ID

$fetchMaster

boolean

If true, passing an ID of 0 will fetch info about the master style.

Returns

arrayfalse

Fetches $styleId from cookie if it's available, or returns the default style ID.

getStyleIdFromCookie(int $allowMaster) : integer

Parameters

$allowMaster

int

If true, allow the master style to be returned

Returns

integer

Generates the style tree association array based on the list of styles (see {@link getAllStyles()}).

getStyleTreeAssociations(array $styleList) : array

Parameters

$styleList

array

List of styles

Returns

arrayFormat: [parent style id][] => child style id

Gets the XML representation of a style, including customized templates and properties.

getStyleXml(array $style) : \DOMDocument

Parameters

$style

array

Returns

\DOMDocument

Return results for admin quick search

getStylesForAdminQuickSearch(string $searchText) : array

Parameters

$searchText

string

Keywords for which to search

Returns

array

Returns an array of all styles, suitable for use in ACP template syntax as options source.

getStylesForOptionsTag(integer $selectedId, array $styleTree) : array

Parameters

$selectedId

integer

Selected style ID

$styleTree

array

Returns

array

Imports a style XML file.

importStyleXml(\SimpleXMLElement $document, integer $parentStyleId, integer $overwriteStyleId) : array

Parameters

$document

\SimpleXMLElement

$parentStyleId

integer

If not overwriting, the ID of the parent style

$overwriteStyleId

integer

If non-0, parent style is ignored

Returns

arrayList of cache rebuilders to run

Applies a limit clause to the provided query if a limit value is specified.

limitQueryResults(string $query, integer $limit, integer $offset) : string
Inherited

If the limit value is 0 or less, no clause is applied.

inherited_from \XenForo_Model::limitQueryResults()

Parameters

$query

string

SQL query to run

$limit

integer

Number of records to limit to; ignored if <= 0

$offset

integer

Offset from the start of the records. 0+

Returns

stringQuery with limit applied if necessary

Prepares the limit-related fetching options that can be applied to various queries.

prepareLimitFetchOptions(array $fetchOptions) : array
Inherited

Includes: limit, offset, page, and perPage.

inherited_from \XenForo_Model::prepareLimitFetchOptions()

Parameters

$fetchOptions

array

Unprepared options

Returns

arrayLimit options; keys: limit, offset

Prepares state related fetch limits, based on the list of conditions.

prepareStateLimitFromConditions(array $fetchOptions, string $table, string $stateField, string $userField) : string
Inherited

Looks for keys "deleted" and "moderated".

inherited_from \XenForo_Model::prepareStateLimitFromConditions()

Parameters

$fetchOptions

array

$table

string

Name of the table to prefix the state and user fields with

$stateField

string

Name of the field that holds the state

$userField

string

Name of the field that holds the user ID

Returns

stringSQL condition to limit state

Rebuilds the style cache that is put in the data registry.

rebuildStyleCache() : array

Returns

array

Recursively rebuilds the parent list in part of the style tree.

rebuildStyleParentListRecursive(integer $styleId) 

Parameters

$styleId

integer

First style to start with. All child will be rebuild.

Reset an entry or the entire local cache.

resetLocalCacheData($name) 
Inherited

This can be used if you know when some cached data has expired.

inherited_from \XenForo_Model::resetLocalCacheData()

Parameters

$name

Sets whether we're allowed to read values from the cache on a model-level.

setAllowCachedRead(boolean $allowCachedRead) 
Inherited

This may be controllable on an individual level basis, if the implementation allows it.

inherited_from \XenForo_Model::setAllowCachedRead()

Parameters

$allowCachedRead

boolean

Injects a local cache value.

setLocalCacheData(string $name, $value) 
Inherited

This should only be used if you know what you're doing or for testing purposes!

Note that you cannot get the existing data via the public interface. If you think you need the set data, use a new object. It defaults to empty. :)

inherited_from \XenForo_Model::setLocalCacheData()

Parameters

$name

string

$value

Helper to determine whether the master style should be shown in lists.

showMasterStyle() : boolean

Returns

boolean

Standardizes a set of node permissions and a user ID to always have appropriate data.

standardizeNodePermissionsAndUserId(integer $nodeId, array | null $permissions, integer | null $userId) 
Inherited

If an invalid permission set or user ID is provided, the current visitor's will be used.

inherited_from \XenForo_Model::standardizeNodePermissionsAndUserId()

Parameters

$nodeId

integer

Node permissions are for

$permissions

arraynull

Permissions for node or null to use current visitor's permissions

$userId

integernull

User permissions belong to or null to use current visitor

Standardizes a permission combination and user ID to always have appropriate data.

standardizePermissionCombinationIdAndUserId(integer | null $permissionCombinationId, integer | null $userId) 
Inherited

If null, users current visitor's values.

inherited_from \XenForo_Model::standardizePermissionCombinationIdAndUserId()

Parameters

$permissionCombinationId

integernull

Permission combination ID or null to use current visitor

$userId

integernull

User permissions belong to or null to use current visitor

Standardizes a set of permissions and a user ID to always have appropriate data.

standardizePermissionsAndUserId(array | null $permissions, integer | null $userId) 
Inherited

If an invalid permission set or user ID is provided, the current visitor's will be used.

inherited_from \XenForo_Model::standardizePermissionsAndUserId()

Parameters

$permissions

arraynull

Global pPermissions or null to use current visitor's permissions

$userId

integernull

User permissions belong to or null to use current visitor

Standardizes a viewing user reference array.

standardizeViewingUserReference(array $viewingUser) 
Inherited

This array must contain all basic user info (preferably all user info) and include global permissions in a "permissions" key. If not an array or missing a user_id, the visitor's values will be used.

inherited_from \XenForo_Model::standardizeViewingUserReference()

Parameters

$viewingUser

arraynull

Standardizes the viewing user reference for the specific node.

standardizeViewingUserReferenceForNode(integer $nodeId, array $viewingUser, array $nodePermissions) 
Inherited
inherited_from \XenForo_Model::standardizeViewingUserReferenceForNode()

Parameters

$nodeId

integer

$viewingUser

arraynull

Viewing user; if null, use visitor

$nodePermissions

arraynull

Permissions for this node; if null, use visitor's

Helper to unserialize permissions in a list of items.

unserializePermissionsInList(array $items, string $serializedKey, string $targetKey) : array
Inherited
inherited_from \XenForo_Model::unserializePermissionsInList()

Parameters

$items

array

List of items

$serializedKey

string

Key where serialized permissions are

$targetKey

string

Key where unserialized permissions will go

Returns

arrayList of items with permissions unserialized

Updates the last modified date of all styles.

updateAllStylesLastModifiedDate(int | null $time) 

Parameters

$time

intnull

Builds the flattened tree recursively, incrementing the depth each time.

_buildFlattenedStyleTree(array $styleList, array $tree, integer $root, integer $depth) : array

Parameters

$styleList

array

List of styles and their information

$tree

array

Tree structure of styles ([parent id][] => style id)

$root

integer

Where to start in the tree

$depth

integer

Current/starting depth

Returns

arrayList of styles with additional depth key

Helper method to get the cache object.

_getCache(boolean $forceCachedRead) : \Zend_Cache_Core | \Zend_Cache_Frontend | false
Inherited

If cache reads are disabled, this will return false.

inherited_from \XenForo_Model::_getCache()

Parameters

$forceCachedRead

boolean

If true, the global "allow cached read" value is ignored

Returns

\Zend_Cache_Core\Zend_Cache_Frontendfalse

Gets the data registry model.

_getDataRegistryModel() : \XenForo_Model_DataRegistry
Inherited
inherited_from \XenForo_Model::_getDataRegistryModel()

Returns

\XenForo_Model_DataRegistry

Helper method to get the database object.

_getDb() : \Zend_Db_Adapter_Abstract
Inherited
inherited_from \XenForo_Model::_getDb()

Returns

\Zend_Db_Adapter_Abstract

Gets the named entry from the local cache.

_getLocalCacheData(string $name) : mixed
Inherited
inherited_from \XenForo_Model::_getLocalCacheData()

Parameters

$name

string

Returns

mixed

Internal function to rebuild the style parent list recursively.

_rebuildStyleParentListRecursive(integer $styleId, array $baseParentList, array $styles, array $styleTree) 

Parameters

$styleId

integer

Base style Id

$baseParentList

array

Base parent list for the style. Should not include this style ID in it.

$styles

array

List of styles

$styleTree

array

Style tree

 Properties

 

$_allowCachedRead : boolean
Inherited

If not, it should be retrieved from the source.

inherited_from \XenForo_Model::$$_allowCachedRead
 

$_cache : \Zend_Cache_Core | \Zend_Cache_Frontend
Inherited
inherited_from \XenForo_Model::$$_cache
 

$_db : \Zend_Db_Adapter_Abstract
Inherited
inherited_from \XenForo_Model::$$_db
 

$_localCacheData : array
Inherited

This data is generally treated as canonical, even if {$_allowCachedRead} is false.

inherited_from \XenForo_Model::$$_localCacheData
 

$_modelCache : array
Inherited
inherited_from \XenForo_Model::$$_modelCache