diff --git a/docfiles/mainpage/main.js b/docfiles/mainpage/main.js index d9bf2ef..e142b43 100644 --- a/docfiles/mainpage/main.js +++ b/docfiles/mainpage/main.js @@ -40,6 +40,7 @@ * - - #### {@link ModelTypes} * - - #### {@link GroupTypes} - Менеджер для доступа к типам компонентов * - - #### {@link CoreConfig} + * - - #### {@link CoreErrors} * - - #### {@link CoreTranslations} * - - #### {@link Datasource} * - - #### {@link UserManager} - Менеджер для доступа к настройкам доступа пользователей @@ -136,9 +137,10 @@ * - {@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** - * - {@link UserManager} - Менеджер, для доступа к данным пользоваталей, определен как **ps.pl.user_manager** + * - {@link CoreErrors} - Менеджер, для доступа к конфигу платформы, определен как **ps.pl.core_errors** + * - {@link CoreTranslations} - Менеджер, для доступа к переводам, определен как **ps.pl.translations** + * - {@link Datasource} - Менеджер, для к каталогу датасорсов, определен как **ps.pl.datasources** + * - {@link UserManager} - Менеджер, для доступа к данным пользоваталей, определен как **ps.pl.users** * * * diff --git a/docfiles/providers/interface/platform.js b/docfiles/providers/interface/platform.js index 057db5e..cd5c1ed 100644 --- a/docfiles/providers/interface/platform.js +++ b/docfiles/providers/interface/platform.js @@ -13,9 +13,10 @@ * - {@link Models} - Менеджер, для доступа к устройствам, определен как **mm** * - {@link Trees} - Менеджер, для доступа к деревьям, определен как **tm** * - {@link CoreConfig} - Менеджер, для доступа к конфигу платформы, определен как **core_config** - * - {@link CoreTranslations} - Менеджер, для доступа к переводам, определен как **core_translations** - * - {@link Datasource} - Менеджер, для к каталогу датасорсов, определен как **datasource_manager** - * - {@link UserManager} - Менеджер, для доступа к данным пользоваталей, определен как **user_manager** + * - {@link CoreErrors} - Менеджер, для доступа к списку ошибок, определен как **core_errors** + * - {@link CoreTranslations} - Менеджер, для доступа к переводам, определен как **translations** + * - {@link Datasource} - Менеджер, для к каталогу датасорсов, определен как **datasources** + * - {@link UserManager} - Менеджер, для доступа к данным пользоваталей, определен как **users** * * @group providers_interface * @namespace Platform @@ -59,11 +60,11 @@ function Platform() { /** * * @public - * @name core_translations + * @name translations * @type {CoreTranslations} * @memberof Platform */ - this.core_translations = new CoreTranslations(); + this.translations = new CoreTranslations(); /** * @@ -77,20 +78,29 @@ function Platform() { /** * * @public - * @name datasource_manager - * @type {Datasource} + * @name core_errors + * @type {CoreErrors} * @memberof Platform */ - this.datasource_manager = new Datasource(); + this.core_errors = new CoreErrors(); /** * * @public - * @name user_manager + * @name datasources + * @type {Datasource} + * @memberof Platform + */ + this.datasources = new Datasource(); + + /** + * + * @public + * @name users * @type {UserManager} * @memberof Platform */ - this.user_manager = new UserManager(); + this.users = new UserManager(); /** * diff --git a/docfiles/providers/managers/core_errors/manager.js b/docfiles/providers/managers/core_errors/manager.js new file mode 100644 index 0000000..c1abb62 --- /dev/null +++ b/docfiles/providers/managers/core_errors/manager.js @@ -0,0 +1,35 @@ +/** + * ### Серверные ошибки + * + * Интерфейс предоставляющий доступ к списку ошибок платформы. + * + * ```bash + * // доступ + * ps.pl.core_errors + * ``` + * + * @group manager + * @namespace CoreErrors + * @extends manager + */ +function CoreErrors() { + /** + * Возвратит перевод названия и описания для ошибки. + *
+ *
+ * Пример + * ```javascript + * var error_info = ps.pl.core_errors.get_error(101); + * // Вывод => + * // {name: "Узел не существует", description: "Узел с требуемым индексом не содержится в дереве п…. Данный код ошибки используется в masterProvider"} + * ``` + * @public + * @function get_error + * @memberof CoreErrors + * @param {number} _id + * @returns {{}} + */ + this.get_error = function (_id) { + + }; +} \ No newline at end of file diff --git a/docfiles/providers/managers/datasource/manager.js b/docfiles/providers/managers/datasource/manager.js index ee944f1..5323c2a 100644 --- a/docfiles/providers/managers/datasource/manager.js +++ b/docfiles/providers/managers/datasource/manager.js @@ -5,7 +5,7 @@ * * ```bash * // доступ - * ps.pl.datasource_manager + * ps.pl.datasources * ``` * * @group manager diff --git a/docfiles/providers/managers/models/model.js b/docfiles/providers/managers/models/model.js index b1c566f..fca9d69 100644 --- a/docfiles/providers/managers/models/model.js +++ b/docfiles/providers/managers/models/model.js @@ -109,6 +109,59 @@ function Model() { }; + /** + * + * @public + * @function get_base_components + * @memberof Models.Model + * @param groupType {v2.model_type} + * @returns {tools.promise()} + */ + this.get_base_components = function () { + + }; + + /** + * + * @public + * @function get_components + * @memberof Models.Model + * @param {v2.string} _c_tag + * @param {v2.list} _parent_c_tags + * @returns {tools.promise()} + */ + this.get_components = function (_c_tag, _parent_c_tags) { + + }; + + /** + * + * @public + * @function get_components_with_id + * @memberof Models.Model + * @param {v2.string} _c_tag + * @param {v2.list} _parent_c_tags + * @param {v2.string} _id + * @returns {tools.promise()} + */ + this.get_components_with_id = function (_c_tag, _parent_c_tags, _id) { + + }; + /** + * + * @public + * @function get_components_with_parent_id + * @memberof Models.Model + * @param {v2.string} _c_tag + * @param {v2.list} _parent_c_tags + * @param {v2.string} _parent_id + * @returns {tools.promise()} + */ + this.get_components_with_parent_id = function (_c_tag, _parent_c_tags, _parent_id) { + + }; + + /** * * @public diff --git a/docfiles/providers/managers/translations/manager.js b/docfiles/providers/managers/translations/manager.js index 3b36eeb..90e83b3 100644 --- a/docfiles/providers/managers/translations/manager.js +++ b/docfiles/providers/managers/translations/manager.js @@ -5,7 +5,7 @@ * * ```bash * // доступ - * ps.pl.core_translations + * ps.pl.translations * ``` * * @group manager @@ -19,7 +19,7 @@ function CoreTranslations() { * * @example * // Пример - * var result = ps.pl.core_translations.translations(); + * var result = ps.pl.translations.translations(); * var string = JSON.stringify(result, true, 3); * * // результат будет примерно такой diff --git a/docfiles/providers/managers/user/manager.js b/docfiles/providers/managers/user/manager.js index a2867ba..76b030d 100644 --- a/docfiles/providers/managers/user/manager.js +++ b/docfiles/providers/managers/user/manager.js @@ -4,7 +4,7 @@ * * ```bash * // доступ - * ps.pl.user_manager + * ps.pl.users * ``` * * @group manager