From ab6ad014416fdb30026dc8072cdb20bbc67f024f Mon Sep 17 00:00:00 2001 From: Aleksey Chichenkov Date: Mon, 18 Mar 2019 12:02:53 +0300 Subject: [PATCH] =?UTF-8?q?=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD?= =?UTF-8?q?=D1=82=D0=B0=D1=86=D0=B8=D1=8F=20=D0=B4=D0=BB=D1=8F=20=D0=BF?= =?UTF-8?q?=D0=B5=D1=80=D0=B5=D0=B2=D0=BE=D0=B4=D0=BE=D0=B2,=20=D0=BA?= =?UTF-8?q?=D0=B0=D1=82=D0=B0=D0=BB=D0=BE=D0=B3=D0=B0=20=D0=B4=D0=B0=D1=82?= =?UTF-8?q?=D0=B0=D1=81=D0=BE=D1=80=D1=81=D0=BE=D0=B2,=20=D0=BA=D0=BE?= =?UTF-8?q?=D0=BD=D1=84=D0=B8=D0=B3=D0=B0=20=D0=BE=D0=B1=D0=BD=D0=BE=D0=B2?= =?UTF-8?q?=D0=BB=D0=B5=D0=BD=D0=B8=D0=B5=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC?= =?UTF-8?q?=D0=B5=D0=BD=D1=82=D0=B0=D1=86=D0=B8=D1=8F=20=D0=BF=D0=BE=D0=B4?= =?UTF-8?q?=20=D1=82=D0=B5=D0=BA=D1=83=D1=89=D0=B8=D0=B5=20=D1=80=D0=B5?= =?UTF-8?q?=D0=B0=D0=BB=D0=B8=D0=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docfiles/mainpage/main.js | 12 ++- docfiles/providers/interface/platform.js | 30 +++++-- .../providers/managers/core_config/manager.js | 86 +++++++++++++++++++ .../providers/managers/datasource/manager.js | 37 ++++++++ .../providers/managers/groupTypes/manager.js | 20 ++++- docfiles/providers/managers/models/manager.js | 19 +++- .../providers/managers/modelsTypes/manager.js | 20 ++++- .../providers/managers/publishers/manager.js | 22 ++++- .../managers/translations/manager.js | 55 ++++++++++++ templates/initi/static/styles/common.css | 1 - 10 files changed, 285 insertions(+), 17 deletions(-) create mode 100644 docfiles/providers/managers/core_config/manager.js create mode 100644 docfiles/providers/managers/datasource/manager.js create mode 100644 docfiles/providers/managers/translations/manager.js diff --git a/docfiles/mainpage/main.js b/docfiles/mainpage/main.js index 37626cc..09d539f 100644 --- a/docfiles/mainpage/main.js +++ b/docfiles/mainpage/main.js @@ -34,11 +34,14 @@ * - #### Грид * - #### Графики * - #### {@link ProvidersSystem Система провайдеров}: - * - - #### {@link Trees} - * - - #### {@link Models} + * - - #### {@link Trees} - Менеджер для работы с деревьями + * - - #### {@link Models} - Менеджер для работы с девайсами(моделями) * - - #### {@link Publishers} * - - #### {@link ModelTypes} - * - - #### {@link GroupTypes} + * - - #### {@link GroupTypes} - Менеджер для доступа к типам компонентов + * - - #### {@link CoreConfig} + * - - #### {@link CoreTranslations} + * - - #### {@link Datasource} * - #### Библиотеки: * - - #### {@link std} - реализация сишной библиотеки на js. * - - #### {@link v2} - сериализуемые типы, которыми можно обмениваться с ядром. @@ -79,6 +82,9 @@ * - {@link ModelTypes} - Менеджер, который позволяет узнать о содержимом модели **ps.pl.mtm** * - {@link Models} - Менеджер, для доступа к устройствам, определен как **ps.pl.mm** * - {@link Trees} - Менеджер, для доступа к деревьям, определен как **ps.pl.tm** + * - {@link CoreConfig} - Менеджер, для доступа к деревьям, определен как **ps.pl.core_config** + * - {@link CoreTranslations} - Менеджер, для доступа к деревьям, определен как **ps.pl.core_translations** + * - {@link Datasource} - Менеджер, для доступа к деревьям, определен как **ps.pl.datasource_manager** * * * diff --git a/docfiles/providers/interface/platform.js b/docfiles/providers/interface/platform.js index 95dc611..3743f59 100644 --- a/docfiles/providers/interface/platform.js +++ b/docfiles/providers/interface/platform.js @@ -5,8 +5,8 @@ */ function Platform() { /** - * @name tm * @public + * @name tm * @type {Trees} * @memberof Platform */ @@ -15,13 +15,11 @@ function Platform() { /** * * @public - * @function mm + * @name mm + * @type {Models} * @memberof Platform - * @returns {Models} */ - this.mm = function () { - - }; + this.mm = new Models(); /** * @@ -30,9 +28,25 @@ function Platform() { * @memberof Platform * @returns {CoreTranslations} */ - this.core_translations = function () { + this.core_translations = new CoreTranslations(); - }; + /** + * + * @public + * @function core_config + * @memberof Platform + * @returns {CoreConfig} + */ + this.core_config = new CoreConfig(); + + /** + * + * @public + * @function datasource_manager + * @memberof Platform + * @returns {Datasource} + */ + this.datasource_manager = new Datasource(); /** * diff --git a/docfiles/providers/managers/core_config/manager.js b/docfiles/providers/managers/core_config/manager.js new file mode 100644 index 0000000..ddcff44 --- /dev/null +++ b/docfiles/providers/managers/core_config/manager.js @@ -0,0 +1,86 @@ +/** + * Интерфейс предоставляющий доступ к конфигурационным данным платформы, у которой был произведен запрос. + * + * ```bash + * // доступ + * ps.pl.core_config + * ``` + * + * @group manager + * @namespace CoreConfig + * @extends manager + */ +function CoreConfig() { + + /** + * Проверяет, является ли данная платформа мастером + * + * @public + * @function is_master + * @memberof CoreConfig + * @returns {boolean} + */ + this.is_master = function () { + + }; + + /** + * Возвращает таг менеджера моделей + * + * @public + * @function model_manager_tag + * @memberof CoreConfig + * @returns {v2.string} + */ + this.model_manager_tag = function () { + + }; + + /** + * Возвращает таг датасорс менеджера + * + * @public + * @function datasource_manager_tag + * @memberof CoreConfig + * @returns {v2.string} + */ + this.datasource_manager_tag = function () { + + }; + + /** + * Возвращает таг менеджера пользователей + * + * @public + * @function user_manager_tag + * @memberof CoreConfig + * @returns {v2.string} + */ + this.user_manager_tag = function () { + + }; + + /** + * Системный адрес платформы + * + * @public + * @function m_sys_addr + * @memberof CoreConfig + * @returns {v2.address} + */ + this.m_sys_addr = function () { + + }; + + /** + * Возвращает список доступный идентификаторов для деревьев + * + * @public + * @function allow_tree_tags + * @memberof CoreConfig + * @returns {v2.set(v2.string)} + */ + this.allow_tree_tags = function () { + + }; +} \ No newline at end of file diff --git a/docfiles/providers/managers/datasource/manager.js b/docfiles/providers/managers/datasource/manager.js new file mode 100644 index 0000000..ca712a2 --- /dev/null +++ b/docfiles/providers/managers/datasource/manager.js @@ -0,0 +1,37 @@ +/** + * Менеджер предназначеный для работы с датасорсами. + * + * ```bash + * // доступ + * ps.pl.datasource_manager + * ``` + * + * @group manager + * @namespace Datasource + * @extends manager + */ +function Datasource() { + + /** + * + * @public + * @function datasource_request + * @param {v2.vc} _data данные, которые нужно передать при запросе. + * @memberof Datasource + * @returns {Promise} + */ + this.datasource_request = function (_data) { + + }; + + /** + * + * @public + * @function catalog + * @memberof Datasource + * @returns {v2.vc} + */ + this.catalog = function () { + + } +} \ No newline at end of file diff --git a/docfiles/providers/managers/groupTypes/manager.js b/docfiles/providers/managers/groupTypes/manager.js index dbeb110..ddc483f 100644 --- a/docfiles/providers/managers/groupTypes/manager.js +++ b/docfiles/providers/managers/groupTypes/manager.js @@ -1,6 +1,12 @@ /** - * Менеджер тип групп. + * #### Менеджер типов групп. * + * Этот менеджер позволяет запросить данные по типу компонента. + * + * ```bash + * // доступ + * ps.pl.gtm + * ``` * @group manager * @namespace GroupTypes */ @@ -8,6 +14,18 @@ function GroupTypes() { /** * Вернет ссылку на Тип группы. * + * + * Пример + * ``` + * // компонентом может быть например portEntity + * ps.pl.gtm.get(new v2.model_type("portEntity")).then(function(_ref){ + * var provider = _ref.value(); + * // теперь можно работать с провайдером группы + * }, function(_err){ + * console.log("произошла ошибка") + * }); + * ``` + * * @public * @function get * @memberof GroupTypes diff --git a/docfiles/providers/managers/models/manager.js b/docfiles/providers/managers/models/manager.js index 9858bdf..a803933 100644 --- a/docfiles/providers/managers/models/manager.js +++ b/docfiles/providers/managers/models/manager.js @@ -1,16 +1,33 @@ /** * Менеджер моделей. + * * Представляет собой интерфейс для доступа ко всем моделям + * * Позволяет по адресу модели, получить на нее ссылку. * + * ```bash + * // доступ + * ps.pl.mm + * ``` * @group manager * @namespace Models * @extends manager */ function Models() { /** - * Вернет ссылку на модель. В качестве идентификатора следует указать адрес дерева. + * Вернет ссылку на модель. * + * В качестве идентификатора следует указать адрес дерева. + * + * Пример + * ``` + * ps.pl.mm.get(new v2.address(["system_address", "some", "model", "address"])).then(function(_ref){ + * var model = _ref.value(); + * // теперь можно работать с провайдером модели + * }, function(_err){ + * console.log("произошла ошибка") + * }); + * ``` * @public * @function get * @param {v2.address} address Адрес модели diff --git a/docfiles/providers/managers/modelsTypes/manager.js b/docfiles/providers/managers/modelsTypes/manager.js index 4b144f3..eeac5f6 100644 --- a/docfiles/providers/managers/modelsTypes/manager.js +++ b/docfiles/providers/managers/modelsTypes/manager.js @@ -1,15 +1,31 @@ /** + * Менеджер для доступа к типам моделей * + * Это системный менеджер, и нужен для работы {@link Models.Model.Groups.Group ModelGroup} + * ```bash + * // доступ + * ps.pl.mtm + * ``` * @group manager * @namespace ModelTypes */ function ModelTypes() { /** * Вернет ссылку на Тип группы. - * + *
+ *
+ * Пример + * ``` + * ps.pl.mtm.get(new v2.string("type")).then(function(_ref){ + * var model = _ref.value(); + * // теперь можно работать с провайдером типа модели + * }, function(_err){ + * console.log("произошла ошибка") + * }); + * ``` * @public * @function get - * @param {v2.string} modelType Адрес модели + * @param {v2.string} modelType * @returns {tools.promise(ModelTypes.ModelType)} * @memberof ModelTypes */ diff --git a/docfiles/providers/managers/publishers/manager.js b/docfiles/providers/managers/publishers/manager.js index 1f7c069..e240b90 100644 --- a/docfiles/providers/managers/publishers/manager.js +++ b/docfiles/providers/managers/publishers/manager.js @@ -1,12 +1,32 @@ /** * Менеджер паблишеров. + *
+ *
+ * **Доступ:** * + * Централизированного доступа к паблишерам нет. + * + * Он осуществляется для каждого менеджера паблишеров в индивидальном порядке, под провайдером, + * + * который его содержит. * @group manager * @namespace Publishers */ function Publishers() { /** - * + * Вернет ссылку на провайдер паблишера. + *
+ *
+ * Пример + * ``` + * var some_provider = null; + * some_provider.publisher_manager.get(new v2.address("some_publisher")).then(function(_ref){ + * var model = _ref.value(); + * // теперь можно работать с провайдером паблишера + * }, function(_err){ + * console.log("произошла ошибка") + * }); + * ``` * @public * @function get * @param {v2.address} address Адрес паблишера diff --git a/docfiles/providers/managers/translations/manager.js b/docfiles/providers/managers/translations/manager.js new file mode 100644 index 0000000..3775255 --- /dev/null +++ b/docfiles/providers/managers/translations/manager.js @@ -0,0 +1,55 @@ +/** + * Менеджер доступа до переводов, которые предоставляет сервер. + * + * ```bash + * // доступ + * ps.pl.core_translations + * ``` + * + * @group manager + * @namespace CoreTranslations + * @extends manager + */ +function CoreTranslations() { + + /** + * Возвращает JSON объект, который содержит переводы. + * + * @example + * // Пример + * var result = ps.pl.core_translations.translations(); + * var string = JSON.stringify(result, true, 3); + * + * // результат будет примерно такой + * // "{ + * // "RightEntities": { + * // "column": { + * // "additionals": "Дополнительно", + * // "contacts": "Контакты", + * // "description": "Описание", + * // "email": "email", + * // "id": "Идентификатор", + * // "name": "Имя", + * // "password": "Пароль", + * // "phone": "Телефон", + * // "position": "Расположение", + * // "surname": "Фамилия" + * // }, + * // "titles": { + * // "Groups": "Список групп", + * // ... + * // }, + * // ... + * // } + * // ... + * // }" + * + * @public + * @function translations + * @memberof CoreTranslations + * @returns {{}} + */ + this.translations = function () { + + } +} \ No newline at end of file diff --git a/templates/initi/static/styles/common.css b/templates/initi/static/styles/common.css index 2b5da0f..5fa1d36 100644 --- a/templates/initi/static/styles/common.css +++ b/templates/initi/static/styles/common.css @@ -92,7 +92,6 @@ div.part > div.desc { div.container-overview > .desc > pre, div.part > pre { margin: 0px; - margin-left: 10px; margin-top: 5px; margin-bottom: 5px; }