AssetIndexingService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\AssetIndexingService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- 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 (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| ensureTopFolder() | Ensures a top level folder exists that matches the model. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| getEventHandlers() (opens new window) | 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() (opens new window) | Checks if this application component has been initialized. |
| getMissingFiles() | Return a list of missing files for an indexing session. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| init() (opens new window) | Initializes the application component. |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| processIndexForSource() | Process index for a source. |
| raiseEvent() (opens new window) | 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 (opens new window)
Arguments
$model(Craft\AssetSourceModel)
Returns
Signature
public integer ensureTopFolder ( Craft\AssetSourceModel $model )
# getIndexEntry()
Return an index model.
View source (opens new window)
Arguments
$sourceId$sessionId$offset
Returns
Signature
public Craft\AssetIndexDataModel, boolean getIndexEntry ( $sourceId, $sessionId, $offset )
# getIndexListForSource()
Signature
public array getIndexListForSource ( $sessionId, $sourceId )
# getIndexingSessionId()
Signature
public string getIndexingSessionId ( )
# getMissingFiles()
Return a list of missing files for an indexing session.
View source (opens new window)
Arguments
$sources$sessionId
Returns
Signature
public array getMissingFiles ( $sources, $sessionId )
# processIndexForSource()
Process index for a source.
View source (opens new window)
Arguments
$sessionId$offset$sourceId
Returns
mixed
Signature
public mixed processIndexForSource ( $sessionId, $offset, $sourceId )
# removeObsoleteFileRecords()
Signature
public null removeObsoleteFileRecords ( $fileIds )
# removeObsoleteFolderRecords()
Signature
public null removeObsoleteFolderRecords ( $folderIds )
# storeIndexEntry()
Signature
public void storeIndexEntry ( $data )
# updateIndexEntryRecordId()
Signature
public null updateIndexEntryRecordId ( $entryId, $recordId )