phpDocumentor
Back to top  

Model for style properties and style property definitions.

Note that throughout, style ID -1 is the ACP master.

package XenForo_StyleProperty

 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

Appends the style property list to an XML document.

appendStylePropertyXml(\DOMElement $rootNode, integer $styleId, string | null $addOnId) 

Parameters

$rootNode

\DOMElement

Node to append to

$styleId

integer

Style to read values/definitions from

$addOnId

stringnull

If not null, limits to values/definitions in the specified add-on

Ensures that a valid cut-off operator is passed.

assertValidCutOffOperator(string $operator) 
Inherited

inherited_from \XenForo_Model::assertValidCutOffOperator()

Parameters

$operator

string

Determines if a style property can be edited in the specified style.

canEditStyleProperty(integer $styleId) : boolean

Parameters

$styleId

integer

Returns

boolean

Determines if a style property definition can be edited in the specified style.

canEditStylePropertyDefinition(integer $styleId) : boolean

Parameters

$styleId

integer

Returns

boolean

Compiles a CSS property from it's user-input-based version to the property cache version.

compileCssPropertyForCache(array $original, array $properties) : array

Parameters

$original

array

Original, input-based CSS rule

$properties

array

A list of all properties, for resolving variable style references

Returns

arrayCSS rule for cache

Cleans up the CSS property output after compilation.

compileCssProperty_cleanUp(array $output, array $original) : array

Parameters

$output

array

Output CSS property

$original

array

Original format of CSS property

Returns

arrayUpdated output CSS property

Compiles all the rules of a CSS property.

compileCssProperty_compileRules(array $output, array $original) : array

Parameters

$output

array

Output CSS property

$original

array

Original format of CSS property

Returns

arrayUpdated output CSS property

Sanitizes the values in the CSS property output array.

compileCssProperty_sanitize(array $output, array $original) : array

Parameters

$output

array

Output CSS property

$original

array

Original format of CSS property

Returns

arrayUpdated output CSS property

Compiles a scalar property value for the cache.

compileScalarPropertyForCache(string $original, array $properties) : string

Parameters

$original

string

Original property value

$properties

array

A list of all properties, for resolving variable style references

Returns

string

Converts @propertyName to {xen:property propertyName}

convertAtPropertiesToTemplateSyntax(string $text, array $properties) : string

Parameters

$text

string

$properties

array

Returns

string

Factory method to get the named model.

create(string $class) : \XenForo_Model
Inherited

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

Create of update a style property definition.

createOrUpdateStylePropertyDefinition(integer $definitionId, array $input) : array

Input data is named after fields in the style property definition, as well as property_value_scalar and property_value_css.

Parameters

$definitionId

integer

Definition to update; if 0, creates a new one

$input

array

List of data from input to change in definition

Returns

arrayDefinition info after saving

Deletes the style properties and definitions in a style (and possibly limited to an add-on).

deleteStylePropertiesAndDefinitionsInStyle(integer $styleId, string | null $addOnId, boolean $leaveChildCustomizations) 

Parameters

$styleId

integer

Style to delete from. 0 for master, -1 for admin

$addOnId

stringnull

If not null, limits deletions to an ad-on

$leaveChildCustomizations

boolean

If true, child customizations of a deleted definition will be left

Deletes a style property development file.

deleteStylePropertyDevelopmentFile(string $name, integer $styleId) 

Parameters

$name

string

$styleId

integer

Definition style ID.

Deletes the style property file if needed.

deleteStylePropertyDevelopmentFileIfNeeded(array $definition, array $property) 

This is used when reverting a customized property; the file is only deleted if we're deleting the property from a style other than the one it was created in.

Parameters

$definition

array

$property

array

Delete the style property groups in the specified style, matching the add-on if provided.

deleteStylePropertyGroupsInStyle(integer $styleId, string | null $addOnId) 

Parameters

$styleId

integer

Style to delete from. 0 for master, -1 for admin

$addOnId

stringnull

If not null, limits deletions to an ad-on

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

Filters a list of properties into 2 groups: scalar properties and css properties.

filterPropertiesByType(array $properties) 

Parameters

$properties

array

[scalar props, css props]

Fetches all color palette properties for the specified style.

getColorPalettePropertiesInStyle(integer $styleId, array $path, array $properties) : array

Parameters

$styleId

integer

$path

arraynull

Path from style to root (earlier positions closer to style); if null, determined automatically

$properties

arraynull

List of properties in this style and all parent styles; if null, determined automatically

Returns

array

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 the default style property definition.

getDefaultStylePropertyDefinition(integer $styleId, string $groupName) : array

Parameters

$styleId

integer

$groupName

string

Returns

array

Gets the default style property group record.

getDefaultStylePropertyGroup(integer $styleId) : array

Parameters

$styleId

integer

Returns

array

Gets the effective properties and groups in a style.

getEffectiveStylePropertiesByGroup(integer $styleId, array $path, array $properties) : array

Properties are organized within the groups (in properties key).

Parameters

$styleId

integer

$path

arraynull

Path from style to root (earlier positions closer to style); if null, determined automatically

$properties

arraynull

List of properties in this style and all parent styles; if null, determined automatically

Returns

arrayFormat: [group name] => group info, with [properties][definition id] => property info

Gets the effective style properties in a style.

getEffectiveStylePropertiesInStyle(integer $styleId, array $path, array $properties) : array

This includes properties that have been customized/created in a parent style.

Includes effectiveState key in each property (customized, inherited, default).

Parameters

$styleId

integer

$path

arraynull

Path from style to root (earlier positions closer to style); if null, determined automatically

$properties

arraynull

List of properties in this style and all parent styles; if null, determined automatically

Returns

arrayFormat: [definition id] => info

Gets the effective list of groups that apply to a style.

getEffectiveStylePropertyGroupsInStyle(integer $styleId, array $path) : array

Parameters

$styleId

integer

$path

arraynull

Path from style to root (earlier positions closer to style); if null, determined automatically

Returns

arrayFormat: [group name] => info

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 parent path from the specified style.

getParentPathFromStyle($styleId) : array

For real styles, this is the parent list. However, this function can handle styles 0 (master) and -1 (ACP).

Parameters

$styleId

Returns

arrayParent list; earlier positions are more specific

Gets style info in the style property-specific way.

getStyle(integer $styleId) : array | false

Parameters

$styleId

integer

Returns

arrayfalse

Gets all style properties in a style with the specified definition IDs that have been customized or defined directly in the style.

getStylePropertiesInStyleByDefinitions(integer $styleId, array $definitionIds) : array

Parameters

$styleId

integer

$definitionIds

array

Returns

arrayFormat: [definition id] => info

Gets all style properties in the specified styles.

getStylePropertiesInStyles(array $styleIds) : array

This only includes properties that have been customized or initially defined in the specified styles. Includes definition info.

Parameters

$styleIds

array

Returns

arrayFormat: [property id] => info

Gets the specified style property by its definition ID and style ID.

getStylePropertyByDefinitionAndStyle(integer $definitionId, integer $styleId) : array | false

Includes definition info.

Parameters

$definitionId

integer

$styleId

integer

Returns

arrayfalse

Gets the specified style property by its ID.

getStylePropertyById(integer $id) : array | false

Includes definition info.

Parameters

$id

integer

Returns

arrayfalse

Get the specified style property definition by ID.

getStylePropertyDefinitionById(integer $propertyDefinitionId) : array | false

Includes default property value.

Parameters

$propertyDefinitionId

integer

Returns

arrayfalse

Gets the specified style property definition by its name and definition style ID.

getStylePropertyDefinitionByNameAndStyle(string $name, integer $styleId) : array | false

Includes default property value.

Parameters

$name

string

$styleId

integer

Returns

arrayfalse

Returns an array of all style property definitions in the specified group

getStylePropertyDefinitionsByGroup($groupName, integer | null $styleId) : array

Parameters

$groupName

$styleId

integernull

If specified, limits to definitions in a specified style

Returns

array

Get the specified style property definitions by their IDs.

getStylePropertyDefinitionsByIds(array $propertyDefinitionIds) : array

Includes default property value.

Parameters

$propertyDefinitionIds

array

Returns

arrayFormat: [property definition id] => info

Get the specified style property definitions by their property names.

getStylePropertyDefinitionsForAdminQuickSearch(string $searchText, array $propertyNames) : array

Does not include default property value.

Parameters

$searchText

string

$propertyNames

array

Returns

array

Gets the name of the style property description phrase.

getStylePropertyDescriptionPhraseName(array $property) : string

Parameters

$property

array

Returns

string

Get the style property development directory based on the style a property/definition is defined in.

getStylePropertyDevelopmentDirectory(integer $styleId) : string

Returns an empty string for non-master properties.

Parameters

$styleId

integer

Returns

string

Gets the full path to a specific style property development file.

getStylePropertyDevelopmentFileName(string $propertyName, integer $styleId) : string

Ensures directory is writable.

Parameters

$propertyName

string

$styleId

integer

Returns

string

Gets the style property development XML.

getStylePropertyDevelopmentXml(integer $styleId) : \DOMDocument

Parameters

$styleId

integer

Returns

\DOMDocument

Gets the specified style property group.

getStylePropertyGroupById(integer $groupId) : array | false

Parameters

$groupId

integer

Returns

arrayfalse

Gets the name of the style property group description phrase.

getStylePropertyGroupDescriptionPhraseName(array $group) : string

Parameters

$group

array

Returns

string

Gets name-value pairs of style property groups in a style.

getStylePropertyGroupOptions(integer $styleId) : array

Parameters

$styleId

integer

Returns

arrayFormat: [name] => title

Gets the name of the style property group title phrase.

getStylePropertyGroupTitlePhraseName(array $group) : string

Parameters

$group

array

Returns

string

Gets all style property groups defined in the specified styles.

getStylePropertyGroupsInStyles(array $styleIds) : array

Parameters

$styleIds

array

Returns

arrayFormat: [property group id] => info

Gets the name of the style property title phrase.

getStylePropertyTitlePhraseName(array $property) : string

Parameters

$property

array

Returns

string

Group a list of style properties by the style they belong to.

groupStylePropertiesByStyle(array $properties) : array

This uses the customization style (not definition style) for grouping.

Parameters

$properties

array

Returns

arrayFormat: [style id][definition id] => info

Imports style properties and definitions from an array.

importStylePropertiesFromArray(array $newProperties, array $newGroups, integer $styleId, string | null $addOnId) 

Parameters

$newProperties

array

List of properties and definitions to import

$newGroups

array

List of groups to import

$styleId

integer

Target style ID

$addOnId

stringnull

If not null, only replaces properties with this add-on; otherwise, all in style

Imports style properties/groups from the development location.

importStylePropertiesFromDevelopment(integer $styleId) 

This only imports one style's worth of properties at a time.

Parameters

$styleId

integer

Style to import for

Imports the development admin navigation XML data.

importStylePropertyDevelopmentXml(string $fileName, $styleId) 

Parameters

$fileName

string

File to read the XML from

$styleId

Imports style properties and definitions from XML.

importStylePropertyXml(\SimpleXMLElement $xml, integer $styleId, string | null $addOnId) 

Parameters

$xml

\SimpleXMLElement

XML node to search within

$styleId

integer

Target style ID

$addOnId

stringnull

If not null, target add-on for definitions; if null, add-on is ''

Reorganizes a property list to key properties by name.

keyPropertiesByName(array $properties) : array

This is only safe to do when getting properties (effective or not) for a single style.

Parameters

$properties

array

Returns

array

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

Updates the group_name of all style property definitions in group $sourceGroup to $destinationGroup.

moveStylePropertiesBetweenGroups(string $sourceGroup, string $destinationGroup) 

Parameters

$sourceGroup

string

$destinationGroup

string

Moves a style property development file, for renames.

moveStylePropertyDevelopmentFile(array $oldDefinition, array $newDefinition) 

Parameters

$oldDefinition

array

$newDefinition

array

Parses background shortcut CSS.

parseBackgroundCss(string $value) : array | false

Parameters

$value

string

Returns

arrayfalseList of property rules to apply or false if shortcut could not be parsed

Parses border shortcut CSS.

parseBorderCss(string $value, string $name) : array | false

Parameters

$value

string

$name

string

The name of the shortcut (border, border-top, etc)

Returns

arrayfalseList of property rules to apply or false if shortcut could not be parsed

Parses font shortcut CSS.

parseFontCss(string $value) : array | false

Parameters

$value

string

Returns

arrayfalseList of property rules to apply or false if shortcut could not be parsed

Parses padding/margin shortcut CSS.

parsePaddingMarginCss(string $value, array $values) : boolean

Parameters

$value

string

$values

array

By reference. Pushes out the effective padding/margin values to later be pulled together.

Returns

boolean

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

Prepares a list of style properties.

prepareStyleProperties(array $properties, integer | null $displayStyleId) : array

Parameters

$properties

array

$displayStyleId

integernull

The ID of the style the properties are being edited in

Returns

array

Prepares a style property (or definition) for display.

prepareStyleProperty(array $property, integer | null $displayStyleId) : array

Parameters

$property

array

$displayStyleId

integernull

The ID of the style the properties are being edited in

Returns

arrayPrepared version

Prepares a style property group for display.

prepareStylePropertyGroup(array $group, integer | null $displayStyleId) : array

If properties are found within, they will be automatically prepared.

Parameters

$group

$displayStyleId

integernull

The ID of the style the groups/properties are being edited in

Returns

arrayPrepared version

Prepares a list of style property groups.

prepareStylePropertyGroups(array $groups, integer | null $displayStyleId) : array

If properties are found within, they will be automatically prepared.

Parameters

$groups

array

$displayStyleId

integernull

The ID of the style the groups/properties are being edited in

Returns

array

Prepares the title and description and group name phrases for a style property

prepareStylePropertyPhrases(array $property) : array

Parameters

$property

array

Returns

array

Rebuilds the property cache for all styles.

rebuildPropertyCacheForAllStyles() 

Rebuild the style property cache in the specified style and all child/dependent styles.

rebuildPropertyCacheInStyleAndChildren(integer $styleId) : array

Parameters

$styleId

integer

Returns

arrayThe property cache for the requested style

Replaces {xen:property} references in a template with the @ property version.

replacePropertiesInTemplateForEditor(string $templateText, integer $editStyleId, array $properties) : string

This allows for easier editing and viewing of properties.

Parameters

$templateText

string

Template with {xen:property} references

$editStyleId

integer

The style the template is being edited in

$properties

arraynull

A list of valid style properties; if null, grabbed automatically ([name] => property)

Returns

stringReplaced template text

Replaces variable references in a style property value.

replaceVariablesInStylePropertyValue(string $value, array $properties, array $seenProperties) : string

Parameters

$value

string

Property value. This is an individual string value.

$properties

array

List of properites to read from.

$seenProperties

Returns

string

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

Saves a set of style property changes from the input format.

saveStylePropertiesInStyleFromInput(integer $styleId, array $properties, array $reset) 

Parameters

$styleId

integer

Style to change properties in

$properties

array

Properties from input; keyed by definition ID

$reset

array

List of properties to reset if customized; keyed by definition ID

Saves style properties in the specified style based on the @ property references that have been parsed out of the template(s).

saveStylePropertiesInStyleFromTemplate(integer $styleId, array $updates, array $properties) 

Parameters

$styleId

integer

Style to save properties into

$updates

array

List of property data to update (return from translateEditorPropertiesToArray)

$properties

array

List of style properties available in this style. Keyed by name!

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

setAllowCachedRead($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

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

Translates @ property style references from the template editor into a structured array, and rewrites the template text to the standard {xen:property} format.

translateEditorPropertiesToArray(string $templateText, string $outputText, array $properties) : array

Parameters

$templateText

string

Template with @ property references

$outputText

string

By reference, the template with {xen:property} values instead

$properties

array

A list of valid style properties in the correct style; keyed by named

Returns

arrayProperty values from the template text. Change detection still needs to be run.

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 property cache in the specified style.

updatePropertyCacheInStyle(integer $styleId, array $effectiveProperties, array $style) : array | false

Parameters

$styleId

integer

$effectiveProperties

array

List of effective properties in style.

$style

arraynull

Style information; queried if needed

Returns

arrayfalseCompiled property cache

Updates the definition-related elements of the style property development file without touching the property value.

updateStylePropertyDevelopmentFile(array $definition) 

Parameters

$definition

array

Updates the specified style property value.

updateStylePropertyValue(array $definition, integer $styleId, mixed $newValue, array $extraOptions, mixed $existingProperty, string $existingValue) 

Parameters

$definition

array

Style property definition

$styleId

integer

Style property is being changed in

$newValue

mixed

New value (string for scalar; array for css)

$extraOptions

boolean

Extra options to pass to the data writer

$existingProperty

mixed

If array/false, considered to be the property to be updated; otherwise, determined automatically

$existingValue

string

The existing value in the place of this property. This may come from the parent style (unlike $existingProperty). This prevents customization from occurring when a value isn't changed.

Writes out a style property development file.

writeStylePropertyDevelopmentFile(array $definition, array $property) 

Parameters

$definition

array

Property definition

$property

array

Property value

_atToPropertyCallback() 

_atToPropertyCallback($property) 

Parameters

$property

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

Helper for CSS property cache compilation.

_getCssValue(array $search, string | array $key) : string

Gets the value(s) for one or more CSS rule keys. Multiple keys will be separated by a space.

Parameters

$search

array

Array to search for keys in

$key

stringarray

One or more keys to search for

Returns

stringValues for matching keys; space separated

Helper for CSS property cache compilation.

_getCssValueRule(array $search, string | array $key) : string

Gets the full rule(s) for one or more CSS rule keys.

Parameters

$search

array

Array to search for keys in

$key

stringarray

One or more keys to search for

Returns

stringFull CSS rules

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

_getPaddingMarginShortCuts() 

_getPaddingMarginShortCuts($type, array $output) 

Parameters

$type

$output

_getStyleModel() 

_getStyleModel() : \XenForo_Model_Style

Returns

\XenForo_Model_Style

 Properties

 

Controls whether a cached read is allowed.

$_allowCachedRead : boolean
Inherited

If not, it should be retrieved from the source.

inherited_from \XenForo_Model::$$_allowCachedRead
 

Cache object

$_cache : \Zend_Cache_Core | \Zend_Cache_Frontend
Inherited

inherited_from \XenForo_Model::$$_cache
 

Database object

$_db : \Zend_Db_Adapter_Abstract
Inherited

inherited_from \XenForo_Model::$$_db
 

Stores local, instance-specific cached data for each model.

$_localCacheData : array
Inherited

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

inherited_from \XenForo_Model::$$_localCacheData
 

Standard approach to caching other model objects for the lifetime of the model.

$_modelCache : array
Inherited

inherited_from \XenForo_Model::$$_modelCache
 

$_tempProperties

$_tempProperties