1. class
  2. XELOS
  3. \
  4. Modules
  5. \
  6. Eventplanner
  7. \
  8. Model
  9. \
  10. Participant

Participant

class Participant extends Model mixin ParticipantDocumentation

Class XELOS\Modules\Eventplanner\Model\Participant

Traits

SortTrait
ScopesTrait

Constants

EVENT_MODEL_AFTER_SAVE

EVENT_MODEL_BEFORE_SAVE

EVENT_MODEL_BEFORE_DELETE

EVENT_MODEL_AFTER_DELETE

FIELD_IS_NULL

$this->find_by_field(Model::IS_NULL)

Properties

EventplannerController $mod
protected string|null $model_name from  Model
protected $table_name
protected bool $table_use_group_id from  Model
protected $table_auto_properties
protected string $table_primary_key from  Model
protected array $table_primary_compound_key from  Model
protected $properties
protected array $properties_meta from  Model
protected array $markers from  Model
bool|string $class_name from  Model
string $render_type from  Model
protected int $model_version

Hint your model version, this parameter might affect certain outcomes and behaviours This version string is added for backwards compatibility

 from  Model
protected string $model_default_render_xui

Defines a XUI helper which can be used to display this model in the render() function e.g. use 'thread' to use this xui helper "XELOS\Modules\Forum\UI\Thread" of the models parent module

 from  Model
protected array $render_params

Parameters that will be consigned to the XUI helper

 from  Model
static string $find_by_separators from  Model
bool $loaded from  Model
bool $saved from  Model
protected array $changed from  Model
array $cache_function_result from  Model
static array $_request_cache from  Model

Methods

ModelCollection|Model|Model[]|int
__call(string $method, array $args = array())

No description

from  Model
__clone()

Magic Function Object Cloning Make sure object references are cleaned up as each object requires a clean and separate reference

from  Model
__construct(int|bool $id = false)

No description

from  Model
mixed
__get(mixed $var)

No description

from  Model
__isset($name)

No description

from  Model
Model
__set(mixed $var, mixed $value)

No description

from  Model
string
__toString()

String Representation of this object (calls for render method)

from  Model
mixed
_call_cached_function(string $function, array $args)

Calls the passed function only if it is not cached yet, otherwise the previous cached result will be returned

from  Model
Query
_scopeAll(Query $Query)

Global named scope scopeAll to use on models to return an unscoped unloaded collection

from  ScopesTrait
Query
_scopeDefault(Query $Query)

Load default scopes

from  ScopesTrait
Query
_scopeGroupId(Query $Query)

Applies Group ID Filtering

from  Model
ModelCollection
_scope_by(string $fn, array $parameters)

Called for scopeby Magic Function Creates a new ModelCollection and applies the passed scope

from  ScopesTrait
ModelCollection
_scope_custom(string $scopeName, Query|null $Query = null)

Called for scope_ Magic Function Creates a new ModelCollection and applies the passed custom scope function

from  ScopesTrait
bool
addTodoNotification()

Add Notification for participant if possible

add_formatted_property(string $property, string $format, array $options = array())

Apply lib->format multi_format on passed property. The result will be written to ->[property]_formatted

from  Model
ModelCollection
add_scope_condition(Condition|ConditionGroup|Query|string $new_condition)

Adds a condition to scope the following find functions

from  ScopesTrait
Model[]
all(mixed $params = ['order_by'=>'COL1)

Return all models

from  Model
bool
clearTodoNotification()

Clear any notification related to this participant/event

clear_cached_functions(string|bool $function = false)

Clears the cache for all functions or a specific one

from  Model
clear_properties()

No description

from  Model
int
count_all() $eturns the count of all models, see $this->find('count')

No description

from  Model
int
count_by_TABLE_COL_and_TABLE_COL2(mixed $COL1_VALUE, mixed $COL2_VALUE)

Returns the count of all models with the specific column value

from  Model
count_by_event_id_and_query($event_id, $query = '', $sql_params = array())

No description

count_by_event_id_and_query_and_custom_id($event_id, $query, $custom_ids, $sql_params = array())

No description

count_by_event_id_and_status_and_query($event_id, $status, $query = '')

No description

count_by_event_id_and_status_and_query_and_unknown($event_id, $status, $query, $unknown)

No description

string|void
debug(bool $show_markers = false, int $mode = 0)

No description

from  Model
bool
delete($notify = false)

No description

int
delete_by_TABLE_COL(mixed $COL_VALUE) Delete rows specified by condition and returns the affected rows. NOTE: This does not trigger a delete() function of the model. If required use pluck('delete')

on the desired collection.

from  Model
void
disable_table_group_id()

Disable the use of the group ID in all queries made

from  Model
void
enable_table_group_id()

Enable the use of the group ID in all queries made

from  Model
exchange_placeholders($text)

No description

ModelCollection|Model|int|null
find(string $mode = 'all', Condition|ConditionGroup|Query|string|array $conditions = false, array|null $query_params = null)

Find Function to find models using the passed condition

from  Model
ModelCollection|Model[]
find_all_by_TABLE_COL_and_TABLE_COL2($COL1_VALUE, $COL2_VALUE, $params=['order_by'=>'COL1, 5]] $)

Returns loaded ModelCollection

from  Model
ModelCollection
find_all_by_event_id(int|int[] $event_id, mixed $query_params)

No description

ModelCollection
find_all_by_event_id_and_id(int $event_id, int|int[] $id, mixed $query_params)

No description

find_all_by_event_id_and_query($event_id, $query, $sql_params = array())

No description

find_all_by_event_id_and_query_and_custom_id($event_id, $query = '', $custom_ids, $sql_params = array())

No description

ModelCollection
find_all_by_event_id_and_status(int $event_id, int|int[] $id, mixed $query_params)

No description

find_all_by_event_id_and_status_and_query($event_id, $status, $query = '', $sql_params = array())

No description

ModelCollection
find_all_by_event_id_and_status_and_query_and_unknown($event_id, $status, $query, int $unknown = 0, array $sql_params = array())

No description

Model
find_by_TABLE_COL(mixed $COL_VALUE, mixed $params = ['order_by'=>'COL1)

Returns all models with a specific column value. Query params can be e.g. order_by

from  Model
Participant|null
find_by_custom_id(string $custom_id, mixed $query_params)

Find the participant with the given custom_id

bool|Participant
find_by_email_and_event_id(mixed $email, mixed $event_id)

overwritten find by function (joins with system_user table)

Participant|null
find_by_event_id_and_custom_id(int $event_id, string $custom_id, mixed $query_params)

Find the participant with the given custom_id

Participant|null
find_by_event_id_and_email(int $event_id, string $email, mixed $query_params)

No description

Participant|null
find_by_event_id_and_user_id(int $event_id, int $user_id, mixed $query_params)

No description

self
find_by_id(int $participant_id)

No description

bool|Participant
find_by_id_and_event_id(mixed $id, mixed $event_id)

overwritten find by function (joins with system_user table)

Participant|null
find_by_user_id_and_event_id(int $user_id, int $event_id)

overwritten find by function (joins with system_user table)

Query
functionNameToQuery(string $query, array $parameters)

Converts a findby* function name to SQL query.

from  Model
array
getChangedProperties(bool $returnOldValues = false)

Return properties which have been changed after model was initialized/loaded We know these values have been changed locally, but these changes are NOT necessarily reflecting the DB diff

from  Model
ModelCollection
getCollectionByQuery(string $model_name, array|string $dbquery_result, string $population_mode = 'full', string $post_fill_function = 'update')

No description

from  Model
array
getDBSchema(string $field = null)

Get DB Schema if available

from  Model
string[]
getI18nPropertyVariants($propertyName, $localeAsKey = false)

Returns a list of all property name variants for all languages, e.g. "title_i18n" -> "title_i18n, title_DE_DE, title_EN_EN"

from  Model
I18nTokenHelper
getI18nTokenForProperty(string $i18nProperty, int|null $limitString = null)

Gets an I18nToken for a model property (e.g. title_i18n)

from  Model
array
getMailParams(Event $event)

No description

ModelCollection
getModelCollection()

Return a new unscoped model collection for further processing

from  Model
int|null
getPrimaryKeyValue()

Get the primary id (post_id) for this model

from  Model
array
getPropertyMarkers(bool $value_discovery = true)

Return properties and markers

from  Model
Query
getScopeQuery(bool $applyDefaultScopes = true)

Returns the Query object which is being used for building the query The function creates a new Query object if required to enable lazy loading

from  ScopesTrait
array
getTouchedProperties(bool $returnOldValues = false)

Return properties which have been touched/set after model was initialized/loaded We know these values have been set, but they might not have changed

from  Model
string
get_created_at_formatted()

Return a Formatted DateTime

from  Model
get_custom_id()

No description

array
get_db_properties()

Returns all properties which are available as DB field (= can be used as find_by() properties) with its currently known raw value Please note that smartTimeFields (updated_at, created_at) are not converted to mysql-date format

from  Model
get_displayname($first_name_last_name = true)

No description

get_displayname_without_email()

No description

Event|null
get_event()

No description

bool|mixed
get_i18n_property(string $property, string $force_language = false)

Return the property translated property value if available

from  Model
string|null
get_model_name()

Returns the SQL table of this model (if available)

from  Model
string|bool
get_model_table_name(string $table_name = null)

Returns the SQL table of this model (if available)

from  Model
array
get_properties(bool $value_discovery = true)

Returns the complete properties array

from  Model
array
get_properties_meta(?string $field = null)

No description

from  Model
mixed
get_property(string|null $property_id, bool $get_raw_value = false)

No description

from  Model
static mixed|null
get_request_cache(string $key)

Return Cache Entry if it exists

from  Model
string|null
get_table_name()

Returns the table name of this model.

from  Model
string|null
get_table_primary_key()

No description

from  Model
string
get_updated_at_formatted()

Return a Formatted DateTime

from  Model
User|null
get_user()

No description

bool
hasChangedProperties()

No description

from  Model
bool
hasExistingDatabaseRecord()

Does this model represent an existing database record? (can be updated)

from  Model
bool
hasTouchedProperties()

Returns true if at least one property is marked as changed

from  Model
init(bool $auto_load = true)

Initializes the model

from  Model
load()

No description

from  Model
bool
load_from_db(string $table_name = null, array $key_fields = [])

No description

from  Model
ModelCollection|Model[]
populate_model_by_query(string $model_name, array|string $dbquery_result, string $population_mode = 'full', string $post_fill_function = 'update') deprecated

No description

from  Model
void
registerDefaultScope($scopeName)

Registers the passed scope as default scope A default scope is present when the model is being loaded and can be removed using the unscope() function if required The passed scope must be defined in a scope[SCOPE_NAME] function e.g. scopeGroupId

from  ScopesTrait
reload_schema()

Reloads the schema of the model

from  Model
bool
remove_from_db(string $table_name, array $key_fields = null)

No description

from  Model
string|null
render()

Generic Renderer

from  Model
replace_with_value($match)

No description

void
resetScopeQuery()

Reset Scope to null

from  ScopesTrait
int|bool
save()

No description

int|bool
save_to_db(string $table_name, array $params = array())

No description

from  Model
bool|array
schema_values(mixed $field_name)

Provides a list of all values allowed for enumerations.

from  Model
ModelCollection
scope(string $scopeName, Query|null $scopeQuery = null)

No description

from  ScopesTrait
ModelCollection
scopeAll()

No description

from  ScopesTrait
Model[]
scope_by_TABLE_COL_and_TABLE_COL2(mixed $COL1_VALUE, mixed $COL2_VALUE)

Returns unloaded ModelCollection

from  Model
ModelCollection
scope_by_id(int|array $id)

No description

from  ScopesTrait
void
self() $this find_by_id($id)

No description

from  Model
void
sendMessage(Event $event, string $subject, string $body, array $participantStatus, bool $sendICal, array $attachment)

Sends a message to all participants in the given statuses.

send_confirmation($type = 'default')

No description

mixed
send_invite()

sends invitation for event to invitee.

void
setModelCollectionReference(ModelCollection $modelCollectionReference)

No description

from  ScopesTrait
bool
set_new_status(int $status, bool $notify = true, string $notify_type = 'default')

Sets status of participant and send notification if status has changed

void
set_properties_from_array(array $input, array|bool $filter = false)

No description

from  Model
set_property(string|array $property_id, mixed $property_value = false, bool $no_change = false)

Set a Property. If $property_id is an array and $property_value is false, set_property is called for each element in the array with the array key and value as params.

from  Model
set_render_params(mixed $params = array())

Sets parameter that will be passed to the XUI helpers

from  Model
static 
set_request_cache(string $key, mixed $value)

Set Request Cache Entry

from  Model
void
sortMoveTo(int $id, int $sortTo, array|null $conditions = [])

Sort this element to a specific position

from  SortTrait
sort_down(int $steps = 1, $params = array())

Decrease Sort Priority (Increases SORT value)

from  SortTrait
sort_up(int $steps = 1, $params = array())

Increase Sort Priority (Decreases SORT value)

from  SortTrait
bool|int
start_workflow(int $status, int $workflow_id)

No description

stop_temporary_group_id_overwrite()

Stops the temporary overwrite of the table_group_id

from  Model
void
temporarily_disable_table_group_id()

Temporarily disable the use of the group ID in all queries made

from  Model
string
to_json()

Returns the model as JSON array

from  Model
string
to_string()

Returns the model as STRING

from  Model
string
to_xml(array|bool $property_filter = false, bool|DOMDocument $doc = false, DOMElement $parent_element = null)

Returns an XML of all model properties

from  Model
void
touchProperty($propertyName)

No description

from  Model
ModelCollection
unscope(string $scopeName = null, Query|null $scopeQuery = null)

Returns an unscoped Collection

from  ScopesTrait
int
update_sort(mixed $id = false, string $direction = 'up', int $steps = 1, array $params = array())

Update the sort property for a given table (Move a record up/down)

from  SortTrait
string|true
validate(array $fieldErrors)

No description

from  Model

Details

in Model at line 1117
ModelCollection|Model|Model[]|int __call(string $method, array $args = array())

No description

Parameters

string $method method-name
array $args params

Return Value

ModelCollection|Model|Model[]|int
  • Returns resource (find...) or affected rows (count..|deleted..)

in Model at line 1684
__clone()

Magic Function Object Cloning Make sure object references are cleaned up as each object requires a clean and separate reference

in Model at line 146
__construct(int|bool $id = false)

No description

Parameters

int|bool $id

Primary ID of the model which should be loaded

in Model at line 1093
mixed __get(mixed $var)

No description

Parameters

mixed $var

Return Value

mixed

in Model at line 1743
__isset($name)

No description

Parameters

$name

in Model at line 1105
Model __set(mixed $var, mixed $value)

No description

Parameters

mixed $var
mixed $value

Return Value

Model

in Model at line 1695
string __toString()

String Representation of this object (calls for render method)

Return Value

string

in Model at line 1155
mixed _call_cached_function(string $function, array $args)

Calls the passed function only if it is not cached yet, otherwise the previous cached result will be returned

Parameters

string $function method-name
array $args params

Return Value

mixed

in ScopesTrait at line 100
Query _scopeAll(Query $Query)

Global named scope scopeAll to use on models to return an unscoped unloaded collection

Parameters

Query $Query Query

Return Value

Query

in ScopesTrait at line 111
Query _scopeDefault(Query $Query)

Load default scopes

Parameters

Query $Query

Return Value

Query

in Model at line 1631
protected Query _scopeGroupId(Query $Query)

Applies Group ID Filtering

Parameters

Query $Query

Return Value

Query

in ScopesTrait at line 143
protected ModelCollection _scope_by(string $fn, array $parameters)

Called for scopeby Magic Function Creates a new ModelCollection and applies the passed scope

Parameters

string $fn
array $parameters

Return Value

ModelCollection

in ScopesTrait at line 159
protected ModelCollection _scope_custom(string $scopeName, Query|null $Query = null)

Called for scope_ Magic Function Creates a new ModelCollection and applies the passed custom scope function

Parameters

string $scopeName

Name of the custom scope - e.g. Active - calls _scopeActive() on the model
Query|null $Query

Return Value

ModelCollection

at line 547
bool addTodoNotification()

Add Notification for participant if possible

Return Value

bool success

in Model at line 954
add_formatted_property(string $property, string $format, array $options = array())

Apply lib->format multi_format on passed property. The result will be written to ->[property]_formatted

Parameters

string $property

Property of models to format
string $format

Format Type (e.g. money, date, ...)
array $options

Additional format options

in ScopesTrait at line 34
ModelCollection add_scope_condition(Condition|ConditionGroup|Query|string $new_condition)

Adds a condition to scope the following find functions

Parameters

Condition|ConditionGroup|Query|string $new_condition

Return Value

ModelCollection

in Model at line 40
Model[] all(mixed $params = ['order_by'=>'COL1)

Return all models

Parameters

mixed $params

Return Value

Model[]

at line 577
bool clearTodoNotification()

Clear any notification related to this participant/event

Return Value

bool

in Model at line 1174
clear_cached_functions(string|bool $function = false)

Clears the cache for all functions or a specific one

Parameters

string|bool $function

in Model at line 616
clear_properties()

No description

in Model at line 40
int count_all() $eturns the count of all models, see $this->find('count')

No description

Parameters

) $eturns the count of all models
see $this->find('count'

Return Value

int

in Model at line 40
int count_by_TABLE_COL_and_TABLE_COL2(mixed $COL1_VALUE, mixed $COL2_VALUE)

Returns the count of all models with the specific column value

Parameters

mixed $COL1_VALUE
mixed $COL2_VALUE

Return Value

int

at line 136
count_by_event_id_and_query($event_id, $query = '', $sql_params = array())

No description

Parameters

$event_id
$query
$sql_params

at line 144
count_by_event_id_and_query_and_custom_id($event_id, $query, $custom_ids, $sql_params = array())

No description

Parameters

$event_id
$query
$custom_ids
$sql_params

at line 132
count_by_event_id_and_status_and_query($event_id, $status, $query = '')

No description

Parameters

$event_id
$status
$query

at line 140
count_by_event_id_and_status_and_query_and_unknown($event_id, $status, $query, $unknown)

No description

Parameters

$event_id
$status
$query
$unknown

in Model at line 939
string|void debug(bool $show_markers = false, int $mode = 0)

No description

Parameters

bool $show_markers

show markers as well?
int $mode

(0 - print, 1 - return, 2 and 3 - Special PopUps)

Return Value

string|void

at line 110
bool delete($notify = false)

No description

Parameters

$notify

Return Value

bool

was delete successful?

in Model at line 40
int delete_by_TABLE_COL(mixed $COL_VALUE) Delete rows specified by condition and returns the affected rows. NOTE: This does not trigger a delete() function of the model. If required use pluck('delete')

on the desired collection.

Parameters

mixed $COL_VALUE) Delete rows specified by condition and returns the affected rows. NOTE: This does not trigger a delete() function of the model. If required use pluck('delete'

Return Value

int

in Model at line 1642
void disable_table_group_id()

Disable the use of the group ID in all queries made

Return Value

void

in Model at line 1667
void enable_table_group_id()

Enable the use of the group ID in all queries made

Return Value

void

at line 680
exchange_placeholders($text)

No description

Parameters

$text

in Model at line 1218
ModelCollection|Model|int|null find(string $mode = 'all', Condition|ConditionGroup|Query|string|array $conditions = false, array|null $query_params = null)

Find Function to find models using the passed condition

Parameters

string $mode

Find mode (all/first/count)
Condition|ConditionGroup|Query|string|array $conditions

Conditions passed as field query string (e.g. 'id=1 and name="TEST"') or as legacy array: First Element contains query, 2..n contain Parameters
array|null $query_params

Further query parameters (e.g. limit, order_by, request_cache)

Return Value

ModelCollection|Model|int|null

depending from $mode: ALL: ModelCollection; FIRST: Model | boolean false on fail COUNT: int

in Model at line 40
ModelCollection|Model[] find_all_by_TABLE_COL_and_TABLE_COL2($COL1_VALUE, $COL2_VALUE, $params=['order_by'=>'COL1, 5]] $)

Returns loaded ModelCollection

Parameters

$COL1_VALUE
$COL2_VALUE
$params=['order_by'=>'COL1
5]] $

Return Value

ModelCollection|Model[]

at line 30
ModelCollection find_all_by_event_id(int|int[] $event_id, mixed $query_params)

No description

Parameters

int|int[] $event_id
mixed $query_params

Return Value

ModelCollection

at line 30
ModelCollection find_all_by_event_id_and_id(int $event_id, int|int[] $id, mixed $query_params)

No description

Parameters

int $event_id
int|int[] $id
mixed $query_params

Return Value

ModelCollection

at line 118
find_all_by_event_id_and_query($event_id, $query, $sql_params = array())

No description

Parameters

$event_id
$query
$sql_params

at line 126
find_all_by_event_id_and_query_and_custom_id($event_id, $query = '', $custom_ids, $sql_params = array())

No description

Parameters

$event_id
$query
$custom_ids
$sql_params

at line 30
ModelCollection find_all_by_event_id_and_status(int $event_id, int|int[] $id, mixed $query_params)

No description

Parameters

int $event_id
int|int[] $id
mixed $query_params

Return Value

ModelCollection

at line 122
find_all_by_event_id_and_status_and_query($event_id, $status, $query = '', $sql_params = array())

No description

Parameters

$event_id
$status
$query
$sql_params

at line 160
ModelCollection find_all_by_event_id_and_status_and_query_and_unknown($event_id, $status, $query, int $unknown = 0, array $sql_params = array())

No description

Parameters

$event_id
$status
$query
int $unknown
array $sql_params

Return Value

ModelCollection

in Model at line 40
Model find_by_TABLE_COL(mixed $COL_VALUE, mixed $params = ['order_by'=>'COL1)

Returns all models with a specific column value. Query params can be e.g. order_by

Parameters

mixed $COL_VALUE
mixed $params

Return Value

Model

at line 30
Participant|null find_by_custom_id(string $custom_id, mixed $query_params)

Find the participant with the given custom_id

Parameters

string $custom_id
mixed $query_params

Return Value

Participant|null

at line 280
bool|Participant find_by_email_and_event_id(mixed $email, mixed $event_id)

overwritten find by function (joins with system_user table)

Parameters

mixed $email
mixed $event_id

Return Value

bool|Participant

at line 30
Participant|null find_by_event_id_and_custom_id(int $event_id, string $custom_id, mixed $query_params)

Find the participant with the given custom_id

Parameters

int $event_id
string $custom_id
mixed $query_params

Return Value

Participant|null

at line 30
Participant|null find_by_event_id_and_email(int $event_id, string $email, mixed $query_params)

No description

Parameters

int $event_id
string $email
mixed $query_params

Return Value

Participant|null

at line 30
Participant|null find_by_event_id_and_user_id(int $event_id, int $user_id, mixed $query_params)

No description

Parameters

int $event_id
int $user_id
mixed $query_params

Return Value

Participant|null

at line 30
self find_by_id(int $participant_id)

No description

Parameters

int $participant_id

Return Value

self

at line 230
bool|Participant find_by_id_and_event_id(mixed $id, mixed $event_id)

overwritten find by function (joins with system_user table)

Parameters

mixed $id
mixed $event_id

Return Value

bool|Participant

at line 256
Participant|null find_by_user_id_and_event_id(int $user_id, int $event_id)

internal  param mixed $id
 

overwritten find by function (joins with system_user table)

Parameters

int $user_id
int $event_id

Return Value

Participant|null

in Model at line 1402
protected Query functionNameToQuery(string $query, array $parameters)

Converts a findby* function name to SQL query.

Parameters

string $query
array $parameters

Return Value

Query

Returns a Query Object with the relevant WHERE Scopes

in Model at line 1857
array getChangedProperties(bool $returnOldValues = false)

Return properties which have been changed after model was initialized/loaded We know these values have been changed locally, but these changes are NOT necessarily reflecting the DB diff

Parameters

bool $returnOldValues

Return values before change or current value after change?

Return Value

array ['property_key'=>'property_value']

in Model at line 970
ModelCollection getCollectionByQuery(string $model_name, array|string $dbquery_result, string $population_mode = 'full', string $post_fill_function = 'update')

No description

Parameters

string $model_name

Model Name, eg.g. category
array|string $dbquery_result

dbquery Result with one record per model OR SQL query
string $population_mode

Population Mode (full or id) - If set to full all object data will be used to fill the objects, if set to id each model will be initialized with the corresponding record id as parameter
string $post_fill_function

Post-Fill Function is triggered on the each model after an object has been filled with data

Return Value

ModelCollection

Always returns a model collection

in Model at line 191
array getDBSchema(string $field = null)

Get DB Schema if available

Parameters

string $field

Return Value

array

in Model at line 1806
string[] getI18nPropertyVariants($propertyName, $localeAsKey = false)

Returns a list of all property name variants for all languages, e.g. "title_i18n" -> "title_i18n, title_DE_DE, title_EN_EN"

Parameters

$propertyName
$localeAsKey

Return Value

string[]

in Model at line 1914
I18nTokenHelper getI18nTokenForProperty(string $i18nProperty, int|null $limitString = null)

Gets an I18nToken for a model property (e.g. title_i18n)

Parameters

string $i18nProperty

The property name (e.g. title_i18n)
int|null $limitString

The translated string will be only $limitString amount of characters long (Adds '...' at the end of the string)

Return Value

I18nTokenHelper

at line 824
array getMailParams(Event $event)

No description

Parameters

Event $event

Return Value

array

in Model at line 1189
ModelCollection getModelCollection()

Return a new unscoped model collection for further processing

Return Value

ModelCollection

in Model at line 334
int|null getPrimaryKeyValue()

Get the primary id (post_id) for this model

Return Value

int|null

in Model at line 492
array getPropertyMarkers(bool $value_discovery = true)

Return properties and markers

Parameters

bool $value_discovery

Return Value

array

in ScopesTrait at line 217
Query getScopeQuery(bool $applyDefaultScopes = true)

Returns the Query object which is being used for building the query The function creates a new Query object if required to enable lazy loading

Parameters

bool $applyDefaultScopes

Return Value

Query

in Model at line 1827
array getTouchedProperties(bool $returnOldValues = false)

Return properties which have been touched/set after model was initialized/loaded We know these values have been set, but they might not have changed

Parameters

bool $returnOldValues

Return values before change or current value after change?

Return Value

array ['property_key'=>'property_value']

in Model at line 1611
string get_created_at_formatted()

Return a Formatted DateTime

Return Value

string

at line 86
get_custom_id()

No description

in Model at line 520
array get_db_properties()

Returns all properties which are available as DB field (= can be used as find_by() properties) with its currently known raw value Please note that smartTimeFields (updated_at, created_at) are not converted to mysql-date format

Return Value

array ['id'=>'1','example_prop'=>'example_val','created_at'=>'']

at line 66
get_displayname($first_name_last_name = true)

No description

Parameters

$first_name_last_name

at line 78
get_displayname_without_email()

No description

at line 48
Event|null get_event()

No description

Return Value

Event|null

in Model at line 1784
bool|mixed get_i18n_property(string $property, string $force_language = false)

Return the property translated property value if available

Parameters

string $property

e.g. title_i18n
string $force_language

FALSE will use current user language, otherwise the passed LOCALE will be used

Return Value

bool|mixed

in Model at line 351
string|null get_model_name()

Returns the SQL table of this model (if available)

Return Value

string|null

Full qualified table name e.g. xmi_crm01_contact

in Model at line 312
string|bool get_model_table_name(string $table_name = null)

Returns the SQL table of this model (if available)

Parameters

string $table_name

Simple table without instance or system prefix

Return Value

string|bool

Full qualified table name e.g. xmi_crm01_contact

in Model at line 474
array get_properties(bool $value_discovery = true)

Returns the complete properties array

Parameters

bool $value_discovery

Retrieve all values by get_property access method

Return Value

array

in Model at line 508
array get_properties_meta(?string $field = null)

No description

Parameters

?string $field

if given returns the meta for that field

Return Value

array

in Model at line 434
mixed get_property(string|null $property_id, bool $get_raw_value = false)

No description

Parameters

string|null $property_id

Marker ID
bool $get_raw_value

deactivate Marker-Function gets triggered

Return Value

mixed

Marker Content

in Model at line 1772
static mixed|null get_request_cache(string $key)

Return Cache Entry if it exists

Parameters

string $key

Cache Key

Return Value

mixed|null

in Model at line 303
string|null get_table_name()

Returns the table name of this model.

Return Value

string|null

in Model at line 325
string|null get_table_primary_key()

No description

Return Value

string|null

Primary Key Field in DB

in Model at line 1620
string get_updated_at_formatted()

Return a Formatted DateTime

Return Value

string

at line 59
User|null get_user()

No description

Return Value

User|null

in Model at line 1868
bool hasChangedProperties()

No description

Return Value

bool

in Model at line 807
bool hasExistingDatabaseRecord()

Does this model represent an existing database record? (can be updated)

Return Value

bool

in Model at line 1835
bool hasTouchedProperties()

Returns true if at least one property is marked as changed

Return Value

bool

in Model at line 210
init(bool $auto_load = true)

Initializes the model

Parameters

bool $auto_load

If set to false the init will NOT TRIGGER load in case of a set primary key property

in Model at line 390
load()

No description

in Model at line 837
protected bool load_from_db(string $table_name = null, array $key_fields = [])

No description

Parameters

string $table_name

Table Name
array $key_fields

Key fields which should be used as WHERE condition

Return Value

bool

in Model at line 1062
ModelCollection|Model[] populate_model_by_query(string $model_name, array|string $dbquery_result, string $population_mode = 'full', string $post_fill_function = 'update') deprecated

deprecated Please use getCollectionByQuery() instead

No description

Parameters

string $model_name

Model Name, eg.g. category
array|string $dbquery_result

dbquery Result with one record per model OR SQL query
string $population_mode

Population Mode (full or id) - If set to full all object data will be used to fill the objects, if set to id each model will be initialized with the corresponding record id as parameter
string $post_fill_function

Post-Fill Function is triggered on the each model after an object has been filled with data

Return Value

ModelCollection|Model[]

empty array if none found and compatibility-mode on (xelos model_version < 1)

in ScopesTrait at line 127
protected void registerDefaultScope($scopeName)

Registers the passed scope as default scope A default scope is present when the model is being loaded and can be removed using the unscope() function if required The passed scope must be defined in a scope[SCOPE_NAME] function e.g. scopeGroupId

Parameters

$scopeName

Return Value

void

in Model at line 161
reload_schema()

Reloads the schema of the model

in Model at line 904
protected bool remove_from_db(string $table_name, array $key_fields = null)

No description

Parameters

string $table_name

Table Name
array $key_fields

Key fields which should be used as WHERE condition

Return Value

bool

in Model at line 1726
string|null render()

Generic Renderer

Return Value

string|null

at line 685
replace_with_value($match)

No description

Parameters

$match

in ScopesTrait at line 231
void resetScopeQuery()

Reset Scope to null

Return Value

void

at line 97
int|bool save()

No description

Return Value

int|bool

Integer represents ID of saved record, true for successful modifications (update, delete), false otherwise

in Model at line 633
protected int|bool save_to_db(string $table_name, array $params = array())

No description

Parameters

string $table_name

Table Name
array $params

Return Value

int|bool

Integer represents ID of saved record, true for successful modifications (update, delete), false otherwise

Exceptions

DatabaseException

in Model at line 1381
bool|array schema_values(mixed $field_name)

Provides a list of all values allowed for enumerations.

Returns FALSE if the field in question does not exist Returns TRUE for non enum fields Returns an array for enum fields with all available values

Parameters

mixed $field_name

The name of the field to examine

Return Value

bool|array

in ScopesTrait at line 81
ModelCollection scope(string $scopeName, Query|null $scopeQuery = null)

No description

Parameters

string $scopeName
Query|null $scopeQuery

Return Value

ModelCollection

in ScopesTrait at line 16
ModelCollection scopeAll()

No description

Return Value

ModelCollection

in Model at line 40
Model[] scope_by_TABLE_COL_and_TABLE_COL2(mixed $COL1_VALUE, mixed $COL2_VALUE)

Returns unloaded ModelCollection

Parameters

mixed $COL1_VALUE
mixed $COL2_VALUE

Return Value

Model[]

in ScopesTrait at line 16
ModelCollection scope_by_id(int|array $id)

No description

Parameters

int|array $id

Return Value

ModelCollection

in Model at line 40
void self() $this find_by_id($id)

No description

Parameters

) $this find_by_id($id

Return Value

void

at line 416
void sendMessage(Event $event, string $subject, string $body, array $participantStatus, bool $sendICal, array $attachment)

Sends a message to all participants in the given statuses.

Parameters

Event $event

The Event where the message is sent from.
string $subject

The message subject
string $body

The message body
array $participantStatus

The statuses of the participants
bool $sendICal

Should an iCal object be send with the message?
array $attachment

Hold the path to the attachment, processed by System API Mail: [['filename' => 'File'], ['folder' => 'Folder where is file is stored']]

Return Value

void

at line 595
send_confirmation($type = 'default')

No description

Parameters

$type

at line 330
mixed send_invite()

sends invitation for event to invitee.

uses system_api_mail to handle response.

Return Value

mixed

$success (true on success || string with error message)

in ScopesTrait at line 88
void setModelCollectionReference(ModelCollection $modelCollectionReference)

No description

Parameters

ModelCollection $modelCollectionReference

Return Value

void

at line 481
bool set_new_status(int $status, bool $notify = true, string $notify_type = 'default')

Sets status of participant and send notification if status has changed

Parameters

int $status
bool $notify
  • Notify organizer and participant? (Only if status has changed!)
string $notify_type

Return Value

bool

in Model at line 599
void set_properties_from_array(array $input, array|bool $filter = false)

No description

Parameters

array $input

Assoc array with field_id=>value
array|bool $filter

Filter array with 1-dim field_id's, only these keys from input will be set

Return Value

void

in Model at line 540
set_property(string|array $property_id, mixed $property_value = false, bool $no_change = false)

Set a Property. If $property_id is an array and $property_value is false, set_property is called for each element in the array with the array key and value as params.

Parameters

string|array $property_id

Marker ID (Can also be an Array)
mixed $property_value Value
bool $no_change

Value

return static

in Model at line 1716
set_render_params(mixed $params = array())

Sets parameter that will be passed to the XUI helpers

Parameters

mixed $params

in Model at line 1756
static set_request_cache(string $key, mixed $value)

Set Request Cache Entry

Parameters

string $key
mixed $value

in SortTrait at line 116
void sortMoveTo(int $id, int $sortTo, array|null $conditions = [])

Sort this element to a specific position

Parameters

int $id

The record ID you intend to move, use 0 if your model has not been saved yet and you intend to save it to the given sort
int $sortTo

Move element to this new position, should be > 0
array|null $conditions

Add conditions

Return Value

void

in SortTrait at line 28
sort_down(int $steps = 1, $params = array())

Decrease Sort Priority (Increases SORT value)

Parameters

int $steps
$params

in SortTrait at line 17
sort_up(int $steps = 1, $params = array())

Increase Sort Priority (Decreases SORT value)

Parameters

int $steps
$params

at line 781
bool|int start_workflow(int $status, int $workflow_id)

No description

Parameters

int $status
int $workflow_id

Return Value

bool|int

Exceptions

ModuleException

in Model at line 1675
stop_temporary_group_id_overwrite()

Stops the temporary overwrite of the table_group_id

in Model at line 1657
void temporarily_disable_table_group_id()

Temporarily disable the use of the group ID in all queries made

Return Value

void

in Model at line 1583
string to_json()

Returns the model as JSON array

Return Value

string

Returns model string

in Model at line 1594
string to_string()

Returns the model as STRING

Return Value

string

Returns model as string

in Model at line 1536
string to_xml(array|bool $property_filter = false, bool|DOMDocument $doc = false, DOMElement $parent_element = null)

Returns an XML of all model properties

Parameters

array|bool $property_filter

if given, only the properties in this array are added
bool|DOMDocument $doc

used from model_collection to add this model to an existing structure
DOMElement $parent_element

to add this model as Child, necessary if doc is given

Return Value

string

Returns formatted XML string

in Model at line 1843
void touchProperty($propertyName)

No description

Parameters

$propertyName

Return Value

void

in ScopesTrait at line 56
ModelCollection unscope(string $scopeName = null, Query|null $scopeQuery = null)

Returns an unscoped Collection

Parameters

string $scopeName
Query|null $scopeQuery

Provide a specific Query Object you want to unscope

Return Value

ModelCollection

in SortTrait at line 43
protected int update_sort(mixed $id = false, string $direction = 'up', int $steps = 1, array $params = array())

Update the sort property for a given table (Move a record up/down)

Parameters

mixed $id

(The record ID you intend to move )
string $direction

(The direction you want the record to move)
int $steps

(The amount of steps you want the record to move)
array $params

key 'filter' optional conditions passed as a key-value array. Key 'order_by' additional ORDER string append to ORDER BY sort

Return Value

int

new Sort Value

in Model at line 1081
string|true validate(array $fieldErrors)

No description

Parameters

array $fieldErrors

Field Errors can be returned via reference as array(array('field'=>$field, 'err_msg'=>$error)) or array($field => $error)

Return Value

string|true

TRUE if everything is correct, String for Error-Message