Iris CRM documentation
\

\IrisDomain

Работа с доменами

Домен - это данные особого типа. Альтернативное название - перечисление. Поле аналогично полю-справочнику, но вместо значений GIUD в качестве ключей можно использовать числовые или строковые значения. В отличие от справочников, набор возможных значений в таком поле неизменен и определяется в соответствующем xml файле config/domains.

Summary

Methods
Properties
Constants
__construct()
getDomain()
get()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct(string$code)

Конструктор

Этот конструктор использовать нежелательно, так как в методе getDomain() предусмотрена возможность создания единственного экземпляра класса для каждого домена.

Parameters

string $code

Код домена, совпадает с названием xml-файла в config/domains.

getDomain()

getDomain(string$code) : \IrisDomain

Создает единственный экземпляр для каждого кода домена (по аналогии с шаблоном Singleton).

Parameters

string $code

Код домена, совпадает с названием xml-файла в config/domains.

Returns

\IrisDomain —

Единственнй экземпляр указанного домена

Пример

// Получить экземпляр домена
$Domain = IrisDomain::getDomain('d_graph_type');
// Получить значение (caption) домена по значению поля БД
$caption = $Domain->get(2);

get()

get(string|null$code, string$attribute_key, string$attribute_get) : string|mixed[]

Получить значение(я) домена

Parameters

string|null $code

Необязательный параметр. По умолчанию null. Значение xml-атрибута для поиска значения домена.
string $attribute_key

Необязательный параметр. По умолчанию 'db_value'. Название xml-атрибута, по которому необходимо выполнить поиск значения домена.
string $attribute_get

Необязательный параметр. По умолчанию 'caption'. Название xml-атрибута, в котором содержится искомое значение.

Returns

string|mixed[] —

Если $code !== null, то значение домана. Иначе массив со всеми значениями домена в формате:

array(
    Значение db_value => array(
        'db_value' => Значение db_value,
        'caption' => Значение caption,
        // Значения других атрибутов, если они перечислены в xml.
    ),
    // ...
)