Class Link in namespace com\setasign\SetaSite\PropertyContainer\Property in SetaSite API Reference

Index

\com\setasign\SetaSite
1. PropertyContainer
  1. Property
    1. AbstractProperty
    2. Boolean
    3. BooleanGroup
    4. Custom
    5. Date
    6. DateTime
    7. File
    8. FloatProperty
    9. Group
    10. Html
    11. Integer
    12. Link
    13. Password
    14. RequiresApplication
    15. Select
    16. StringProperty
    17. Template
    18. Text

com\setasign\SetaSite\PropertyContainer\Property

Link Interface RequiresApplicationForToStringInterface

File: /SetaSite/src/PropertyContainer/Property/Link.php

Class hierarchy

AbstractProperty
- Link

Implements

Summary

Constants

VALIDATOR_EMPTY

public const Link::VALIDATOR_EMPTY = 'empty'

VALIDATOR_ONLY_INTERNAL

public const Link::VALIDATOR_ONLY_INTERNAL = 'onlyInternal'

Properties

$cachedLink

protected ?string Link::$cachedLink

Remember the page link

$config

protected \com\setasign\SetaFramework\Config\Config AbstractProperty::$config

$containerParent

protected \com\setasign\SetaSite\PropertyContainer\ContainerParent\PageParentInterface Link::$containerParent

$filesystemManager

protected Link::$filesystemManager

$requestPathPrefix

protected Link::$requestPathPrefix

$value

protected mixed AbstractProperty::$value

Static Methods

cleanupConfig()

public static AbstractProperty::cleanupConfig (

\com\setasign\SetaFramework\Config\Config $config

): void

Parameters

$config : \com\setasign\SetaFramework\Config\Config

Methods

__construct()

public AbstractProperty::__construct (

\com\setasign\SetaSite\PropertyContainer\ContainerParent\ContainerParentInterface $containerParent,
?\com\setasign\SetaFramework\Config\Config $config = null

)

Parameters

$containerParent : \com\setasign\SetaSite\PropertyContainer\ContainerParent\ContainerParentInterface
$config : ?\com\setasign\SetaFramework\Config\Config

__clone()

public AbstractProperty::__clone (

void

): void

__toString()

public Link::__toString (

void

): string

Returns the link as path. The language and requestPathPrefix are included.

exportValue()

public Link::exportValue (

void

): mixed

Export the value, to use it in a Database

getConfig()

public AbstractProperty::getConfig (

void

): \com\setasign\SetaFramework\Config\Config

getDefaultValue()

public AbstractProperty::getDefaultValue (

void

): void

getValidators()

public AbstractProperty::getValidators (

void

): \com\setasign\SetaFramework\Config\Config

getValue()

public AbstractProperty::getValue (

void

): mixed

isNull()

public AbstractProperty::isNull (

void

): bool

Checks whether the value is null

isValid()

public Link::isValid (

array &$result = array ( )

): bool

Checks whether the value of the property is valid

Parameters

$result : array

parseValue()

protected Link::parseValue (

mixed $value

): mixed

Parses the value to the correct format

Parameters

$value : mixed

setApplication()

public Link::setApplication (

\com\setasign\SetaSite\SetaSite $setasite

): void

Parameters

$setasite : \com\setasign\SetaSite\SetaSite

setValue()

public Link::setValue (

mixed $value,
bool $ignoreEditable = false

): void

Sets the value

Parameters

$value : mixed
$ignoreEditable : bool: Ignore editable property, only for internal use!