PHP Interface Sulu\Component\Content\Types\ResourceLocator\Strategy\ResourceLocatorStrategyInterface

显示文件 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.
generate ( string $title, string $parentUuid, string $webspaceKey, string $languageCode, string $segmentKey = null ) : string Returns whole path for given title and parent-uuid.
getChildPart ( $resourceSegment ) : string Returns the child part from the given resource segment.
getInputType ( ) : string Returns input-type for javscript-component.
isValid ( string $path, string $webspaceKey, string $languageCode, string $segmentKey = null ) : boolean Checks if path is valid.
loadByContent ( Sulu\Component\Content\Document\Behavior\ResourceSegmentBehavior $document ) : 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, integer $userId ) Creates a new route for given path.

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

generate() public method

Returns whole path for given title and parent-uuid.
public generate ( string $title, string $parentUuid, string $webspaceKey, string $languageCode, string $segmentKey = null ) : string
$title string title of new node
$parentUuid string uuid of the parent of the new node
$webspaceKey string key of portal
$languageCode string
$segmentKey string
return string whole path

getChildPart() public method

Returns the child part from the given resource segment.
public getChildPart ( $resourceSegment ) : string
$resourceSegment
return string

getInputType() public method

Returns input-type for javscript-component.
public getInputType ( ) : string
return string

isValid() public method

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

loadByContent() public method

Returns path for given contentNode.
public loadByContent ( Sulu\Component\Content\Document\Behavior\ResourceSegmentBehavior $document ) : string
$document Sulu\Component\Content\Document\Behavior\ResourceSegmentBehavior reference node
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

Creates a new route for given path.
public save ( Sulu\Component\Content\Document\Behavior\ResourceSegmentBehavior $document, integer $userId )
$document Sulu\Component\Content\Document\Behavior\ResourceSegmentBehavior
$userId integer