Options model.
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_Options |
---|
__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 neededappendOptionsAddOnXml(\DOMElement $rootNode, string $addOnId)
string
Add-on ID to be exported
assertValidCutOffOperator(string $operator)
inherited_from | \XenForo_Model::assertValidCutOffOperator() |
---|
string
buildOptionArray() : array
array
canEditOptionAndGroupDefinitions() : boolean
boolean
canWriteOptionsDevelopmentFile($fileName) : boolean
If the file does not exist, it checks whether the parent directory is writable.
boolean
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
deleteOptionsForAddOn(string $addOnId)
string
deleteOptionsInGroup(string $groupId) : array
If an option is in multiple groups, it will not deleted until the last reference is removed.
string
array
List of option IDs that were deletedfetchAllKeyed(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
getAllOptions(array $fetchOptions) : array
array
array
Format: [option_id] => option infogetConditionsForClause(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 valuegetDefaultOption() : array
Used when creating a new option.
array
getDefaultOptionGroup() : array
Used when creating a new option group.
array
getGroupForOption(string $optionId) : array
string
array
getModelFromCache(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
getOptionById(string $optionId, array $fetchOptions) : array | false
string
array
array
false
Option infogetOptionExplainPhraseName(string $optionId) : string
string
string
getOptionGroupById(string $groupId, array $fetchOptions) : array | false
string
array
array
false
Option group infogetOptionGroupDescriptionPhraseName(string $groupId) : string
string
string
getOptionGroupList(array $fetchOptions) : array
array
Format: [] => group infogetOptionGroupMasterDescriptionPhraseValue(string $groupId) : string
string
string
getOptionGroupMasterTitlePhraseValue(string $groupId) : string
string
string
getOptionGroupTitlePhraseName(string $groupId) : string
string
string
getOptionGroupsByAddOn(string $addOnId, array $fetchOptions) : array
string
array
Format: [group id] => infogetOptionGroupsByIds(array $groupIds, array $fetchOptions) : array
array
array
array
Format: [group id] => infogetOptionMasterExplainPhraseValue(string $optionId) : string
string
string
getOptionMasterTitlePhraseValue(string $optionId) : string
string
string
getOptionRelationsByOptionId(string $optionId) : array
string
array
Format: [group id] => display ordergetOptionRelationsGroupedByOption(array $optionIds) : array
array
List of option IDs
array
Format: [option id][] = relation infogetOptionTitlePhraseName(string $optionId) : string
string
string
getOptions(array $conditions, array $fetchOptions) : array
array
array
array
getOptionsByAddOn(string $addOnId, array $fetchOptions) : array
string
array
array
Format: [option group id] => infogetOptionsByIds(array $optionIds, array $fetchOptions) : array
array
List of option IDs
array
Format: [option id] => option infogetOptionsDevelopmentFileName() : string
string
getOptionsInGroup(string $groupId, array $fetchOptions) : array
string
array
array
Format: [] => option info30getOrderByClause(array $choices, array $fetchOptions, string $defaultOrderSql) : string
inherited_from | \XenForo_Model::getOrderByClause() |
---|
array
array
string
string
Order by clause or empty stringimportOptionsAddOnXml(\SimpleXMLElement $xml, string $addOnId)
string
Add-on to import for
importOptionsDevelopmentXml(string $fileName)
string
File to read the XML from
limitQueryResults(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, offsetprepareOption(array $option) : array
array
array
Prepared optionprepareOptionConditions(array $conditions, array $fetchOptions) : string
array
array
string
prepareOptionFetchOptions(array $fetchOptions) : array
array
array
prepareOptionFormatParams(string $editFormat, string $formatParamsString) : array
string
Edit format (textbox, spinbox, callback, etc)
string
Unparsed format params
array
prepareOptionGroup(array $group) : array
array
Unprepared group
array
Prepared groupprepareOptionGroupFetchOptions(array $fetchOptions) : array
array
array
prepareOptionGroups(array $groups, boolean $includeDisabledAddons) : array
array
boolean
If false, remove option groups belonging to disabled add-ons.
array
prepareOptionOrderOptions(array $fetchOptions, string $defaultOrderSql) : string
array
string
string
prepareOptions(array $options, boolean $includeDisabledAddOns) : array
array
Collection of options
boolean
If false, remove options belonging to disabled add-ons.
array
Collection of prepared optionsprepareStateLimitFromConditions(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 staterebuildOptionCache() : array
array
Rebuild options arrayresetLocalCacheData($name)
This can be used if you know when some cached data has expired.
inherited_from | \XenForo_Model::resetLocalCacheData() |
---|
setAllowCachedRead(boolean $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 unserializedupdateOptions(array $options)
array
Format: [option id] => new option value
_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
_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
_parseNamedFormatParams(string $params) : array
Parameters use format "name => value" with one parameter per line.
string
Unparsed params
array
Format: [name] => value/label$_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 |
---|
$_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 |
---|
FETCH_ADDON
FETCH_GROUP