XenForo Reference Guide for Developer
Back to top  

Model for cron behaviors.

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_Cron

 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 add-on cron entry XML to a given DOM element.

appendCronEntriesAddOnXml(\DOMElement $rootNode, string $addOnId) 

Parameters

$rootNode

\DOMElement

Node to append all prefix elements to

$addOnId

string

Add-on ID to be exported

Ensures that a valid cut-off operator is passed.

assertValidCutOffOperator(string $operator) 
Inherited
inherited_from \XenForo_Model::assertValidCutOffOperator()

Parameters

$operator

string

Calculate the next run time for an entry using the given rules.

calculateNextRunTime(array $runRules, integer | null $currentTime) : integer

Rules expected in keys: minutes, hours, dow, dom (all arrays) and day_type (string: dow or dom) Array rules are in format: -1 means "any", any other value means on those specific occurances. DoW runs 0 (Sunday) to 6 (Saturday).

Parameters

$runRules

array

Run rules. See above for format.

$currentTime

integernull

Current timestamp; null to use current time from application

Returns

integerNext run timestamp

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

Deletes the cron entries that belong to the specified add-on.

deleteCronEntriesForAddOn(string $addOnId) 

Parameters

$addOnId

string

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 cron entries, ordered by their next run time.

getAllCronEntries() : array

Returns

arrayFormat: [entry id] => info

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 file name for the development output.

getCronDevelopmentFileName() : string

Returns

string

Gets the DOM document that represents the cron development file.

getCronDevelopmentXml() : \DOMDocument

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

Returns

\DOMDocument

Gets all cron entries that belong to the specified add-on, ordered by their entry IDs.

getCronEntriesByAddOnId(string $addOnId) : array

Parameters

$addOnId

string

Returns

arrayFormat: [entry id] => info

Gets the named cron entries.

getCronEntriesByIds(array $ids) : array

Parameters

$ids

array

List of cron entries by IDs

Returns

arrayFormat: [entry id] => info

Gets all cron entries that need to be run.

getCronEntriesToRun(integer | null $currentTime) : array

Parameters

$currentTime

integernull

Current timestamp, null to use current time from application

Returns

arrayFormat: [entry id] => info

Gets the specified cron entry.

getCronEntryById(string $id) : array | false

Parameters

$id

string

Returns

arrayfalse

Gets a cron entry's master title phrase text.

getCronEntryMasterTitlePhraseValue(string $entryId) : string

Parameters

$entryId

string

Returns

string

Gets the phrase name for a cron entry.

getCronEntryPhraseName(string $entryId) : string

Parameters

$entryId

string

Returns

string

Gets the default, prepared cron entry for use on the insert entry form.

getDefaultCronEntry() : array

Returns

array

Gets the minimum next run time stamp (ie, time next entry is due to run).

getMinimumNextRunTime() : integer

If no entries are runnable, returns 0x7FFFFFFF (basically never run an entry).

Returns

integer

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 prefixes from the development XML format.

importCronDevelopmentXml(string $fileName) 

This will overwrite all prefixes.

Parameters

$fileName

string

Imports the cron entries for an add-on.

importCronEntriesAddOnXml(\SimpleXMLElement $xml, string $addOnId) 

Parameters

$xml

\SimpleXMLElement

XML element pointing to the root of the event data

$addOnId

string

Add-on to import for

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 a list of cron entries for display.

prepareCronEntries(array $entries) : array

Parameters

$entries

array

Returns

array

Prepares the given cron entry for display, by doing processing beyond the DB, preparing the title phrase, etc.

prepareCronEntry(array $entry) : array

Parameters

$entry

array

Returns

array

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

Runs the given entry if possible.

runEntry(array $entry) 

Parameters

$entry

array

Info about cron entry

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

Atomically update the next run time for a cron entry.

updateCronRunTimeAtomic(array $entry) : boolean

This allows you to determine whehter a cron entry still needs to be run.

Parameters

$entry

array

Cron entry info

Returns

booleanTrue if updated (thus safe to run), false otherwise

Updates the data registry entry for the minimum next run time.

updateMinimumNextRunTime() : integer

Cron calls are not needed until that point.

Returns

integerMinimum next run time

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

Modifies the next run time based on the day of month rules.

_modifyRunTimeDayOfMonth(array $dayRules, \DateTime $nextRun) 

Note that if the required DoM doesn't exist (eg, Feb 30), it will be rolled over as if it did (eg, to Mar 2).

Parameters

$dayRules

$nextRun

\DateTime

Date calculation object. This will be modified.

Modifies the next run time based on the day of week rules.

_modifyRunTimeDayOfWeek(array $dayRules, \DateTime $nextRun) 

Parameters

$dayRules

$nextRun

\DateTime

Date calculation object. This will be modified.

Modifies the next run time based on the hour rules.

_modifyRunTimeHours(array $hourRules, \DateTime $nextRun) 

Parameters

$hourRules

array

Rules about what hours are valid (-1, or any number of values 0-23)

$nextRun

\DateTime

Date calculation object. This will be modified.

Modifies the next run time based on the minute rules.

_modifyRunTimeMinutes(array $minuteRules, \DateTime $nextRun) 

Parameters

$minuteRules

array

Rules about what minutes are valid (-1, or any number of values 0-59)

$nextRun

\DateTime

Date calculation object. This will be modified.

General purpose run time calculator for a set of rules.

_modifyRunTimeUnits(array $unitRules, \DateTime $nextRun, integer $currentUnitValue, string $unitName, string $rolloverUnitName) 

Parameters

$unitRules

array

List of rules for unit. Array of ints, values -1 to unit-defined max.

$nextRun

\DateTime

Date calculation object. This will be modified.

$currentUnitValue

integer

The current value for the specified unit type

$unitName

string

Name of the current unit (eg, minute, hour, day, etc)

$rolloverUnitName

string

Name of the unit to use when rolling over; one unit bigger (eg, minutes to hours)

 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