PHP Interface Newscoop\Service\ISyncResourceService

Inheritance: extends Newscoop\Service\IEntityService

Show file Open project: sourcefabric/newscoop

Public Methods

Method	Description
clearAllFor ( str $path )	Clears all resources that are prefixed by the provided path.
findByPath ( string $path ) : Resource	Provides the synchronized Resource based on the provided resource.
findByPathOrId ( $pathOrId ) : Resource	Provides the synchronized Resource based on the provided resource.
getResource ( string $name, string $path ) : Resource	Provides the synchronized Resource based on the provided name and path.
getSynchronized ( Resource $resource ) : Resource	Provides the synchronized Resource based on the provided resource.
getThemePath ( str $themePath ) : Resource	Provides the synchronized Resource based on the provided theme path.

Method Details

clearAllFor() public method

Clears all resources that are prefixed by the provided path.

public clearAllFor ( str $path )
$path	str	The path for which all resources should be cleared has to end with a '/'.

findByPath() public method

The synchronization of a resource means the association of that resource with the database.

public findByPath ( string $path ) : Resource
$path	string	The Resource Path to be synchronized, not null, not empty.
return	Newscoop\Entity\Resource	The synchronized Resource.

findByPathOrId() public method

The synchronization of a resource means the association of that resource with the database.

public findByPathOrId ( $pathOrId ) : Resource
return	Newscoop\Entity\Resource	The synchronized Resource.

getResource() public method

The synchronization of a resource means the association of that resource with the database.

public getResource ( string $name, string $path ) : Resource
$name	string	The name of the Resource to be synchronized, not null, not empty.
$path	string	The path of the Resource to be synchronized, not null, not empty.
return	Newscoop\Entity\Resource	The synchronized Resource.

getSynchronized() public method

The synchronization of a resource means the association of that resource with the database.

public getSynchronized ( Resource $resource ) : Resource
$resource	Newscoop\Entity\Resource	The Resource to be synchronized, not null, not empty.
return	Newscoop\Entity\Resource	The synchronized Resource.

getThemePath() public method

The synchronization of a resource means the association of that resource with the database.

public getThemePath ( str $themePath ) : Resource
$themePath	str	The theme path to be synchronized, not null, not empty.
return	Newscoop\Entity\Resource	The synchronized Resource.