phpDocumentor
Back to top  

Model for attachments.

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_Attachment

 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 the specified attachment can be deleted.

canDeleteAttachment(array $attachment, string $tempHash, array $viewingUser) : boolean

Unassociated attachments can be deleted if the temp hash is known.

Parameters

$attachment

array

$tempHash

string

$viewingUser

arraynull

Viewing user ref; if null, uses visitor

Returns

boolean

Determines if the specified attachment can be viewed.

canViewAttachment(array $attachment, string $tempHash, array $viewingUser) : boolean

Unassociated attachments can be viewed if the temp hash is known.

Parameters

$attachment

array

$tempHash

string

$viewingUser

arraynull

Viewing user ref; if null, uses visitor

Returns

boolean

countAttachments() 

countAttachments(array $conditions, array $fetchOptions) 

Parameters

$conditions

$fetchOptions

Factory method to get the named model.

create(string $class) : \XenForo_Model
Inherited

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

deleteAttachmentData() 

deleteAttachmentData($dataId) 

Parameters

$dataId

Deletes attachments from the specified content IDs.

deleteAttachmentsFromContentIds(string $contentType, array $contentIds) 

Parameters

$contentType

string

$contentIds

array

Deletes unassociated attachments up to a certain date.

deleteUnassociatedAttachments(integer $maxDate) 

Parameters

$maxDate

integer

Maximum timestamp to delete up to

deleteUnusedAttachmentData() 

deleteUnusedAttachmentData() 

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 specified attachment by it's ID.

getAttachmentById(integer $attachmentId) : array | false

Includes some data info.

Parameters

$attachmentId

integer

Returns

arrayfalse

Fetches attachment constraints

getAttachmentConstraints() : array

Returns

array

Gets the specified attachment data by ID.

getAttachmentDataById(integer $dataId) : array | false

Parameters

$dataId

integer

Returns

arrayfalse

Gets the full path to this attachment's data.

getAttachmentDataFilePath(array $data) : string

Parameters

$data

array

Attachment data info

Returns

string

Gets the attachment handler object for a specified content type.

getAttachmentHandler(string $contentType) : \XenForo_AttachmentHandler_Abstract | null

Parameters

$contentType

string

Returns

\XenForo_AttachmentHandler_Abstractnull

Gets an array of phrases identifying each attachment handler content type

getAttachmentHandlerContentTypeNames() : array

Returns

array[$contentType => XenForo_Phrase $phrase]

Gets the full path to this attachment's thumbnail.

getAttachmentThumbnailFilePath(array $data) : string

Parameters

$data

array

Attachment data info

Returns

string

Gets the URL to this attachment's thumbnail.

getAttachmentThumbnailUrl(array $data) : string

May be absolute or relative to the application root directory.

Parameters

$data

array

Attachment data info

Returns

string

Gets all attachments (and data) matching the given conditions

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

Parameters

$conditions

array

$fetchOptions

array

Returns

array

Gets the attachments (along with limited data info) that belong to the given content ID.

getAttachmentsByContentId(string $contentType, integer $contentId) : array

Parameters

$contentType

string

$contentId

integer

Returns

arrayFormat: [attachment id] => info

Get attachments (and limited data info) by the given content IDs.

getAttachmentsByContentIds(string $contentType, array $contentIds) : array

Parameters

$contentType

string

$contentIds

array

Returns

arrayFormat: [attachment id] => info

Gets all attachments (with limited data info) that have the specified temp hash.

getAttachmentsByTempHash(string $tempHash) : array

Parameters

$tempHash

string

Returns

arrayFormat: [attachment 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

Fetches the link to the host content of an attachment

getContentLink(array $attachment, array $extraParams, boolean $skipPrepend) : string | boolean

Parameters

$attachment

array

$extraParams

array

$skipPrepend

boolean

Returns

stringboolean

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

Inserts a temporary attachment for the specified attachment data.

insertTemporaryAttachment(integer $dataId, string $tempHash) : integer

Parameters

$dataId

integer

$tempHash

string

Returns

integer$attachmentId

Inserts uploaded attachment data.

insertUploadedAttachmentData(\XenForo_Upload $file, integer $userId, array $extra) : integer

Parameters

$file

\XenForo_Upload

Uploaded attachment info. Assumed to be valid

$userId

integer

User ID uploading

$extra

array

Extra params to set

Returns

integerAttachment data ID

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

Logs the viewing of an attachment.

logAttachmentView(integer $attachmentId) 

Parameters

$attachmentId

integer

Prepares an attachment for viewing (mainly as a "thumbnail" or similar view).

prepareAttachment(array $attachment, boolean $fetchContentLink) : array

Parameters

$attachment

array

$fetchContentLink

boolean

If true, will fetch a link to the host content in the 'content_link' key

Returns

array

Prepare SQL conditions for fetching attachments

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

Parameters

$conditions

array

$fetchOptions

array

Returns

string

prepareAttachmentFetchOptions() 

prepareAttachmentFetchOptions(array $fetchOptions) 

Parameters

$fetchOptions

Prepares a list of attachments.

prepareAttachments(array $attachments, boolean $fetchContentLinks) : array

Parameters

$attachments

array

$fetchContentLinks

boolean

If true, will fetch link to the host content in the 'content_link' key for each attachment

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

Sets whether we're allowed to read values from the cache on a model-level.

setAllowCachedRead($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

Updates attachment views in bulk.

updateAttachmentViews() 

Helper to delete attachments from a set of pairs [attachment id] => data id.

_deleteAttachmentsFromPairs(array $attachments) 

Parameters

$attachments

array

[attachment id] => data id

Forces the system to cache all available attachment handlers, to avoid multiple queries later

_getAttachmentHandlers() : array

Returns

array[contentType => handlerObject]

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

 

$dataColumns

$dataColumns 

 

Controls whether a cached read is allowed.

$_allowCachedRead : boolean
Inherited

If not, it should be retrieved from the source.

inherited_from \XenForo_Model::$$_allowCachedRead
 

Cache object

$_cache : \Zend_Cache_Core | \Zend_Cache_Frontend
Inherited

inherited_from \XenForo_Model::$$_cache
 

Database object

$_db : \Zend_Db_Adapter_Abstract
Inherited

inherited_from \XenForo_Model::$$_db
 

Stores local, instance-specific cached data for each model.

$_localCacheData : array
Inherited

This data is generally treated as canonical, even if {$_allowCachedRead} is false.

inherited_from \XenForo_Model::$$_localCacheData
 

Standard approach to caching other model objects for the lifetime of the model.

$_modelCache : array
Inherited

inherited_from \XenForo_Model::$$_modelCache

 Constants

 

<p>Join user table to fetch attachment options</p>

FETCH_USER : integer