Функции класса ObjectModule

НАЧАЛО >> Оглавление >> Сервер приложений ИРБИС 64/128 >> Ядро системы >> ObjectModule >> Функции класса ObjectModule📄 Скачать в DOCX

Справочник сформирован по текущему файлу classes/ObjectModule.php и предназначен для разработчиков модулей ИРБИС 128. В него включены методы базового класса ObjectModule, их текущие сигнатуры, описания из PHPDoc, параметры и возвращаемые значения.

1. Список методов

2. function __construct($name = NULL)

Вы не должны переопределять этот метод! Для инициализации Вашего модуля в качестве конструктора ииспользуйте фунцию Init().

Параметр Сигнатура Описание
$name $name = NULL не используется

Возвращаемое значение: не описано.

3. function __destruct()

Вы не должны переопределять этот метод! Действий не производится

Возвращаемое значение: не описано.

4. public function __call($name, $arguments)

Вы не должны переопределять этот метод! При вызове функции, которая не определена как член класса модуля происходит поиск класса 'fncall_'.$this->ModuleName.''.$name в файле $this->_ModuleName.'/__call/'.$name.'.inc' и вызывается метод Exec этого класса, с передачей ему параметров $arguments Подробное описание создания внешних функций см. в 4.3.6.4

Параметр Сигнатура Описание
$name $name Имя внешнего метода для вызова
$arguments $arguments Аргументы для внешнего метода

Возвращаемое значение: mixed

5. function PreInit()

Предварительная инициализация модуля. Не переопределяйте эту функцию! Для инициализации Вашего модуля в качестве конструктора ииспользуйте фунцию Init()

Возвращаемое значение: не описано.

6. function Init()

Инициализация модуля Используется вместо __construct

Возвращаемое значение: не описано.

7. function LoadAdminVariables()

Загрузка переменных в $this->_admoptslist

Возвращаемое значение: void

8. function InitVariables()

Описание в исходном коде не задано.

Возвращаемое значение: не описано.

9. function UpdateOptsCache()

Обновление кеша значений настроек модуля

Возвращаемое значение: не описано.

10. function PostInit()

Описание в исходном коде не задано.

Возвращаемое значение: не описано.

11. function ClearCache()

Описание в исходном коде не задано.

Возвращаемое значение: не описано.

12. final function GetAdminVariableInfo($name)

Получение информации о переменной записи модуля

Параметр Сигнатура Описание
$name $name Имя переменной

Возвращаемое значение: array|null

13. function hh($name)

Замена недопустимых в использовании имени файла символов на символ _

Параметр Сигнатура Описание
$name $name Имя файла

Возвращаемое значение: mixed Имя файла с замененными недопустимыми символами на _

14. function Debug($msg)

Фунция при включенной переменной $this->debug==true выводит в лог-файл строку вида $this->_RecordType.': '.var_export($msg,true). Тип вывода – E_USER_NOTICE

Параметр Сигнатура Описание
$msg $msg Переменная для вывода в лог-файл

Возвращаемое значение: не описано.

15. function DebugPrint($msg)

Фунция при включенной переменной $this->debug==true выводит на экран значение print_r(Smsg) в обрамлении тегов 







Параметр
Сигнатура
Описание






$msg
$msg
Переменная для вывода в лог-файл






Возвращаемое значение: не описано.


16. function GetRecordTitle()


Фунция возвращает название управляемой модулем записи из $this-> _RecordType


Возвращаемое значение: string Название управляемой модулем записи из $this-> _RecordType


17. function GetIconCls()


Возвращает имя CSS-класса для иконки модуля. Необходимо переопределить эту функцию если Вам необходима собственная иконка для модуля


Возвращаемое значение: string имя CSS-класса для иконки модуля ‘irb-info’


18. function GetRecord($sid)


Фунция возвращает запись по ее sid






Параметр
Сигнатура
Описание






$sid
$sid
sid записи для возврата






Возвращаемое значение: ObjectData|null Объект, управляемый модулем Record или NULL если запись не существует


19. function GetRecords($src = '', $posl = '')


Фунция возвращает список первых 5000 записей, найденных в БД $this->_dbname с использованием поиска $src и последовательного поиска $posl. Результаты поиска кешируются. Это означает, что функция применима только к запросам, результат которых не изменяется с течением времени.






Параметр
Сигнатура
Описание






$src
$src = ''
поисковое выражение ISIS. По умолчанию $this->_defaultAdminRecListSearch




$posl
$posl = ''
поисковое выражение последовательного поиска ISIS






Возвращаемое значение: array Нулевой элемент массива – число найденных записей (>=0) или код ошибки (<0). Последующие элементы массива – найденные записи (ObjectData, управляемый модулем Record)


20. function GetSidDir(ObjectData $r)


Возвращает каталог, где хранятся sid-данные записи $r.






Параметр
Сигнатура
Описание






$r
ObjectData $r
- Запись (Record)






Возвращаемое значение: string Путь к каталогу где хранятся sid-данные записи $r


21. function GetRecBySid($sid)


Получение записи по ее sid






Параметр
Сигнатура
Описание






$sid
$sid
sid записи для возврата






Возвращаемое значение: ObjectData|null Объект, управляемый модулем Record или NULL если запись не существует


22. function Reload(&$r)


Deprecated






Параметр
Сигнатура
Описание






$r
&$r







Возвращаемое значение: не описано.


23. function Save(&$r)


Сохраняет запись в БД по умолчанию для модуля. При сохранении записи сбрасывает глобальный флаг модуля.






Параметр
Сигнатура
Описание






$r
&$r







Возвращаемое значение: bool


24. function ConfigureEditor(&$f, $r, $rowner, $objtype)


Конфигурирует редактор для записи. Вы должны переопределить эту функцию для добавления своих полей редактирования управляемой модулем записи. Для получения подробностей см. описание модуля he2






Параметр
Сигнатура
Описание






$f
&$f
Модуль he2




$r
$r
Редактируемая запись или NULL если запись новая




$rowner
$rowner
Запись-владелец редактируемой записи (для наследования прав доступа)




$objtype
$objtype
Тип редактируемой записи (значение поля 920)






Возвращаемое значение: mixed Модуль he2


25. function ResetGlobalFlag()


Сбрасывает флаг модуля. Устаревают все зависимые от него флаги. Для получения подробностей см. описание модуля Flags


Возвращаемое значение: не описано.


26. function ShowAll($sopts = array())


Показывает результат поиска всех управляемых модулем записей






Параметр
Сигнатура
Описание






$sopts
$sopts = array()







Возвращаемое значение: void


27. function OnBeforeSave(&$db, &$r)


Исполняется перед сохранением записи, управляемой модулем






Параметр
Сигнатура
Описание






$db
&$db
БД в которой происходит сохранение




$r
&$r
сохраняемая запись






Возвращаемое значение: array Возвращает массив вида array('IsOk'=>true,'ErrorMessage'=>''). Если IsOk==false то запись не будет сохранена.


28. function OnAfterSave($db, $r)


Исполняется после сохранения записи, управляемой модулем






Параметр
Сигнатура
Описание






$db
$db
БД в которой произошло сохранение




$r
$r
Сохраненная запись






Возвращаемое значение: не описано.


29. function OnAfterDelete($r)


Исполняется после удаления записи






Параметр
Сигнатура
Описание






$r
$r
Удаленная запись






Возвращаемое значение: не описано.


30. function GetRightName($right)


Получит заголовок типа права






Параметр
Сигнатура
Описание






$right
$right
Тип права






Возвращаемое значение: mixed


31. function GetPossibleRightsList()


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


Возвращаемое значение: array Нумерованный массив строк с перечнем типов прав


32. function AppendRight($right, $title)


Добавить новый тип прав к модулю






Параметр
Сигнатура
Описание






$right
$right
Тип права




$title
$title
Заголовок права






Возвращаемое значение: не описано.


33. function GetDbName()


Возвращает имя БД по умолчанию


Возвращаемое значение: mixed


34. function SetupModule($silent = false, $skiprights = false)


Функция установки модуля. При наследовании первой строкой вызывать parent::SetupModule






Параметр
Сигнатура
Описание






$silent
$silent = false
Если true то ошибки будут возвращены в виде строки, иначе выведены на экран




$skiprights
$skiprights = false
Устанавливать модуль с наивысшими правами






Возвращаемое значение: bool|string


35. function GetModuleRec($readonly = false)


Вернуть запись текущего модуля






Параметр
Сигнатура
Описание






$readonly
$readonly = false







Возвращаемое значение: mixed


36. function GetModuleSid()


Получить sid записи модуля


Возвращаемое значение: string sid записи модуля или пустая строка если запись не найдена


37. function CreateNewRecord($fset, $skiprightscheck = false, $rowner = null)


Создать новую запись управляемого модулем типа






Параметр
Сигнатура
Описание






$fset
$fset
Описание дополинтельных полей, которые необходимо добавить к создаваемой записи.




$skiprightscheck
$skiprightscheck = false
Создать запись вне зависимости от прав




$rowner
$rowner = null







Возвращаемое значение: mixed


38. function SetLinks($sid, $linktype, $links)


Описание в исходном коде не задано.






Параметр
Сигнатура
Описание






$sid
$sid





$linktype
$linktype





$links
$links







Возвращаемое значение: не описано.


39. function CreateLink($sid1, $sid2, $linktype1, $linktype2 = '')


Описание в исходном коде не задано.






Параметр
Сигнатура
Описание






$sid1
$sid1





$sid2
$sid2





$linktype1
$linktype1





$linktype2
$linktype2 = ''







Возвращаемое значение: не описано.


40. function KillLink($sid1, $sid2, $linktype1, $linktype2 = '')


Описание в исходном коде не задано.






Параметр
Сигнатура
Описание






$sid1
$sid1





$sid2
$sid2





$linktype1
$linktype1





$linktype2
$linktype2 = ''







Возвращаемое значение: не описано.


41. function LinkDrop()


Описание в исходном коде не задано.


Возвращаемое значение: не описано.


42. function LinkAdd()


Описание в исходном коде не задано.


Возвращаемое значение: не описано.


43. function ShowFull($sid)


Вывести на экран запись в формате full






Параметр
Сигнатура
Описание






$sid
$sid
sid выводимой на экран записи






Возвращаемое значение: void


44. function GetLinkedSysObject($sid, $linktype)


Описание в исходном коде не задано.






Параметр
Сигнатура
Описание






$sid
$sid





$linktype
$linktype







Возвращаемое значение: не описано.


45. function GetLinkedSysObjectArray($sid, $linktype)


Описание в исходном коде не задано.






Параметр
Сигнатура
Описание






$sid
$sid





$linktype
$linktype







Возвращаемое значение: не описано.


46. function GetModuleTitle()


Возвращает название модуля


Возвращаемое значение: string


47. function GetModuleAdminPanel()


Возвращает ExtJs код создания наследника от Ext.Panel для панели управления модулем


Возвращаемое значение: string


48. function ConfigureAdminEditor(&$f, $r, $rowner, $objtype)


Конфигурирует редактор записи модуля для АРМ Администратор






Параметр
Сигнатура
Описание






$f
&$f
Модуль he2




$r
$r
Запись модуля




$rowner
$rowner
Родительская запись модуля




$objtype
$objtype
Тип объекта (в данном случае всегда 'MODULE')






Возвращаемое значение: mixed


49. function ConfigureRecordEditor(&$f, $r, $rowner, $objtype)


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






Параметр
Сигнатура
Описание






$f
&$f
Модуль he2




$r
$r
Редактируемая запись




$rowner
$rowner
Родительская запись




$objtype
$objtype
Тип объекта (всегда == $this->_RecordType)






Возвращаемое значение: не описано.


50. function GetRecordDefault113Fields()


Возвращает массив с правами по умолчанию для управляемого типа записей


Возвращаемое значение: array[]


51. function GetFormattedRecordList($dbname, $src, $format, $formatModule = '', $page = 1, $recsOnPage = 20, $params = null, $totalRecs = null)


Возвращает одну страницу отформатированных записей в виде текстового буфера






Параметр
Сигнатура
Описание






$dbname
$dbname
Имя БД для поиска записей




$src
$src
Поисковый запрос на языке ISIS




$format
$format
Формат




$formatModule
$formatModule = ''
Модуль, содержащий формат




$page
$page = 1
Номер страницы с которой начать расформатирование




$recsOnPage
$recsOnPage = 20
Количество записей на странице




$params
$params = null
Параметры для формата




$totalRecs
$totalRecs = null
общее число записей по запросу, опционально, для оптимизации постраничного отображения






Возвращаемое значение: string отформатированные записи в виде текстового буфера


52. function GetFormattedRecordListReverse($dbname, $src, $format, $formatModule = '', $page = 1, $recsOnPage = 20, $params = null, $totalRecs = null)


Возвращает одну страницу отформатированных записей виде текстового буфера, расположение записей в обратном порядке относительно GetFormattedRecordList






Параметр
Сигнатура
Описание






$dbname
$dbname
Имя БД для поиска записей




$src
$src
Поисковый запрос на языке ISIS




$format
$format
Формат




$formatModule
$formatModule = ''
Модуль, содержащий формат




$page
$page = 1
Номер страницы с которой начать расформатирование




$recsOnPage
$recsOnPage = 20
Количество записей на странице




$params
$params = null
Параметры для формата




$totalRecs
$totalRecs = null
общее число записей по запросу, опционально, для оптимизации постраничного отображения






Возвращаемое значение: string отформатированные записи в виде текстового буфера


53. function UseLng()


Описание в исходном коде не задано.


Возвращаемое значение: не описано.


54. function LNG($textid, $params = null)


Описание в исходном коде не задано.






Параметр
Сигнатура
Описание






$textid
$textid





$params
$params = null







Возвращаемое значение: не описано.


55. protected function IndexRecord(&$db, &$r, $fld = 1288)


Описание в исходном коде не задано.






Параметр
Сигнатура
Описание






$db
&$db





$r
&$r





$fld
$fld = 1288







Возвращаемое значение: не описано.


56. function GetRecordIndex(ObjectData $db, ObjectData $r)


Функция возвращает массив массивов с индексами вида array(0=>array('A'='IDXPREFIX','B'=>'TERMIN1'),1=>array('A'='IDXPREFIX','B'=>'TERMIN2')) Приведенный пример создаст 2 индекса в записи: IDXPREF=TERMIN1 и IDXPREF=TERMIN2






Параметр
Сигнатура
Описание






$db
ObjectData $db
БД в которой находится запись




$r
ObjectData $r
Запись для индексирования






Возвращаемое значение: array[]


57. function GetLastTotalCount()


Описание в исходном коде не задано.


Возвращаемое значение: не описано.


58. function fe_fGetAllProfiles($db, $r, &$res, &$pftb = NULL)


Описание в исходном коде не задано.






Параметр
Сигнатура
Описание






$db
$db





$r
$r





$res
&$res





$pftb
&$pftb = NULL







Возвращаемое значение: не описано.


59. function ApplyProfile($profilesid = '', $saveuserchoise = true)


Применяет пользовательский профиль. SID профиля так же можно передать в POST или GET запросе в параметре с именем $this->_profilename SID профиля хранится в SID-папке пользователя по пути $thi->_profilesavepath






Параметр
Сигнатура
Описание






$profilesid
$profilesid = ''





$saveuserchoise
$saveuserchoise = true







Возвращаемое значение: void


60. function GetProfileCount()


Описание в исходном коде не задано.


Возвращаемое значение: не описано.


61. function fe_fGetAllowedViewSids($db, $r, &$res, &$pftb = NULL)


Описание в исходном коде не задано.






Параметр
Сигнатура
Описание






$db
$db





$r
$r





$res
&$res





$pftb
&$pftb = NULL







Возвращаемое значение: не описано.


62. function GetAllowedViewSids()


Возвращает массив вида 'sid'=>'brief' со списком доступных на просмотр записей модуля


Возвращаемое значение: array


63. function UseWIrbisScripts($nocache = false)


Подключает JS-скрипты, включая специфичные для модуля






Параметр
Сигнатура
Описание






$nocache
$nocache = false
Если true, то скрипты выводятся повторно даже если уже выводились (например, если вывод был сброшен)






Возвращаемое значение: не описано.