Documentation

Domain extends YamlEntity
in package

cloudrexx

core

model

Domain Entity

A entity that represents a domain.

Constants

NAME_VALIDATION_REGEXP = '/^(?!-)([\p{L}\p{N}-]{1,63}(?<!-)\.)+[\p{L}\p{N}]{2,63}$/u': Regex to valid the name of a domain

Properties

$id : int: Primary identifier of the domain
$localeCodes : array<string|int, mixed>: List of locale codes ordered by translation fallback order per Cx instance
$name : string: Domain name of the domain
$nestingCount : int: Counts the nesting level of __call()
$stringRepresentationBlank : bool: Whether blank string representations are valid
$stringRepresentationFields : array<string|int, mixed>: List of fields that should be available in the string representation
$stringRepresentationFormat : string: Sprintf format for the string representation
$validators : array<string|int, mixed>: Initialize this array as follows: array( 'columName' => Zend_Validate )
$virtual : bool: Defines if an entity is virtual and therefore not persistable.

Methods

__call() : mixed: Route methods like getName(), getType(), getDirectory(), etc.
__construct() : mixed: Constructor to initialize a new domain.
__get() : mixed: This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.
__toString() : string: Returns this entity's identifying value
getComponentController() : SystemComponent: Returns the component controller for this component
getId() : int: Return primary identifier of domain
getKeyAsString() : string: Returns this entity's key
getName() : string: Return the domain name of domain
getNameWithPunycode() : string: Return the domain name with the following schema <idn notation> (<punycode notation>) Attention. Returns the punycode notation only when needed
getParts() : array<string|int, mixed>: Returns the domain parts as an array where the tld is listed in index 0, sld in index 1 etc.
getTld() : string: Returns the top-level-domain of the Domain
getTranslatedFieldValue() : mixed: Returns the value of a translatable field using fallback mechanisms
initializeValidators() : mixed: Set $this->validators
isVirtual() : bool: Returns the virtuality of the entity
setId() : mixed: Set primary identifier of domain
setName() : mixed: Set a domain name of domain
setVirtual() : mixed: Set the virtuality of the entity
validate() : mixed
getFallbackLocaleCodes() : array<string|int, mixed>: Returns a list of all locale codes ordered by fallback order
getStringRepresentationBlank() : bool: Whether blank string representations are valid
getStringRepresentationFields() : array<string|int, mixed>: Returns a list of fields available in the string representation
getStringRepresentationFormat() : string: Returns the sprintf() format for the string representation

NAME_VALIDATION_REGEXP

Regex to valid the name of a domain


    public
        string
    NAME_VALIDATION_REGEXP
    = '/^(?!-)([\p{L}\p{N}-]{1,63}(?<!-)\.)+[\p{L}\p{N}]{2,63}$/u'

$id

Primary identifier of the domain


        protected
            int
    $id

$localeCodes

List of locale codes ordered by translation fallback order per Cx instance


        protected
        static    array<string|int, mixed>
    $localeCodes
     = array()

Array in the form: array(<instanceId> => array(<localeCode>, ...))

$name

Domain name of the domain


        protected
            string
    $name

$nestingCount

Counts the nesting level of __call()


        protected
        static    int
    $nestingCount
     = 0

$stringRepresentationBlank

Whether blank string representations are valid


        protected
            bool
    $stringRepresentationBlank
     = false

Whether blank string representations are valid

$stringRepresentationFields

List of fields that should be available in the string representation


        protected
            array<string|int, mixed>
    $stringRepresentationFields
     = array()

List of field names

$stringRepresentationFormat

Sprintf format for the string representation


        protected
            string
    $stringRepresentationFormat
     = ''

Sprintf format string

$validators

Initialize this array as follows: array( 'columName' => Zend_Validate )


        protected
            array<string|int, mixed>
    $validators
     = array()

$virtual

Defines if an entity is virtual and therefore not persistable.


        protected
            bool
    $virtual
     = false

Defaults to FALSE - not virtual.

__call()

Route methods like getName(), getType(), getDirectory(), etc.


    public
                    __call(string $methodName, array<string|int, mixed> $arguments) : mixed

Parameters

$methodName : string: Name of method to call
$arguments : array<string|int, mixed>: List of arguments for the method to call

Return values

mixed —

Return value of the method to call

__construct()

Constructor to initialize a new domain.


    public
                    __construct([string $name = '' ]) : mixed

Parameters

$name : string = '': Domain name of new domain

__get()

This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.


    public
                    __get(mixed $name) : mixed

Parameters

$name : mixed

#[ReturnTypeWillChange]

__toString()

Returns this entity's identifying value


    public
                    __toString() : string

By default this returns the same as getKeyAsString(), but this method might get overridden by subclasses.

Return values

string —

Identifying value for this entity

getComponentController()

Returns the component controller for this component


    public
                    getComponentController() : SystemComponent

Return values

SystemComponent

getId()

Return primary identifier of domain


    public
                    getId() : int

Return values

int —

Primary identifier of domain

getKeyAsString()

Returns this entity's key


    public
        final            getKeyAsString([string $separator = '/' ]) : string

If this entity has a composite key, the fields are separated by $separator.

Parameters

$separator : string = '/': (optional) Separator for composite key fields, default "/"

Return values

string —

Entity key as string

getName()

Return the domain name of domain


    public
                    getName() : string

Return values

string —

Domain name of domain

getNameWithPunycode()

Return the domain name with the following schema <idn notation> (<punycode notation>) Attention. Returns the punycode notation only when needed


    public
                    getNameWithPunycode() : string

Return values

string —

Domain name of domain

getParts()

Returns the domain parts as an array where the tld is listed in index 0, sld in index 1 etc.


    public
                    getParts() : array<string|int, mixed>

Return values

array<string|int, mixed> —

the domain parts as an array

getTld()

Returns the top-level-domain of the Domain


    public
                    getTld() : string

Return values

string —

the top-level-domain of the Domain

getTranslatedFieldValue()

Returns the value of a translatable field using fallback mechanisms


    public
                    getTranslatedFieldValue(string $fieldName) : mixed

If the field is not translatable its value is returned anyway. Tries to return the value in the following locales (if non-empty):

Current locale
Default locale
All other locales

Parameters

$fieldName : string: Name of a translatable field

initializeValidators()

Set $this->validators


    public
                    initializeValidators() : mixed

Validators can be found in lib/FRAMEWORK/Validator.class.php These will be executed if validate() is called

isVirtual()

Returns the virtuality of the entity


    public
                    isVirtual() : bool

Return values

bool —

TRUE if the entity is virtual, otherwise FALSE

setId()

Set primary identifier of domain


    public
                    setId(int $id) : mixed

Parameters

$id : int: Primary identifiert for domain

setName()

Set a domain name of domain


    public
                    setName(string $name) : mixed

Parameters

$name : string: Domain name to set the domain to

setVirtual()

Set the virtuality of the entity


    public
                    setVirtual(bool $virtual) : mixed

Parameters

$virtual : bool: TRUE to set the entity as virtual or otherwise to FALSE

validate()


    public
                    validate() : mixed

getFallbackLocaleCodes()

Returns a list of all locale codes ordered by fallback order


    protected
                    getFallbackLocaleCodes() : array<string|int, mixed>

First entry is the current locale
Second entry is the default locale (if different from current, it's omitted otherwise)
Then all other locales follow (in no particular order)

Return values

array<string|int, mixed> —

List of locale codes

getStringRepresentationBlank()

Whether blank string representations are valid


    protected
                    getStringRepresentationBlank() : bool

Return values

bool —

Whether blank string representations are valid

getStringRepresentationFields()

Returns a list of fields available in the string representation


    protected
                    getStringRepresentationFields() : array<string|int, mixed>

Return values

array<string|int, mixed> —

List of field names

getStringRepresentationFormat()

Returns the sprintf() format for the string representation


    protected
                    getStringRepresentationFormat() : string

Return values

string —

sprintf() format string

Domain extends YamlEntity in package cloudrexx core model

Tags

Table of Contents

Constants

Properties

Methods

Constants

NAME_VALIDATION_REGEXP

Properties

$id

$localeCodes

Tags

$name

$nestingCount

$stringRepresentationBlank

Tags

$stringRepresentationFields

Tags

$stringRepresentationFormat

Tags

$validators

$virtual

Methods

__call()

Parameters

Tags

Attributes

Return values

__construct()

Parameters

__get()

Parameters

Attributes

__toString()

Return values

getComponentController()

Return values

getId()

Return values

getKeyAsString()

Parameters

Return values

getName()

Return values

getNameWithPunycode()

Return values

getParts()

Return values

getTld()

Return values

getTranslatedFieldValue()

Parameters

initializeValidators()

isVirtual()

Return values

setId()

Parameters

setName()

Parameters

setVirtual()

Parameters

validate()

Tags

getFallbackLocaleCodes()

Tags

Return values

getStringRepresentationBlank()

Return values

getStringRepresentationFields()

Return values

getStringRepresentationFormat()

Return values

Domain extends YamlEntity
in package

cloudrexx

core

model