AssetSourcesService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\AssetSourcesService » 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 AssetSourcesService
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. |
| deleteSourceById() | Deletes an asset source by its ID. |
| 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. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| getAllSourceIds() | Returns all of the source IDs. |
| getAllSourceTypes() | Returns all available source types. |
| getAllSources() | Returns all sources. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| getPublicSourceIds() | Returns all source IDs that have public URLs. |
| getPublicSources() | Returns all sources that have public URLs. |
| getSourceById() | Returns a source by its ID. |
| getSourceType() | Returns an asset source type by its class handle. |
| getSourceTypeById() | Returns a source type by a given source ID. |
| getTotalSources() | Returns the total number of sources |
| getTotalViewableSources() | Returns the total number of sources that are viewable by the current user. |
| getViewableSourceIds() | Returns all source IDs that are viewable by the current user. |
| getViewableSources() | Returns all sources that are viewable by the current user. |
| 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. |
| populateSourceType() | Populates an asset source type with a given source. |
| raiseEvent() (opens new window) | Raises an event. |
| reorderSources() | Reorders asset sources. |
| saveSource() | Saves an asset source. |
# deleteSourceById()
Deletes an asset source by its ID.
View source (opens new window)
Arguments
$sourceId(integer (opens new window))
Returns
Throws
Signature
public boolean deleteSourceById ( $sourceId )
# getAllSourceIds()
Signature
public array getAllSourceIds ( )
# getAllSourceTypes()
Signature
public array getAllSourceTypes ( )
# getAllSources()
Returns all sources.
View source (opens new window)
Arguments
$indexBy(string (opens new window), null (opens new window))
Returns
Signature
public array getAllSources ( $indexBy = null )
# getPublicSourceIds()
Signature
public array getPublicSourceIds ( )
# getPublicSources()
Returns all sources that have public URLs.
View source (opens new window)
Arguments
$indexBy
Returns
Signature
public array getPublicSources ( $indexBy = null )
# getSourceById()
Returns a source by its ID.
View source (opens new window)
Arguments
$sourceId(integer (opens new window))
Returns
Signature
public Craft\AssetSourceModel, null getSourceById ( $sourceId )
# getSourceType()
Returns an asset source type by its class handle.
View source (opens new window)
Arguments
$class(string (opens new window))
Returns
Signature
public Craft\BaseAssetSourceType, null getSourceType ( $class )
# getSourceTypeById()
Returns a source type by a given source ID.
View source (opens new window)
Arguments
$sourceId
Returns
Signature
public Craft\BaseAssetSourceType getSourceTypeById ( $sourceId )
# getTotalSources()
Signature
public integer getTotalSources ( )
# getTotalViewableSources()
Returns the total number of sources that are viewable by the current user.
View source (opens new window)
Returns
Signature
public integer getTotalViewableSources ( )
# getViewableSourceIds()
Returns all source IDs that are viewable by the current user.
View source (opens new window)
Returns
Signature
public array getViewableSourceIds ( )
# getViewableSources()
Returns all sources that are viewable by the current user.
View source (opens new window)
Arguments
$indexBy(string (opens new window), null (opens new window))
Returns
Signature
public array getViewableSources ( $indexBy = null )
# populateSourceType()
Populates an asset source type with a given source.
View source (opens new window)
Arguments
$source(Craft\AssetSourceModel)
Returns
Signature
public Craft\BaseAssetSourceType, null populateSourceType ( Craft\AssetSourceModel $source )
# reorderSources()
Reorders asset sources.
View source (opens new window)
Arguments
$sourceIds(array (opens new window))
Returns
Throws
Signature
public boolean reorderSources ( $sourceIds )
# saveSource()
Saves an asset source.
View source (opens new window)
Arguments
$source(Craft\AssetSourceModel)
Returns
Throws
Signature
public boolean saveSource ( Craft\AssetSourceModel $source )