Iris CRM documentation
\

\Loader

Подключение файлов

Определение последовательности подключения файлов с учетом наследования конфигураций.

Summary

Methods
Properties
Constants
getLoader()
loadOnce()
getFileName()
getNewFileName()
getChildClassName()
getJSCode()
basePath()
baseUrl()
getOrder()
getOriginalName()
No public properties found
DS
__construct()
$_order
N/A
No private methods found
No private properties found
N/A

Constants

DS

DS

Разделитель каталогов (/)

Properties

$_order

$_order

Порядок наследования, по умолчанию array('', '_industry', '_custom').

Т.е. по умолчанию родительские классы - это классы без постфикса (классы базовой конфигурации). От них наследуются классы отраслевых решений. От классов отраслевых решений наследуется пользовательская настройка (классы с _custom).

Methods

getLoader()

getLoader() : \Loader

Возвращает единственный экземпляр класса с учетом дочерних классов

Returns

\Loader —

Единственный экземпляр

Пример

  $Loader = Loader::getLoader();
  $path = $Loader->basePath();

loadOnce()

loadOnce(string$file, string$path) : string

Подключение PHP файлов в порядке наследования

Если у подключаемого файла есть родители, то они тоже подключаются через include_once.

Parameters

string $file

Название файла относительно $path
string $path

Необязательный параметр. По умолчанию null. Путь, относительно которого следует выполнять поиск. Путь указывается относительно Loader::basePath(). Если null, то используется Loader::basePath().

Returns

string —

Постфикс названия последнего подгруженного файла (он последний в цепочке иерархии).

Пример

Loader::getLoader()->loadOnce('config/common/Lib/document.php');
class ds_Document_Product extends DocumentConfig { ... }

getFileName()

getFileName(string$file, string$path) : string

Возвращает название файла с учетом иерархии

Метод используется главным образом для PHP и XML, а также для JS и других файлов.

Parameters

string $file

Название файла относительно $path. Название следует указывать без постфикса (без _custom).
string $path

Необязательный параметр. По умолчанию null. Путь, относительно которого следует выполнять поиск. Путь указывается относительно Loader::basePath(). Если null, то используется Loader::basePath().

Returns

string —

Название файла (последнего в цепочке иерархии) Если подходящего файла не существует, то будет возвращет $file без изменений.

getNewFileName()

getNewFileName(string$file, string$path) : string

Возвращает название для сохранения файла с учетом иерархии

Метод используется главным образом для XML, а также для PHP, JS и других файлов.

Parameters

string $file

Название файла относительно $path Название следует указывать без постфикса (без _custom).
string $path

Необязательный параметр. По умолчанию null. Путь, относительно которого следует выполнять поиск. Путь указывается относительно Loader::basePath(). Если null, то используется Loader::basePath().

Returns

string —

Название файла (последнего в цепочке иерархии)

getChildClassName()

getChildClassName(string$className) : string

Получение имени дочернего класса в цепочке иерархии

Parameters

string $className

Название родительского класса (без _custom)

Returns

string —

Название дочернего класса (c _custom)

getJSCode()

getJSCode(string$file, string$path, bool$include) : string

Получить Javascript код с учётом иерархии файлов конфигурации

Parameters

string $file

Название файла относительно $path (без _custom)
string $path

Необязательный параметр. По умолчанию null. Путь, относительно которого следует выполнять поиск. Путь указывается относительно Loader::basePath(). Если null, то используется Loader::basePath().
bool $include

Возвращать ссылку на файл вместо его содержимого (ссылка в секции script).

Returns

string —

Javascript код

basePath()

basePath() : string

Получить путь к каталогу с Iris CRM

Returns

string

baseUrl()

baseUrl() : string

Получить web адрес Iris CRM

Returns

string

getOrder()

getOrder() : string[]

Получить массив с порядком наследования

Returns

string[]

getOriginalName()

getOriginalName(string$name) : string

Возвращает оригинальное имя класса или файла (без _custom)

Parameters

string $name

Финальное имя (с _custom)

Returns

string —

Оригинальное имя (без _custom)

__construct()

__construct()

Конструктор

Конструктор для создания экземпляра класса использовать не рекмендуется. Для создания экземпляра класса предусмотрена возможность создания единственного экземпляра через Loader::getLoader(). Конструктор следует использовать только для переопределения порядка наследования. Подробнее - http://iris-crm.ru/recommendations-for-customization