XenForo Reference Guide for Developer
Back to top  

Model for forums

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_Forum

 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

Determines if a thread can be locked or unlocked in the specified forum with the given permissions.

canLockUnlockThreadInForum(array $forum, string $errorPhraseKey, array $nodePermissions, array $viewingUser) : boolean

Parameters

$forum

array

$errorPhraseKey

string

$nodePermissions

arraynull

$viewingUser

arraynull

Returns

boolean

Determines if a new thread can be posted in the specified forum, with the given permissions.

canPostThreadInForum(array $forum, string $errorPhraseKey, array $nodePermissions, array $viewingUser) : boolean

If no permissions are specified, permissions are retrieved from the currently visiting user. This does not check viewing permissions.

Parameters

$forum

array

Info about the forum posting in

$errorPhraseKey

string

Returned phrase key for a specific error

$nodePermissions

arraynull

$viewingUser

arraynull

Returns

boolean

Determines if a thread can be stuck or unstuck in the specified forum with the given permissions.

canStickUnstickThreadInForum(array $forum, string $errorPhraseKey, array $nodePermissions, array $viewingUser) : boolean

Parameters

$forum

array

$errorPhraseKey

string

$nodePermissions

arraynull

$viewingUser

arraynull

Returns

boolean

Determines if a new attachment can be posted in the specified forum, with the given permissions.

canUploadAndManageAttachment(array $forum, string $errorPhraseKey, array $nodePermissions, array $viewingUser) : boolean

If no permissions are specified, permissions are retrieved from the currently visiting user. This does not check viewing permissions.

Parameters

$forum

array

Info about the forum posting in

$errorPhraseKey

string

Returned phrase key for a specific error

$nodePermissions

arraynull

$viewingUser

arraynull

Returns

boolean

Determines if the specified forum can be viewed with the given permissions.

canViewForum(array $forum, string $errorPhraseKey, array $nodePermissions, array $viewingUser) : boolean

Parameters

$forum

array

Info about the forum posting in

$errorPhraseKey

string

Returned phrase key for a specific error

$nodePermissions

arraynull

$viewingUser

arraynull

Returns

boolean

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 the set of attachment params required to allow uploading.

getAttachmentParams(array $forum, array $contentData, array $nodePermissions, array $viewingUser) : array | false

Parameters

$forum

array

$contentData

array

Information about the content, for URL building

$nodePermissions

arraynull

$viewingUser

arraynull

Returns

arrayfalse

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 extra data that applies to the specified forum nodes.

getExtraForumDataForNodes(array $nodeIds, array $fetchOptions) : array

Parameters

$nodeIds

array

$fetchOptions

array

Options that affect what is fetched

Returns

arrayFormat: [node id] => extra info

Fetches the combined node-forum record for the specified node id

getForumById(integer $id, array $fetchOptions) : array

Parameters

$id

integer

Node ID

$fetchOptions

array

Options that affect what is fetched

Returns

array

Fetches the combined node-forum record for the specified node name

getForumByNodeName(string $name, array $fetchOptions) : array

Parameters

$name

string

Node name

$fetchOptions

array

Options that affect what is fetched

Returns

array

Fetch a single forum by the ID of a thread contained within it

getForumByThreadId(integer $threadId) : array

Parameters

$threadId

integer

Returns

array

Gets the forum counters for the specified forum.

getForumCounters(integer $forumId) : array

Parameters

$forumId

integer

Returns

arrayKeys: discussion_count, message_count

Gets all forums matching the specified criteria (no criteria implemented yet).

getForums(array $conditions, array $fetchOptions) : array

Parameters

$conditions

array

$fetchOptions

array

Returns

array

Fetches the combined node-forum records for the specified forum/node IDs.

getForumsByIds(array $forumIds, array $fetchOptions) : array

Parameters

$forumIds

array

$fetchOptions

array

Options that affect what is fetched

Returns

arrayFormat: [node id] => info

getForumsByThreadIds() 

getForumsByThreadIds(array $threadIds) 

Parameters

$threadIds

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 permissions in use for a specific forum from the details of the forum, or from a permissions override list if provided.

getPermissionsForForum(array $forum, array $permissionsList) : array

When looking within the forum, looks for "nodePermissions" or "node_permission_cache" keys.

Parameters

$forum

array

Forum info

$permissionsList

array

Optional permissions to override; format: [forum id] => permissions

Returns

arrayPermissions for forum

Gets the count of unread threads in the given forum.

getUnreadThreadCountInForum(integer $forumId, integer $userId, integer $forumReadDate, string | array $ignored) : integer | false

This only applies to registered users. If no user ID is given, false is returned.

Parameters

$forumId

integer

$userId

integer

$forumReadDate

integer

Time when the whole forum is read from

$ignored

stringarray

List of ignored user IDs; if string, unserialized and keys used

Returns

integerfalse

Get the time when a user has marked the given forum as read.

getUserForumReadDate(integer $userId, integer $forumId) : integer | null

Parameters

$userId

integer

$forumId

integer

Returns

integernullNull if guest; timestamp otherwise

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

Marks the specified forum as read up to a specific time.

markForumRead(array $forum, integer $readDate, array $viewingUser) : boolean

Forum must have the forum_read_date key.

Parameters

$forum

array

Forum info

$readDate

integer

Timestamp to mark as read until

$viewingUser

arraynull

Returns

booleanTrue if marked as read

Determine if the forum should be marked as read and do so if needed.

markForumReadIfNeeded(array $forum, array $viewingUser) : boolean

Parameters

$forum

array

$viewingUser

arraynull

Returns

boolean

Marks a forum and all sub-forums read.

markForumTreeRead(array $baseForum, integer $readDate, array $viewingUser) : array

This can be used without a base forum to mark all forums as read.

Parameters

$baseForum

arraynull

Info about base forum to mark read; may be null

$readDate

integer

Date to set as read date

$viewingUser

arraynull

Returns

arrayA list of node IDs that were marked as read

Prepares a forum for display.

prepareForum(array $forum) : array

Parameters

$forum

array

Unprepared forum

Returns

arrayPrepared forum

Prepares a collection of forum fetching related conditions into an SQL clause

prepareForumConditions(array $conditions, array $fetchOptions) : string

Parameters

$conditions

array

List of conditions

$fetchOptions

array

Modifiable set of fetch options (may have joins pushed on to it)

Returns

stringSQL clause (at least 1=1)

Checks the 'join' key of the incoming array for the presence of the FETCH_x bitfields in this class and returns SQL snippets to join the specified tables if required

prepareForumJoinOptions(array $fetchOptions) : array

Parameters

$fetchOptions

array

Array containing a 'join' integer key build from this class's FETCH_x bitfields and other keys

Returns

arrayContaining 'selectFields' and 'joinTables' keys. Example: selectFields = ', user.*, foo.title'; joinTables = ' INNER JOIN foo ON (foo.id = other.id) '

Prepares a collection of forums for display.

prepareForums(array $forums) : array

Parameters

$forums

array

Unprepared forums

Returns

arrayPrepared forums

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

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

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

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

 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