DOF - Вклад участника [ru]

Разработка:storages/cov

2014-03-20T17:49:23Z

Ibragim: /* add_options_to_custom_object($plugintype, $plugincode, $objectid, stdClass $customobj=null, $substorage=null) */

===Таблица в базе данных===
''cov'' - Custom Options Values - Значения Дополнительных Опций. В справочник сохраняются значения дополнительных полей для существующих плагинов.

====Подробный формат полей в таблице:====

* id - уникальный идентификатор записи
* plugintype - тип плагина, к объекту которого привязана дополнительная опция (почти всегда - storage)
* plugincode - код плагина, к объекту которого привязана дополнительная опция
* substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
* objectid - id объекта, к которому привязывается дополнительная опция
* code - код дополнительной переменной (имя поля). Пока подчиняется такому же правилу, как и имена полей в БД. Потом с помощью слешей добавим возможность добавлять вложенные поля (пока не реализуем).
* value - значение дополнительной опции

===Дополнительные методы:===
===='''save_option($plugintype, $plugincode, $objectid, $code, $value=null, $substorage=null)'''====
Метод сохраняет настройку в справочник.
Создает запись, если с такими параметрами записи еще нет.
Обновляет запись, если она есть с такими параметрами, и переданный $value !== NULL
Если запись с переданными параметрами есть, а в качестве $value передали NULL, то запись будет удалена

''Аргументы:''

* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $code - код дополнительной переменной (имя поля)
* $value - значение дополнительной опции
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)

===='''get_option($plugintype, $plugincode, $objectid, $code, $substorage=null)'''====
Метод возвращает одно значение из таблицы настроек по переданным параметрам.

''Аргументы:''

* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $code - код дополнительной переменной (имя поля)
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
''Возвращаемые значения:''
* mixed: NULL - если значение не найдено|string значение - если найдено

===='''add_options_to_custom_object($plugintype, $plugincode, $objectid, stdClass $customobj=null, $substorage=null)'''====
Метод получает из справочника опции по переданным параметрам и добавляет их в качестве свойств к переданному объекту $customobj. Если не передали объект $customobj, полученные значения будут присоединены к новому stdClass(). Метод возвращает получившийся $customobj.

''Аргументы:''

* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $customobj - объект, к которому будут присоединены полученные из справочника опции.
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
''Возвращаемые значения:''
* stdClass - переданные в метод объект, дополненный дополнительными опциями из справочника

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/cov

2014-03-20T17:49:15Z

Ibragim: /* get_option($plugintype, $plugincode, $objectid, $code, $substorage=null) */

===Таблица в базе данных===
''cov'' - Custom Options Values - Значения Дополнительных Опций. В справочник сохраняются значения дополнительных полей для существующих плагинов.

====Подробный формат полей в таблице:====

* id - уникальный идентификатор записи
* plugintype - тип плагина, к объекту которого привязана дополнительная опция (почти всегда - storage)
* plugincode - код плагина, к объекту которого привязана дополнительная опция
* substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
* objectid - id объекта, к которому привязывается дополнительная опция
* code - код дополнительной переменной (имя поля). Пока подчиняется такому же правилу, как и имена полей в БД. Потом с помощью слешей добавим возможность добавлять вложенные поля (пока не реализуем).
* value - значение дополнительной опции

===Дополнительные методы:===
===='''save_option($plugintype, $plugincode, $objectid, $code, $value=null, $substorage=null)'''====
Метод сохраняет настройку в справочник.
Создает запись, если с такими параметрами записи еще нет.
Обновляет запись, если она есть с такими параметрами, и переданный $value !== NULL
Если запись с переданными параметрами есть, а в качестве $value передали NULL, то запись будет удалена

''Аргументы:''

* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $code - код дополнительной переменной (имя поля)
* $value - значение дополнительной опции
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)

===='''get_option($plugintype, $plugincode, $objectid, $code, $substorage=null)'''====
Метод возвращает одно значение из таблицы настроек по переданным параметрам.

''Аргументы:''

* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $code - код дополнительной переменной (имя поля)
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
''Возвращаемые значения:''
* mixed: NULL - если значение не найдено|string значение - если найдено

===='''add_options_to_custom_object($plugintype, $plugincode, $objectid, stdClass $customobj=null, $substorage=null)'''====
Метод получает из справочника опции по переданным параметрам и добавляет их в качестве свойств к переданному объекту $customobj. Если не передали объект $customobj, полученные значения будут присоединены к новому stdClass(). Метод возвращает получившийся $customobj.
''Аргументы:''
* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $customobj - объект, к которому будут присоединены полученные из справочника опции.
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
''Возвращаемые значения:''
* stdClass - переданные в метод объект, дополненный дополнительными опциями из справочника

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/cov

2014-03-20T17:49:05Z

Ibragim: /* save_option($plugintype, $plugincode, $objectid, $code, $value=null, $substorage=null) */

===Таблица в базе данных===
''cov'' - Custom Options Values - Значения Дополнительных Опций. В справочник сохраняются значения дополнительных полей для существующих плагинов.

====Подробный формат полей в таблице:====

* id - уникальный идентификатор записи
* plugintype - тип плагина, к объекту которого привязана дополнительная опция (почти всегда - storage)
* plugincode - код плагина, к объекту которого привязана дополнительная опция
* substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
* objectid - id объекта, к которому привязывается дополнительная опция
* code - код дополнительной переменной (имя поля). Пока подчиняется такому же правилу, как и имена полей в БД. Потом с помощью слешей добавим возможность добавлять вложенные поля (пока не реализуем).
* value - значение дополнительной опции

===Дополнительные методы:===
===='''save_option($plugintype, $plugincode, $objectid, $code, $value=null, $substorage=null)'''====
Метод сохраняет настройку в справочник.
Создает запись, если с такими параметрами записи еще нет.
Обновляет запись, если она есть с такими параметрами, и переданный $value !== NULL
Если запись с переданными параметрами есть, а в качестве $value передали NULL, то запись будет удалена

''Аргументы:''

* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $code - код дополнительной переменной (имя поля)
* $value - значение дополнительной опции
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)

===='''get_option($plugintype, $plugincode, $objectid, $code, $substorage=null)'''====
Метод возвращает одно значение из таблицы настроек по переданным параметрам.
''Аргументы:''
* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $code - код дополнительной переменной (имя поля)
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
''Возвращаемые значения:''
* mixed: NULL - если значение не найдено|string значение - если найдено

===='''add_options_to_custom_object($plugintype, $plugincode, $objectid, stdClass $customobj=null, $substorage=null)'''====
Метод получает из справочника опции по переданным параметрам и добавляет их в качестве свойств к переданному объекту $customobj. Если не передали объект $customobj, полученные значения будут присоединены к новому stdClass(). Метод возвращает получившийся $customobj.
''Аргументы:''
* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $customobj - объект, к которому будут присоединены полученные из справочника опции.
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
''Возвращаемые значения:''
* stdClass - переданные в метод объект, дополненный дополнительными опциями из справочника

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/cov

2014-03-20T17:48:35Z

Ibragim: /* save_option($plugintype, $plugincode, $objectid, $code, $value=null, $substorage=null) */

===Таблица в базе данных===
''cov'' - Custom Options Values - Значения Дополнительных Опций. В справочник сохраняются значения дополнительных полей для существующих плагинов.

====Подробный формат полей в таблице:====

* id - уникальный идентификатор записи
* plugintype - тип плагина, к объекту которого привязана дополнительная опция (почти всегда - storage)
* plugincode - код плагина, к объекту которого привязана дополнительная опция
* substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
* objectid - id объекта, к которому привязывается дополнительная опция
* code - код дополнительной переменной (имя поля). Пока подчиняется такому же правилу, как и имена полей в БД. Потом с помощью слешей добавим возможность добавлять вложенные поля (пока не реализуем).
* value - значение дополнительной опции

===Дополнительные методы:===
===='''save_option($plugintype, $plugincode, $objectid, $code, $value=null, $substorage=null)'''====
Метод сохраняет настройку в справочник.
Создает запись, если с такими параметрами записи еще нет.
Обновляет запись, если она есть с такими параметрами, и переданный $value !== NULL
Если запись с переданными параметрами есть, а в качестве $value передали NULL, то запись будет удалена
''Аргументы:''

* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $code - код дополнительной переменной (имя поля)
* $value - значение дополнительной опции
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)

===='''get_option($plugintype, $plugincode, $objectid, $code, $substorage=null)'''====
Метод возвращает одно значение из таблицы настроек по переданным параметрам.
''Аргументы:''
* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $code - код дополнительной переменной (имя поля)
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
''Возвращаемые значения:''
* mixed: NULL - если значение не найдено|string значение - если найдено

===='''add_options_to_custom_object($plugintype, $plugincode, $objectid, stdClass $customobj=null, $substorage=null)'''====
Метод получает из справочника опции по переданным параметрам и добавляет их в качестве свойств к переданному объекту $customobj. Если не передали объект $customobj, полученные значения будут присоединены к новому stdClass(). Метод возвращает получившийся $customobj.
''Аргументы:''
* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $customobj - объект, к которому будут присоединены полученные из справочника опции.
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
''Возвращаемые значения:''
* stdClass - переданные в метод объект, дополненный дополнительными опциями из справочника

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/cov

2014-03-20T17:46:51Z

Ibragim: /* Подробный формат полей в таблице: */

===Таблица в базе данных===
''cov'' - Custom Options Values - Значения Дополнительных Опций. В справочник сохраняются значения дополнительных полей для существующих плагинов.

====Подробный формат полей в таблице:====

* id - уникальный идентификатор записи
* plugintype - тип плагина, к объекту которого привязана дополнительная опция (почти всегда - storage)
* plugincode - код плагина, к объекту которого привязана дополнительная опция
* substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
* objectid - id объекта, к которому привязывается дополнительная опция
* code - код дополнительной переменной (имя поля). Пока подчиняется такому же правилу, как и имена полей в БД. Потом с помощью слешей добавим возможность добавлять вложенные поля (пока не реализуем).
* value - значение дополнительной опции

===Дополнительные методы:===
===='''save_option($plugintype, $plugincode, $objectid, $code, $value=null, $substorage=null)'''====
Метод сохраняет настройку в справочник.
Создает запись, если с такими параметрами записи еще нет.
Обновляет запись, если она есть с такими параметрами, и переданный $value !== NULL
Если запись с переданными параметрами есть, а в качестве $value передали NULL, то запись будет удалена
''Аргументы:''
* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $code - код дополнительной переменной (имя поля)
* $value - значение дополнительной опции
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)

===='''get_option($plugintype, $plugincode, $objectid, $code, $substorage=null)'''====
Метод возвращает одно значение из таблицы настроек по переданным параметрам.
''Аргументы:''
* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $code - код дополнительной переменной (имя поля)
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
''Возвращаемые значения:''
* mixed: NULL - если значение не найдено|string значение - если найдено

===='''add_options_to_custom_object($plugintype, $plugincode, $objectid, stdClass $customobj=null, $substorage=null)'''====
Метод получает из справочника опции по переданным параметрам и добавляет их в качестве свойств к переданному объекту $customobj. Если не передали объект $customobj, полученные значения будут присоединены к новому stdClass(). Метод возвращает получившийся $customobj.
''Аргументы:''
* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $customobj - объект, к которому будут присоединены полученные из справочника опции.
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
''Возвращаемые значения:''
* stdClass - переданные в метод объект, дополненный дополнительными опциями из справочника

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/cov

2014-03-20T17:46:07Z

Ibragim: /* Таблица в базе данных */

===Таблица в базе данных===
''cov'' - Custom Options Values - Значения Дополнительных Опций. В справочник сохраняются значения дополнительных полей для существующих плагинов.

====Подробный формат полей в таблице:====

* id
* plugintype - тип плагина, к объекту которого привязана дополнительная опция (почти всегда - storage)
* plugincode - код плагина, к объекту которого привязана дополнительная опция
* substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
* objectid - id объекта, к которому привязывается дополнительная опция
* code - код дополнительной переменной (имя поля). Пока подчиняется такому же правилу, как и имена полей в БД. Потом с помощью слешей добавим возможность добавлять вложенные поля (пока не реализуем).
* value - значение дополнительной опции

===Дополнительные методы:===
===='''save_option($plugintype, $plugincode, $objectid, $code, $value=null, $substorage=null)'''====
Метод сохраняет настройку в справочник.
Создает запись, если с такими параметрами записи еще нет.
Обновляет запись, если она есть с такими параметрами, и переданный $value !== NULL
Если запись с переданными параметрами есть, а в качестве $value передали NULL, то запись будет удалена
''Аргументы:''
* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $code - код дополнительной переменной (имя поля)
* $value - значение дополнительной опции
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)

===='''get_option($plugintype, $plugincode, $objectid, $code, $substorage=null)'''====
Метод возвращает одно значение из таблицы настроек по переданным параметрам.
''Аргументы:''
* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $code - код дополнительной переменной (имя поля)
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
''Возвращаемые значения:''
* mixed: NULL - если значение не найдено|string значение - если найдено

===='''add_options_to_custom_object($plugintype, $plugincode, $objectid, stdClass $customobj=null, $substorage=null)'''====
Метод получает из справочника опции по переданным параметрам и добавляет их в качестве свойств к переданному объекту $customobj. Если не передали объект $customobj, полученные значения будут присоединены к новому stdClass(). Метод возвращает получившийся $customobj.
''Аргументы:''
* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $customobj - объект, к которому будут присоединены полученные из справочника опции.
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
''Возвращаемые значения:''
* stdClass - переданные в метод объект, дополненный дополнительными опциями из справочника

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/cov

2014-03-20T17:45:07Z

Ibragim: /* Подробный формат полей в таблице: */

===Таблица в базе данных===
''cov'' - Custom Options Values - Значения Дополнительных Опций.
Описание настройки всех плагинов должно записываться в языковой файл в виде - config:код настройки.

====Подробный формат полей в таблице:====

* id
* plugintype - тип плагина, к объекту которого привязана дополнительная опция (почти всегда - storage)
* plugincode - код плагина, к объекту которого привязана дополнительная опция
* substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
* objectid - id объекта, к которому привязывается дополнительная опция
* code - код дополнительной переменной (имя поля). Пока подчиняется такому же правилу, как и имена полей в БД. Потом с помощью слешей добавим возможность добавлять вложенные поля (пока не реализуем).
* value - значение дополнительной опции

===Дополнительные методы:===
===='''save_option($plugintype, $plugincode, $objectid, $code, $value=null, $substorage=null)'''====
Метод сохраняет настройку в справочник.
Создает запись, если с такими параметрами записи еще нет.
Обновляет запись, если она есть с такими параметрами, и переданный $value !== NULL
Если запись с переданными параметрами есть, а в качестве $value передали NULL, то запись будет удалена
''Аргументы:''
* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $code - код дополнительной переменной (имя поля)
* $value - значение дополнительной опции
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)

===='''get_option($plugintype, $plugincode, $objectid, $code, $substorage=null)'''====
Метод возвращает одно значение из таблицы настроек по переданным параметрам.
''Аргументы:''
* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $code - код дополнительной переменной (имя поля)
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
''Возвращаемые значения:''
* mixed: NULL - если значение не найдено|string значение - если найдено

===='''add_options_to_custom_object($plugintype, $plugincode, $objectid, stdClass $customobj=null, $substorage=null)'''====
Метод получает из справочника опции по переданным параметрам и добавляет их в качестве свойств к переданному объекту $customobj. Если не передали объект $customobj, полученные значения будут присоединены к новому stdClass(). Метод возвращает получившийся $customobj.
''Аргументы:''
* $plugintype - тип плагина, к объекту которого привязана дополнительная опция(почти всегда - storage)
* $plugincode - код плагина, к объекту которого привязана дополнительная опция
* $objectid - id объекта, к которому привязывается дополнительная опция
* $customobj - объект, к которому будут присоединены полученные из справочника опции.
* $substorage - код подхранилища: не актуально для storage, поэтому почти всегда пустая строка, но в перспективе, может понадобится (аналогично похожему полю в реестре синхронизаций)
''Возвращаемые значения:''
* stdClass - переданные в метод объект, дополненный дополнительными опциями из справочника

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/cov

2014-03-20T17:34:12Z

Ibragim: /* Подробный формат полей в таблице: */

Разработка:storages/config

2014-03-20T17:33:07Z

Ibragim: /* Таблица в базе данных */

{{Infobox_Plugin
| name = config
| type = storages
}}

===Таблица в базе данных===
''config'' - таблица настроек.
Описание настройки всех плагинов должно записываться в языковой файл в виде - config:код настройки.

====Подробный формат полей в таблице:====
* id - номер записи
* departmentid - номер записи в таблице [[Разработка:storages/departments | departments ]]
* code - кодовое обозначение
* type - тип настройки. Задается как тип элемента quickform. Возможные значения
** checkbox
** password
** passwordunmask
** text
** textarea
** date_selector
** date_time_selector
** selectyesno
** advcheckbox
** file
** radio
** select
** htmleditor
** dof_duration
* value - значения настройки
* plugintype - тип плагина (im, storage, workflow, sync, modlib)
* plugincode - код плагина
* noextend - запретить наследование настройки (принимает или 0 или 1)
* personid - персона из [[Разработка:storages/persons | persons ]], для которго действует настройка(0 для всех)

[[Категория:Плагины_storages]]

===Дополнительные методы:===

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/cov

2014-03-20T17:28:56Z

Ibragim: Новая страница: «===Таблица в базе данных=== ''cov'' - Custom Options Values - Значения Дополнительных Опций. Описание настр...»

Разработка:im/agroups

2012-11-08T16:13:53Z

Ibragim: /* im/agroups - Группы */

{{Infobox_Plugin
| name = agroups
| type = im
}}
=im/agroups - Группы=
Модуль редактирования параметров академической группы, (или класса в средней школе).
Работает в паре с модулем storage/agroups.
Позволяет создавать и редактировать различные атрибуты группы - название, код и т.п.
==Список групп==
На этой странице можно просмотреть список всех групп учебного заведения либо групп, отобранных по определенным критериям или их комбинации. Критериями отбора могут быть: отдел учебного заведения, программа обучения, статус группы. Просмотр отобранных групп возможен лишь при наличии соответствующих полномочий.

Список выводится в виде таблицы. Количество строк таблицы выводимых на одну страницу настраивается в параметрах конфигурации. Если список слишком длинный, то он разбивается на страницы и появляется список ссылок на них.

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

С этой страницы можно перейти на страницу создания группы или редактирования ее параметров.

На страницу могут передаваться в качестве входных параметров id учебной программы, id подразделения, код статуса группы в любой комбинации. Или не передаваться ничего. Если значения в бд найдены, то выводится соответствующий список. Если какой-то параметр неправильного типа - он не учитывается при формировании списка групп. Если он правильного типа, но такого значения нет в таблице, то выводится сообщение
''(Не найдено ни одной группы с такими параметрами)''
Например, такое сообщение будет выведено, если во входных параметрах будет передан id программы 999999999999, или статус группы "букадырур". Если же переданный id программы будет иметь значение "дывларыда", а статус равен 9999, то они будут исключены из критериев отбора групп.

==Страница группы==
На этой странице выводится одна строка таблицы списка групп. Отсюда можно перейти на страницу редактирования параметров группы или на страницу списка групп.

Также на этой странице возможно
* получить список группы для распечатки экзаменационной или зачетной ведомости
* Просмотреть информацию о программе группы
* Просмотреть все предметы изучаемой программы

==Создание/изменение параметров группы==
На этой странице отображается форма, в которой можно определить параметры группы. Это название группы, код группы, программа обучения группы, отдел, к которому приписана группа. Поле "статус" менять нельзя, потому что он меняется автоматически при наступлении определенных событий.
Поле "параллель" можно задать только при формировании группы. Как только группа начала обучение параллель менять нельзя.

При заполнении полей следует учитывать набор символов, который можно использовать:
* название группы - цифры, русские и латинские буквы в любом регистре, тире.
* код группы - цифры, русские и латинские буквы в нижнем регистре, тире. Если вы введете буквы в верхнем регистре, то они будут автоматически преобразованы к нижнему.

Код группы должен быть уникален среди всех групп.

Страница создания и редактирования группы содержит обязательный параметр agroupid.
* Если он передан - то редактируется группа с переданным id
* Если он не передан (или передана строка), то будет создана новая группа с указанными параметрами
* Если передан номер не существующей в БД записи - то будет выведено сообщение об ошибке

==API==
===show($obj)===
Возвращает html-код отображения информации об учебной группе в виде таблицы.
* Входные параметры:
** $obj - объект, запись из таблицы agoups
*Возвращаемые значения:
** html-код таблицы или
** false в случае ошибки.

===show_id($id)===
Возвращает html-код отображения информации об учебной группе в виде таблицы
* Входные параметры:
** $id - id записи из таблицы agroups;
* Возвращаемые значения:
** html-код таблицы или
** false в случае ошибки

===showlist($list)===
Возвращает html-код отображения информации о нескольких группах в виде таблицы.
* Входные параметры:
** $list - массив объектов. Каждый объект - это запись из таблицы agroups.
* Возвращаемые значения:
** html-код таблицы или
** false в случае ошибки.

===form($id=NULL)===
Возвращает html-код формы создания новой или редактирования существующей группы.
* Входные переменные:
** $id - id записи из таблицы agroups (по умолчанию NULL). Значения этой записи будут использованы для заполнения полей формы значениями по умолчанию. Если $id = NULL, то поля формы остаются пустыми.
* Возвращаемые значения:
** html-код или
** false в случае ошибки.

===get_listing($limitfrom, $limitnum, $conds)===
Возвращает список учебных групп, выбранных по заданным критериям.
* Входные переменные:
** $limitfrom - порядковый номер записи в общем списке записей, удовлетворяющих критериям выборки. Эта запись будет первой в возвращаемом списке.
** $limitnum - количество записей, которые нужно вернуть.
** $conds - объект - список параметров для выборки записей. Название свойства объекта - это название поля в таблице agroups.
* Выходные значения:
** массив записей из таблицы agroups или
** false в случае ошибки.

===get_select_listing($inputconds)===
Возвращает фрагмент sql-запроса после слова WHERE.
* Входные переменные:
** $inputconds - объект. Содержит критерии выборки для формирования запроса. Свойство объекта - название поля в таблице agroups.
* Возвращаемые значения:
** фрагмент строки запроса, который будет вставлен в запрос после слова WHERE.

===metacontracts_autocomplete_handler($agroup,$metaautocompleteid,$metaautocompletetext,$departmentid)===
Обрабатывает данные из автокомплит-поля "метаконтракт"
* Входные переменные:
** $agroup-группа
** $metaautocompleteid - id обьекта из поля "metacontract"
** $metaautocompletetext - текст из поля "metacontract"
** $departmentid - id подразделения
* Возвращаемые значения
** Объект группы с добавленным полем "метаконтракт"|false

===Список карточек:===
* Инициализация плагина
* Редактирование страницы просмотра одного класса
* Редактирование страницы просмотра списка
** добавляется фильтрация по программе и подразделению
* Редактирование интерфейса формы
* Редактирование обработчика формы
* Вставка на страницу списка классов меню поиска

Разработка:storages/workplaces

2012-11-03T17:30:01Z

Ibragim: /* update_and_normalize($personid, $organizationid = null, $post = null) */

{{Infobox_Plugin
| name = workplaces
| type = storages
}}

===Таблица в базе данных===
''workplaces''

====Подробный формат полей в таблице:====
* personid - id персоны в таблице [[Разработка:storages/persons | persons ]]
* organizationid - id организации в таблице [[Разработка:storages/organizations | organizations ]]
* statuswork - рабочий статус (основное место работы/совместитель/не известно/уволен)
* post - должность
* receptiondate - дата приема
* dismissaldate - дата увольнения
* phonework - рабочий телефон
* addnumber - добавочный номер
* comment - коментарий

===Дополнительные методы:===
===='''widgets_field_variants_list($querytype, $depid, $data)'''====

Обработка AJAX-запросов из форм.

''Аргументы:''
* $querytype(string) - тип запроса
* $depid(int) - подразделение, в котором ищутся должности
* $data(array) - дополнительные данные пришедшие из json-запроса
''Возвращаемые значения:''
* (array) - массив полученных обьектов.
''Структура работы:''
# Через case перебираем тип запроса и в зависимости от этого вызываем нужный метод.
# Возвращаем массив вида array(0 => $this->dof->modlib('ig')->igs('choose')), если такого типа запроса нет.

===='''widgets_workplaces_list($departmentid, $fullname)'''====

Получить список должностей по первым буквам названия должности(post)

''Аргументы:''
* $departmentid(int) - подразделение, в котором ищутся должности
* $post(string) - первые несколько букв поля post
''Возвращаемые значения:''
* (array) - массив полученных обьектов.
''Структура работы:''
# Формируем SQL запрос на получение похожих на строку $post данных по полю post
# Отправляем запрос базе.
# Формируем полученные из базы данные в массив объектов для возвращения в форму.

===='''update_and_normalize($personid, $organizationid = null, $post = null)'''====
Реализация увольнения и назначения на должность, смены должности.
*Если существует активная привязка:
*1) Если мы меняем органимзацию:
переносим старую привязку в архивный статус и создаем новую привязку с новой организацией
*2) Если организация не меняется-только обновляем запись
Если активной привязки не существует: создать новую привязку в активном статусе
При создании привязки заносится дата принятия на работу, при перемещении в архивный статус-
дата увольнения
*Если привязка не существует-создаем привязку в активном статусе

''Аргументы:''
* $personid(int) - id персоны
* $organizationid(int) - id организации
* $post(string) - название должности
''Возвращаемые значения:''
* bool true|false
''Структура работы:''
# Проверяем, существует ли для данного пользователя активная привязка(если не существует-создаем активную привязку)
# Если активная привязка существует: проверяем, совпадает ли переданный id организации, с тем что записан в привязке
# В зависимости от этого совпадения, либо переводим текущую привязку в архивный статус и создаем новую в активном статусе, либо просто обновляем текущую привязку

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|workplaces
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|Генерируется каждый раз при вставке новой записи в таблицу workplaces.
|-
|storage
|workplaces
|update
|Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.
''Пример:'' array('old' => $dataobject_old, 'new' => $dataobject_new)
|Генерируется каждый раз при обновлении записи в таблице workplaces.
|-
|storage
|workplaces
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|Генерируется каждый раз при удалении записи из таблицы workplaces.
|}

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/workplaces

2012-11-03T17:29:10Z

Ibragim: /* Дополнительные методы: */

{{Infobox_Plugin
| name = workplaces
| type = storages
}}

===Таблица в базе данных===
''workplaces''

====Подробный формат полей в таблице:====
* personid - id персоны в таблице [[Разработка:storages/persons | persons ]]
* organizationid - id организации в таблице [[Разработка:storages/organizations | organizations ]]
* statuswork - рабочий статус (основное место работы/совместитель/не известно/уволен)
* post - должность
* receptiondate - дата приема
* dismissaldate - дата увольнения
* phonework - рабочий телефон
* addnumber - добавочный номер
* comment - коментарий

===Дополнительные методы:===
===='''widgets_field_variants_list($querytype, $depid, $data)'''====

Обработка AJAX-запросов из форм.

''Аргументы:''
* $querytype(string) - тип запроса
* $depid(int) - подразделение, в котором ищутся должности
* $data(array) - дополнительные данные пришедшие из json-запроса
''Возвращаемые значения:''
* (array) - массив полученных обьектов.
''Структура работы:''
# Через case перебираем тип запроса и в зависимости от этого вызываем нужный метод.
# Возвращаем массив вида array(0 => $this->dof->modlib('ig')->igs('choose')), если такого типа запроса нет.

===='''widgets_workplaces_list($departmentid, $fullname)'''====

Получить список должностей по первым буквам названия должности(post)

''Аргументы:''
* $departmentid(int) - подразделение, в котором ищутся должности
* $post(string) - первые несколько букв поля post
''Возвращаемые значения:''
* (array) - массив полученных обьектов.
''Структура работы:''
# Формируем SQL запрос на получение похожих на строку $post данных по полю post
# Отправляем запрос базе.
# Формируем полученные из базы данные в массив объектов для возвращения в форму.

===='''update_and_normalize($personid, $organizationid = null, $post = null)'''====
Реализация увольнения и назначения на должность, смены должности.
Если существует активная привязка:
*1) Если мы меняем органимзацию:
переносим старую привязку в архивный статус и создаем новую привязку с новой организацией
*2) Если организация не меняется-только обновляем запись
Если активной привязки не существует: создать новую привязку в активном статусе
При создании привязки заносится дата принятия на работу, при перемещении в архивный статус-
дата увольнения

''Аргументы:''
* $personid(int) - id персоны
* $organizationid(int) - id организации
* $post(string) - название должности
''Возвращаемые значения:''
* bool true|false
''Структура работы:''
# Проверяем, существует ли для данного пользователя активная привязка(если не существует-создаем активную привязку)
# Если активная привязка существует: проверяем, совпадает ли переданный id организации, с тем что записан в привязке
# В зависимости от этого совпадения, либо переводим текущую привязку в архивный статус и создаем новую в активном статусе, либо просто обновляем текущую привязку

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|workplaces
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|Генерируется каждый раз при вставке новой записи в таблицу workplaces.
|-
|storage
|workplaces
|update
|Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.
''Пример:'' array('old' => $dataobject_old, 'new' => $dataobject_new)
|Генерируется каждый раз при обновлении записи в таблице workplaces.
|-
|storage
|workplaces
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|Генерируется каждый раз при удалении записи из таблицы workplaces.
|}

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:im/employees

2012-11-03T17:07:17Z

Ibragim: /* API */

{{Infobox_Plugin
| name = employees
| type = im
}}
=im/employees - Сотрудники=
Интерфейс Для работы с сотрудниками организации, назначений на должности.
Работает вместе с модулями storage/eagreements, storage/appointments, storage/schpositions, storage/positions и storage/teachers.
Позволяет создавать и редактировать должности и вакансии, договора с сотрудниками и назначения на должности, а также создавать связи для учителей с предметами.

== Список возможных действий и список сотрудников (list.php)==
Здесь находится список все сотрудиников, с которыми заключены договора. Список сотрудников выводится в виде таблицы, с полями:
* ФИО сотрудника (ссылается на сотрудника в таблице persons)
* подразделение
* Договор
* Дата начала работы
* инструменты (ссылка на страницу просмотра договора)

Также на этой странице отображается список возможных операций для назначения сотрудника на должность.
* Список должностей
** Создание новой должности
* Список вакансий
** Создание новой вакансии
* Список назначений
** Создание договора с сотрудником и назначения на должность
** Создание новой должности
** Увольнение сотрудника (пока нет)

== Список должностей ==
На странице отображается список всех должностей.
Дополнительными параметрами являются departmentid (подразделение), name (название должности), code (кодовое название должности). Также можно указать дополнительный параметр status, который отображает должности с указанным статусом. При отсутствии должности с данными параметрами выводится сообщение, что должности не найдены. При отсутствии всех параметров выводится общий список должностей.

Список выводится в виде таблицы. Количество строк таблицы выводимых на одну страницу настраивается в параметрах конфигурации. Если список слишком длинный, то он разбивается на страницы и появляется список ссылок на них.

Вверху списка отображается ссылка на создание новой должности. Также со страницы можно перейти на страницу просмотра или редактирования должности.

== Создание/редактирование должности ==
На этой странице отображается форма, в которой можно определить параметры должности.

'''Назначение полей:'''
* Название - наименование должности.
* Код - кодовое наименование должности. Указывается латинскими буквами в нижнем регистре. Должно быть уникальным.
* Подразделение - подразделение, для которого создается должность.
Ниже стоит галочка, если необходимо автоматически создать вакансии и поле с указанием количества создаваемых вакансий и количеством часов для каждой вакансии. По умолчанию все вакансии создаются на 36 часов. Количество часов можно задать от 1 до 40.

Страница создания и редактирования должности содержит обязательный параметр id.
* Если он передан - то редактируется должность с переданным id
* Если он равен 0 (или передана строка), то будет загружена форма создания новой должности.
* Если передан номер не существующей в БД записи - то будет выведено сообщение об ошибке.

== Просмотр должности ==
На этой странице выводится вся информация об указанной должности. Отсюда можно перейти на страницу редактирования должности, на страницу со списком должностей, просмотреть список вакансий на должности, или создать новую вакансию на данную должность.

Также на этой странице возможно изменить статус должности. Список статусов должности указан в плагине [[Разработка:workflows/positions | workflows/positions ]]

Содержит обязательный параметр id. Если не указан, или указан неверно - выводится сообщение об ошибке.

== Список вакансий ==
На странице отображается список всех вакансий.
Дополнительными параметрами фильтрации являются
* departmentid (подразделение),
* positionid (должность)
* ststus (статус)

Также можно указать дополнительный параметр status, который отображает вакансии с указанным статусом. При отсутствии вакансий с данными параметрами выводится сообщение, что вакансии не найдены. При отсутствии всех параметров выводится общий список вакансий.

Список выводится в виде таблицы. Количество строк таблицы выводимых на одну страницу настраивается в параметрах конфигурации. Если список слишком длинный, то он разбивается на страницы и появляется список ссылок на них.

Вверху списка отображается ссылка на создание новой вакансии. Также со страницы можно перейти на страницу просмотра или редактирования вакансии.

== Создание/редактирование вакансии ==
На этой странице отображается форма, в которой можно определить параметры вакансии.

'''Назначение полей:'''
* Подразделение - подразделение, для которого создается вакансия.
* Должность - выбор должности из списка уже существующих и не отмененных.
* Ставка - указывается время в часах в неделю, которая занимает данная вакансия. Обязательно для заполнения.

Страница создания и редактирования темы содержит обязательный параметр id.
* Если он передан - то редактируется вакансия с переданным id
* Если он равен 0 (или передана строка), то будет загружена форма создания новой вакансии.
* Если он не передан или передан номер не существующей в БД записи - то будет выведено сообщение об ошибке.

== Просмотр вакансии ==
На этой странице выводится вся информация об указанной вакансии. Отсюда можно перейти на страницу редактирования вакансии или на страницу со списком вакансий.
На этой странице также проискходит изменение статуса вакансии. Список статусов вакакнсии указан в плагине [[Разработка:workflows/schpositions | workflows/schpositions ]]

Содержит обязательный параметр id. Если не указан, или указан неверно - выводится сообщение об ошибке.

== Список должностных назначений ==
На странице отображается список всех назначений на должности с договорами сотрудников.
Дополнительными параметрами являются departmentid (подразделение), personid (имя сотрудника, заключившего договор), worktime (ставка) и schposition (вакансия). Также можно указать дополнительный параметр status, который отображает назначения с указанным статусом. При отсутствии назначений с данными параметрами выводится сообщение, что назначения не найдены. При отсутствии всех параметров выводится общий список назначений на должности.

Список выводится в виде таблицы. Количество строк таблицы выводимых на одну страницу настраивается в параметрах конфигурации. Если список слишком длинный, то он разбивается на страницы и появляется список ссылок на них.

Вверху списка отображается ссылка на создание нового назначения и договора с назначением. Также со страницы можно перейти на страницу просмотра или редактирования назначения и договора.

== Создание/редактирование назначения на должность ==
На этой странице отображается форма, в которой можно определить параметры назначения на должность.

'''Назначение полей:'''
* Сотрудник - выбор сотрудника из списка, с которыми заключен договор.
* Должность - выбор вакансии по должности из списка уже существующих и не отмененных.
* Табельный номер - табельный номер сотрудника. Уникальный.
* Ставка - ставка в часах в неделю, которую сотрудник занимает по данной вакансии. Не должна превышать количество свободных часов ставки вакансии.
* Дата - дата назначения сотрудника на должность.
* Подразделение - подразделения, которому назначается сотрудник на должность.

Страница создания и редактирования должности содержит обязательный параметр id.
* Если он передан - то редактируется назначение на должность с переданным id
* Если он равен 0 (или передана строка), то будет загружена форма создания нового назначения.
* Если передан номер не существующей в БД записи - то будет выведено сообщение об ошибке.

== Создание/редактирование договора с сотрудником ==
На этой странице отображается форма, в которой можно определить параметры договора с сотрудником и назначения на должность.

'''Назначение полей:'''
* Тип сотрудника - какой сотрудник будет выбран: пользователь moodle или персона деканата. Если будет выбран пользователь Moodle, то для него автоматически будет создана персона деканата.
* Сотрудник - выбор сотрудника из существующих пользователей, в зависимости от выбранного в первом меню типа.
* Должность - выбор вакансии по должности из списка уже существующих и не отмененных.
* Заметки - какие либо заметки по данному сотруднику.
* Табельный номер - табельный номер сотрудника. Уникальный.
* Ставка - ставка в часах в неделю, которую сотрудник занимает по данной вакансии. Не должна превышать количество свободных часов ставки вакансии.
* Дата - дата назначения сотрудника на должность.
* Подразделение - подразделения, которому назначается сотрудник на должность.

'''Увольнение сотрудника:'''

Ниже отображается форма увольнения сотрудника со всеми занятыми им вакансиями и кнопкой "Уволить", если сотрудник еще не уволен.

Загружается форма, где отображаются все занятые сотрудником вакансии. Напротив каждой ставится отображается галочка "Освободить". Ниже кнопка "Освободить с должностей". Для увольнения сотрудника снизу располагается галочка подтверждающая увольнение сотрудника и кнопка "Уволить". При увольнении сотрудник автоматически освобождается от всех занятых им должностей.

Страница создания и редактирования темы содержит обязательный параметр id.
* Если он передан - то редактируется назначение на должность с переданным id и договор приписанный к назначению.
* Если он равен 0 (или передана строка), то будет загружена форма создания нового назначения с договором.
* Если передан номер не существующей в БД записи - то будет выведено сообщение об ошибке.

== Просмотр назначения на должность ==
На этой странице выводится вся информация об указанном назначении на должность. Отсюда можно перейти на страницу редактирования назначения на должность и/или договора с сотрудником, а также на страницу просмотра договора с сотрудником или на страницу со списком назначений на должности.

Также на этой странице находится форма добавления и удаления предметов в список преподаваемых. Предметы сгруппированы по программам. Справа находится список предметов, которые учитель может преподавать, а слева - которые он будет преподавать. Предметы в левой колонке отмечены разными цветами:
* Серым отмечены предметы которые учитель планирует преподавать
* Черным отмечены предметы, которые учитель уже преподает

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

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

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

Содержит обязательный параметр id. Если не указан, или указан неверно - выводится сообщение об ошибке.

Чтобы таблица с доступными и преподаваемыми дисциплинами не вылезала за ширину экрана, названия и коды дисциплин и программ обрезаются в соответствии с конфигурационными переменными.

Если название было обрезано, в конец добавляется многоточие. Обрезку выполняет метод cut_item_fullname(im/employees)

По умолчанию были приняты следующие значения конфигурационных переменных:

//максимальная длина названия дисциплины

$maxpitemnamelength = 65;

//максимальная длина кода дисциплины

$maxpitemcodelength = 30;

//максимальная длина названия программы

$maxprogrammnamelength = 45;

//максимальная длина кода программы

$maxprogrammcodelength = 30;

== Просмотр договора с сотрудником ==
На этой странице выводится вся информация об указанном договоре с сотрудником. Отсюда можно перейти на страницу со списком назначений на должности. На этой странице также происходит изменение статуса договора. Список статусов договора указан в плагине [[Разработка:workflows/eagreements | workflows/eagreements ]]

Содержит обязательный параметр id. Если не указан, или указан неверно - выводится сообщение об ошибке.

== Список преподавателей дисциплины ==
На этой странице выводится кратная информация о дисциплине:
* Подразделение (ссылка на просмотр подразделения),
* Программа (ссылка на просмотр программы),
* Дисциплина (ссылка на просмотр дисциплины)
А также количество часов, отведенное на преподавание этой дисциплины.

Далее идет список преподавателей, которые ведут эту дисциплину. Преподаватели выводятся в алфавитном порядке, и сортируются по фамилии. Таблица с преподавателями содержит поля:
* порядковый номер
* ФИО (ссылка на данные пользователя в таблице persons)
* табельный номер (ссылка на запись в appointments).
* номер договора (ссылка на договор с сотрудником).
==API==

Здесь описаны функции для работы с сотрудниками.
===== cut_item_fullname() =====
Обрезает переданные строки в соответствии с переданными лимитами и добавляет окончания к строкам. Затем соединяет их в одну(в формате $str1 [$str2])
''Параметры:''
* $str1 - первая часть строки
* $len1 - лимит первой части строки
* $str2 - вторая часть строки
* $len2 - лимит второй части строки
* $appendix - окончание

''Возвращаемые значения:''
* (string) - обрезанная строка $str1 [$str2]

Разработка:im/employees

2012-11-03T16:58:38Z

Ibragim: /* Просмотр назначения на должность */

Разработка:im/employees

2012-11-03T16:57:06Z

Ibragim: /* Просмотр назначения на должность */

{{Infobox_Plugin
| name = employees
| type = im
}}
=im/employees - Сотрудники=
Интерфейс Для работы с сотрудниками организации, назначений на должности.
Работает вместе с модулями storage/eagreements, storage/appointments, storage/schpositions, storage/positions и storage/teachers.
Позволяет создавать и редактировать должности и вакансии, договора с сотрудниками и назначения на должности, а также создавать связи для учителей с предметами.

== Список возможных действий и список сотрудников (list.php)==
Здесь находится список все сотрудиников, с которыми заключены договора. Список сотрудников выводится в виде таблицы, с полями:
* ФИО сотрудника (ссылается на сотрудника в таблице persons)
* подразделение
* Договор
* Дата начала работы
* инструменты (ссылка на страницу просмотра договора)

Также на этой странице отображается список возможных операций для назначения сотрудника на должность.
* Список должностей
** Создание новой должности
* Список вакансий
** Создание новой вакансии
* Список назначений
** Создание договора с сотрудником и назначения на должность
** Создание новой должности
** Увольнение сотрудника (пока нет)

== Список должностей ==
На странице отображается список всех должностей.
Дополнительными параметрами являются departmentid (подразделение), name (название должности), code (кодовое название должности). Также можно указать дополнительный параметр status, который отображает должности с указанным статусом. При отсутствии должности с данными параметрами выводится сообщение, что должности не найдены. При отсутствии всех параметров выводится общий список должностей.

Список выводится в виде таблицы. Количество строк таблицы выводимых на одну страницу настраивается в параметрах конфигурации. Если список слишком длинный, то он разбивается на страницы и появляется список ссылок на них.

Вверху списка отображается ссылка на создание новой должности. Также со страницы можно перейти на страницу просмотра или редактирования должности.

== Создание/редактирование должности ==
На этой странице отображается форма, в которой можно определить параметры должности.

'''Назначение полей:'''
* Название - наименование должности.
* Код - кодовое наименование должности. Указывается латинскими буквами в нижнем регистре. Должно быть уникальным.
* Подразделение - подразделение, для которого создается должность.
Ниже стоит галочка, если необходимо автоматически создать вакансии и поле с указанием количества создаваемых вакансий и количеством часов для каждой вакансии. По умолчанию все вакансии создаются на 36 часов. Количество часов можно задать от 1 до 40.

Страница создания и редактирования должности содержит обязательный параметр id.
* Если он передан - то редактируется должность с переданным id
* Если он равен 0 (или передана строка), то будет загружена форма создания новой должности.
* Если передан номер не существующей в БД записи - то будет выведено сообщение об ошибке.

== Просмотр должности ==
На этой странице выводится вся информация об указанной должности. Отсюда можно перейти на страницу редактирования должности, на страницу со списком должностей, просмотреть список вакансий на должности, или создать новую вакансию на данную должность.

Также на этой странице возможно изменить статус должности. Список статусов должности указан в плагине [[Разработка:workflows/positions | workflows/positions ]]

Содержит обязательный параметр id. Если не указан, или указан неверно - выводится сообщение об ошибке.

== Список вакансий ==
На странице отображается список всех вакансий.
Дополнительными параметрами фильтрации являются
* departmentid (подразделение),
* positionid (должность)
* ststus (статус)

Также можно указать дополнительный параметр status, который отображает вакансии с указанным статусом. При отсутствии вакансий с данными параметрами выводится сообщение, что вакансии не найдены. При отсутствии всех параметров выводится общий список вакансий.

Список выводится в виде таблицы. Количество строк таблицы выводимых на одну страницу настраивается в параметрах конфигурации. Если список слишком длинный, то он разбивается на страницы и появляется список ссылок на них.

Вверху списка отображается ссылка на создание новой вакансии. Также со страницы можно перейти на страницу просмотра или редактирования вакансии.

== Создание/редактирование вакансии ==
На этой странице отображается форма, в которой можно определить параметры вакансии.

'''Назначение полей:'''
* Подразделение - подразделение, для которого создается вакансия.
* Должность - выбор должности из списка уже существующих и не отмененных.
* Ставка - указывается время в часах в неделю, которая занимает данная вакансия. Обязательно для заполнения.

Страница создания и редактирования темы содержит обязательный параметр id.
* Если он передан - то редактируется вакансия с переданным id
* Если он равен 0 (или передана строка), то будет загружена форма создания новой вакансии.
* Если он не передан или передан номер не существующей в БД записи - то будет выведено сообщение об ошибке.

== Просмотр вакансии ==
На этой странице выводится вся информация об указанной вакансии. Отсюда можно перейти на страницу редактирования вакансии или на страницу со списком вакансий.
На этой странице также проискходит изменение статуса вакансии. Список статусов вакакнсии указан в плагине [[Разработка:workflows/schpositions | workflows/schpositions ]]

Содержит обязательный параметр id. Если не указан, или указан неверно - выводится сообщение об ошибке.

== Список должностных назначений ==
На странице отображается список всех назначений на должности с договорами сотрудников.
Дополнительными параметрами являются departmentid (подразделение), personid (имя сотрудника, заключившего договор), worktime (ставка) и schposition (вакансия). Также можно указать дополнительный параметр status, который отображает назначения с указанным статусом. При отсутствии назначений с данными параметрами выводится сообщение, что назначения не найдены. При отсутствии всех параметров выводится общий список назначений на должности.

Список выводится в виде таблицы. Количество строк таблицы выводимых на одну страницу настраивается в параметрах конфигурации. Если список слишком длинный, то он разбивается на страницы и появляется список ссылок на них.

Вверху списка отображается ссылка на создание нового назначения и договора с назначением. Также со страницы можно перейти на страницу просмотра или редактирования назначения и договора.

== Создание/редактирование назначения на должность ==
На этой странице отображается форма, в которой можно определить параметры назначения на должность.

'''Назначение полей:'''
* Сотрудник - выбор сотрудника из списка, с которыми заключен договор.
* Должность - выбор вакансии по должности из списка уже существующих и не отмененных.
* Табельный номер - табельный номер сотрудника. Уникальный.
* Ставка - ставка в часах в неделю, которую сотрудник занимает по данной вакансии. Не должна превышать количество свободных часов ставки вакансии.
* Дата - дата назначения сотрудника на должность.
* Подразделение - подразделения, которому назначается сотрудник на должность.

Страница создания и редактирования должности содержит обязательный параметр id.
* Если он передан - то редактируется назначение на должность с переданным id
* Если он равен 0 (или передана строка), то будет загружена форма создания нового назначения.
* Если передан номер не существующей в БД записи - то будет выведено сообщение об ошибке.

== Создание/редактирование договора с сотрудником ==
На этой странице отображается форма, в которой можно определить параметры договора с сотрудником и назначения на должность.

'''Назначение полей:'''
* Тип сотрудника - какой сотрудник будет выбран: пользователь moodle или персона деканата. Если будет выбран пользователь Moodle, то для него автоматически будет создана персона деканата.
* Сотрудник - выбор сотрудника из существующих пользователей, в зависимости от выбранного в первом меню типа.
* Должность - выбор вакансии по должности из списка уже существующих и не отмененных.
* Заметки - какие либо заметки по данному сотруднику.
* Табельный номер - табельный номер сотрудника. Уникальный.
* Ставка - ставка в часах в неделю, которую сотрудник занимает по данной вакансии. Не должна превышать количество свободных часов ставки вакансии.
* Дата - дата назначения сотрудника на должность.
* Подразделение - подразделения, которому назначается сотрудник на должность.

'''Увольнение сотрудника:'''

Ниже отображается форма увольнения сотрудника со всеми занятыми им вакансиями и кнопкой "Уволить", если сотрудник еще не уволен.

Загружается форма, где отображаются все занятые сотрудником вакансии. Напротив каждой ставится отображается галочка "Освободить". Ниже кнопка "Освободить с должностей". Для увольнения сотрудника снизу располагается галочка подтверждающая увольнение сотрудника и кнопка "Уволить". При увольнении сотрудник автоматически освобождается от всех занятых им должностей.

Страница создания и редактирования темы содержит обязательный параметр id.
* Если он передан - то редактируется назначение на должность с переданным id и договор приписанный к назначению.
* Если он равен 0 (или передана строка), то будет загружена форма создания нового назначения с договором.
* Если передан номер не существующей в БД записи - то будет выведено сообщение об ошибке.

== Просмотр назначения на должность ==
На этой странице выводится вся информация об указанном назначении на должность. Отсюда можно перейти на страницу редактирования назначения на должность и/или договора с сотрудником, а также на страницу просмотра договора с сотрудником или на страницу со списком назначений на должности.

Также на этой странице находится форма добавления и удаления предметов в список преподаваемых. Предметы сгруппированы по программам. Справа находится список предметов, которые учитель может преподавать, а слева - которые он будет преподавать. Предметы в левой колонке отмечены разными цветами:
* Серым отмечены предметы которые учитель планирует преподавать
* Черным отмечены предметы, которые учитель уже преподает

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

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

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

Содержит обязательный параметр id. Если не указан, или указан неверно - выводится сообщение об ошибке.

Чтобы таблица с доступными и преподаваемыми дисциплинами не вылезала за ширину экрана, названия и коды дисциплин и программ обрезаются в соответствии с конфигурационными переменными.<br/>
Если название было обрезано, в конец добавляется многоточие. Обрезку выполняет метод cut_item_fullname(im/employees)
По умолчанию были приняты следующие значения конфигурационных переменных
//максимальная длина названия дисциплины
$maxpitemnamelength = 65;
//максимальная длина кода дисциплины
$maxpitemcodelength = 30;
//максимальная длина названия программы
$maxprogrammnamelength = 45;
//максимальная длина кода программы
$maxprogrammcodelength = 30;

== Просмотр договора с сотрудником ==
На этой странице выводится вся информация об указанном договоре с сотрудником. Отсюда можно перейти на страницу со списком назначений на должности. На этой странице также происходит изменение статуса договора. Список статусов договора указан в плагине [[Разработка:workflows/eagreements | workflows/eagreements ]]

Содержит обязательный параметр id. Если не указан, или указан неверно - выводится сообщение об ошибке.

== Список преподавателей дисциплины ==
На этой странице выводится кратная информация о дисциплине:
* Подразделение (ссылка на просмотр подразделения),
* Программа (ссылка на просмотр программы),
* Дисциплина (ссылка на просмотр дисциплины)
А также количество часов, отведенное на преподавание этой дисциплины.

Далее идет список преподавателей, которые ведут эту дисциплину. Преподаватели выводятся в алфавитном порядке, и сортируются по фамилии. Таблица с преподавателями содержит поля:
* порядковый номер
* ФИО (ссылка на данные пользователя в таблице persons)
* табельный номер (ссылка на запись в appointments).
* номер договора (ссылка на договор с сотрудником).
==API==

Разработка:storages/persons

2012-10-31T18:02:30Z

Ibragim: /* Подробный формат полей в таблице: */

{{Infobox_Plugin
| name = persons
| type = storages
}}
===Таблица в базе данных===
''persons'' - адресная книга, в которую включены все участники учебного процесса: учащиеся, законные представители, сотрудники, преподаватели и т. д.

====Подробный формат полей в таблице:====
*firstname - имя
*middlename - отчество
*lastname - фамилия
*sortname - ФИО для сортировки по умолчанию (нужно ли оно?)
*preferredname - префикс для имения (Mr. Dr. Г-н, Г-а)
*dateofbirth - дата рождения у UTS
*gender - пол (male, female, unknown)
*email - основной адрес электронной почты
*phonehome - домашний телефон
*phonework - рабочий телефон
*phonecell - сотовый телефон
*passtypeid - тип удостоверения личности (1 - свидетельство о рождение, 2 - паспорт гражданина РФ, 3 - загранпасспорт, 4 - разрешение на временное проживание лица без гражданства, 5 - вид на жительство, 6 - военный билет, 7 - водительсткое удостоверение пластиковое, 8 - вод. удостоверение форма 1, 9 - вод. удостоверение международное)
*passportserial - серия удостоверения личности (если предусмотрена типом документа)
*passportnum - номер удостоверения личности
*passportdate - дата выдачи удостоверения личности
*passportem - название организации, выдавшей удостоверение личности
*citizenship - гражданство
*passportaddrid - адрес прописки по паспорту
*mdluser - id пользователя в moodle (если есть)
*sync2moodle - признак синхронизации с moodle
** 1 - синхронизирован и имеет mdluser (id пользователя в Moodle)
** 0 - не синхронизирован и по идее не должен иметь mdluser
*addressid - текущий адрес
*status - Статусы персоны (normal, deleted, archived)
*adddate - дата добавления
*departmentid - основной отдел, к которому приписан человек (может редактировать его данные в persons)

===Дополнительные методы:===

===='''get_bu($userid = NULL,$create=false)'''====

Получение объект по moodleid

''Аргументы:''
* (int) $userid - id пользователя в moodle, по умолчанию null
* (bool) $create создание персоны по текущему пользователю, по умолчанию false,
''Возвращаемые значения:''
* object - данные персоны

===='''get_by_moodleid($muserid = NULL,$create=false)'''====

Получение объект по moodleid

''Аргументы:''
* (int) $muserid - id пользователя в moodle, по умолчанию null
* (bool) $create создание персоны по текущему пользователю, по умолчанию false,
''Возвращаемые значения:''
* object - данные персоны

===='''get_by_moodleid_id($muserid = NULL,$create=false)'''====

Получение объект по moodleid

''Аргументы:''
* (int) $muserid - id пользователя в moodle,если не указан берется $USER->id. По умолчанию null
* (bool) $create создание персоны по текущему пользователю, по умолчанию false,
''Возвращаемые значения:''
* mixed (int) id персоны или (bool) - false

===='''get_list_synced()'''====

Получает список синхронизируемых персон.

''Аргументы:''
нет
''Возвращаемые значения:''
* (array) список персон, требующих синхронизации.

===='''get_list_normal()'''====

Получение списка неудаленных персон.

''Аргументы:''
нет
''Возвращаемые значения:''
* (array) список неудаленных персон.

===='''get_list_search_lastname($query)'''====

Получение списка персон по запрашиваемой фамилии

''Аргументы:''
* (str) $query - фамилия, которую ищем.
''Возвращаемые значения:''
* (array) список персон.

===='''get_list_search($query)'''====

Получение списка персон по запрашиваемой фамилии

''Аргументы:''
* (str) $query - фамилия, или отчество, или имя, или $mail, или usermoodle, которые ищем.
''Возвращаемые значения:''
* (array) список персон.

===='''is_email_unique($email)'''====

Проверяет, если другие персоны с указанным email.

''Аргументы:''
* (str) $email - электронный адрес, который ищем.
''Возвращаемые значения:''
* (bool) true - нет, false - да.

===='''reg_moodleuser($USER)'''====

Регестрирует персону для переданного пользователя Moodle

''Аргументы:''
* (obj) $USER - пользователь Moodle.
''Возвращаемые значения:''
* (int) id созданной персоны в таблице [[Разработка:storages/persons | persons ]]
* (bool) false если запись не удалась.

===='''get_fullname($id)'''====

Возвращает полное имя пользователя в формате ФИО.

''Аргументы:''
* (int) $id - id записи пользователя, чье имя необходимо
''Возвращаемые значения:''
* (str) - полное имя пользователя или пустая строка, если пользователь не найден.

===Планы:===
====Дополнительные методы:====
*Получить запись вместе с адресом
*Сохранить (добавить или обновить) запись вместе с адресом
*Найти список людей, относящихся к структурному подразделению
*Удалить (изменить статус на "удален")

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|persons
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|Генерируется каждый раз при вставке новой записи в таблицу persons.
|-
|storage
|persons
|update
|Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.
''Пример:'' array('old' => $dataobject_old, 'new' => $dataobject_new)
|Генерируется каждый раз при обновлении записи в таблице persons.
|-
|storage
|persons
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|Генерируется каждый раз при удалении записи из таблицы persons.
|}

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/metacontracts

2012-10-17T13:34:10Z

Ibragim:

{{Infobox_Plugin
| name = metacontracts
| type = storages
}}

==Таблица в базе данных==
''metacontracts'' - таблица для хранения данных [[Разработка:storages/metacontracts | метаконтрактов]].

===Подробный формат полей в таблице:===
* organizationid - id организации в таблице [[Разработка:storages/organizations | organizations ]]
* num - номер метаконтракта
* departmentid - id подразделения

===Дополнительные методы:===
===='''widgets_field_variants_list($querytype, $depid, $data)'''====

Обработка AJAX-запросов из форм.

''Аргументы:''
* $querytype(string) - тип запроса
* $depid(int) - подразделение, в котором ищутся организации
* $data(array) - дополнительные данные пришедшие из json-запроса
''Возвращаемые значения:''
* (array) - массив полученных обьектов.
''Структура работы:''
# Через case перебираем тип запроса и в зависимости от этого вызываем нужный метод.
# Возвращаем массив вида array(0 => $this->dof->modlib('ig')->igs('choose')), если такого типа запроса нет.

===='''widgets_metacontracts_list($departmentid, $fullname)'''====

Получить список метаконтрактов по первым буквам номера метаконтракта, айди метаконтракта

''Аргументы:''
* $departmentid(int) - подразделение, в котором ищутся метаконтракты
* $fullname(string) - первые несколько букв какого либо поля
''Возвращаемые значения:''
* (array) - массив полученных обьектов.
''Структура работы:''
# Формируем SQL запрос на получение похожих на строку $fullname данных по нескольким полям
# Отправляем запрос базе.
# Формируем полученные из базы данные в массив объектов для возвращения в форму.

Разработка:storages/organizations

2012-10-17T13:32:46Z

Ibragim:

{{Infobox_Plugin
| name = organizations
| type = storages
}}

===Таблица в базе данных===
''organizations''

====Подробный формат полей в таблице:====
* fullname - полное наименование
* shortname - краткое наименование
* inn - идентификационный номер налогоплательщика
* kpp - код причины поставки на учет
* ogrn - основной государственный регистрационный номер
* bankrequisites - банковские реквизиты
* legaladdressid - юридический адрес
* currentaddressid - физический адрес
* mailingaddressid - почтовый адрес
* phone - телефон
* fax - факс
* additionalrequisites - дополнительные реквизиты
* head - ФИО руководителя
* posthead - должность руководителя
* actionhead - основание действия руководителя

===Дополнительные методы:===
===='''widgets_field_variants_list($querytype, $depid, $data)'''====

Обработка AJAX-запросов из форм.

''Аргументы:''
* $querytype(string) - тип запроса
* $depid(int) - подразделение, в котором ищутся организации
* $data(array) - дополнительные данные пришедшие из json-запроса
''Возвращаемые значения:''
* (array) - массив полученных обьектов.
''Структура работы:''
# Через case перебираем тип запроса и в зависимости от этого вызываем нужный метод.
# Возвращаем массив вида array(0 => $this->dof->modlib('ig')->igs('choose')), если такого типа запроса нет.

===='''widgets_organizations_list($departmentid, $fullname)'''====

Получить список организаций по первым буквам полного имени, короткого имени,ИНН,ОГРН,телефонного номера и айди

''Аргументы:''
* $departmentid(int) - подразделение, в котором ищутся организации
* $fullname(string) - первые несколько букв какого либо поля
''Возвращаемые значения:''
* (array) - массив полученных обьектов.
''Структура работы:''
# Формируем SQL запрос на получение похожих на строку $fullname данных по нескольким полям
# Отправляем запрос базе.
# Формируем полученные из базы данные в массив объектов для возвращения в форму.

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|organizations
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|Генерируется каждый раз при вставке новой записи в таблицу organizations.
|-
|storage
|organizations
|update
|Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.
''Пример:'' array('old' => $dataobject_old, 'new' => $dataobject_new)
|Генерируется каждый раз при обновлении записи в таблице organizations.
|-
|storage
|organizations
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|Генерируется каждый раз при удалении записи из таблицы organizations.
|}

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/workplaces

2012-10-17T13:24:54Z

Ibragim:

Разработка:storages/persons

2012-10-17T13:20:44Z

Ibragim:

{{Infobox_Plugin
| name = persons
| type = storages
}}
===Таблица в базе данных===
''persons'' - адресная книга, в которую включены все участники учебного процесса: учащиеся, законные представители, сотрудники, преподаватели и т. д.

====Подробный формат полей в таблице:====
*firstname - имя
*middlename - отчество
*lastname - фамилия
*sortname - ФИО для сортировки по умолчанию (нужно ли оно?)
*preferredname - префикс для имения (Mr. Dr. Г-н, Г-а)
*dateofbirth - дата рождения у UTS
*gender - пол (male, female, unknown)
*email - основной адрес электронной почты
*phonehome - домашний телефон
*phonework - рабочий телефон
*phonecell - сотовый телефон
*passtypeid - тип удостоверения личности (1 - свидетельство о рождение, 2 - паспорт гражданина РФ, 3 - загранпасспорт, 4 - разрешение на временное проживание лица без гражданства, 5 - вид на жительство, 6 - военный билет, 7 - водительсткое удостоверение пластиковое, 8 - вод. удостоверение форма 1, 9 - вод. удостоверение международное)
*passportserial - серия удостоверения личности (если предусмотрена типом документа)
*passportnum - номер удостоверения личности
*passportdate - дата выдачи удостоверения личности
*passportem - название организации, выдавшей удостоверение личности
*citizenship - гражданство
*passportaddrid - адрес прописки по паспорту
*mdluser - id пользователя в moodle (если есть)
*sync2moodle - признак синхронизации с moodle
** 1 - синхронизирован и имеет mdluser (id пользователя в Moodle)
** 0 - не синхронизирован и по идее не должен иметь mdluser
*addressid - текущий адрес
*status - Статусы персоны (normal, deleted, archived)
*adddate - дата добавления
*organizationid - id организации в таблице [[Разработка:storages/organizations | organizations ]]
*workplaceid - id объекта в таблице [[Разработка:storages/workplaces | workplaces ]]
*departmentid - основной отдел, к которому приписан человек (может редактировать его данные в persons)

===Дополнительные методы:===

===='''get_bu($userid = NULL,$create=false)'''====

Получение объект по moodleid

''Аргументы:''
* (int) $userid - id пользователя в moodle, по умолчанию null
* (bool) $create создание персоны по текущему пользователю, по умолчанию false,
''Возвращаемые значения:''
* object - данные персоны

===='''get_by_moodleid($muserid = NULL,$create=false)'''====

Получение объект по moodleid

''Аргументы:''
* (int) $muserid - id пользователя в moodle, по умолчанию null
* (bool) $create создание персоны по текущему пользователю, по умолчанию false,
''Возвращаемые значения:''
* object - данные персоны

===='''get_by_moodleid_id($muserid = NULL,$create=false)'''====

Получение объект по moodleid

''Аргументы:''
* (int) $muserid - id пользователя в moodle,если не указан берется $USER->id. По умолчанию null
* (bool) $create создание персоны по текущему пользователю, по умолчанию false,
''Возвращаемые значения:''
* mixed (int) id персоны или (bool) - false

===='''get_list_synced()'''====

Получает список синхронизируемых персон.

''Аргументы:''
нет
''Возвращаемые значения:''
* (array) список персон, требующих синхронизации.

===='''get_list_normal()'''====

Получение списка неудаленных персон.

''Аргументы:''
нет
''Возвращаемые значения:''
* (array) список неудаленных персон.

===='''get_list_search_lastname($query)'''====

Получение списка персон по запрашиваемой фамилии

''Аргументы:''
* (str) $query - фамилия, которую ищем.
''Возвращаемые значения:''
* (array) список персон.

===='''get_list_search($query)'''====

Получение списка персон по запрашиваемой фамилии

''Аргументы:''
* (str) $query - фамилия, или отчество, или имя, или $mail, или usermoodle, которые ищем.
''Возвращаемые значения:''
* (array) список персон.

===='''is_email_unique($email)'''====

Проверяет, если другие персоны с указанным email.

''Аргументы:''
* (str) $email - электронный адрес, который ищем.
''Возвращаемые значения:''
* (bool) true - нет, false - да.

===='''reg_moodleuser($USER)'''====

Регестрирует персону для переданного пользователя Moodle

''Аргументы:''
* (obj) $USER - пользователь Moodle.
''Возвращаемые значения:''
* (int) id созданной персоны в таблице [[Разработка:storages/persons | persons ]]
* (bool) false если запись не удалась.

===='''get_fullname($id)'''====

Возвращает полное имя пользователя в формате ФИО.

''Аргументы:''
* (int) $id - id записи пользователя, чье имя необходимо
''Возвращаемые значения:''
* (str) - полное имя пользователя или пустая строка, если пользователь не найден.

===Планы:===
====Дополнительные методы:====
*Получить запись вместе с адресом
*Сохранить (добавить или обновить) запись вместе с адресом
*Найти список людей, относящихся к структурному подразделению
*Удалить (изменить статус на "удален")

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|persons
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|Генерируется каждый раз при вставке новой записи в таблицу persons.
|-
|storage
|persons
|update
|Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.
''Пример:'' array('old' => $dataobject_old, 'new' => $dataobject_new)
|Генерируется каждый раз при обновлении записи в таблице persons.
|-
|storage
|persons
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|Генерируется каждый раз при удалении записи из таблицы persons.
|}

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/persons

2012-10-17T13:05:25Z

Ibragim:

{{Infobox_Plugin
| name = persons
| type = storages
}}
===Таблица в базе данных===
''persons'' - адресная книга, в которую включены все участники учебного процесса: учащиеся, законные представители, сотрудники, преподаватели и т. д.

====Подробный формат полей в таблице:====
*firstname - имя
*middlename - отчество
*lastname - фамилия
*sortname - ФИО для сортировки по умолчанию (нужно ли оно?)
*preferredname - префикс для имения (Mr. Dr. Г-н, Г-а)
*dateofbirth - дата рождения у UTS
*gender - пол (male, female, unknown)
*email - основной адрес электронной почты
*phonehome - домашний телефон
*phonework - рабочий телефон
*phonecell - сотовый телефон
*passtypeid - тип удостоверения личности (1 - свидетельство о рождение, 2 - паспорт гражданина РФ, 3 - загранпасспорт, 4 - разрешение на временное проживание лица без гражданства, 5 - вид на жительство, 6 - военный билет, 7 - водительсткое удостоверение пластиковое, 8 - вод. удостоверение форма 1, 9 - вод. удостоверение международное)
*passportserial - серия удостоверения личности (если предусмотрена типом документа)
*passportnum - номер удостоверения личности
*passportdate - дата выдачи удостоверения личности
*passportem - название организации, выдавшей удостоверение личности
*citizenship - гражданство
*passportaddrid - адрес прописки по паспорту
*mdluser - id пользователя в moodle (если есть)
*sync2moodle - признак синхронизации с moodle
** 1 - синхронизирован и имеет mdluser (id пользователя в Moodle)
** 0 - не синхронизирован и по идее не должен иметь mdluser
*addressid - текущий адрес
*status - Статусы персоны (normal, deleted, archived)
*adddate - дата добавления
*organizationid - id организации в таблице [[Разработка:storages/organizations | organizations ]]
*workplaceid - id объекта в таблице [[Разработка:storages/workplaces | workplaces ]]
*departmentid - основной отдел, к которому приписан человек (может редактировать его данные в persons)

===Дополнительные методы:===

===='''get_bu($userid = NULL,$create=false)'''====

Получение объект по moodleid

''Аргументы:''
* (int) $userid - id пользователя в moodle, по умолчанию null
* (bool) $create создание персоны по текущему пользователю, по умолчанию false,
''Возвращаемые значения:''
* object - данные персоны

===='''get_by_moodleid($muserid = NULL,$create=false)'''====

Получение объект по moodleid

''Аргументы:''
* (int) $muserid - id пользователя в moodle, по умолчанию null
* (bool) $create создание персоны по текущему пользователю, по умолчанию false,
''Возвращаемые значения:''
* object - данные персоны

===='''get_by_moodleid_id($muserid = NULL,$create=false)'''====

Получение объект по moodleid

''Аргументы:''
* (int) $muserid - id пользователя в moodle,если не указан берется $USER->id. По умолчанию null
* (bool) $create создание персоны по текущему пользователю, по умолчанию false,
''Возвращаемые значения:''
* mixed (int) id персоны или (bool) - false

===='''get_list_synced()'''====

Получает список синхронизируемых персон.

''Аргументы:''
нет
''Возвращаемые значения:''
* (array) список персон, требующих синхронизации.

===='''get_list_normal()'''====

Получение списка неудаленных персон.

''Аргументы:''
нет
''Возвращаемые значения:''
* (array) список неудаленных персон.

===='''get_list_search_lastname($query)'''====

Получение списка персон по запрашиваемой фамилии

''Аргументы:''
* (str) $query - фамилия, которую ищем.
''Возвращаемые значения:''
* (array) список персон.

===='''get_list_search($query)'''====

Получение списка персон по запрашиваемой фамилии

''Аргументы:''
* (str) $query - фамилия, или отчество, или имя, или $mail, или usermoodle, которые ищем.
''Возвращаемые значения:''
* (array) список персон.

===='''is_email_unique($email)'''====

Проверяет, если другие персоны с указанным email.

''Аргументы:''
* (str) $email - электронный адрес, который ищем.
''Возвращаемые значения:''
* (bool) true - нет, false - да.

===='''reg_moodleuser($USER)'''====

Регестрирует персону для переданного пользователя Moodle

''Аргументы:''
* (obj) $USER - пользователь Moodle.
''Возвращаемые значения:''
* (int) id созданной персоны в таблице [[Разработка:storages/persons | persons ]]
* (bool) false если запись не удалась.

===='''get_fullname($id)'''====

Возвращает полное имя пользователя в формате ФИО.

''Аргументы:''
* (int) $id - id записи пользователя, чье имя необходимо
''Возвращаемые значения:''
* (str) - полное имя пользователя или пустая строка, если пользователь не найден.

===Планы:===
====Дополнительные методы:====
*Получить запись вместе с адресом
*Сохранить (добавить или обновить) запись вместе с адресом
*Найти список людей, относящихся к структурному подразделению
*Удалить (изменить статус на "удален")

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|persons
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|Генерируется каждый раз при вставке новой записи в таблицу persons.
|-
|storage
|persons
|update
|Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.
''Пример:'' array('old' => $dataobject_old, 'new' => $dataobject_new)
|Генерируется каждый раз при обновлении записи в таблице persons.
|-
|storage
|persons
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|Генерируется каждый раз при удалении записи из таблицы persons.
|}

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/organizations

2012-10-17T12:53:02Z

Ibragim: /* Дополнительные методы: */

{{Infobox_Plugin
| name = organizations
| type = storages
}}

===Таблица в базе данных===
''organizations''

====Подробный формат полей в таблице:====
* fullname - полное наименование
* shortname - краткое наименование
* inn - идентификационный номер налогоплательщика
* kpp - код причины поставки на учет
* ogrn - основной государственный регистрационный номер
* bankrequisites - банковские реквизиты
* legaladdressid - юридический адрес
* currentaddressid - физический адрес
* mailingaddressid - почтовый адрес
* phone - телефон
* fax - факс
* additionalrequisites - дополнительные реквизиты
* head - ФИО руководителя
* posthead - должность руководителя
* actionhead - основание действия руководителя

===Дополнительные методы:===
===='''widgets_field_variants_list($querytype, $depid, $data)'''====

Обработка AJAX-запросов из форм.

''Аргументы:''
* $querytype(string) - тип запроса
* $depid(int) - подразделение, в котором ищутся организации
* $data(array) - дополнительные данные пришедшие из json-запроса
''Возвращаемые значения:''
* (array) - массив полученных обьектов.
''Структура работы:''
# Через case перебираем тип запроса и в зависимости от этого вызываем нужный метод.
# Возвращаем массив вида array(0 => $this->dof->modlib('ig')->igs('choose')), если такого типа запроса нет.

===='''widgets_organizations_list($departmentid, $fullname)'''====

Получить список организация по первым буквам полного имени, короткого имени,ИНН,ОГРН,телефонного номера и айди

''Аргументы:''
* $departmentid(int) - подразделение, в котором ищутся организации
* $fullname(string) - первые несколько букв какого либо поля
''Возвращаемые значения:''
* (array) - массив полученных обьектов.
''Структура работы:''
# Формируем SQL запрос на получение похожих на строку $fullname данных по нескольким полям
# Отправляем запрос базе.
# Формируем полученные из базы данные в массив объектов для возвращения в форму.

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|organizations
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|Генерируется каждый раз при вставке новой записи в таблицу organizations.
|-
|storage
|organizations
|update
|Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.
''Пример:'' array('old' => $dataobject_old, 'new' => $dataobject_new)
|Генерируется каждый раз при обновлении записи в таблице organizations.
|-
|storage
|organizations
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|Генерируется каждый раз при удалении записи из таблицы organizations.
|}

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/contracts

2012-10-17T12:32:02Z

Ibragim:

{{Infobox_Plugin
| name = contracts
| type = storages
}}

===Таблица в базе данных===
''contracts'' - договор учащегося с учебным заведением. Отношения учащегося с учебного заведения начинаются с явного или подразумеваемого заключения договора на оказание образовательных услуг, выражающегося в виде записи в таблице contracts, связывающей учащегося, куратора и законного представителя.

====Подробный формат полей в таблице:====
* typeid - тип договора, если у учебного заведения предусмотрено несколько разных типов договоров
* num - номер договора
* numpass - номер пропуска, студенческого билета и т.п.
* date - дата заключения
* sellerid - менеджер по работе с клиентами (приемная комиссия, партнер) - добавляет договор, меняет статус до "подписан клиентом", отслеживает статус договора и ход обучения (id по таблице [[Разработка:storages/persons | persons ]])
* clientid - клиент, оплачивающий обучение (законный представитель, сам совершеннолетний ученик или куратор от организации, может принимать значение 0 или null, если клиент создается, а контракт имеет черновой вариант) (по таблице [[Разработка:storages/persons | persons ]])
* studentid - ученик ( может принимать значение 0, если ученик создается, а контракт имеет черновой вариант) (по таблице [[Разработка:storages/persons | persons ]])
* adddate - дата добавления в БД
* notes - заметки
* departmentid - подразделение в таблице [[Разработка:storages/departments | departments ]], к которому приписан контракт на обучение (например, принявшее ученика)
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/contracts | contracts ]]
* contractform - форма договора (шаблон)
* organizationid - юридическое лицо в таблице [[Разработка:storages/organizations | organizations ]], оплачивающее договор, если ученик платит за себя сам - то не указывается.
* curatorid - куратор или классный руководитель данного ученика (по таблице [[Разработка:storages/persons | persons ]] или не указан), отслеживает учебный процесс, держит связь с учеником, является посредником между учеником и системой, может быть внешней персоной.
* enddate - дата окончания договора
* metacontractid - id метаконтракта, к которому привязан контракт, в таблице [[Разработка:storages/metacontracts | metacontracts ]]

===Дополнительные методы:===

===='''insert($dataobject,$quiet=NULL)'''====

Вставляет запись в таблицу(ы) плагина.

''Аргументы:''
* dataobject(object) - запись.
* $quiet(bool) - определяет, создавать ли события, по умолчанию - null.
''Возвращаемые значения:''
* int - id вставленной записи.
* bool - false, если операция не удалась.

===='''get_list_by_seller($pid = NULL)'''====

Ищет список действующих контрактов для куратора.

''Аргументы:''
* $pid(int) - id персоны-куратора в таблице [[Разработка:storages/persons | persons ]], по умолчанию - null.
''Возвращаемые значения:''
* (array) - список контрактов.
* (bool) - false, если контракты не найдены.
''Структура работы:''
# если id персоны не указано, устанавливаем id текущего пользователя.
# по SQL-запросу находим список необходимых контрактов.

===='''get_list_by_client($pid = NULL)'''====

Ищет список действующих контрактов, заключенных данным клиентом.

''Аргументы:''
* $pid(int) - id персоны-клиента в таблице [[Разработка:storages/persons | persons ]], по умолчанию - null.
''Возвращаемые значения:''
* (array) - список контрактов.
* (bool) - false, если контракты не найдены.
''Структура работы:''
# если id персоны не указано, устанавливаем id текущего пользователя.
# по SQL-запросу находим список необходимых контрактов.

===='''get_list_by_student($pid = NULL)'''====

Ищет список действующих контрактов для студента.

''Аргументы:''
* $pid(int) - id персоны-студента в таблице [[Разработка:storages/persons | persons ]], по умолчанию - null.
''Возвращаемые значения:''
* (array) - список контрактов.
* (bool) - fals, если контракты не найдены.
''Структура работы:''
# если id персоны не указано, устанавливаем id текущего пользователя.
# по SQL-запросу находим список необходимых контрактов.

===='''get_list_by_status($status)'''====

Ищет список контрактов по статусу.

''Аргументы:''
* $status(string) - статус контракта.
''Возвращаемые значения:''
* (array) - список контрактов.
* (bool) - false, если контракты не найдены.

===='''is_person_used($pid,$except=null)'''====

Проверяет есть ли другие активные договора, где используется учетная запись.

''Аргументы:''
* $pid(int) - id персоны в таблице [[Разработка:storages/persons | persons ]].
* $except(int) - id контракта, который следует исключить, по умолчанию - null.
''Возвращаемые значения:''
* (bool) - true, если контракты были найдены и false, если их нет.
''Структура работы:''
# формируем SQL-запрос.
# если задан контракт, который слудует исключить, исключаем его из поиска.
# находим конракты и возвращаем результат.

===='''is_seller($contractid = null,$personid = null)'''====

Проверяет, является ли персона куратором по контракту.

''Аргументы:''
* $contractid(int) - id контракта, по умолчанию - null.
* $personid(int) - id персоны в таблице [[Разработка:storages/persons | persons ]], по умолчанию - null.
''Возвращаемые значения:''
* (bool) - true, если да и false, если нет.

===='''is_student($contractid = null,$personid = null)'''====

Проверяет, является ли персона студентом.

''Аргументы:''
* $contractid(int) - id контракта, по умолчанию - null.
* $personid(int) - id персоны в таблице [[Разработка:storages/persons | persons ]], по умолчанию - null.
''Возвращаемые значения:''
* (bool) - true, если да и false, если нет.

===='''is_client($contractid = null,$personid = null)'''====

Проверяет, является ли персона клиентом.

''Аргументы:''
* $contractid(int) - id контракта, по умолчанию - null.
* $personid(int) - id персоны в таблице [[Разработка:storages/persons | persons ]], по умолчанию - null.
''Возвращаемые значения:''
* (bool) - true, если да и false, если нет.

===='''is_personel($userid, $except=null, $where = 'moodle')'''====

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

''Аргументы:''
* $mdluser(int) - id пользователя в moodle
* $except(bool) - id контракта, который надо исключить из поиска
* $where(string) - идентификатор происхождения id пользователя: mоodle - id из таблицы mdl_user, fdo - из таблицы [[Разработка:storages/persons | persons ]]
''Возвращаемые значения:''
* (bool) - true, если да и false, если нет.

===='''get_seller($id)'''====

Находит ФИО продавца и его id по id контракта

''Аргументы:''
* $id(int) - id контракта.
''Возвращаемые значения:''
* (object) - ФИО продовца и его id.
* (bool) - false, если произошла ошибка.

===='''get_contracts_for_person($pid = NULL)'''====

Находит список договоров для конкретной персоны.

''Аргументы:''
* $pid(int) - id персоны, по умолчанию - null.
''Возвращаемые значения:''
* (array) - список контрактов.

===Планы:===
====Дополнительные методы:====
* Сгенерировать номер контракта
* Найти контракт по номеру
* Найти контракт по номеру пропуска
* Найти список действующих контрактов, относящихся к структурному подразделению

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|contracts
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|Генерируется каждый раз при вставке новой записи в таблицу contracts.
|-
|storage
|contracts
|update
|Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.
''Пример:'' array('old' => $dataobject_old, 'new' => $dataobject_new)
|Генерируется каждый раз при обновлении записи в таблице contracts.
|-
|storage
|contracts
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|Генерируется каждый раз при удалении записи из таблицы contracts.
|}

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/agroups

2012-10-17T12:19:57Z

Ibragim:

{{Infobox_Plugin
| name = agroups
| type = storages
}}

===Таблица в базе данных===
''agroups'' - классы/академические группы. Связывают контракты на обучение и учебные программы при групповой форме обучения.

====Подробный формат полей в таблице:====
* name - название академической группы/класса
* code - кодовое обозначение группы (текстовое поле, обязательное, уникальное)
* programmid - id учебной программы в таблице [[Разработка:storages/programms | programms ]], которую реализует академическая группа
* departmentid - отдел в таблице [[Разработка:storages/departments | departments ]], ответственный за группу
* agenum - порядковый номер текущего учебного периода (изменяется приказом по контингенту). Параллель группы может быти изменена только если группа находится в статусе "формируется".
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/agroups | agroups ]]
* metacontractid - id заключенного с группой метаконтракта в таблице [[Разработка:storages/metacontracts | metacontracts ]]

===Дополнительные методы:===

===='''insert($dataobject,$quiet=NULL)'''====

Вставляет запись в таблицу(ы) плагина

''Аргументы:''
* $dataobject(object) - данные записи.
* $quiet(bool) - генерировать или нет события, по умолчанию null.
''Возвращаемые значения:''
* int - id вставленной записи.
* bool - false, если операция не удалась.

===='''search_group_code($code)'''====

находит группу по коду

''Аргументы:''
* $code - код группы.
''Возвращаемые значения:''
* object - объект группы.
* bool - false, если группа не найдена.

===='''get_groups_programm($prid, $status = 'learn', $agenum = null, $dpid = null)'''====

находит все группы, обучающиеся по учебной программе.

''Аргументы:''
* $prid(int) - id программы в таблице [[Разработка:storages/programms | programms ]].
* $status(string) - статус группы, по умолчанию - 'learn'.
* $agenum(int) - номер периода, по умолчанию - null.
* $dpid(int) - id структурного подразделения, по умолчанию - null.
''Возвращаемые значения:''
* array - список групп.
* bool - false, если группы не найдены.
''Структура работы:''
* формируем SQL-запрос и возвращаем список групп:
** если указывается статус - группы с указанным статусом,
** если статус указывается null - группы с любым статусом,
** если статус не указывается - группы со статусом learn.
** если указывается номер периода - группы с указанным периодом,
** если номер периода указывается null или не указывается - группы с любым периодом.
** если указывается id подразделения - группы указанного подразделения,
** если id подразделения указывается null или не указывается - группы любого подразделения.

===='''get_group_department($dpid, $prid = null, $status = 'learn')'''====

Получает все группы, относящиеся к структурному подразделению и обучающиеся по программе

''Аргументы:''
* $dpid(int) - id структурного подразделения в таблице [[Разработка:storages/departments | departments ]].
* $prid(int) - id программы в таблице [[Разработка:storages/programms | programms ]], по умолчанию - все(null).
* $status(string) - статус группы, по умолчанию - 'learn'.
''Возвращаемые значения:''
* array - список групп.
* bool - false, если группы не найдены.
''Структура работы:''
* формируем SQL-запрос и возвращаем список групп:
** если указывается id программы - группы с указанным id,
** если id программы не указывается или указывается как null- группы с любым id.
** если указывается статус - группы с указанным статусом,
** если статус указывается null - группы с любым статусом,
** если статус не указывается - группы со статусом learn.

===='''get_group_cstream($csid)'''====

Получить все группы, подписанные на учебный процесс с данным id.

''Аргументы:''
* $csid(int) - id учебного процесса в таблице [[Разработка:storages/cstreams | cstreams ]].
''Возвращаемые значения:''
* (array) - список групп.
* (bool) - false, если группы не найдены.

===='''get_numberof_agroups($select)'''====

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

''Аргументы:''
* $select(string) - критерии отбора записей.
''Возвращаемые значения:''
* int - количество найденных записей.

===='''get_group_nocstream($csid)'''====

находит список групп, не связаных с данным потоком

''Аргументы:''
* $csid(int) - id учебного процесса.
''Возвращаемые значения:''
* array - список групп.
* bool - false, если произошла ошибка.

===Планы:===

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|agroups
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|Генерируется каждый раз при вставке новой записи в таблицу agroups.
|-
|storage
|agroups
|update
|Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.
''Пример:'' array('old' => $dataobject_old, 'new' => $dataobject_new)
|Генерируется каждый раз при обновлении записи в таблице agroups.
|-
|storage
|agroups
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|Генерируется каждый раз при удалении записи из таблицы agroups.
|}

[[Категория:Разработка]]
[[Категория:Плагины_storages]]

Разработка:storages/metacontracts

2012-10-17T12:18:48Z

Ibragim:

Разработка:storages/metacontracts

2012-10-17T12:18:14Z

Ibragim:

Разработка:storages/metacontracts

2012-10-17T12:17:26Z

Ibragim:

Разработка:storages/metacontracts

2012-10-17T12:15:31Z

Ibragim:

Разработка:storages/metacontracts

2012-10-17T12:08:55Z

Ibragim:

{{Infobox_Plugin
| name = orderdata
| type = storages
}}

==Таблица в базе данных==
''orderdata'' - таблица для хранения данных [[Разработка:storages/metacontracts | метаконтрактов]].

===Подробный формат полей в таблице:===
* orderid - id приказа, которому принадлежат данные в таблице [[Разработка:storages/orders | orders ]]
* firstlvlname - имя переменной первого уровня в данных приказа
* varnum - номер переменной в данных приказа
* scalar - скалярная ли переменная или нет
* data - значение переменной первого уровня
* ind - проиндексированное поле со значениями

Разработка:storages/metacontracts

2012-10-17T12:08:20Z

Ibragim:

{{Infobox_Plugin
| name = orderdata
| type = storages
}}

==Таблица в базе данных==
''orderdata'' - таблица для хранения данных [[Разработка:storages/orders | приказов]].

===Подробный формат полей в таблице:===
* orderid - id приказа, которому принадлежат данные в таблице [[Разработка:storages/orders | orders ]]
* firstlvlname - имя переменной первого уровня в данных приказа
* varnum - номер переменной в данных приказа
* scalar - скалярная ли переменная или нет
* data - значение переменной первого уровня
* ind - проиндексированное поле со значениями

Разработка:storages/metacontracts

2012-10-16T12:54:05Z

Ibragim: Удалено содержимое страницы

Разработка:storages/metacontracts

2012-10-16T12:53:51Z

Ibragim: Новая страница: «1»

Разработка:storages/agroups

2012-10-16T09:06:26Z

Ibragim: /* Подробный формат полей в таблице: */

{{Infobox_Plugin
| name = agroups
| type = storages
}}

===Таблица в базе данных===
''agroups'' - классы/академические группы. Связывают контракты на обучение и учебные программы при групповой форме обучения.

====Подробный формат полей в таблице:====
* name - название академической группы/класса
* code - кодовое обозначение группы (текстовое поле, обязательное, уникальное)
* programmid - id учебной программы в таблице [[Разработка:storages/programms | programms ]], которую реализует академическая группа
* departmentid - отдел в таблице [[Разработка:storages/departments | departments ]], ответственный за группу
* agenum - порядковый номер текущего учебного периода (изменяется приказом по контингенту). Параллель группы может быти изменена только если группа находится в статусе "формируется".
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/agroups | agroups ]]
* metacontractid - id метаконтракта в таблице [[Разработка:storages/metacontracts | metacontracts ]]

===Дополнительные методы:===

===='''insert($dataobject,$quiet=NULL)'''====

Вставляет запись в таблицу(ы) плагина

''Аргументы:''
* $dataobject(object) - данные записи.
* $quiet(bool) - генерировать или нет события, по умолчанию null.
''Возвращаемые значения:''
* int - id вставленной записи.
* bool - false, если операция не удалась.

===='''search_group_code($code)'''====

находит группу по коду

''Аргументы:''
* $code - код группы.
''Возвращаемые значения:''
* object - объект группы.
* bool - false, если группа не найдена.

===='''get_groups_programm($prid, $status = 'learn', $agenum = null, $dpid = null)'''====

находит все группы, обучающиеся по учебной программе.

''Аргументы:''
* $prid(int) - id программы в таблице [[Разработка:storages/programms | programms ]].
* $status(string) - статус группы, по умолчанию - 'learn'.
* $agenum(int) - номер периода, по умолчанию - null.
* $dpid(int) - id структурного подразделения, по умолчанию - null.
''Возвращаемые значения:''
* array - список групп.
* bool - false, если группы не найдены.
''Структура работы:''
* формируем SQL-запрос и возвращаем список групп:
** если указывается статус - группы с указанным статусом,
** если статус указывается null - группы с любым статусом,
** если статус не указывается - группы со статусом learn.
** если указывается номер периода - группы с указанным периодом,
** если номер периода указывается null или не указывается - группы с любым периодом.
** если указывается id подразделения - группы указанного подразделения,
** если id подразделения указывается null или не указывается - группы любого подразделения.

===='''get_group_department($dpid, $prid = null, $status = 'learn')'''====

Получает все группы, относящиеся к структурному подразделению и обучающиеся по программе

''Аргументы:''
* $dpid(int) - id структурного подразделения в таблице [[Разработка:storages/departments | departments ]].
* $prid(int) - id программы в таблице [[Разработка:storages/programms | programms ]], по умолчанию - все(null).
* $status(string) - статус группы, по умолчанию - 'learn'.
''Возвращаемые значения:''
* array - список групп.
* bool - false, если группы не найдены.
''Структура работы:''
* формируем SQL-запрос и возвращаем список групп:
** если указывается id программы - группы с указанным id,
** если id программы не указывается или указывается как null- группы с любым id.
** если указывается статус - группы с указанным статусом,
** если статус указывается null - группы с любым статусом,
** если статус не указывается - группы со статусом learn.

===='''get_group_cstream($csid)'''====

Получить все группы, подписанные на учебный процесс с данным id.

''Аргументы:''
* $csid(int) - id учебного процесса в таблице [[Разработка:storages/cstreams | cstreams ]].
''Возвращаемые значения:''
* (array) - список групп.
* (bool) - false, если группы не найдены.

===='''get_numberof_agroups($select)'''====

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

''Аргументы:''
* $select(string) - критерии отбора записей.
''Возвращаемые значения:''
* int - количество найденных записей.

===='''get_group_nocstream($csid)'''====

находит список групп, не связаных с данным потоком

''Аргументы:''
* $csid(int) - id учебного процесса.
''Возвращаемые значения:''
* array - список групп.
* bool - false, если произошла ошибка.

===Планы:===

===События===
В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.
====Перехватываемые события====
{| border="1"
|+ Таблица событий, которые перехватывает этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|colspan=5 align=center | ''Этот плагин не перехватывает никаких событий''
|}
====Генерируемые события====
{| border="1"
|+ Таблица событий, которые генерирует этот плагин
! Тип плагина
! Код плагина
! Код события
! Доп. данные
! Пояснение
|-
|storage
|agroups
|insert
|Массив, содержащий в поле "new" объект с данными для вставки в таблицу.
''Пример:'' array('new' => $dataobject)
|Генерируется каждый раз при вставке новой записи в таблицу agroups.
|-
|storage
|agroups
|update
|Массив, содержащий в поле "new" обновленный объект, и в поле "old" объект со старыми данными, до обновления записи.
''Пример:'' array('old' => $dataobject_old, 'new' => $dataobject_new)
|Генерируется каждый раз при обновлении записи в таблице agroups.
|-
|storage
|agroups
|delete
|Массив, содержащий в поле "old" объект с данными, которые удаляются из таблицы
''Пример:'' array('old' => $dataobject)
|Генерируется каждый раз при удалении записи из таблицы agroups.
|}

[[Категория:Разработка]]
[[Категория:Плагины_storages]]