документация для переводов, каталога датасорсов, конфига
обновление документация под текущие реалии
This commit is contained in:
parent
46fe25fc86
commit
ab6ad01441
@ -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**
|
||||
*
|
||||
*
|
||||
*
|
||||
|
||||
@ -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();
|
||||
|
||||
/**
|
||||
*
|
||||
|
||||
86
docfiles/providers/managers/core_config/manager.js
Normal file
86
docfiles/providers/managers/core_config/manager.js
Normal file
@ -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 () {
|
||||
|
||||
};
|
||||
}
|
||||
37
docfiles/providers/managers/datasource/manager.js
Normal file
37
docfiles/providers/managers/datasource/manager.js
Normal file
@ -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 () {
|
||||
|
||||
}
|
||||
}
|
||||
@ -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
|
||||
|
||||
@ -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 Адрес модели
|
||||
|
||||
@ -1,15 +1,31 @@
|
||||
/**
|
||||
* Менеджер для доступа к типам моделей
|
||||
*
|
||||
* Это системный менеджер, и нужен для работы {@link Models.Model.Groups.Group ModelGroup}
|
||||
* ```bash
|
||||
* // доступ
|
||||
* ps.pl.mtm
|
||||
* ```
|
||||
* @group manager
|
||||
* @namespace ModelTypes
|
||||
*/
|
||||
function ModelTypes() {
|
||||
/**
|
||||
* Вернет ссылку на Тип группы.
|
||||
*
|
||||
* <br/>
|
||||
* <br/>
|
||||
* Пример
|
||||
* ```
|
||||
* 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
|
||||
*/
|
||||
|
||||
@ -1,12 +1,32 @@
|
||||
/**
|
||||
* Менеджер паблишеров.
|
||||
* <br>
|
||||
* <br>
|
||||
* **Доступ:**
|
||||
*
|
||||
* Централизированного доступа к паблишерам нет.
|
||||
*
|
||||
* Он осуществляется для каждого менеджера паблишеров в индивидальном порядке, под провайдером,
|
||||
*
|
||||
* который его содержит.
|
||||
* @group manager
|
||||
* @namespace Publishers
|
||||
*/
|
||||
function Publishers() {
|
||||
/**
|
||||
*
|
||||
* Вернет ссылку на провайдер паблишера.
|
||||
* <br/>
|
||||
* <br/>
|
||||
* Пример
|
||||
* ```
|
||||
* 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 Адрес паблишера
|
||||
|
||||
55
docfiles/providers/managers/translations/manager.js
Normal file
55
docfiles/providers/managers/translations/manager.js
Normal file
@ -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 () {
|
||||
|
||||
}
|
||||
}
|
||||
@ -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;
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user