PHP Interface Sulu\Component\Content\Types\ResourceLocator\Mapper\ResourceLocatorMapperInterface

Mostra file Open project: sulu/sulu Interface Usage Examples

Public Methods

Method Description
deleteByPath ( string $path, string $webspaceKey, string $languageCode, string $segmentKey = null ) Deletes given resource locator node.
getParentPath ( string $uuid, string $webspaceKey, string $languageCode, string $segmentKey = null ) : string Returns resource locator for parent node.
getUniquePath ( string $path, string $webspaceKey, string $languageCode, string $segmentKey = null ) : string Returns a unique path with "-1" if necessary.
loadByContent ( PHPCR\NodeInterface $contentNode, string $webspaceKey, string $languageCode, string $segmentKey = null ) : string Returns path for given contentNode.
loadByContentUuid ( string $uuid, string $webspaceKey, string $languageCode, string $segmentKey = null ) : string Returns path for given contentNode.
loadByResourceLocator ( string $resourceLocator, string $webspaceKey, string $languageCode, string $segmentKey = null ) : string Returns the uuid of referenced content node.
loadHistoryByContentUuid ( string $uuid, string $webspaceKey, string $languageCode, string $segmentKey = null ) : ResourceLocatorInformation[] Returns history for given contentNode.
save ( Sulu\Component\Content\Document\Behavior\ResourceSegmentBehavior $document ) Saves the route for the given document.
unique ( string $path, string $webspaceKey, string $languageCode, string $segmentKey = null ) : boolean Checks if given path is unique.

Method Details

deleteByPath() public method

Deletes given resource locator node.
public deleteByPath ( string $path, string $webspaceKey, string $languageCode, string $segmentKey = null )
$path string of resource locator node
$webspaceKey string key of portal
$languageCode string
$segmentKey string

getParentPath() public method

Returns resource locator for parent node.
public getParentPath ( string $uuid, string $webspaceKey, string $languageCode, string $segmentKey = null ) : string
$uuid string
$webspaceKey string
$languageCode string
$segmentKey string
return string

getUniquePath() public method

Returns a unique path with "-1" if necessary.
public getUniquePath ( string $path, string $webspaceKey, string $languageCode, string $segmentKey = null ) : string
$path string
$webspaceKey string key of portal
$languageCode string
$segmentKey string
return string

loadByContent() public method

Returns path for given contentNode.
public loadByContent ( PHPCR\NodeInterface $contentNode, string $webspaceKey, string $languageCode, string $segmentKey = null ) : string
$contentNode PHPCR\NodeInterface reference node
$webspaceKey string key of portal
$languageCode string
$segmentKey string
return string path

loadByContentUuid() public method

Returns path for given contentNode.
public loadByContentUuid ( string $uuid, string $webspaceKey, string $languageCode, string $segmentKey = null ) : string
$uuid string uuid of contentNode
$webspaceKey string key of portal
$languageCode string
$segmentKey string
return string path

loadByResourceLocator() public method

Returns the uuid of referenced content node.
public loadByResourceLocator ( string $resourceLocator, string $webspaceKey, string $languageCode, string $segmentKey = null ) : string
$resourceLocator string requested RL
$webspaceKey string key of portal
$languageCode string
$segmentKey string
return string uuid of content node

loadHistoryByContentUuid() public method

Returns history for given contentNode.
public loadHistoryByContentUuid ( string $uuid, string $webspaceKey, string $languageCode, string $segmentKey = null ) : ResourceLocatorInformation[]
$uuid string uuid of contentNode
$webspaceKey string key of portal
$languageCode string
$segmentKey string
return Sulu\Component\Content\Types\ResourceLocator\ResourceLocatorInformation[]

save() public method

Saves the route for the given document.
public save ( Sulu\Component\Content\Document\Behavior\ResourceSegmentBehavior $document )
$document Sulu\Component\Content\Document\Behavior\ResourceSegmentBehavior

unique() public method

Checks if given path is unique.
public unique ( string $path, string $webspaceKey, string $languageCode, string $segmentKey = null ) : boolean
$path string
$webspaceKey string key of portal
$languageCode string
$segmentKey string
return boolean