PHP Class Neos\Neos\Ui\TYPO3CR\Service\NodeService

Show file Open project: neos/neos-ui Class Usage Examples

Protected Properties

Property Type Description
$contextFactory TYPO3\TYPO3CR\Domain\Service\ContextFactoryInterface
$domainRepository TYPO3\Neos\Domain\Repository\DomainRepository
$siteRepository TYPO3\Neos\Domain\Repository\SiteRepository

Public Methods

Method Description
getClosestDocument ( TYPO3\TYPO3CR\Domain\Model\NodeInterface $node ) : TYPO3\TYPO3CR\Domain\Model\NodeInterface Helper method to retrieve the closest document for a node
getNodeFromContextPath ( string $contextPath, TYPO3\Neos\Domain\Model\Site $site = null, TYPO3\Neos\Domain\Model\Domain $domain = null ) : TYPO3\TYPO3CR\Domain\Model\NodeInterface Converts a given context path to a node object
isDocument ( TYPO3\TYPO3CR\Domain\Model\NodeInterface $node ) : boolean Helper method to check if a given node is a document node.

Protected Methods

Method Description
prepareContextProperties ( string $workspaceName, array $dimensions = null ) : array Prepares the context properties for the nodes based on the given workspace and dimensions

Method Details

getClosestDocument() public method

Helper method to retrieve the closest document for a node
public getClosestDocument ( TYPO3\TYPO3CR\Domain\Model\NodeInterface $node ) : TYPO3\TYPO3CR\Domain\Model\NodeInterface
$node TYPO3\TYPO3CR\Domain\Model\NodeInterface
return TYPO3\TYPO3CR\Domain\Model\NodeInterface

getNodeFromContextPath() public method

Converts a given context path to a node object
public getNodeFromContextPath ( string $contextPath, TYPO3\Neos\Domain\Model\Site $site = null, TYPO3\Neos\Domain\Model\Domain $domain = null ) : TYPO3\TYPO3CR\Domain\Model\NodeInterface
$contextPath string
$site TYPO3\Neos\Domain\Model\Site
$domain TYPO3\Neos\Domain\Model\Domain
return TYPO3\TYPO3CR\Domain\Model\NodeInterface

isDocument() public method

Helper method to check if a given node is a document node.
public isDocument ( TYPO3\TYPO3CR\Domain\Model\NodeInterface $node ) : boolean
$node TYPO3\TYPO3CR\Domain\Model\NodeInterface The node to check
return boolean A boolean which indicates if the given node is a document node.

prepareContextProperties() protected method

Prepares the context properties for the nodes based on the given workspace and dimensions
protected prepareContextProperties ( string $workspaceName, array $dimensions = null ) : array
$workspaceName string
$dimensions array
return array

Property Details

$contextFactory protected property

protected ContextFactoryInterface,TYPO3\TYPO3CR\Domain\Service $contextFactory
return TYPO3\TYPO3CR\Domain\Service\ContextFactoryInterface

$domainRepository protected property

protected DomainRepository,TYPO3\Neos\Domain\Repository $domainRepository
return TYPO3\Neos\Domain\Repository\DomainRepository

$siteRepository protected property

protected SiteRepository,TYPO3\Neos\Domain\Repository $siteRepository
return TYPO3\Neos\Domain\Repository\SiteRepository