Guides

CrossReferenceNode extends LinkInlineNode

A cross-reference node is a link node that can reference targets outside of the current document.

Examples are external URLs, other documents or sections in the project and other Interlink projects.

Table of Contents

Methods

getClasses()  : array<string|int, string>
getClassesString()  : string
getDebugInformation()  : array<string, string>
getInterlinkDomain()  : string
getInterlinkGroup()  : string
getOptions()  : array<string, scalar|null>
getTargetReference()  : string
getUrl()  : string
getValue()  : mixed
hasOption()  : bool
setClasses()  : void
setUrl()  : void
setValue()  : void
withKeepExistingOptions()  : Node
withOptions()  : Node

Methods

getClasses()

public getClasses() : array<string|int, string>
Return values
array<string|int, string>

getClassesString()

public getClassesString() : string
Return values
string

getDebugInformation()

public getDebugInformation() : array<string, string>
Return values
array<string, string>

getOptions()

public getOptions() : array<string, scalar|null>
Return values
array<string, scalar|null>

getTargetReference()

public getTargetReference() : string
Return values
string

getValue()

public getValue() : mixed

hasOption()

public hasOption(string $name) : bool
Parameters
$name : string
Return values
bool

setClasses()

public setClasses(array<string|int, string> $classes) : void
Parameters
$classes : array<string|int, string>

setUrl()

public setUrl(string $url) : void
Parameters
$url : string

setValue()

public setValue(mixed $value) : void
Parameters
$value : mixed

withKeepExistingOptions()

public withKeepExistingOptions(array<string, scalar|null> $options) : Node
Parameters
$options : array<string, scalar|null>
Return values
Node

withOptions()

public withOptions(array<string, scalar|null> $options) : Node
Parameters
$options : array<string, scalar|null>
Return values
Node

        
On this page

Search results