1С-Битрикс: Сайт медицинской организации (стр. 1 )

1С-Битрикс: Сайт медицинской организации

Руководство по API модуля “1С-Битрикс: Сайт медицинской организации (расширенный) (sitemedicine_ext)“

Содержание

Введение.................................................................................................................................... 4

Класс MCPeriod........................................................................................................................ 5

Свойства класса........................................................................................................................ 5

Поля, используемые в методах............................................................................................... 5

Основные методы...................................................................................................................... 6

Add............................................................................................................................................ 6

Clear........................................................................................................................................... 7

Delete......................................................................................................................................... 7

GetList........................................................................................................................................ 7

Update........................................................................................................................................ 8

Вспомогательные методы........................................................................................................ 9

FindPeriodInArray........................................................................................................................ 9

IsSamePeriods.......................................................................................................................... 10

Класс MCPeriodType............................................................................................................ 11

Свойства класса...................................................................................................................... 11

Поля, используемые в методах............................................................................................. 11

Основные методы.................................................................................................................... 11

ClearLinkToSites........................................................................................................................ 11

GetLinksWithSites...................................................................................................................... 11

GetList...................................................................................................................................... 12

GetById..................................................................................................................................... 13

LinkToSite................................................................................................................................. 13

Вспомогательные методы...................................................................................................... 13

GetTypeName............................................................................................................................ 13

Класс MCSchedule................................................................................................................. 14

Свойства класса...................................................................................................................... 14

Поля, используемые в методах............................................................................................. 14

Основные методы.................................................................................................................... 14

Add........................................................................................................................................... 14

Сlear......................................................................................................................................... 15

ClearSchedules.......................................................................................................................... 15

Delete....................................................................................................................................... 15

GetList...................................................................................................................................... 15

Update...................................................................................................................................... 17

Вспомогательные методы........................................................................................................ 18

WorkingToday........................................................................................................................... 18

CheckFreeTime.......................................................................................................................... 18

GetDayData............................................................................................................................... 19

GetEmployeeServices................................................................................................................ 19

GetRecordedUsers..................................................................................................................... 19

Класс MCTalon........................................................................................................................ 21

Свойства класса...................................................................................................................... 21

Поля, используемые в методах............................................................................................. 21

Основные методы.................................................................................................................... 21

Add........................................................................................................................................... 21

ClearReserved........................................................................................................................... 22

Clear......................................................................................................................................... 22

Delete....................................................................................................................................... 23

GenerateUID.............................................................................................................................. 23

GetList...................................................................................................................................... 23

Update...................................................................................................................................... 24

Вспомогательные методы...................................................................................................... 25

Reserve..................................................................................................................................... 25

Save......................................................................................................................................... 25

ChangeState.............................................................................................................................. 25

GetNotExported......................................................................................................................... 26

GetStateName........................................................................................................................... 26

GetTalonData............................................................................................................................. 26

GetTalonPlace........................................................................................................................... 26

GetTalonServices....................................................................................................................... 27

Класс MCUser.......................................................................................................................... 28

Свойства класса...................................................................................................................... 28

Основные методы.................................................................................................................... 28

AddUserInfo.............................................................................................................................. 28

ClearUserInfo............................................................................................................................. 28

СreateUser................................................................................................................................. 28

DeleteUserInfo........................................................................................................................... 29

GetUserInfo............................................................................................................................... 29

UpdateUserInfo.......................................................................................................................... 29

Вспомогательные методы...................................................................................................... 30

GeneratePassword..................................................................................................................... 30

ExistUserEmail.......................................................................................................................... 30

ExistUserLogin.......................................................................................................................... 30

IsUserRecordedToday................................................................................................................ 30

NewRecordAlert......................................................................................................................... 31

RegistrationAlert........................................................................................................................ 31

Класс MCUserProperties...................................................................................................... 32

Поля, используемые в методах............................................................................................. 32

Основные методы.................................................................................................................... 32

Add........................................................................................................................................... 32

CheckField................................................................................................................................ 33

CheckValue............................................................................................................................... 33

Clear......................................................................................................................................... 34

ClearLinks.................................................................................................................................. 34

Delete....................................................................................................................................... 34

GetList...................................................................................................................................... 34

GetPropertyListHtml................................................................................................................... 35

GetTypeList............................................................................................................................... 35

Update...................................................................................................................................... 35

Вспомогательные методы...................................................................................................... 36

GetNewPropertyID..................................................................................................................... 36

Класс MCWeek........................................................................................................................ 37

Свойства класса...................................................................................................................... 37

Поля, используемые в методах............................................................................................. 37

Основные методы.................................................................................................................... 37

Add........................................................................................................................................... 37

Copy......................................................................................................................................... 37

GetList...................................................................................................................................... 38

Заключение............................................................................................................................. 39

Введение

Данное руководство предназначено для пользователей системы «1C-Битрикс: Сайт медицинской организации». В документе рассматриваются классы и методы модуля «1С-Битрикс: Сайт медицинской организации (расширенный) (sitemedicine_ext)», предназначенные для работы с сервисом электронной регистратуры.

Класс MCPeriod

Класс используется для работы с периодами времени в расписании.

Свойства класса

·  MCPeriod::$LAST_ERRORS – содержит массив ошибок, которые возникли во время работы последнего метода.

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

Название поля	Тип	Описание
ID	число	ID периода.
PERIOD_TYPE TYPE	число	Тип периода, можно задавать с помощью специальных констант: ·  rec_type_talon - запись по талону; ·  rec_type_line - живая очередь; ·  rec_type_wish - запись в желаемое время; ·  rec_type_vacation — отпуск; ·  rec_type_hospital — больничный.
TIME_START	строка	Время начала периода в формате "HH:MM:SS"
TIME_END	строка	Время окончания периода в формате "HH:MM:SS"
DURATION	число	Продолжительность приема в минутах
PLACEMENT	число	ID помещения (элемента инфоблока помещений), где будет проходить прием
SECTOR	число	ID врачебного участка (элемента инфоблока врачебных участков)
SITE_ID	строка	ID сайта, к которому привязывается период
NAME	строка	Название периода

Основные методы

Add

mixed Add ( array fields )

Метод создает новый период времени работы. Использует следующие параметры:

fields - массив параметров периода. В качестве ключей данного массива допустимо использовать:

·  PERIOD_TYPE - тип периода.

·  TIME_START - время начала периода в формате "HH:MM:SS".

·  TIME_END - время окончания периода в формате "HH:MM:SS".

·  DURATION - продолжительность приема в минутах.

·  PLACEMENT - (необязательный параметр) ID помещения (элемента инфоблока помещений), где будет проходить прием.

·  SECTOR - (необязательный параметр) ID врачебного участка (элемента инфоблока врачебных участков).

·  SITE_ID - (необязательный параметр) идентификатор сайта, к которому привязывается период. Если данный параметр не указан, то привязывается текущий сайт по значению стандартной константы SITE_ID.

·  NAME - (необязательный параметр) название периода. В случае если название не заданно, оно создается в формате "<время начала периода> - <время конца периода>”.

В случае успеха возвращает массив следующего вида:

Array( [ID] => 15 [NAME] => 8:00:00 - 11:00:00 среда )

В случае неудачи возвращает false.

Пример использования:

$arFields = array( 'PERIOD_TYPE' => rec_type_talon, 'TIME_START' => "8:00:00", 'TIME_END' => "12:00:00", 'DURATION' => 15, ); MCPeriod::Add($arFields);

Clear

Clear ()

Метод удаляет все созданные ранее периоды.

Delete

mixed Delete ( int id )

Метод удаляет период с определенным ID.

GetList

mixed GetList ( array filter = array() )

Метод возвращает список периодов в виде массива.

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

·  ID — ID периода.

·  TYPE — тип периода.

·  NAME — имя периода. Возможен поиск по шаблону "%NAME%.

·  TIME_START — время начала периода. Имеет два возможных формата:

·  Строка времени в формате "hh:mm:ss".

·  Массив вида

array ( 'COMPARSION' => 'знак сравнения', 'TIME' => 'время в формате "hh:mm:ss", )

·  TIME_END - время конца периода. Имеет два возможных формата:

·  Строка времени в формате "hh:mm:ss".

·  Массив вида

array ( 'COMPARSION' => 'знак сравнения', 'TIME' => 'время в формате "hh:mm:ss", )

·  PLACEMENT — ID помещения (элемент инфоблока помещений).

·  SECTOR - ID врачебного участка (элемент инфоблока врачебных участков).

·  DURATION - продолжительность приема в минутах.

·  SITE_ID — ID сайта.

Пример использования:

$arFilter = array( 'TIME_START' => array( 'COMPARSION' => '>', 'TIME' =>'12:00:00' ), ); var_dump(MCPeriod::GetList($arFilter));

Update

mixed GetList ( int id array fields )

id – ID обновляемого периода.

fields – массив обновляемых полей. В качестве ключей данного массива допустимо использовать:

·  PERIOD_TYPE - тип периода.

·  TIME_START - время начала периода в формате "HH:MM:SS".

·  TIME_END - время окончания периода в формате "HH:MM:SS".

·  DURATION - продолжительность приема в минутах.

·  PLACEMENT - (необязательный параметр) ID помещения (элемента инфоблока помещений), где будет проходить прием.

·  SECTOR - (необязательный параметр) ID врачебного участка (элемента инфоблока врачебных участков).

·  SITE_ID - (необязательный параметр) идентификатор сайта, к которому привязывается период. Если данный параметр не указан, то привязывается текущий сайт по значению стандартной константы SITE_ID.

·  NAME - (необязательный параметр) название периода. В случае если название не заданно, оно создается в формате "<время начала периода> - <время конца периода>”.

В случае успеха возвращает ID обновляемого периода.

В случае неудачи возвращает false.

Пример использования:

$arFields = array( 'PERIOD_TYPE' => rec_type_talon, 'TIME_START' => "8:00:00", 'TIME_END' => "12:00:00", 'DURATION' => 15, ); MCPeriod::Update(15, $arFields);

Вспомогательные методы

FindPeriodInArray

mixed FindPeriodInArray ( array needle array haystack )

Метод ищет определенный период в массиве.

needle – период в виде массива полей

haystack – массив периодов

В случае успеха возвращает ключ найденного элемента.

В случае неудачи возвращает false.

IsSamePeriods

bool IsSamePeriods ( array first array second )

Сравнивает два периода. Если периоды совпадают - возвращает true, в противном случае возвращает false.

first – массив полей периода.

second - массив полей периода.

Сравнение идет по полям TIME_START, TIME_END, DURATION, PERIOD_TYPE, PLACEMENT, SECTOR, SITE_ID.

Класс MCPeriodType

Свойства класса

·  MCPeriod::$LAST_ERRORS – содержит массив ошибок, которые возникли во время работы последнего метода.

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

Название поля	Тип	Описание
ID	число	ID типа периода. Можно задавать с помощью специальных констант: ·  rec_type_talon - запись по талону; ·  rec_type_line - живая очередь; ·  rec_type_talon - запись по талону; ·  rec_type_wish - запись в желаемое время; ·  rec_type_vacation — отпуск; ·  rec_type_hospital — больничный.
NAME	строка	Название типа периода
DESCRIPTION	строка	Описание типа периода
CODE	строка	Символьный код типа периода

Основные методы

ClearLinkToSites

ClearLinkToSites ()

Метод удаляет все привязки типов периодов к ID сайтов.

GetLinksWithSites

mixed GetLinksWithSites ( string site_id = false array select = array() )

Метод возвращает сайт или список сайтов с привязанными к ним типами периодов.

site_id – ID сайта, для которого надо сделать выборку. Если false — возвращает информацию для всех сайтов.

select - массив полей, которые нужно выбирать. Если массив пуст - выбирает только данные из таблицы связей с периодами. Если в массиве что-то есть - в текущей реализации выберет все поля типов периодов (имя, описание) вне зависимости от того, что указано в массиве.

Пример использования:

print_r(MCPeriodType::GetLinksWithSites('s1')) Array( [s1] => Array( [1] => Array () [2] => Array () ) ) print_r(MCPeriodType::GetLinksWithSites('s1',array('something'))) Array( [s1] => Array( [1] => Array( [NAME] => Живая очередь [DESCRIPTION] => Живая очередь, прием ведется без записи ) [2] => Array( [NAME] => Запись по талону [DESCRIPTION] => Прием по талонам<br> для записи щелкните по нему один раз левой кнопкой мыши ) ) )

GetList

array GetList()

Метод возвращает все периоды, которые доступны в данной установке в виде массива:

print_r(MCPeriodType::GetList()) Array ( [s1] => Array( [0] => Array( [ID] => 1 [NAME] => Живая очередь [DESCRIPTION] => Живая очередь, прием ведется без записи ) [1] => Array( [ID] => 2 [NAME] => Запись по талону [DESCRIPTION] => Прием по талонам<br> для записи щелкните по нему один раз левой кнопкой мыши ) ) )

GetById

mixed GetById( int id )

Метод возвращает информацию о типе периода по его идентификатору.