Documentation

EventField extends EntityBase
in package

EventField

Tags
copyright

Cloudrexx AG

author

Project Team SS4U info@cloudrexx.com

subpackage

module_calendar

Table of Contents

Properties

$description  : text
$event  : Event
$langId  : int
$localeCodes  : array<string|int, mixed>
List of locale codes ordered by translation fallback order per Cx instance
$nestingCount  : int
Counts the nesting level of __call()
$orgCity  : string
$orgCountry  : string
$orgName  : string
$place  : string
$placeCity  : string
$placeCountry  : string
$redirect  : string
$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
$teaser  : text
$title  : string
$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.
__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
getDescription()  : text
Get description
getEvent()  : Event
Get event
getKeyAsString()  : string
Returns this entity's key
getLangId()  : int
Get langId
getOrgCity()  : string
Get orgCity
getOrgCountry()  : string
Get orgCountry
getOrgName()  : string
Get orgName
getPlace()  : string
Get place
getPlaceCity()  : string
Get placeCity
getPlaceCountry()  : string
Get placeCountry
getRedirect()  : string
Get redirect
getTeaser()  : text
Get teaser
getTitle()  : string
Get title
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
setDescription()  : mixed
Set description
setEvent()  : mixed
Set event
setLangId()  : mixed
Set langId
setOrgCity()  : mixed
Set orgCity
setOrgCountry()  : mixed
Set orgCountry
setOrgName()  : mixed
Set orgName
setPlace()  : mixed
Set place
setPlaceCity()  : mixed
Set placeCity
setPlaceCountry()  : mixed
Set placeCountry
setRedirect()  : mixed
Set redirect
setTeaser()  : mixed
Set teaser
setTitle()  : mixed
Set title
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

Properties

$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>, ...))

Tags
see
getFallbackLocaleCodes()

$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

Tags
see
getStringRepresentationBlank()

$stringRepresentationFields

List of fields that should be available in the string representation

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

List of field names

Tags
see
getStringRepresentationFields()

$stringRepresentationFormat

Sprintf format for the string representation

protected string $stringRepresentationFormat = ''

Sprintf format string

Tags
see
getStringRepresentationFormat()

$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.

Methods

__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

Tags
throws
Exception

If __call() nesting level reaches 20

Return values
mixed —

Return value of the method to call

__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

__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

getDescription()

Get description

public getDescription() : text
Return values
text —

$description

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

getLangId()

Get langId

public getLangId() : int
Return values
int —

$langId

getOrgCity()

Get orgCity

public getOrgCity() : string
Return values
string —

$orgCity

getOrgCountry()

Get orgCountry

public getOrgCountry() : string
Return values
string —

$orgCountry

getOrgName()

Get orgName

public getOrgName() : string
Return values
string —

$orgName

getPlace()

Get place

public getPlace() : string
Return values
string —

$place

getPlaceCity()

Get placeCity

public getPlaceCity() : string
Return values
string —

$placeCity

getPlaceCountry()

Get placeCountry

public getPlaceCountry() : string
Return values
string —

$placeCountry

getRedirect()

Get redirect

public getRedirect() : string
Return values
string —

$redirect

getTeaser()

Get teaser

public getTeaser() : text
Return values
text —

$teaser

getTitle()

Get title

public getTitle() : string
Return values
string —

$title

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

setDescription()

Set description

public setDescription(text $description) : mixed
Parameters
$description : text

setEvent()

Set event

public setEvent(Event $event) : mixed
Parameters
$event : Event

setLangId()

Set langId

public setLangId(int $langId) : mixed
Parameters
$langId : int

setOrgCity()

Set orgCity

public setOrgCity(string $orgCity) : mixed
Parameters
$orgCity : string

setOrgCountry()

Set orgCountry

public setOrgCountry(string $orgCountry) : mixed
Parameters
$orgCountry : string

setOrgName()

Set orgName

public setOrgName(string $orgName) : mixed
Parameters
$orgName : string

setPlace()

Set place

public setPlace(string $place) : mixed
Parameters
$place : string

setPlaceCity()

Set placeCity

public setPlaceCity(string $placeCity) : mixed
Parameters
$placeCity : string

setPlaceCountry()

Set placeCountry

public setPlaceCountry(string $placeCountry) : mixed
Parameters
$placeCountry : string

setRedirect()

Set redirect

public setRedirect(string $redirect) : mixed
Parameters
$redirect : string

setTeaser()

Set teaser

public setTeaser(text $teaser) : mixed
Parameters
$teaser : text

setTitle()

Set title

public setTitle(string $title) : mixed
Parameters
$title : string

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

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)
Tags
todo

Order the array by the fallback order (same as in ContentManager)

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


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results