XenForo Reference Guide for Developer
Back to top  

Model class for manipulating the news feed.

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.

author kier
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

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

Permanently delete an item or items from the news feed

delete(string $contentType, integer $contentId, integer $userId, string $action) 

Parameters

$contentType

string

$contentId

integer

$userId

integer

(optional)

$action

string

(optional)

Clears a user's cache, forcing a clean fetch on the next news feed load

deleteNewsFeedCache(integer $userId) 

Parameters

$userId

integer

Deletes old news feed items.

deleteOldNewsFeedItems(integer | null $dateCut) 

This does not trigger a cache rebuild, so a user could keep old records around until they're pushed off.

Parameters

$dateCut

integernull

Uses default setting if null

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

Fills out a collection of news feed items, to include the necessary content and prepares them for view.

fillOutNewsFeedItems(array $newsFeed, array $viewingUser) : array

Also filters out unviewable items.

Parameters

$newsFeed

array

$viewingUser

array

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 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 ID of the newest feed item in an array of feed items

getNewestNewsFeedIdFromArray(array $newsFeed) : integer

Parameters

$newsFeed

array

News feed array

Returns

integer

Gets a news feed with the specified conditions.

getNewsFeed(array $conditions, integer $fetchOlderThanId, array $viewingUser) : array

Parameters

$conditions

array

$fetchOlderThanId

integer

If > 0, only fetches items with a lower ID than this

$viewingUser

arraynull

Returns

array

Fetches a user's cached news feed

getNewsFeedCache(integer $userId) : array

Parameters

$userId

integer

Returns

array

Returns news feed data for the specified user.

getNewsFeedForUser(array $user, integer $fetchOlderThanId, array $viewingUser) : array

By default, returns the most recent items unless a 'fetchOlderThanId' is specified.

Parameters

$user

array

$fetchOlderThanId

integer

If specified, switches the mode of the function to return results older than the specified news feed id

$viewingUser

arraynull

Information about the viewing user (keys: user_id, permission_combination_id, permissions) or null for visitor

Returns

array

Fetches a single news feed item using its ID

getNewsFeedItemById(integer $newsFeedId) : array | false

Parameters

$newsFeedId

integer

Returns

arrayfalse

Gets news feed items matching the given conditions.

getNewsFeedItems(array $conditions, array $viewingUser, integer | null $maxItems) : array

Parameters

$conditions

array

$viewingUser

array

$maxItems

integernull

Returns

array

Gets news feed items for a particular viewing user.

getNewsFeedItemsForUser(array $viewingUser, array $conditions, integer | null $maxItems) : array

This will get news feed items for all user he/she follows.

Parameters

$viewingUser

array

$conditions

array

$maxItems

integernull

Returns

array

Gets the ID of the oldest feed item in an array of news feed items

getOldestNewsFeedIdFromArray(array $newsFeed) : integer

Parameters

$newsFeed

array

News feed array

Returns

integer

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

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

Publish a news feed item

publish(integer $userId, string $username, string $contentType, integer $contentId, string $action, array $extraData) 

Parameters

$userId

integer

$username

string

$contentType

string

$contentId

integer

$action

string

$extraData

array

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

Caches an instance of every news feed handler required by the data provided

_cacheHandlersForNewsFeed(array $newsFeed) 

Parameters

$newsFeed

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

Fetches content data for news feed items

_getContentForNewsFeedItems(array $data, array $viewingUser) : array

Parameters

$data

array

Raw news feed data

$viewingUser

array

Information about the viewing user (keys: user_id, permission_combination_id, permissions)

Returns

array

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

Fetches an instance of the specified news feed handler class

_getNewsFeedHandlerFromCache(string $class) : \XenForo_NewsFeedHandler_Abstract

Parameters

$class

string

Returns

\XenForo_NewsFeedHandler_Abstract

Fetches an instance of the user model

_getUserModel() : \XenForo_Model_User

Returns

\XenForo_Model_User

Filters out unviewable news feed items and returns only those the user can view.

_getViewableNewsFeedItems(array $items, array $viewingUser) : array

Parameters

$items

array

$viewingUser

array

Returns

arrayFiltered items

Takes all new feed items and appends old items from the cache until the array contains options->newsFeedMaxItems items

_mergeLatestNewsFeedItemsWithCache(array $newsFeed, array $cachedItems) 

Parameters

$newsFeed

array

$cachedItems

array

Wraps around the prepareX functions in the handler class for each content type.

_prepareNewsFeedItem(array $item, string $handlerClassName, array $viewingUser) : mixed

Also does basic setup such as fetching user avatars.

Parameters

$item

$handlerClassName

string

$viewingUser

array

Information about the viewing user (keys: user_id, permission_combination_id, permissions)

Returns

mixed

Runs prepareNewsFeedItem on an array of items

_prepareNewsFeedItems(array $items, array $viewingUser) : array

Parameters

$items

array

$viewingUser

array

Information about the viewing user (keys: user_id, permission_combination_id, permissions)

Returns

array

Saves a user's news feed into their cache

_saveCache(integer $userId, array $newsFeed) : integer

Parameters

$userId

integer

$newsFeed

array

Returns

integernews_feed_id of latest news feed item in the cache

 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
 

$_handlerCache : array
 

$_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