Какого типа является свойство глобального контекста справочники
В модели разработки прикладных решений 1С:Предприятия для ряда сущностей предметной области используется объектный подход манипулирования данными. Эти сущности описываются в конфигурации объектами метаданных: Справочник, Документ, ПланВидовХарактеристик, ПланСчетов и ПланВидовРасчета. С точки зрения модели данных 1С:Предприятия, в базе данных для этих сущностей хранятся объекты. Разумеется, язык запросов предоставляет доступ к этим сущностям, как и ко всем другим данным, в модели реляционных таблиц. Но доступ специализированными объектами встроенного языка, предназначенными для манипулирования этими данными, предоставляется именно в объектной технике.
Рассмотрим состав типов, используемых для манипулирования этими сущностями в конфигурации. Мы будем рассматривать состав типов и их использование на примере справочника. Для других перечисленных объектов метаданных имеется аналогичный состав типов.
Тип СправочникиМенеджер предназначен в основном для доступа к менеджерам конкретных справочников. Кроме того, он имеет метод ТипВсеСсылки(), который позволяет получить значение ОписаниеТипов, содержащее типы ссылок всех справочников конфигурации. Например, с помощью данного значения (используя метод СодержитТип()) можно проверить, является ли тип некоторого значениям типом ссылки какого-либо справочника.
Тип СправочникМенеджер предоставляют доступ к общим действиям, относящимся к конкретному справочнику. С помощью его методов выполняются действия, относящиеся к справочнику, а не к его конкретным объектам. Например, его методы позволяют создать новый объект или найти объект по коду. Менеджер является своего рода “точкой входа” в конкретный справочник в объектной модели встроенного языка.
Заметим, что объекты типа СправочникиМенеджер и СправочникМенеджер имеются в системе в единственном экземпляре.
Подробнее остановимся на типах СправочникСсылка и СправочникОбъект. На следующем рисунке изображено хранение справочника в базе данных.
Справочник хранится в таблице. Запись таблицы определяет объект базы данных – элемент справочника. Объект базы данных включает не только запись в основной таблице справочника, но и все записи всех табличных частей справочника, относящиеся к данному объекту. Таким образом, объект базы данных представляет собой запись основной таблицы и строки табличных частей.
В таблице справочника присутствует поле Ссылка, которое хранит значения, однозначно идентифицирующие объекты (элементы справочника) в базе данных 1С:Предприятия. Если в какой либо другой таблице нужно сослаться на некоторый объект базы данных, то в поле этой таблицы будет храниться именно значение ссылки.
Для манипулирования справочником во встроенном языке существуют два основных типа СправочникСсылка.ХХХХ и СправочникОбъект.ХХХХ, где ХХХХ — имя справочника в метаданных. Важно, что имеются отдельные типы для каждого справочника, они появляются в системе при создании справочника в метаданных. Таким образом, типы ссылок двух разных справочников не будут совпадать между собой.
Назначение типов СправочникСсылка и СправочникОбъект существенно различается. Значение типа СправочникСсылка – хранит ссылку, идентифицирующую объект в базе данных, а значение типа СправочникОбъект позволяет считывать и записывать данные объекта.
Значение типа СправочникСсылка используется везде, где нужно хранить ссылку на элемент. Фактически значение СправочникСсылка хранит только внутренний идентификатор, хранящийся в поле Ссылка таблицы справочника. Это значение хранится в полях других таблиц базы данных, выбирается в поле ввода, указывается в параметрах запроса при поиске по ссылке и т.д. Важно, что значение типа СправочникСсылка можно сравнивать с другим значением типа СправочникСсылка и они буду всегда равны, если это ссылка на один и тот же объект в базе данных (независимо от способа получения и от того откуда получено значение).
Значение типа СправочникОбъект используется в основном для создания нового объекта, изменения существующего объекта и удаления объекта. Кроме того, СправочникОбъект используется для отображения и редактирования всех данных элемента справочника в форме элемента. Также СправочникОбъект используется при редактировании строки списка справочника (при отображении строк списка СправочникОбъект не используется). Для одного и того же элемента справочника можно получить несколько объектов типа СправочникОбъект. При сравнении этих значений они будут равны, только если это один и тот же объект встроенного языка. Два объекта встроенного языка, полученные для одного элемента справочника, не будут равны, даже если в них считан один и тот же объект базы данных и совпадают все данные объекта.
Объект может быть создан с помощью менеджера справочника. В этом случае создается новый объект, которого еще нет в базе данных. Если его записать, то появится новый объект в базе данных. Объект может быть получен из ссылки. В этом случае из базы данных считывается существующий объект, на который указывает ссылка. Объект также может быть получен из выборки (СправочникВыборка). В этом случае данные объекта заполняются данными, считанными в процессе считывания выборки.
СправочникОбъект оптимизирует запись изменений в базу данных. Например, Если не менялись реквизиты самого объекта, то будет записываться только минимальная информация об изменении. Если не менялись строки табличной части, то табличная часть не будет записываться. Если менялись только отдельные строки или добавлялись строки, то будут записываться только измененные и добавленные строки. Однако если строки удалялись или изменялся порядок строк, то будут записываться все строки табличной части.
Для объектов обеспечивается оптимистическая блокировка. То есть объект не может быть записан, если он был изменен в базе данных после считывания. Этот механизм обеспечивает логическую целостность изменения объектов. Каждый, кто меняет объект, может быть уверен, что его изменения не “затрут” изменений сделанных другими пользователями (сессиями) или другими объектами в этой же сессии. Такая блокировка не препятствует изменению объекта другими сессиями или этой сессией. Однако если с момента считывания объекта и до попытки его записи объект был изменен в базе данных, то запись не будет выполнена.
Кроме того, существует механизм пессимистической блокировки, который запрещает изменения другими сессиями или этой сессией, до снятия блокировки этим объектом встроенного языка. Данный механизм необходимо включать в явном виде методом Заблокировать(). В основном он предназначен для блокировки объектов, редактируемых в форме. Расширение формы элемента справочника автоматически включает блокировку, чтобы пользователь был уверен что, начав редактировать объект, он сможет его записать.
И СправочникСсылка, и СправочникОбъект предоставляют доступ через свойства к данным объекта – значениям полей таблицы. Однако это происходит совершенно по-разному, так как назначение и использование этих типов принципиально отличается. Значение СправочникОбъект хранит свойства непосредственно в объекте встроенного языка. Они заполняются при считывании существующего объекта значениями из базы данных, а для нового объекта инициализируются значениями по умолчанию. Значение СправочникСсылка при обращении к свойствам осуществляет считывание информации из базы данных. Однако чтобы считывание происходило не при каждом обращении – данные объектов кэшируются системой. Если обращаться через ссылки к свойствам одного и того же объекта базы данных, то считывание данных будет происходить только при первом обращении, а так же после того как система выгрузит этот объект из кэша. Данные объекта удерживаются в кэше около 20 минут, но после интервала в 20 секунд при очередном обращении будет выполняться проверка того, что объект в базе данных не менялся, и, при необходимости, выполняется обновление данных в кэше. Если объект записывается в данной сессии, то он сразу обновляется в кэше. Также имеются ограничения на количество объектов хранимых в кэше. Следует заметить, что в рамках транзакции система использует отдельный кэш, поэтому обращение к данным объекта через ссылки в транзакциях гарантированно выдает актуальные данные.
Тип СправочникВыборка предназначен для динамического обхода элементов справочника. Механизм выборок для объектных таблиц не имеет существенных отличий от выборок других таблиц. Можно заметить, что считанные в выборке элементы могут быть получены в качестве значений типа СправочникОбъект. При этом они не будут повторно считываться из базы данных. Следует учитывать, что выборка всегда считывает данные объектов целиком (все поля и все табличные части).
Тип СправочникСписок предназначен для динамического просмотра данных справочника в элементе управления ТабличноеПоле. У него может быть настроен состав считываемых полей (колонок), отбор и сортировка. Список осуществляет считывание данных порциями в процессе навигации пользователем в табличном поле.
Кроме указанных типов значений справочник определяет несколько расширений элементов управления и форм, предназначенных для интерактивного ввода и просмотра, данных справочника. Расширения не являются типами данных, а добавляют специфические свойства, методы и события к соответствующим объектам. Кроме того, расширения определяют некоторое специфическое поведение форм и элементов управления при конфигурировании и работе пользователя с системой.
Источник
Теперь займемся кодом. Нам, в дополнение к клиентской процедуре команды СоздатьЭлементСправочника, понадобится серверная процедура или функция, которая и занимается созданием элемента. Обратиться к объекту СправочникМенеджер для конкретного справочника можно различными способами. Предположим, мы заранее знаем, с каким справочником нам нужно работать (например, это – справочник Номенклатура). Для того, чтобы вызвать метод этого справочника СоздатьЭлемент, нам понадобится такая конструкция:
В данном случае происходит следующее. Посредством объекта СправочникиМенеджер (Справочники) мы получаем доступ к объекту СправочникМенеджер для справочника Номенклатура и выполняем его метод СоздатьЭлемент. Этот метод возвращает нам объект типа СправочникОбъект (доступ к нему возможен через переменную НовыйЭлемент).
В нашем случае имя справочника задает пользователь, оно нам заранее неизвестно. В том случае, если имя справочника для вышеописанной конструкции будет, перед обращением к менеджеру справочника, записано в некую переменную, мы можем использовать такую конструкцию (в нашем случае имя справочника хранится в текстовой переменной ИмяСправочника):
Оператор[…], который используется в данной конструкции, заменяет конструкцию с точкой и жестко заданным именем справочника.
После того, как мы получили переменную типа СправочникОбъект, мы можем настроить необходимые свойства конкретного элемента справочника (в нашем случае – наименование) и записать элемент. Вот, как выглядит результирующий код:
Процедура СоздатьЭлементСправочника(Команда)
КодНовогоЭлемента=СоздатьЭлементСправочникаНаСервере();
Сообщить(“В справочнике “+ИмяСправочника+” создан элемент
“+НаименованиеЭлемента + ” с автоматически присвоенным кодом:
“+КодНовогоЭлемента);
КонецПроцедуры
Функция СоздатьЭлементСправочникаНаСервере()
НовыйЭлемент = Справочники[ИмяСправочника].СоздатьЭлемент();
НовыйЭлемент.Наименование=НаименованиеЭлемента;
НовыйЭлемент.Записать();
Возврат (НовыйЭлемент.Код);
КонецФункции
Обратите внимание на то, что мы в серверной процедуре обращаемся к реквизитам формы напрямую – они доступны и на сервере и на клиенте, так как функция, в которой они вызываются – это функция, объявленная с используемой по умолчанию директивой &НаСервере. Если бы мы в подобной ситуации попытались воспользоваться серверной внеконтекстной функцией (директива &НаСервереБезКонтекста) – обращаться к контексту формы (к ее реквизитам), мы не смогли бы. Вместо того, чтобы пользоваться стандартными механизмами обмена данными с сервером (а при вызове серверной процедуры на сервер передаются данные от клиента о состоянии формы), нам пришлось бы организовывать передачу этих данных вручную через параметры методов. Серверная внеконтекстная функция позволила бы снизить объем данных, передаваемых с клиента на сервер и обратно. Но она, в то же время, способна выполнять те же действия с базой, что и функция, объявленная с ключевым словом &НаСервере.
Вот, каковы результаты работы этого кода,
рис.
5.10.
Рис.
5.10.
Создание нового элемента справочника
Функция СоздатьЭлементСправочникаНаСервере создает новый элемент, заполняет его свойство Наименование, после чего записывает его и возвращает код нового элемента. Код формируется системой автоматически. Если заглянуть в справочник ЕдиницыИзмерения – там, действительно, будет создан новый элемент с заданным нами наименованием.
Продолжим наши примеры программной работы со справочниками. Нам нужно реализовать автоматическую пометку всех элементов (но не групп) справочника на удаление. Создадим новую команду ПометитьНаУдалениеВсеЭлементыСправочника. После создания процедуры, связанной с этой командой и серверной процедуры, выполняющей работу с базой. У нас получился такой код:
Процедура ПометитьНаУдалениеВсеЭлементыСправочника(Команда)
ПометитьНаУдаление();
КонецПроцедуры
Процедура ПометитьНаУдаление()
СчетчикПомеченных = 0;
Выборка = Справочники[ИмяСправочника].Выбрать();
Пока Выборка.Следующий() Цикл
Элемент=Выборка.ПолучитьОбъект();
Если НЕ Элемент.ЭтоГруппа Тогда
Элемент.УстановитьПометкуУдаления(Истина);
СчетчикПомеченных=СчетчикПомеченных+1;
КонецЕсли;
КонецЦикла;
Сообщить(“В справочнике “+ИмяСправочника+” помечено на удаление”+СчетчикПомеченных+” элементов”);
КонецПроцедуры
В процедуре ПометитьНаУдаление() мы сначала присваиваем 0 переменной СчетчикПомеченых – с ее помощью мы будем подсчитывать количество помеченных на удаление элементов справочника. В качестве имени справочника мы используем уже знакомый по прошлой процедуре реквизит ИмяСправочника. Конструкция Справочники[ИмяСправочника] позволяет нам обратиться к объекту типа СправочникМенеджер для заданного справочника. Этот объект имеет метод Выбрать(). Метод Выбрать() позволяет сформировать выборку элементов справочника по заданным условиям. Мы, в данном случае, условий не задаем, то есть в выборку попадают все элементы и группы справочника – метод возвращает значение типа СправочникВыборка. СправочникВыборка не содержит элементов справочника, объект этого типа можно считать способом доступа к элементам, способом их перебора. При обращении к выборке обход элементов осуществляется динамически, данные считываются из базы порциями, что позволяет эффективно использовать данный механизм даже для работы с большими справочниками, так как все элементы, входящие в выборку (соответствующие условиям выборки) в память не загружаются.
Команда Выборка.Следующий(), во-первых, возвращает значение Истина (в нашем случае это приводит к запуску следующей итерации цикла), если в выборке выбран следующий элемент, во-вторых, получает следующий элемент выборки. Обращение к этому элементу осуществляется через ту же переменную Выборка типа СправочникВыборка. Для получения объекта элемента справочника мы пользуемся методом Выборка.ПолучитьОбъект() – он возвращает объект типа СправочникОбъект, с которым мы можем дальше работать. А именно, мы проверяем, не является ли найденный элемент группой, если не является – используем метод УстановитьПометкуУдаления объекта типа СправочникОбъект. Этот метод принимает один обязательный параметр, которые следует первым в списке параметров, а именно – для установки пометки удаления он должен быть установлен в значение Истина (как в нашем случае), для снятия – в значение Ложь.
После установки пометки удаления мы увеличиваем счетчик СчетчикПомеченных и переходим к следующей итерации цикла. Когда цикл перебора элементов выборки завершается, мы выводим сообщение о количестве элементов, помеченных на удаление в справочнике, имя которого задано в реквизите ИмяСправочника.
Среди объектов, с которыми вы имеете дело, работая со справочниками, вам встретится объект типа СправочникСсылка. Обычно мы задаем подобный тип (СправочникСсылка.Контрагенты и т.д.) при настройке реквизитов других объектов, которые должны хранить некий элемент нужного справочника. На самом деле, элемент хранится в таблице справочника, в базе данных, а реквизит хранит лишь ссылку. При программной работе со справочниками мы получаем объект СправочникСсылка, когда, например, ищем какой-то элемент справочника. Ссылку можно использовать для идентификации элемента, а так же – для перехода к объекту типа СправочникОбъект, если тот элемент, на который у нас есть ссылка, нужно, например, отредактировать. Объект типа СправочникСсылка не предназначен для изменения элемента справочника. В свою очередь, от СправочникОбъект можно перейти к СправочникСсылка – у объекта имеется соответствующее поле – Ссылка.
Рассмотрим пример. В заданном справочнике нужно найти элемент с заданным наименованием (или сообщить, что элемента с таким наименованием в справочнике нет), изменить регистр символов в наименовании таким образом, чтобы все буквы были прописными, и сообщить пользователю его код с указанием старого и нового наименования.
Обычным образом добавим в форму обработки новую команду, для указания имени справочника и наименования искомого элемента используем те же реквизиты ИмяСправочника и НаименованиеЭлемента, реорганизуем элементы управления на форме,
рис.
5.11.
Поиск, редактирование заданного элемента и вывод необходимых сообщений реализуется с помощью следующего кода:
Процедура НайтиЗаданныйЭлемент(Команда)
НайтиЗаданныйЭлементНаСервере();
КонецПроцедуры
Процедура НайтиЗаданныйЭлементНаСервере()
СсылкаНаЭлемент=Справочники[ИмяСправочника].НайтиПоНаименованию(НаименованиеЭлемента);
Если СсылкаНаЭлемент=Справочники[ИмяСправочника].ПустаяСсылка() Тогда
Сообщить (“В справочнике “+ИмяСправочника+” нет элемента “+НаименованиеЭлемента);
Иначе
Элемент=СсылкаНаЭлемент.ПолучитьОбъект();
СтароеНаименование=Элемент.Наименование;
Элемент.Наименование=ВРег(Элемент.Наименование);
Элемент.Записать();
Сообщить(“Элемент справочника “+ИмяСправочника+”
с кодом “+Элемент.Код+” найден, наименование изменено
с “+СтароеНаименование+” на “+Элемент.Наименование);
КонецЕсли;
КонецПроцедуры
В процедуре НайтиЗаданныйЭлементНаСервере() мы обращаемся к методу НайтиПоНаименованию() объекта СправочникМенеджер, полученному посредством конструкции Справочники[ИмяСправочника]. Этот метод, среди прочих, принимает обязательный параметр, который должен содержать строку с наименованием искомого объекта. Мы передаем ему реквизит с искомой строкой. Если метод нашел элемент, наименование которого соответствует этой строке, он вернет ссылку на элемент с типом СправочникСсылка.ИмяСправочника. Если нет – будет возвращена пустая ссылка. Сравнивая возвращенную ссылку с пустой ссылкой на элемент справочника, который мы обрабатываем, мы принимаем решение о том, сообщить ли пользователю об отсутствии искомого элемента, или, если элемент все же найден, переходим от ссылки на него к объекту (метод ПолучитьОбъект() объекта СправочникСсылка), выполняем с ним необходимые действия и выводим соответствующее сообщение пользователю. Вот как выглядит работа этого кода,
рис.
5.12.
Рис.
5.12.
Результат работы кода по поиску и редактированию элемента справочника
Итак, мы обсудили различные типы данных, которые могут встретиться вам при работе со справочниками. Подведем краткие итоги по их основным особенностям и использованию
СправочникиМенеджер – доступен через свойство глобального контекста Справочники. Предназначен для управления справочниками, позволяет получить доступ к объекту СправочникМенеджер конкретного справочника.
СправочникМенеджер – нужен для управления справочником как объектом конфигурации. С его помощью можно создавать элементы и группы справочника, искать элементы в справочнике, помечать их на удаление, получать выборки элементов справочника.
СправочникВыборка – объект этого типа предназначен для работы с выборкой элементов справочника, полученной по заданным условиям. Для получения выборки используется метод Выбрать() объекта СправочникМенеджер
СправочникСсылка – основная область применения – использование в реквизитах других объектов для указания ссылки на определенный элемент справочника. Ссылка – это идентификатор элемента. Если имеется объект СправочникСсылка, а элемент справочника нужно редактировать или выполнять с ним другие подобные действия (копирование элемента, например), от ссылки осуществляется переход к объекту типа СправочникОбъект.
СправочникОбъект – предназначен для манипуляций с отдельным элементом справочника, в частности, для чтения, изменения, добавления, удаления элементов.
Для работы с метаданными справочника можно использовать свойство глобального контекста Метаданные, или, например, метод Метаданные() объекта типа СправочникСсылка. Для работы с метаданными справочника применяется тип данных ОбъектМетаданных: Справочник.
Иногда возникает путаница с понятиями “данные, хранящиеся в справочнике” и “метаданные справочника”. Данные справочника – это элементы справочника – например, в справочнике ЕдиницыИзмерения может храниться элемент с наименованием “Штука”, и кодом “0001”. Метаданные – это, как принято говорить, “данные о данных”. То есть, например – это имя справочника, набор его реквизитов, список владельцев справочника и так далее. Метаданные, другими словами – это то, что мы редактируем, работая в Конфигураторе, а данные – это то, с чем мы взаимодействуем, работая со справочником в пользовательском режиме. При работе со справочником как с объектом метаданных, мы можем обращаться к свойствам этого объекта только для чтения – операции по модификации метаданных производятся в визуальном режиме с помощью Конфигуратора. При программной работе с данными справочника, мы имеем полный набор инструментов для управления этими данными.
Есть еще один тип данных, имеющий отношение к справочникам, о котором мы здесь не упоминали. Это – СправочникСписок – он используется для управления списком элементов справочника в табличных полях.
Обсудив программную работу со справочниками, перейдем к разговору об отчетах
Источник