НАЧАЛО >> Сервер приложений ИРБИС 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
Описание
Добавить новый тип прав к модулю
Аргументы
Имя
Тип
Значение по умолчанию
$right
mixed
Тип права
$title
Заголовок права
Возвращаемое значение
n/a
Конфигурирует редактор записи модуля для АРМ Администратор
$f
Модуль he2
$r
Запись модуля
$rowner
Родительская запись модуля
$objtype
Тип объекта (в данном случае всегда 'MODULE')
Конфигурирует редактор для записи. Вы должны переопределить эту функцию для добавления своих полей редактирования управляемой модулем записи. Для получения подробностей см. описание модуля he2
\ObjectData|null
Редактируемая запись или NULL если запись новая
\ObjectData
Запись-владелец редактируемой записи (для наследования прав доступа)
string
Тип редактируемой записи (значение поля 920)
Конфигурирует редактор управляемой записи
Редактируемая запись
Родительская запись
Тип объекта (всегда == $this->_RecordType)
$sid1
$sid2
$linktype1
$linktype2
''
Создать новую запись управляемого модулем типа
$fset
array
Описание дополинтельных полей, которые необходимо добавить к создаваемой записи.
$skiprightscheck
Создать запись вне зависимости от прав
false
Запись верхнего уровня от которой наследуются права
null
Фунция при включенной переменной $this->debug==true выводит в лог-файл строку вида $this->_RecordType.': '.var_export($msg,true). Тип вывода – E_USER_NOTICE
$msg
Переменная для вывода в лог-файл
Фунция при включенной переменной $this->debug==true выводит на экран значение print_r(Smsg) в обрамлении тегов
Получение информации о переменной записи модуля
$name
Имя переменной
array|null
public GetArrAsParams ( $arr, ) : n/a
$arr
Возвращает имя БД по умолчанию
Возвращает отформатированные записи в виде текстового буфера
$dbname
Имя БД для поиска записей
$src
Поисковый запрос на языке ISIS
$format
Формат
$formatModule
Имя модуля, содержащего формат
$page
Номер страницы с которой начать расформатирование
1
$recsOnPage
Количество записей на странице
20
$params
Параметры формата
public GetFormattedRecordListReverse ( mixed $dbname, mixed $src, mixed $format, mixed $formatModule, mixed $page = 1, mixed $recsOnPage = 20, , mixed $params = null) : string
Возвращает отформатированные записи в виде текстового буфера, расположение записей в обратном порядке относительно GetFormattedRecordList
Возвращает имя CSS-класса для иконки модуля. Необходимо переопределить эту функцию если Вам необходима собственная иконка для модуля
имя CSS-класса для иконки модуля ‘irb-info’
$sid
$linktype
Возвращает ExtJs код создания наследника от Ext.Panel для панели Администратора
Вернуть запись текущего модуля
$readonly
boolean
установка в true позволяет быстрее получить запись, но не позволяет ее в будущем сохранить
ObjectData|null
Объект, управляемый модулем Record или NULL если запись не существует
Получить sid записи модуля
sid записи модуля или пустая строка если запись не найдена
Возвращает название модуля
Получить список всех возможных типов прав модуля
Нумерованный массив строк с перечнем типов прав
Получение записи по ее sid
sid записи для возврата
Фунция возвращает запись по ее sid
public GetRecordDefault113Fields ( ) : array<mixed,array>
Возвращает массив с правами по умолчанию для управляемого типа записей
array<mixed,array>
Фунция возвращает название управляемой модулем записи из $this-> _RecordType
Название управляемой модулем записи из $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
БД в которой находится запись
Запись для индексирования
Массив массивов с индексами вида array(0=>array('A'='IDXPREFIX','B'=>'TERMIN1'),1=>array('A'='IDXPREFIX','B'=>'TERMIN2')). Приведенный пример создаст 2 индекса в записи: IDXPREF=TERMIN1 и IDXPREF=TERMIN2
Фунция возвращает список первых 5000 записей, найденных в БД $this->_dbname с использованием поиска $src и последовательного поиска $posl. Результаты поиска кешируются. Это означает, что функция применима только к запросам, результат которых не изменяется с течением времени.
поисковое выражение ISIS. По умолчанию '"V=<_RecordType>"'
$posl
поисковое выражение последовательного поиска ISIS
Нулевой элемент массива – число найденных записей (>=0) или код ошибки (<0). Последующие элементы массива – найденные записи (ObjectData, управляемый модулем Record)
Получит заголовок типа права
Возвращает каталог, где хранятся sid-данные записи $r.
Путь к каталогу где хранятся sid-данные записи $r
Инициализация модуля Используется вместо __construct
Исполняется после удаления записи
Удаленная запись
public OnAfterSave ( mixed $db, mixed $r,) : n/a
Исполняется после сохранения записи, управляемой модулем
БД в которой произошло сохранение записи
Запись
Исполняется перед сохранением записи, управляемой модулем
БД в которой происходит сохранение
сохраняемая запись
Возвращает массив вида array('IsOk'=>true,'ErrorMessage'=>''). Если IsOk==false то запись не будет сохранена.
Пост-инициализация модуля.
protected PreInit ( ) : n/a
Предварительная инициализация модуля. Для инициализации Вашего модуля в качестве конструктора ииспользуйте фунцию Init()
Deprecated
Сбрасывает флаг модуля. Устаревают все зависимые от него флаги. Для получения подробностей см. описание модуля Flags
Сохраняет запись в БД по умолчанию для модуля. При сохранении записи сбрасывает глобальный флаг модуля.
$links
Функция установки модуля. При наследовании первой строкой вызывать parent::SetupModule
$silent
Если true то ошибки будут возвращены в виде строки, иначе выведены на экран
$skiprights
Устанавливать модуль с наивысшими правами
boolean|string
Показывает результат поиска всех управляемых модулем записей
void
Вывести на экран запись в формате full
sid выводимой на экран записи
Вы не должны переопределять этот метод! При вызове функции, которая не определена как член класса модуля происходит поиск класса 'fncall_'.$this->_ModuleName.'_'.$name в файле $this->_ModuleName.'/__call/'.$name.'.inc' и вызывается функция Exec этого класса, с передачей этой функции параметров $arguments Подробное описание создания внешних функций см. в 4.3.6.4
Имя внешнего метода для вызова
$arguments
Аргументы для внешнего метода
Вы не должны переопределять этот метод! Для инициализации Вашего модуля в качестве конструктора ииспользуйте фунцию Init().
не используется
NULL
Вы не должны переопределять этот метод! Действий не производится
Замена недопустимых в использовании имени файла символов на символ _
Имя файла
Имя файла с замененными недопустимыми символами на _
