PHP Interface Sulu\Bundle\ContentBundle\Repository\NodeRepositoryInterface

Deprecation:
Show file Open project: sulu/sulu Interface Usage Examples

Public Methods

Method Description
copyLocale ( string $uuid, integer $userId, string $webspaceKey, string $srcLocale, string[] $destLocales )
deleteNode ( string $uuid, string $webspaceKey ) removes given node.
getFilteredNodes ( array $filterConfig, string $languageCode, string $webspaceKey, boolean $preview = false, boolean $api = false ) : array Returns the content of a smart content configuration.
getIndexNode ( string $webspaceKey, string $languageCode ) : array returns start node for given portal.
getNode ( string $uuid, string $webspaceKey, string $languageCode, boolean $breadcrumb = false, boolean $complete = true, boolean $excludeGhosts = false ) : array returns node for given uuid.
getNodes ( string $parent, string $webspaceKey, string $languageCode, integer $depth = 1, boolean $flat = true, boolean $complete = true, boolean $excludeGhosts = false ) : array returns a list of nodes.
getNodesByIds ( array $ids, string $webspaceKey, string $languageCode ) : array returns list of nodes with given ids.
getNodesTree ( string $uuid, string $webspaceKey, string $languageCode, boolean $excludeGhosts = false, boolean $appendWebspaceNode = false ) : array returns tree to content node given by uuid.
getReferences ( string $uuid ) : PHPCR\NodeInterface[] Return the nodes which refer to the structure with the given UUID.
getWebspaceNode ( $webspaceKey, $languageCode, integer $depth = 1, boolean $excludeGhosts = false ) : mixed returns webspace as node.
getWebspaceNodes ( string $languageCode ) : array Return all webspaces as nodes.
loadExtensionData ( string $uuid, string $extension, string $webspaceKey, string $languageCode ) : array returns data of given extension api ready.
orderAt ( string $uuid, integer $position, string $webspaceKey, string $languageCode, integer $userId ) : array brings a given node into a given position.
saveExtensionData ( string $uuid, array $data, string $extensionName, string $webspaceKey, string $languageCode, integer $userId ) : array save extension data.

Method Details

copyLocale() public method

public copyLocale ( string $uuid, integer $userId, string $webspaceKey, string $srcLocale, string[] $destLocales )
$uuid string
$userId integer
$webspaceKey string
$srcLocale string
$destLocales string[]

deleteNode() public method

removes given node.
public deleteNode ( string $uuid, string $webspaceKey )
$uuid string
$webspaceKey string

getFilteredNodes() public method

Returns the content of a smart content configuration.
public getFilteredNodes ( array $filterConfig, string $languageCode, string $webspaceKey, boolean $preview = false, boolean $api = false ) : array
$filterConfig array The config of the smart content
$languageCode string The desired language code
$webspaceKey string The webspace key
$preview boolean If true also unpublished pages will be returned
$api boolean If true result will be formated for HAL API
return array

getIndexNode() public method

returns start node for given portal.
public getIndexNode ( string $webspaceKey, string $languageCode ) : array
$webspaceKey string
$languageCode string
return array

getNode() public method

returns node for given uuid.
public getNode ( string $uuid, string $webspaceKey, string $languageCode, boolean $breadcrumb = false, boolean $complete = true, boolean $excludeGhosts = false ) : array
$uuid string
$webspaceKey string
$languageCode string
$breadcrumb boolean
$complete boolean
$excludeGhosts boolean
return array

getNodes() public method

returns a list of nodes.
public getNodes ( string $parent, string $webspaceKey, string $languageCode, integer $depth = 1, boolean $flat = true, boolean $complete = true, boolean $excludeGhosts = false ) : array
$parent string uuid of parent node
$webspaceKey string key of current portal
$languageCode string
$depth integer
$flat boolean
$complete boolean
$excludeGhosts boolean
return array

getNodesByIds() public method

returns list of nodes with given ids.
public getNodesByIds ( array $ids, string $webspaceKey, string $languageCode ) : array
$ids array
$webspaceKey string
$languageCode string
return array

getNodesTree() public method

returns tree to content node given by uuid.
public getNodesTree ( string $uuid, string $webspaceKey, string $languageCode, boolean $excludeGhosts = false, boolean $appendWebspaceNode = false ) : array
$uuid string
$webspaceKey string
$languageCode string
$excludeGhosts boolean
$appendWebspaceNode boolean if TRUE webspace will added as own node in first layer
return array

getReferences() public method

Return the nodes which refer to the structure with the given UUID.
public getReferences ( string $uuid ) : PHPCR\NodeInterface[]
$uuid string
return PHPCR\NodeInterface[]

getWebspaceNode() public method

returns webspace as node.
public getWebspaceNode ( $webspaceKey, $languageCode, integer $depth = 1, boolean $excludeGhosts = false ) : mixed
$webspaceKey
$languageCode
$depth integer
$excludeGhosts boolean
return mixed

getWebspaceNodes() public method

Return all webspaces as nodes.
public getWebspaceNodes ( string $languageCode ) : array
$languageCode string The desired language code
return array

loadExtensionData() public method

returns data of given extension api ready.
public loadExtensionData ( string $uuid, string $extension, string $webspaceKey, string $languageCode ) : array
$uuid string
$extension string
$webspaceKey string
$languageCode string
return array

orderAt() public method

brings a given node into a given position.
public orderAt ( string $uuid, integer $position, string $webspaceKey, string $languageCode, integer $userId ) : array
$uuid string
$position integer
$webspaceKey string
$languageCode string
$userId integer
return array

saveExtensionData() public method

save extension data.
public saveExtensionData ( string $uuid, array $data, string $extensionName, string $webspaceKey, string $languageCode, integer $userId ) : array
$uuid string
$data array
$extensionName string
$webspaceKey string
$languageCode string
$userId integer
return array