AssetSourcesService

Type
Class
Namespace
Craft
Inherits
Craft\AssetSourcesService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
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

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.
deleteSourceById()Deletes an asset source by its ID.
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.
evaluateExpression()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()Returns the list of attached event handlers for an event.
getIsInitialized()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()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.
populateSourceType()Populates an asset source type with a given source.
raiseEvent()Raises an event.
reorderSources()Reorders asset sources.
saveSource()Saves an asset source.

deleteSourceById()

Deletes an asset source by its ID.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean deleteSourceById ( $sourceId )

getAllSourceIds()

Returns all of the source IDs.

View source

Returns

array

Signature

public array getAllSourceIds ( )

getAllSourceTypes()

Returns all available source types.

View source

Returns

array

Signature

public array getAllSourceTypes ( )

getAllSources()

Returns all sources.

View source

Arguments

Returns

array

Signature

public array getAllSources ( $indexBy = null )

getPublicSourceIds()

Returns all source IDs that have public URLs.

View source

Returns

array

Signature

public array getPublicSourceIds ( )

getPublicSources()

Returns all sources that have public URLs.

View source

Arguments

  • $indexBy

Returns

array

Signature

public array getPublicSources ( $indexBy = null )

getSourceById()

Returns a source by its ID.

View source

Arguments

Returns

Craft\AssetSourceModel, null

Signature

public Craft\AssetSourceModel, null getSourceById ( $sourceId )

getSourceType()

Returns an asset source type by its class handle.

View source

Arguments

Returns

Craft\BaseAssetSourceType, null

Signature

public Craft\BaseAssetSourceType, null getSourceType ( $class )

getSourceTypeById()

Returns a source type by a given source ID.

View source

Arguments

  • $sourceId

Returns

Craft\BaseAssetSourceType

Signature

public Craft\BaseAssetSourceType getSourceTypeById ( $sourceId )

getTotalSources()

Returns the total number of sources

View source

Returns

integer

Signature

public integer getTotalSources ( )

getTotalViewableSources()

Returns the total number of sources that are viewable by the current user.

View source

Returns

integer

Signature

public integer getTotalViewableSources ( )

getViewableSourceIds()

Returns all source IDs that are viewable by the current user.

View source

Returns

array

Signature

public array getViewableSourceIds ( )

getViewableSources()

Returns all sources that are viewable by the current user.

View source

Arguments

Returns

array

Signature

public array getViewableSources ( $indexBy = null )

populateSourceType()

Populates an asset source type with a given source.

View source

Arguments

Returns

Craft\BaseAssetSourceType, null

Signature

public Craft\BaseAssetSourceType, null populateSourceType ( Craft\AssetSourceModel $source )

reorderSources()

Reorders asset sources.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean reorderSources ( $sourceIds )

saveSource()

Saves an asset source.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean saveSource ( Craft\AssetSourceModel $source )