Функции класса ObjectModule
НАЧАЛО >> Сервер приложений ИРБИС 64/128 >> Ядро системы >> ObjectModule >> Функции класса ObjectModule
Список функций модуля
public AppendRight ( mixed $right, mixed $title, ) : n/a
public ConfigureAdminEditor ( mixed $f, mixed $r, mixed $rowner, mixed $objtype, ) : mixed
public ConfigureEditor ( mixed $f, \ObjectData|null $r, \ObjectData $rowner, string $objtype, ) : mixed
public ConfigureRecordEditor ( mixed $f, mixed $r, mixed $rowner, mixed $objtype, ) : n/a
public CreateLink ( $sid1, $sid2, $linktype1, $linktype2 = '', ) : n/a
public CreateNewRecord ( array $fset, mixed $skiprightscheck = false, $rowner=null) : mixed
public Debug ( mixed $msg, ) : n/a
public DebugPrint ( mixed $msg, ) : n/a
public final GetAdminVariableInfo ( mixed $name, ) : array|null
public GetDbName ( ) : mixed
public GetFormattedRecordList ( mixed $dbname, mixed $src, mixed $format, mixed $formatModule, mixed $page = 1, mixed $recsOnPage = 20, mixed $params = null) : string
public GetFormattedRecordListReverse ( mixed $dbname, mixed $src, mixed $format, mixed $formatModule, mixed $page = 1, mixed $recsOnPage = 20, mixed $params = null) : string
public GetIconCls ( ) : string
public GetLinkedSysObject ( $sid, $linktype, ) : n/a
public GetLinkedSysObjectArray ( $sid, $linktype, ) : n/a
public GetModuleAdminPanel ( ) : string
public GetModuleRec ( $readonly=false ) : mixed
public GetModuleSid ( ) : string
public GetModuleTitle ( ) : string
public GetPossibleRightsList ( ) : array
public GetRecBySid ( mixed $sid, ) : \ObjectData|null
public GetRecord ( mixed $sid, ) : \ObjectData|null
public GetRecordDefault113Fields ( ) : array
public GetRecordTitle ( ) : string
public GetRecordIndex ( ObjectData $db, ObjectData $r ) : array
public GetRecords ( mixed $src = '', mixed $posl = '', ) : array
public GetRightName ( mixed $right, ) : mixed
public GetSidDir ( \ObjectData $r, ) : string
public Init ( ) : n/a
public KillLink ( $sid1, $sid2, $linktype1, $linktype2 = '', ) : n/a
public LinkAdd ( ) : n/a
public LinkDrop ( ) : n/a
public OnAfterDelete ( mixed $r, ) : n/a
public OnAfterSave ( mixed $db, mixed $r, ) : n/a
public OnBeforeSave ( mixed $db, mixed $r, ) : array
protected PostInit ( ) : n/a
private PreInit ( ) : n/a
public Reload ( mixed $r, ) : n/a
public ResetGlobalFlag ( ) : n/a
public Save ( mixed $r, ) : boolean
public SetLinks ( $sid, $linktype, $links, ) : n/a
public SetupModule ( mixed $silent = false, mixed $skiprights = false, ) : boolean|string
public ShowAll ( ) : void
public ShowFull ( mixed $sid, ) : void
public __call ( mixed $name, mixed $arguments, ) : mixed
public __construct ( mixed $name = NULL, ) : n/a
public __destruct ( ) : n/a
public hh ( mixed $name, ) : mixed
public AppendRight ( mixed $right, mixed $title, ) : n/a
Описание
Добавить новый тип прав к модулю
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$right
|
mixed
|
Тип права
|
|
|
$title
|
mixed
|
Заголовок права
|
|
Возвращаемое значение
public ConfigureAdminEditor ( mixed $f, mixed $r, mixed $rowner, mixed $objtype, ) : mixed
Описание
Конфигурирует редактор записи модуля для АРМ Администратор
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$f
|
mixed
|
Модуль he2
|
|
|
$r
|
mixed
|
Запись модуля
|
|
|
$rowner
|
mixed
|
Родительская запись модуля
|
|
|
$objtype
|
mixed
|
Тип объекта (в данном случае всегда 'MODULE')
|
|
Возвращаемое значение
public ConfigureEditor ( mixed $f, \ObjectData|null $r, \ObjectData $rowner, string $objtype, ) : mixed
Описание
Конфигурирует редактор для записи. Вы должны переопределить эту функцию для добавления своих полей редактирования управляемой модулем записи. Для получения подробностей см. описание модуля he2
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$f
|
mixed
|
Модуль he2
|
|
|
$r
|
\ObjectData|null
|
Редактируемая запись или NULL если запись новая
|
|
|
$rowner
|
\ObjectData
|
Запись-владелец редактируемой записи (для наследования прав доступа)
|
|
|
$objtype
|
string
|
Тип редактируемой записи (значение поля 920)
|
|
Возвращаемое значение
|
Тип
|
Описание
|
|
mixed
|
Модуль he2
|
public ConfigureRecordEditor ( mixed $f, mixed $r, mixed $rowner, mixed $objtype, ) : n/a
Описание
Конфигурирует редактор управляемой записи
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$f
|
mixed
|
Модуль he2
|
|
|
$r
|
mixed
|
Редактируемая запись
|
|
|
$rowner
|
mixed
|
Родительская запись
|
|
|
$objtype
|
mixed
|
Тип объекта (всегда == $this->_RecordType)
|
|
Возвращаемое значение
public CreateLink ( $sid1, $sid2, $linktype1, $linktype2 = '', ) : n/a
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$sid1
|
n/a
|
|
|
|
$sid2
|
n/a
|
|
|
|
$linktype1
|
n/a
|
|
|
|
$linktype2
|
n/a
|
|
''
|
Возвращаемое значение
public CreateNewRecord ( array $fset, mixed $skiprightscheck = false, $rowner=null) : mixed
Описание
Создать новую запись управляемого модулем типа
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$fset
|
array
|
Описание дополинтельных полей, которые необходимо добавить к создаваемой записи.
|
|
|
$skiprightscheck
|
mixed
|
Создать запись вне зависимости от прав
|
false
|
|
$rowner
|
mixed
|
Запись верхнего уровня от которой наследуются права
|
null
|
Возвращаемое значение
public Debug ( mixed $msg, ) : n/a
Описание
Фунция при включенной переменной $this->debug==true выводит в лог-файл строку вида $this->_RecordType.': '.var_export($msg,true). Тип вывода – E_USER_NOTICE
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$msg
|
mixed
|
Переменная для вывода в лог-файл
|
|
Возвращаемое значение
public DebugPrint ( mixed $msg, ) : n/a
Описание
Фунция при включенной переменной $this->debug==true выводит на экран значение print_r(Smsg) в обрамлении тегов
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$msg
|
mixed
|
Переменная для вывода в лог-файл
|
|
Возвращаемое значение
public final GetAdminVariableInfo ( mixed $name, ) : array|null
Описание
Получение информации о переменной записи модуля
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$name
|
mixed
|
Имя переменной
|
|
Возвращаемое значение
public GetArrAsParams ( $arr, ) : n/a
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$arr
|
n/a
|
|
|
Возвращаемое значение
public GetDbName ( ) : mixed
Описание
Возвращает имя БД по умолчанию
Возвращаемое значение
public GetFormattedRecordList ( mixed $dbname, mixed $src, mixed $format, mixed $formatModule, mixed $page = 1, mixed $recsOnPage = 20, mixed $params = null) : string
Описание
Возвращает отформатированные записи в виде текстового буфера
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$dbname
|
mixed
|
Имя БД для поиска записей
|
|
|
$src
|
mixed
|
Поисковый запрос на языке ISIS
|
|
|
$format
|
mixed
|
Формат
|
|
|
$formatModule
|
mixed
|
Имя модуля, содержащего формат
|
'' |
|
$page
|
mixed
|
Номер страницы с которой начать расформатирование
|
1
|
|
$recsOnPage
|
mixed
|
Количество записей на странице
|
20
|
|
$params
|
mixed
|
Параметры формата
|
null
|
Возвращаемое значение
|
Тип
|
Описание
|
|
string
|
Возвращает отформатированные записи в виде текстового буфера
|
public GetFormattedRecordListReverse ( mixed $dbname, mixed $src, mixed $format, mixed $formatModule, mixed $page = 1, mixed $recsOnPage = 20, , mixed $params = null) : string
Описание
Возвращает отформатированные записи в виде текстового буфера, расположение записей в обратном порядке относительно GetFormattedRecordList
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$dbname
|
mixed
|
Имя БД для поиска записей
|
|
|
$src
|
mixed
|
Поисковый запрос на языке ISIS
|
|
|
$format
|
mixed
|
Формат
|
|
|
$formatModule
|
mixed
|
Имя модуля, содержащего формат
|
'' |
|
$page
|
mixed
|
Номер страницы с которой начать расформатирование
|
1
|
|
$recsOnPage
|
mixed
|
Количество записей на странице
|
20
|
|
$params
|
mixed
|
Параметры формата
|
null
|
Возвращаемое значение
|
Тип
|
Описание
|
|
string
|
Возвращает отформатированные записи в виде текстового буфера
|
public GetIconCls ( ) : string
Описание
Возвращает имя CSS-класса для иконки модуля. Необходимо переопределить эту функцию если Вам необходима собственная иконка для модуля
Возвращаемое значение
|
Тип
|
Описание
|
|
string
|
имя CSS-класса для иконки модуля ‘irb-info’
|
public GetLinkedSysObject ( $sid, $linktype, ) : n/a
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$sid
|
n/a
|
|
|
|
$linktype
|
n/a
|
|
|
Возвращаемое значение
public GetLinkedSysObjectArray ( $sid, $linktype, ) : n/a
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$sid
|
n/a
|
|
|
|
$linktype
|
n/a
|
|
|
Возвращаемое значение
public GetModuleAdminPanel ( ) : string
Описание
Возвращает ExtJs код создания наследника от Ext.Panel для панели Администратора
Возвращаемое значение
public GetModuleRec ( $readonly=false ) : mixed
Описание
Вернуть запись текущего модуля
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$readonly
|
boolean
|
установка в true позволяет быстрее получить запись, но не позволяет ее в будущем сохранить
|
false |
Возвращаемое значение
|
Тип
|
Описание
|
|
ObjectData|null
|
Объект, управляемый модулем Record или NULL если запись не существует
|
Возвращаемое значение
public GetModuleSid ( ) : string
Описание
Получить sid записи модуля
Возвращаемое значение
|
Тип
|
Описание
|
|
string
|
sid записи модуля или пустая строка если запись не найдена
|
public GetModuleTitle ( ) : string
Описание
Возвращает название модуля
Возвращаемое значение
public GetPossibleRightsList ( ) : array
Описание
Получить список всех возможных типов прав модуля
Возвращаемое значение
|
Тип
|
Описание
|
|
array
|
Нумерованный массив строк с перечнем типов прав
|
public GetRecBySid ( mixed $sid, ) : \ObjectData|null
Описание
Получение записи по ее sid
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$sid
|
mixed
|
sid записи для возврата
|
|
Возвращаемое значение
|
Тип
|
Описание
|
|
\ObjectData|null
|
Объект, управляемый модулем Record или NULL если запись не существует
|
public GetRecord ( mixed $sid, ) : \ObjectData|null
Описание
Фунция возвращает запись по ее sid
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$sid
|
mixed
|
sid записи для возврата
|
|
Возвращаемое значение
|
Тип
|
Описание
|
|
\ObjectData|null
|
Объект, управляемый модулем Record или NULL если запись не существует
|
public GetRecordDefault113Fields ( ) : array<mixed,array>
Описание
Возвращает массив с правами по умолчанию для управляемого типа записей
Возвращаемое значение
|
Тип
|
Описание
|
|
array<mixed,array>
|
|
public GetRecordTitle ( ) : string
Описание
Фунция возвращает название управляемой модулем записи из $this-> _RecordType
Возвращаемое значение
|
Тип
|
Описание
|
|
string
|
Название управляемой модулем записи из $this-> _RecordType
|
public GetRecordIndex ( ObjectData $db,ObjectData $r ) : array
Описание
Функция возвращает массив массивов с индексами вида array(0=>array('A'='IDXPREFIX','B'=>'TERMIN1'),1=>array('A'='IDXPREFIX','B'=>'TERMIN2')). Приведенный пример создаст 2 индекса в записи: IDXPREF=TERMIN1 и IDXPREF=TERMIN2
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$db
|
ObjectData
|
БД в которой находится запись
|
|
|
$r
|
ObjectData
|
Запись для индексирования
|
|
Возвращаемое значение
|
Тип
|
Описание
|
|
array
|
Массив массивов с индексами вида array(0=>array('A'='IDXPREFIX','B'=>'TERMIN1'),1=>array('A'='IDXPREFIX','B'=>'TERMIN2')). Приведенный пример создаст 2 индекса в записи: IDXPREF=TERMIN1 и IDXPREF=TERMIN2
|
public GetRecords ( mixed $src = '', mixed $posl = '', ) : array
Описание
Фунция возвращает список первых 5000 записей, найденных в БД $this->_dbname с использованием поиска $src и последовательного поиска $posl. Результаты поиска кешируются. Это означает, что функция применима только к запросам, результат которых не изменяется с течением времени.
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$src
|
mixed
|
поисковое выражение ISIS. По умолчанию '"V=<_RecordType>"'
|
''
|
|
$posl
|
mixed
|
поисковое выражение последовательного поиска ISIS
|
''
|
Возвращаемое значение
|
Тип
|
Описание
|
|
array
|
Нулевой элемент массива – число найденных записей (>=0) или код ошибки (<0). Последующие элементы массива – найденные записи (ObjectData, управляемый модулем Record)
|
public GetRightName ( mixed $right, ) : mixed
Описание
Получит заголовок типа права
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$right
|
mixed
|
Тип права
|
|
Возвращаемое значение
public GetSidDir ( \ObjectData $r, ) : string
Описание
Возвращает каталог, где хранятся sid-данные записи $r.
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$r
|
\ObjectData
|
|
|
Возвращаемое значение
|
Тип
|
Описание
|
|
string
|
Путь к каталогу где хранятся sid-данные записи $r
|
public Init ( ) : n/a
Описание
Инициализация модуля Используется вместо __construct
Возвращаемое значение
public KillLink ( $sid1, $sid2, $linktype1, $linktype2 = '', ) : n/a
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$sid1
|
n/a
|
|
|
|
$sid2
|
n/a
|
|
|
|
$linktype1
|
n/a
|
|
|
|
$linktype2
|
n/a
|
|
''
|
Возвращаемое значение
public LinkAdd ( ) : n/a
Возвращаемое значение
public LinkDrop ( ) : n/a
Возвращаемое значение
public OnAfterDelete ( mixed $r, ) : n/a
Описание
Исполняется после удаления записи
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$r
|
mixed
|
Удаленная запись
|
|
Возвращаемое значение
public OnAfterSave ( mixed $db, mixed $r,) : n/a
Описание
Исполняется после сохранения записи, управляемой модулем
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$db
|
mixed
|
БД в которой произошло сохранение записи
|
|
|
$r
|
mixed
|
Запись
|
|
Возвращаемое значение
public OnBeforeSave ( mixed $db, mixed $r, ) : array
Описание
Исполняется перед сохранением записи, управляемой модулем
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$db
|
mixed
|
БД в которой происходит сохранение
|
|
|
$r
|
mixed
|
сохраняемая запись
|
|
Возвращаемое значение
|
Тип
|
Описание
|
|
array
|
Возвращает массив вида array('IsOk'=>true,'ErrorMessage'=>''). Если IsOk==false то запись не будет сохранена.
|
protected PostInit ( ) : n/a
Описание
Пост-инициализация модуля.
Возвращаемое значение
protected PreInit ( ) : n/a
Описание
Предварительная инициализация модуля.
Для инициализации Вашего модуля в качестве конструктора ииспользуйте фунцию Init()
Возвращаемое значение
public Reload ( mixed $r, ) : n/a
Описание
Deprecated
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$r
|
mixed
|
|
|
Возвращаемое значение
public ResetGlobalFlag ( ) : n/a
Описание
Сбрасывает флаг модуля. Устаревают все зависимые от него флаги. Для получения подробностей см. описание модуля Flags
Возвращаемое значение
public Save ( mixed $r, ) : boolean
Описание
Сохраняет запись в БД по умолчанию для модуля. При сохранении записи сбрасывает глобальный флаг модуля.
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$r
|
mixed
|
|
|
Возвращаемое значение
public SetLinks ( $sid, $linktype, $links, ) : n/a
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$sid
|
n/a
|
|
|
|
$linktype
|
n/a
|
|
|
|
$links
|
n/a
|
|
|
Возвращаемое значение
public SetupModule ( mixed $silent = false, mixed $skiprights = false, ) : boolean|string
Описание
Функция установки модуля. При наследовании первой строкой вызывать parent::SetupModule
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$silent
|
mixed
|
Если true то ошибки будут возвращены в виде строки, иначе выведены на экран
|
false
|
|
$skiprights
|
mixed
|
Устанавливать модуль с наивысшими правами
|
false
|
Возвращаемое значение
|
Тип
|
Описание
|
|
boolean|string
|
|
public ShowAll ( ) : void
Описание
Показывает результат поиска всех управляемых модулем записей
Возвращаемое значение
public ShowFull ( mixed $sid, ) : void
Описание
Вывести на экран запись в формате full
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$sid
|
mixed
|
sid выводимой на экран записи
|
|
Возвращаемое значение
public __call ( mixed $name, mixed $arguments, ) : mixed
Описание
Вы не должны переопределять этот метод! При вызове функции, которая не определена как член класса модуля происходит поиск класса 'fncall_'.$this->_ModuleName.'_'.$name в файле $this->_ModuleName.'/__call/'.$name.'.inc' и вызывается функция Exec этого класса, с передачей этой функции параметров $arguments Подробное описание создания внешних функций см. в 4.3.6.4
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$name
|
mixed
|
Имя внешнего метода для вызова
|
|
|
$arguments
|
mixed
|
Аргументы для внешнего метода
|
|
Возвращаемое значение
public __construct ( mixed $name = NULL, ) : n/a
Описание
Вы не должны переопределять этот метод! Для инициализации Вашего модуля в качестве конструктора ииспользуйте фунцию Init().
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$name
|
mixed
|
не используется
|
NULL
|
Возвращаемое значение
public __destruct ( ) : n/a
Описание
Вы не должны переопределять этот метод! Действий не производится
Возвращаемое значение
public hh ( mixed $name, ) : mixed
Описание
Замена недопустимых в использовании имени файла символов на символ _
Аргументы
|
Имя
|
Тип
|
Описание
|
Значение по умолчанию
|
|
$name
|
mixed
|
Имя файла
|
|
Возвращаемое значение
|
Тип
|
Описание
|
|
mixed
|
Имя файла с замененными недопустимыми символами на _
|
