AssetIndexingService

Type
Class
Namespace
Craft
Inherits
Craft\AssetIndexingService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
1.0
Deprecated in
This class will have several breaking changes in Craft 3.0.

Class AssetIndexingService

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
ensureTopFolder()Ensures a top level folder exists that matches the model.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
getEventHandlers()Returns the list of attached event handlers for an event.
getIndexEntry()Return an index model.
getIndexListForSource()Gets index list for a source.
getIndexingSessionId()Returns a unique indexing session id.
getIsInitialized()Checks if this application component has been initialized.
getMissingFiles()Return a list of missing files for an indexing session.
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()Initializes the application component.
isInitialized()Checks if this application component has been initialized yet, or not.
processIndexForSource()Process index for a source.
raiseEvent()Raises an event.
removeObsoleteFileRecords()Remove obsolete file records.
removeObsoleteFolderRecords()Remove obsolete folder records.
storeIndexEntry()Store an index entry.
updateIndexEntryRecordId()

ensureTopFolder()

Ensures a top level folder exists that matches the model.

View source

Arguments

Returns

integer

Signature

public integer ensureTopFolder ( Craft\AssetSourceModel $model )

getIndexEntry()

Return an index model.

View source

Arguments

  • $sourceId
  • $sessionId
  • $offset

Returns

Craft\AssetIndexDataModel, boolean

Signature

public Craft\AssetIndexDataModel, boolean getIndexEntry ( $sourceId, $sessionId, $offset )

getIndexListForSource()

Gets index list for a source.

View source

Arguments

  • $sessionId
  • $sourceId

Returns

array

Signature

public array getIndexListForSource ( $sessionId, $sourceId )

getIndexingSessionId()

Returns a unique indexing session id.

View source

Returns

string

Signature

public string getIndexingSessionId ( )

getMissingFiles()

Return a list of missing files for an indexing session.

View source

Arguments

  • $sources
  • $sessionId

Returns

array

Signature

public array getMissingFiles ( $sources, $sessionId )

processIndexForSource()

Process index for a source.

View source

Arguments

  • $sessionId
  • $offset
  • $sourceId

Returns

mixed

Signature

public mixed processIndexForSource ( $sessionId, $offset, $sourceId )

removeObsoleteFileRecords()

Remove obsolete file records.

View source

Arguments

  • $fileIds

Returns

null

Signature

public null removeObsoleteFileRecords ( $fileIds )

removeObsoleteFolderRecords()

Remove obsolete folder records.

View source

Arguments

  • $folderIds

Returns

null

Signature

public null removeObsoleteFolderRecords ( $folderIds )

storeIndexEntry()

Store an index entry.

View source

Arguments

  • $data

Signature

public void storeIndexEntry ( $data )

updateIndexEntryRecordId()

View source

Arguments

  • $entryId
  • $recordId

Returns

null

Signature

public null updateIndexEntryRecordId ( $entryId, $recordId )