__construct()
addFetchOptionJoin()
addPositionLimit()
assertValidCutOffOperator()
create()
delete()
deleteNewsFeedCache()
deleteOldNewsFeedItems()
fetchAllKeyed()
fillOutNewsFeedItems()
getConditionsForClause()
getContentTypeField()
getContentTypesWithField()
getModelFromCache()
getNewestNewsFeedIdFromArray()
getNewsFeed()
getNewsFeedCache()
getNewsFeedForUser()
getNewsFeedItemById()
getNewsFeedItems()
getNewsFeedItemsForUser()
getOldestNewsFeedIdFromArray()
getOrderByClause()
limitQueryResults()
prepareLimitFetchOptions()
prepareStateLimitFromConditions()
publish()
resetLocalCacheData()
setAllowCachedRead()
setLocalCacheData()
standardizeNodePermissionsAndUserId()
standardizePermissionCombinationIdAndUserId()
standardizePermissionsAndUserId()
standardizeViewingUserReference()
standardizeViewingUserReferenceForNode()
unserializePermissionsInList()
_cacheHandlersForNewsFeed()
_getCache()
_getContentForNewsFeedItems()
_getDataRegistryModel()
_getDb()
_getLocalCacheData()
_getNewsFeedHandlerFromCache()
_getUserModel()
_getViewableNewsFeedItems()
_mergeLatestNewsFeedItemsWithCache()
_prepareNewsFeedItem()
_prepareNewsFeedItems()
_saveCache()
$_allowCachedRead
$_cache
$_db
$_handlerCache
$_localCacheData
$_modelCache
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 |
__construct()
Use create() statically unless you know what you're doing.
inherited_from | \XenForo_Model::__construct() |
---|
addFetchOptionJoin(array $fetchOptions, integer $join)
Join should be one of the constants.
inherited_from | \XenForo_Model::addFetchOptionJoin() |
---|
array
integer
addPositionLimit(string $table, integer $limit, integer $offset, string $column) : string
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() |
---|
string
Name of the table alias to prefix. May be blank for no table reference.
integer
Number of records to limit to; ignored if <= 0
integer
Offset from the start of the records. 0+
string
Name of the column that is storing the position
string
Position limit clause if neededassertValidCutOffOperator(string $operator)
inherited_from | \XenForo_Model::assertValidCutOffOperator() |
---|
string
create(string $class) : \XenForo_Model
The class must exist or be autoloadable or an exception will be thrown.
inherited_from | \XenForo_Model::create() |
---|
string
Class to load
delete(string $contentType, integer $contentId, integer $userId, string $action)
string
integer
integer
(optional)
string
(optional)
deleteNewsFeedCache(integer $userId)
integer
deleteOldNewsFeedItems(integer | null $dateCut)
This does not trigger a cache rebuild, so a user could keep old records around until they're pushed off.
integer
null
Uses default setting if null
fetchAllKeyed(string $sql, string $key, mixed $bind, string $nullPrefix) : array
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() |
---|
string
SQL to execute
string
Column with which to key the results array
mixed
Parameters for the SQL
string
If the key is null, prefix the counter with this
array
fillOutNewsFeedItems(array $newsFeed, array $viewingUser) : array
Also filters out unviewable items.
array
array
array
getConditionsForClause(array $sqlConditions) : string
This always returns a value that can be used in a clause such as WHERE.
inherited_from | \XenForo_Model::getConditionsForClause() |
---|
array
string
getContentTypeField(string $contentType, string $fieldName) : string | false
inherited_from | \XenForo_Model::getContentTypeField() |
---|
string
string
string
false
getContentTypesWithField(string $fieldName) : array
inherited_from | \XenForo_Model::getContentTypesWithField() |
---|
string
array
Format: [content type] => field valuegetModelFromCache(string $class) : \XenForo_Model
If it does not exist, it will be instantiated.
inherited_from | \XenForo_Model::getModelFromCache() |
---|
string
Name of the class to load
getNewestNewsFeedIdFromArray(array $newsFeed) : integer
array
News feed array
integer
getNewsFeed(array $conditions, integer $fetchOlderThanId, array $viewingUser) : array
array
integer
If > 0, only fetches items with a lower ID than this
array
null
array
getNewsFeedCache(integer $userId) : array
integer
array
getNewsFeedForUser(array $user, integer $fetchOlderThanId, array $viewingUser) : array
By default, returns the most recent items unless a 'fetchOlderThanId' is specified.
array
integer
If specified, switches the mode of the function to return results older than the specified news feed id
array
null
Information about the viewing user (keys: user_id, permission_combination_id, permissions) or null for visitor
array
getNewsFeedItemById(integer $newsFeedId) : array | false
integer
array
false
getNewsFeedItems(array $conditions, array $viewingUser, integer | null $maxItems) : array
array
array
integer
null
array
getNewsFeedItemsForUser(array $viewingUser, array $conditions, integer | null $maxItems) : array
This will get news feed items for all user he/she follows.
array
array
integer
null
array
getOldestNewsFeedIdFromArray(array $newsFeed) : integer
array
News feed array
integer
getOrderByClause(array $choices, array $fetchOptions, string $defaultOrderSql) : string
inherited_from | \XenForo_Model::getOrderByClause() |
---|
array
array
string
string
Order by clause or empty stringlimitQueryResults(string $query, integer $limit, integer $offset) : string
If the limit value is 0 or less, no clause is applied.
inherited_from | \XenForo_Model::limitQueryResults() |
---|
string
SQL query to run
integer
Number of records to limit to; ignored if <= 0
integer
Offset from the start of the records. 0+
string
Query with limit applied if necessaryprepareLimitFetchOptions(array $fetchOptions) : array
Includes: limit, offset, page, and perPage.
inherited_from | \XenForo_Model::prepareLimitFetchOptions() |
---|
array
Unprepared options
array
Limit options; keys: limit, offsetprepareStateLimitFromConditions(array $fetchOptions, string $table, string $stateField, string $userField) : string
Looks for keys "deleted" and "moderated".
inherited_from | \XenForo_Model::prepareStateLimitFromConditions() |
---|
array
string
Name of the table to prefix the state and user fields with
string
Name of the field that holds the state
string
Name of the field that holds the user ID
string
SQL condition to limit statepublish(integer $userId, string $username, string $contentType, integer $contentId, string $action, array $extraData)
integer
string
string
integer
string
array
resetLocalCacheData($name)
This can be used if you know when some cached data has expired.
inherited_from | \XenForo_Model::resetLocalCacheData() |
---|
setAllowCachedRead($allowCachedRead)
This may be controllable on an individual level basis, if the implementation allows it.
inherited_from | \XenForo_Model::setAllowCachedRead() |
---|
boolean
setLocalCacheData(string $name, $value)
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() |
---|
string
standardizeNodePermissionsAndUserId(integer $nodeId, array | null $permissions, integer | null $userId)
If an invalid permission set or user ID is provided, the current visitor's will be used.
inherited_from | \XenForo_Model::standardizeNodePermissionsAndUserId() |
---|
integer
Node permissions are for
array
null
Permissions for node or null to use current visitor's permissions
integer
null
User permissions belong to or null to use current visitor
standardizePermissionCombinationIdAndUserId(integer | null $permissionCombinationId, integer | null $userId)
If null, users current visitor's values.
inherited_from | \XenForo_Model::standardizePermissionCombinationIdAndUserId() |
---|
integer
null
Permission combination ID or null to use current visitor
integer
null
User permissions belong to or null to use current visitor
standardizePermissionsAndUserId(array | null $permissions, integer | null $userId)
If an invalid permission set or user ID is provided, the current visitor's will be used.
inherited_from | \XenForo_Model::standardizePermissionsAndUserId() |
---|
array
null
Global pPermissions or null to use current visitor's permissions
integer
null
User permissions belong to or null to use current visitor
standardizeViewingUserReference(array $viewingUser)
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() |
---|
array
null
standardizeViewingUserReferenceForNode(integer $nodeId, array $viewingUser, array $nodePermissions)
inherited_from | \XenForo_Model::standardizeViewingUserReferenceForNode() |
---|
integer
array
null
Viewing user; if null, use visitor
array
null
Permissions for this node; if null, use visitor's
unserializePermissionsInList(array $items, string $serializedKey, string $targetKey) : array
inherited_from | \XenForo_Model::unserializePermissionsInList() |
---|
array
List of items
string
Key where serialized permissions are
string
Key where unserialized permissions will go
array
List of items with permissions unserialized_cacheHandlersForNewsFeed(array $newsFeed)
array
_getCache(boolean $forceCachedRead) : \Zend_Cache_Core | \Zend_Cache_Frontend | false
If cache reads are disabled, this will return false.
inherited_from | \XenForo_Model::_getCache() |
---|
boolean
If true, the global "allow cached read" value is ignored
\Zend_Cache_Core
\Zend_Cache_Frontend
false
_getContentForNewsFeedItems(array $data, array $viewingUser) : array
array
Raw news feed data
array
Information about the viewing user (keys: user_id, permission_combination_id, permissions)
array
_getDb() : \Zend_Db_Adapter_Abstract
inherited_from | \XenForo_Model::_getDb() |
---|
\Zend_Db_Adapter_Abstract
_getLocalCacheData(string $name) : mixed
inherited_from | \XenForo_Model::_getLocalCacheData() |
---|
string
mixed
_getNewsFeedHandlerFromCache(string $class) : \XenForo_NewsFeedHandler_Abstract
_getViewableNewsFeedItems(array $items, array $viewingUser) : array
array
array
array
Filtered items_mergeLatestNewsFeedItemsWithCache(array $newsFeed, array $cachedItems)
array
array
_prepareNewsFeedItem(array $item, string $handlerClassName, array $viewingUser) : mixed
Also does basic setup such as fetching user avatars.
string
array
Information about the viewing user (keys: user_id, permission_combination_id, permissions)
mixed
_prepareNewsFeedItems(array $items, array $viewingUser) : array
array
array
Information about the viewing user (keys: user_id, permission_combination_id, permissions)
array
_saveCache(integer $userId, array $newsFeed) : integer
integer
array
integer
news_feed_id of latest news feed item in the cache$_allowCachedRead : boolean
If not, it should be retrieved from the source.
inherited_from | \XenForo_Model::$$_allowCachedRead |
---|
$_cache : \Zend_Cache_Core | \Zend_Cache_Frontend
inherited_from | \XenForo_Model::$$_cache |
---|
$_db : \Zend_Db_Adapter_Abstract
inherited_from | \XenForo_Model::$$_db |
---|
$_handlerCache : array
$_localCacheData : array
This data is generally treated as canonical, even if {$_allowCachedRead} is false.
inherited_from | \XenForo_Model::$$_localCacheData |
---|
$_modelCache : array
inherited_from | \XenForo_Model::$$_modelCache |
---|