XenForo Reference Guide for Developer
Back to top  

Base class for models.

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_Mvc

 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

Returns the total number of phrases in the master language

countMasterPhrases() : integer

Returns

integer

Counts the number of translated phrases in each non-master language

countTranslatedPhrasesPerLanguage(array $languages) : array

Parameters

$languages

array

Array of languages

Returns

arrayThe $languages array including a phraseCount key

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 language ID, no matter how many levels below.

getAllChildLanguageIds(integer $languageId) : array

Parameters

$languageId

integer

Returns

arrayArray of language IDs

getAllLanguages() 

getAllLanguages() 

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

getAllLanguagesAsFlattenedTree(integer $baseDepth) : array

The return is an array containing all languages and their related info. Each language 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: [language id] => (array) language info, including depth

Gets all languages in the format expected by the language cache.

getAllLanguagesForCache() : array

Returns

arrayFormat: [language id] => info, with phrase cache as 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

Helper to get the default language

getDefaultLanguage() : array

Returns

array

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

getDirectChildLanguageIds(integer $languageId) : array

Parameters

$languageId

integer

Returns

arrayArray of language IDs

Gets the base parent list for a language.

getLanguageBaseParentList(integer $languageId) : array

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

Parameters

$languageId

integer

Returns

arrayList of parent language IDs (including 0)

getLanguageById() 

getLanguageById($id, $fetchMaster) 

Parameters

$id

$fetchMaster

Generates the date and time format examples based on the current time.

getLanguageFormatExamples() : array

Returns

array[0] => date formats, [1] => time formats; keyed by format string

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

getLanguageIdFromCookie() : integer

Returns

integer

Gets the parent => language associations from a flat list of language info.

getLanguageTreeAssociations(array $languageList) : array

Parameters

$languageList

array

Returns

array[parent id][] => language id

Gets the DOM document that represents a language file.

getLanguageXml(array $language, string | null $limitAddOnId, boolean $getUntranslated) : \DOMDocument

This must be turned into XML (or HTML) by the caller.

Parameters

$language

array

$limitAddOnId

stringnull

If specified, only exports phrases from the specified add-on

$getUntranslated

boolean

If true, gets untranslated phrases in this language

Returns

\DOMDocument

Return results for admin quick search

getLanguagesForAdminQuickSearch(string $searchText) : array

Parameters

$searchText

string

Keywords for which to search

Returns

array

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

getLanguagesForOptionsTag($selectedId, array $languageTree) : array

Parameters

$selectedId

$languageTree

array

Returns

array

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

Imports a language XML file.

importLanguageXml(\SimpleXMLElement $document, integer $parentLanguageId, integer $overwriteLanguageId) : array

Parameters

$document

\SimpleXMLElement

$parentLanguageId

integer

If not overwriting, the ID of the parent lang

$overwriteLanguageId

integer

If non-0, parent lang 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 full language cache.

rebuildLanguageCache() : array

Returns

arrayFormat: [language id] => info, with phrase cache as array

Rebuilds all language caches (including global phrase cache).

rebuildLanguageCaches() 

Rebuilds the global phrase cache for all languages.

rebuildLanguageGlobalPhraseCache(array $globalPhraseTitles) 

Parameters

$globalPhraseTitles

arraynull

List of phrases that should be included. If null, uses flag from phrase table.

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

rebuildLanguageParentListRecursive(integer $languageId) 

Parameters

$languageId

integer

First language 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 language should be shown in lists.

showMasterLanguage() : 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

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

_buildFlattenedLanguageTree(array $languageList, array $tree, integer $root, integer $depth) : array

Parameters

$languageList

array

List of languages and their information

$tree

array

Tree structure of languages ([parent id][] => language id)

$root

integer

Where to start in the tree

$depth

integer

Current/starting depth

Returns

arrayList of languages with additional depth key

Internal handler to get call child language IDs.

_getAllChildLanguageIds(integer $parentId, array $languageTree) : array

Parameters

$parentId

integer

Parent language ID

$languageTree

array

Tree of languages ([parent id][] => language id)

Returns

array

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

_getPhraseModel() 

_getPhraseModel() : \XenForo_Model_Phrase

Returns

\XenForo_Model_Phrase

Internal function to rebuild the language parent list recursively.

_rebuildLanguageParentListRecursive(integer $languageId, array $baseParentList, array $languages, array $languageTree) 

Parameters

$languageId

integer

Base lanaguage Id

$baseParentList

array

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

$languages

array

List of languages

$languageTree

array

Language 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