Skip to content
This repository has been archived by the owner on May 2, 2021. It is now read-only.

Latest commit

 

History

History
executable file
·
2846 lines (1206 loc) · 41.6 KB

UserGroups.md

File metadata and controls

executable file
·
2846 lines (1206 loc) · 41.6 KB

components\account\models\UserGroups

API index

Class index

Properties

Methods

Inheritance index

Properties

Methods

Properties

Property $generatedLabels

In class: components\account\models\UserGroups

protected mixed $generatedLabels = array()

Property $labels

In class: components\account\models\UserGroups

protected mixed $labels = array()

Property $relation_preferences

In class: components\account\models\UserGroups

protected mixed $relation_preferences = array()

Property $relations

In class: components\account\models\UserGroups

protected mixed $relations = array('AccountsToUserGroups' => array('id' => 'AccountsToUserGroups.user_group_id'), 'Accounts' => array('id' => 'AccountsToUserGroups.user_group_id'))
  • Visibility: protected
  • This property is static.

Property $relations_by_column

In class: components\account\models\UserGroups

protected mixed $relations_by_column

Property $table_name

In class: components\account\models\UserGroups

protected mixed $table_name = 'account_user_groups'
  • Visibility: protected
  • This property is static.

Property $validate

In class: components\account\models\UserGroups

protected mixed $validate = array('id' => array('required', 'number' => 'int', 'gt' => 0))
  • Visibility: protected
  • This property is static.

Methods

Method clear_table_data_cache

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::clear_table_data_cache()

Method get_related_model

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::get_related_model($name)

Arguments

  • $name mixed

Method model_data

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::model_data($get)

Arguments

  • $get mixed

Method table_data

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::table_data($get, $set)

Arguments

  • $get mixed
  • $set mixed

Method validate_data

In class: components\account\models\UserGroups

mixed components\account\models\UserGroups::validate_data($data)
  • Visibility: public
  • This method is static.

Arguments

  • $data mixed

Method validated_create

In class: components\account\models\UserGroups

mixed components\account\models\UserGroups::validated_create($data)
  • Visibility: public
  • This method is static.

Arguments

  • $data mixed

Method create_table_data

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::create_table_data()

Method __clone

In class: components\account\models\UserGroups

mixed dependencies\Data::__clone()

Method __construct

In class: components\account\models\UserGroups

mixed dependencies\Data::__construct($data, $context, $key)

Arguments

  • $data mixed
  • $context mixed
  • $key mixed

Method __destruct

In class: components\account\models\UserGroups

mixed dependencies\Data::__destruct()

Method __get

In class: components\account\models\UserGroups

mixed dependencies\Data::__get($key)

Arguments

  • $key mixed

Method __set

In class: components\account\models\UserGroups

mixed dependencies\Data::__set($key, $val)

Arguments

  • $key mixed
  • $val mixed

Method __toString

In class: components\account\models\UserGroups

mixed dependencies\Data::__toString()

Method __unset

In class: components\account\models\UserGroups

mixed dependencies\Data::__unset($key)

Arguments

  • $key mixed

Method _attempt_unserialize

In class: components\account\models\UserGroups

mixed dependencies\Data::_attempt_unserialize()

Method _clear_context

In class: components\account\models\UserGroups

mixed dependencies\Data::_clear_context()

Method _set_context

In class: components\account\models\UserGroups

mixed dependencies\Data::_set_context($context, $key)

Arguments

  • $context mixed
  • $key mixed

Method _success

In class: components\account\models\UserGroups

mixed dependencies\Successable::_success()

Method add_rules

In class: components\account\models\UserGroups

mixed dependencies\Data::add_rules()

Method ai

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::ai($get_key)

Arguments

  • $get_key mixed

Method all

In class: components\account\models\UserGroups

mixed dependencies\Data::all($callback)

Arguments

  • $callback mixed

Method and_is

In class: components\account\models\UserGroups

mixed dependencies\Successable::and_is($check, $callback)

Arguments

  • $check mixed
  • $callback mixed

Method and_not

In class: components\account\models\UserGroups

mixed dependencies\Successable::and_not($check)

Arguments

  • $check mixed

Method any

In class: components\account\models\UserGroups

mixed dependencies\Data::any($callback)

Arguments

  • $callback mixed

Method as_array

In class: components\account\models\UserGroups

mixed dependencies\Data::as_array($serialized, $unset_as_null)

Arguments

  • $serialized mixed
  • $unset_as_null mixed

Method as_form

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::as_form($id)

Create an HTML form for updating this model.

as_form(&$id[, $action][, $columns])

Arguments

  • $id mixed

Method as_json

In class: components\account\models\UserGroups

mixed dependencies\Data::as_json($flags, $options)

Arguments

  • $flags mixed
  • $options mixed

Method as_list

In class: components\account\models\UserGroups

mixed dependencies\Data::as_list()

Method as_options

In class: components\account\models\UserGroups

mixed dependencies\Data::as_options()

Method as_rlist

In class: components\account\models\UserGroups

mixed dependencies\Data::as_rlist()

Method as_table

In class: components\account\models\UserGroups

mixed dependencies\Data::as_table()

Method back

In class: components\account\models\UserGroups

mixed dependencies\Data::back()

Method become

In class: components\account\models\UserGroups

mixed dependencies\Data::become(\dependencies\Data $data)

Arguments

Method check

In class: components\account\models\UserGroups

mixed dependencies\Data::check($node_name)

Arguments

  • $node_name mixed

Method clear

In class: components\account\models\UserGroups

mixed dependencies\Data::clear()

Method component

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::component()

Method convert

In class: components\account\models\UserGroups

mixed dependencies\Data::convert()

Method copy

In class: components\account\models\UserGroups

mixed dependencies\Data::copy()

Method copyto

In class: components\account\models\UserGroups

mixed dependencies\Data::copyto($to)

Arguments

  • $to mixed

Method delete

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::delete()

Method dump

In class: components\account\models\UserGroups

mixed dependencies\Data::dump($format, $l)

Arguments

  • $format mixed
  • $l mixed

Method each

In class: components\account\models\UserGroups

mixed dependencies\Data::each($callback)

Arguments

  • $callback mixed

Method enforce_rules

In class: components\account\models\UserGroups

mixed dependencies\Data::enforce_rules($recursive)

Arguments

  • $recursive mixed

Method eq

In class: components\account\models\UserGroups

mixed dependencies\Data::eq($value, $callback)

Arguments

  • $value mixed
  • $callback mixed

Method extract

In class: components\account\models\UserGroups

mixed dependencies\Data::extract($id)

Arguments

  • $id mixed

Method failure

In class: components\account\models\UserGroups

mixed dependencies\Successable::failure($callback)

Arguments

  • $callback mixed

Method filter

In class: components\account\models\UserGroups

mixed dependencies\Data::filter($callback)

Arguments

  • $callback mixed

Method format

In class: components\account\models\UserGroups

mixed dependencies\Data::format($format)

Arguments

  • $format mixed

Method generation

In class: components\account\models\UserGroups

mixed dependencies\Data::generation()

Method get

In class: components\account\models\UserGroups

mixed dependencies\Data::get($as)

Arguments

  • $as mixed

Method getIterator

In class: components\account\models\UserGroups

mixed dependencies\Data::getIterator()

Method get_users

In class: components\account\models\UserGroups

mixed components\account\models\UserGroups::get_users()
  • Visibility: public

Method gt

In class: components\account\models\UserGroups

mixed dependencies\Data::gt($value, $callback)

Arguments

  • $value mixed
  • $callback mixed

Method having

In class: components\account\models\UserGroups

mixed dependencies\Data::having()

Method hdelete

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::hdelete()

Method hsave

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::hsave($parent_pks, $index)

Arguments

  • $parent_pks mixed
  • $index mixed

Method html_escape

In class: components\account\models\UserGroups

mixed dependencies\Data::html_escape($flags)

Arguments

  • $flags mixed

Method idx

In class: components\account\models\UserGroups

mixed dependencies\Data::idx($key)

Arguments

  • $key mixed

Method is

In class: components\account\models\UserGroups

mixed dependencies\Successable::is($check, $callback)

Arguments

  • $check mixed
  • $callback mixed

Method is_childnode

In class: components\account\models\UserGroups

mixed dependencies\Data::is_childnode()

Method is_empty

In class: components\account\models\UserGroups

mixed dependencies\Data::is_empty()

Method is_false

In class: components\account\models\UserGroups

mixed dependencies\Data::is_false()

Method is_godnode

In class: components\account\models\UserGroups

mixed dependencies\Data::is_godnode()

Method is_leafnode

In class: components\account\models\UserGroups

mixed dependencies\Data::is_leafnode()

Method is_numeric

In class: components\account\models\UserGroups

mixed dependencies\Data::is_numeric()

Method is_parent

In class: components\account\models\UserGroups

mixed dependencies\Data::is_parent()

Method is_set

In class: components\account\models\UserGroups

mixed dependencies\Data::is_set()

Method is_true

In class: components\account\models\UserGroups

mixed dependencies\Data::is_true()

Method join

In class: components\account\models\UserGroups

mixed dependencies\Data::join($separator)

Arguments

  • $separator mixed

Method key

In class: components\account\models\UserGroups

mixed dependencies\Data::key()

Method keyof

In class: components\account\models\UserGroups

mixed dependencies\Data::keyof($node)

Arguments

  • $node mixed

Method keys

In class: components\account\models\UserGroups

mixed dependencies\Data::keys()

Method ksort

In class: components\account\models\UserGroups

\dependencies\Data dependencies\Data::ksort()

Sorts the data object by key.

Return value

dependencies\Data - Returns $this

Method labels

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::labels($originals)

Arguments

  • $originals mixed

Method lowercase

In class: components\account\models\UserGroups

mixed dependencies\Data::lowercase()

Method lt

In class: components\account\models\UserGroups

mixed dependencies\Data::lt($value, $callback)

Arguments

  • $value mixed
  • $callback mixed

Method map

In class: components\account\models\UserGroups

mixed dependencies\Data::map($callback)

Arguments

  • $callback mixed

Method md5

In class: components\account\models\UserGroups

mixed dependencies\Data::md5()

Method merge

In class: components\account\models\UserGroups

mixed dependencies\Data::merge($val, $deep)

Arguments

  • $val mixed
  • $deep mixed

Method model

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::model()

Method moveto

In class: components\account\models\UserGroups

mixed dependencies\Data::moveto($to)

Arguments

  • $to mixed

Method not

In class: components\account\models\UserGroups

mixed dependencies\Successable::not($check, $callback)

Arguments

  • $check mixed
  • $callback mixed

Method offsetExists

In class: components\account\models\UserGroups

mixed dependencies\Data::offsetExists($key)

Arguments

  • $key mixed

Method offsetGet

In class: components\account\models\UserGroups

mixed dependencies\Data::offsetGet($key)

Arguments

  • $key mixed

Method offsetSet

In class: components\account\models\UserGroups

mixed dependencies\Data::offsetSet($key, $val)

Arguments

  • $key mixed
  • $val mixed

Method offsetUnset

In class: components\account\models\UserGroups

mixed dependencies\Data::offsetUnset($key)

Arguments

  • $key mixed

Method otherwise

In class: components\account\models\UserGroups

mixed dependencies\Data::otherwise($default)

Arguments

  • $default mixed

Method parse

In class: components\account\models\UserGroups

mixed dependencies\Data::parse($regex, $flags)

Arguments

  • $regex mixed
  • $flags mixed

Method pks

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::pks($get_keys)

Arguments

  • $get_keys mixed

Method push

In class: components\account\models\UserGroups

mixed dependencies\Data::push()

Method relation_preferences

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::relation_preferences()

Method relations_by_column

In class: components\account\models\UserGroups

array dependencies\BaseModel::relations_by_column(string $column)

Gets the relations grouped by column name, rather than target model name.

Arguments

  • $column string - Gets the result for one specific column. Defaults to returning all columns.

Return value

array - The relations of this model grouped by column name. The format for this is: [column_name] => array( | For every column... (only if $column is not set) [0,1,...,n] => array( | A 0-indexed array of relations. [target] => (string), | The target field of the relation. [model] => (string) | The target model of the relation. ) )

Method render_form

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::render_form($id, $action, array $options)

Arguments

  • $id mixed
  • $action mixed
  • $options array

Method reverse

In class: components\account\models\UserGroups

mixed dependencies\Data::reverse()

Method save

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::save()

Method serialize

In class: components\account\models\UserGroups

mixed dependencies\Data::serialize()

Method serialized

In class: components\account\models\UserGroups

mixed dependencies\Data::serialized()

Method set

In class: components\account\models\UserGroups

mixed dependencies\Data::set()

Method size

In class: components\account\models\UserGroups

mixed dependencies\Data::size()

Method sks

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::sks($get_keys)

Arguments

  • $get_keys mixed

Method slice

In class: components\account\models\UserGroups

mixed dependencies\Data::slice($offset, $length)

Arguments

  • $offset mixed
  • $length mixed

Method split

In class: components\account\models\UserGroups

mixed dependencies\Data::split($s)

Arguments

  • $s mixed

Method success

In class: components\account\models\UserGroups

mixed dependencies\Successable::success($callback)

Arguments

  • $callback mixed

Method table

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::table($model_name)

Arguments

  • $model_name mixed

Method trim

In class: components\account\models\UserGroups

mixed dependencies\Data::trim($charlist)

Arguments

  • $charlist mixed

Method type

In class: components\account\models\UserGroups

mixed dependencies\Data::type()

Method un_set

In class: components\account\models\UserGroups

mixed dependencies\Data::un_set()

Method unserialize

In class: components\account\models\UserGroups

mixed dependencies\Data::unserialize($d)

Arguments

  • $d mixed

Method unserialized

In class: components\account\models\UserGroups

mixed dependencies\Data::unserialized()

Method uppercase

In class: components\account\models\UserGroups

mixed dependencies\Data::uppercase()

Method validate

In class: components\account\models\UserGroups

mixed dependencies\Data::validate($name, array $rules, $translate)

Arguments

  • $name mixed
  • $rules array
  • $translate mixed

Method validate_model

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::validate_model($options)

Validates the whole model, based on static validation rules.

Options: array $rules - Defines extra rules per field name. boolean $force_create - Tries to ignore the PK if it has an auto_increment attribute. Otherwise throws programmer exception. boolean $nullify - When set to true, fields that are valid but empty will be set to NULL (default: false).

Arguments

  • $options mixed

Method validation_errors

In class: components\account\models\UserGroups

mixed dependencies\Data::validation_errors($names)

Arguments

  • $names mixed

Method walk

In class: components\account\models\UserGroups

mixed dependencies\Data::walk($callback)

Arguments

  • $callback mixed

Method without

In class: components\account\models\UserGroups

mixed dependencies\Data::without()

Method refresh_labels

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::refresh_labels()

Method _do_check

In class: components\account\models\UserGroups

mixed dependencies\Successable::_do_check($check)

Arguments

  • $check mixed

Method get_save_data

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::get_save_data($insert, $data)

Arguments

  • $insert mixed
  • $data mixed

Method validate_column

In class: components\account\models\UserGroups

mixed dependencies\BaseModel::validate_column($column_name, $value)

Arguments

  • $column_name mixed
  • $value mixed