PHP Class Neos\Neos\ViewHelpers\Link\NodeViewHelper

The target node can be provided as string or as a Node object; if not specified at all, the generated URI will refer to the current document node inside the TypoScript context. When specifying the node argument as string, the following conventions apply: *node starts with /:* The given path is an absolute node path and is treated as such. Example: /sites/acmecom/home/about/us *node does not start with /:* The given path is treated as a path relative to the current node. Examples: given that the current node is /sites/acmecom/products/, stapler results in /sites/acmecom/products/stapler, ../about results in /sites/acmecom/about/, ./neos/info results in /sites/acmecom/products/neos/info. *node starts with a tilde character (~):* The given path is treated as a path relative to the current site node. Example: given that the current node is /sites/acmecom/products/, ~/about/us results in /sites/acmecom/about/us, ~ results in /sites/acmecom. = Examples = some link some link (depending on current node, format etc.) bookmark this page bookmark this page (depending on current workspace, current node, format, host etc.) Corporate imprint Corporate imprint (depending on current workspace, current node, format etc.) Corporate imprint Corporate imprint (depending on current workspace, current node, format etc.) About us About us (depending on current workspace, current node, format etc.) Imprint (depending on current workspace, current node, format etc.) see our {linkedNode.label} page see our About Us page (depending on current workspace, current node, format etc.)
Inheritance: extends Neos\FluidAdaptor\Core\ViewHelper\AbstractTagBasedViewHelper, use trait Neos\Fusion\ViewHelpers\TypoScriptContextTrait
Show file Open project: neos/neos-development-collection Class Usage Examples

Protected Properties

Property Type Description
$linkingService Neos\Neos\Service\LinkingService
$tagName string

Public Methods

Method Description
initializeArguments ( ) : void Initialize arguments
render ( mixed $node = null, string $format = null, boolean $absolute = false, array $arguments = [], string $section = '', boolean $addQueryString = false, array $argumentsToBeExcludedFromQueryString = [], string $baseNodeName = 'documentNode', string $nodeVariableName = 'linkedNode', boolean $resolveShortcuts = true ) : string Renders the link. Renders the linked node's label if there's no child content.

Method Details

initializeArguments() public method

Initialize arguments
public initializeArguments ( ) : void
return void

render() public method

Renders the link. Renders the linked node's label if there's no child content.
public render ( mixed $node = null, string $format = null, boolean $absolute = false, array $arguments = [], string $section = '', boolean $addQueryString = false, array $argumentsToBeExcludedFromQueryString = [], string $baseNodeName = 'documentNode', string $nodeVariableName = 'linkedNode', boolean $resolveShortcuts = true ) : string
$node mixed A node object, a string node path (absolute or relative), a string node://-uri or NULL
$format string Format to use for the URL, for example "html" or "json"
$absolute boolean If set, an absolute URI is rendered
$arguments array Additional arguments to be passed to the UriBuilder (for example pagination parameters)
$section string The anchor to be added to the URI
$addQueryString boolean If set, the current query parameters will be kept in the URI
$argumentsToBeExcludedFromQueryString array arguments to be removed from the URI. Only active if $addQueryString = TRUE
$baseNodeName string The name of the base node inside the TypoScript context to use for the ContentContext or resolving relative paths
$nodeVariableName string The variable the node will be assigned to for the rendered child content
$resolveShortcuts boolean INTERNAL Parameter - if FALSE, shortcuts are not redirected to their target. Only needed on rare backend occasions when we want to link to the shortcut itself.
return string The rendered link

Property Details

$linkingService protected property

protected LinkingService,Neos\Neos\Service $linkingService
return Neos\Neos\Service\LinkingService

$tagName protected property

protected string $tagName
return string