[{"data":1,"prerenderedAt":531},["ShallowReactive",2],{"navigation_docs":3,"-modules-options-components":238,"-modules-options-components-surround":528},[4,45,60],{"title":5,"description":6,"icon":7,"path":8,"stem":9,"children":10},"Методология",null,"ruler","\u002Fmethodology","1.methodology",[11,15,20,25,30,35,40],{"title":12,"path":8,"stem":13,"description":14},"bxshef: методология и проверка навыков","1.methodology\u002Findex","Как писать навыки ИИ-агентов для Битрикса и как проверять, что им можно верить",{"title":16,"path":17,"stem":18,"description":19},"Стандарт навыка","\u002Fmethodology\u002Fstandard","1.methodology\u002F1.standard","11 правил, каждое из провала на стенде",{"title":21,"path":22,"stem":23,"description":24},"Методология проверки","\u002Fmethodology\u002Fmethod","1.methodology\u002F2.method","lint → eval → стенд; что измерено",{"title":26,"path":27,"stem":28,"description":29},"bxshef — CLI","\u002Fmethodology\u002Fbxshef","1.methodology\u002F3.bxshef","lint, eval, feedback",{"title":31,"path":32,"stem":33,"description":34},"GitHub Action","\u002Fmethodology\u002Faction","1.methodology\u002F4.action","тот же lint + eval в любом репозитории навыков",{"title":36,"path":37,"stem":38,"description":39},"Заготовка репозитория","\u002Fmethodology\u002Ftemplate","1.methodology\u002F5.template","с чего начать автору модуля",{"title":41,"path":42,"stem":43,"description":44},"Приёмник отзывов","\u002Fmethodology\u002Ffeedback","1.methodology\u002F6.feedback","куда уходят отзывы ИИ-агентов",{"title":46,"description":6,"icon":47,"path":48,"stem":49,"children":50},"Навыки","sparkles","\u002Fskills","2.skills",[51,55],{"title":52,"path":48,"stem":53,"description":54},"Навыки shef.*","2.skills\u002Findex","npx skills add bx-shef\u002Fskills",{"title":56,"path":57,"stem":58,"description":59},"shef-feedback","\u002Fskills\u002Fshef-feedback","2.skills\u002F1.shef-feedback","Отправить отзыв о навыке shef-* или навыке команды. Брать ВСЕГДА, когда просят оставить или отправить отзыв о навыке — даже если сам навык в диалоге не виден, —",{"title":61,"description":6,"icon":62,"path":63,"stem":64,"children":65},"Модули shef.*","package","\u002Fmodules","3.modules",[66,69,131,179],{"title":61,"path":63,"stem":67,"description":68},"3.modules\u002Findex","Что за чем ставить",{"title":70,"description":6,"path":71,"stem":72,"children":73},"shef.options","\u002Fmodules\u002Foptions","3.modules\u002F1.options\u002Findex",[74,76,81,86,91,96,101,106,110,114,119,123,127],{"title":70,"path":71,"stem":72,"description":75},"фундамент: настройки, трейты, компоненты",{"title":77,"path":78,"stem":79,"description":80},"[`\\Shef\\Options\\Installator`] Installer","\u002Fmodules\u002Foptions\u002Finstaller","3.modules\u002F1.options\u002F1.installer","Для облегчения установок.",{"title":82,"path":83,"stem":84,"description":85},"Сборка, CI и релиз","\u002Fmodules\u002Foptions\u002Fbuild-and-install","3.modules\u002F1.options\u002F10.build-and-install","Раскладка репозитория — в module-structure.md, процесс —\nв CONTRIBUTING.md, установка глазами пользователя —\nв README.md.",{"title":87,"path":88,"stem":89,"description":90},"Раскладка репозитория","\u002Fmodules\u002Foptions\u002Fmodule-structure","3.modules\u002F1.options\u002F11.module-structure","Файл про устройство репозитория. Опорные точки модуля — в CLAUDE.md,\nпроцесс — в CONTRIBUTING.md, сборка — в\nbuild-and-install.md.",{"title":92,"path":93,"stem":94,"description":95},"Проверка на портале","\u002Fmodules\u002Foptions\u002Fportal-check","3.modules\u002F1.options\u002F12.portal-check","Всё, что ниже рантайма Битрикса, тестами не закрыть: установка, права, кеш,\nраскладка файлов, поведение при обновлении. Проверять это приходится руками —\nи лучше по списку, потому что забытый шаг находит не разработчик, а клиент.",{"title":97,"path":98,"stem":99,"description":100},"[`\\Shef\\Options\\Main\\Options`] Опции настроек модуля","\u002Fmodules\u002Foptions\u002Foptions","3.modules\u002F1.options\u002F2.options","Поддерживает следующие типы:",{"title":102,"path":103,"stem":104,"description":105},"Работа с пользователями","\u002Fmodules\u002Foptions\u002Fsecurity","3.modules\u002F1.options\u002F3.security","",{"title":107,"path":108,"stem":109,"description":105},"[`\\Shef\\Options\\Main\\Utils`] Утилиты","\u002Fmodules\u002Foptions\u002Futils","3.modules\u002F1.options\u002F4.utils",{"title":111,"path":112,"stem":113,"description":105},"[`\\Shef\\Options\\Components`] Работа с компонентами","\u002Fmodules\u002Foptions\u002Fcomponents","3.modules\u002F1.options\u002F5.components",{"title":115,"path":116,"stem":117,"description":118},"[`\\Shef\\Options\\Options`] Паттерны","\u002Fmodules\u002Foptions\u002Fpattern","3.modules\u002F1.options\u002F6.pattern","Запускаемые примеры: singleton.php,\nconfig.php, smartstd.php —\nкак их гонять, написано в examples\u002FREADME.md.",{"title":120,"path":121,"stem":122,"description":105},"[`\\Shef\\Options\\Tests`] Тестирование","\u002Fmodules\u002Foptions\u002Ftests","3.modules\u002F1.options\u002F7.tests",{"title":124,"path":125,"stem":126,"description":105},"[`\\Shef\\Options\\TraitList`] Набор трейтов","\u002Fmodules\u002Foptions\u002Ftraitlist","3.modules\u002F1.options\u002F8.traitlist",{"title":128,"path":129,"stem":130,"description":105},"Правила для ИИ-агентов в этом репозитории","\u002Fmodules\u002Foptions\u002Fagent-rules","3.modules\u002F1.options\u002F9.agent-rules",{"title":132,"description":6,"path":133,"stem":134,"children":135},"shef.problems","\u002Fmodules\u002Fproblems","3.modules\u002F2.problems\u002Findex",[136,138,143,147,152,157,161,166,169,172,175],{"title":132,"path":133,"stem":134,"description":137},"логи, журнал событий, учёт проблем",{"title":139,"path":140,"stem":141,"description":142},"[`\\Shef\\Problems\\Integration`] События и меню","\u002Fmodules\u002Fproblems\u002Fevents","3.modules\u002F2.problems\u002F1.events","Что модуль регистрирует в ядре при установке. Список — в .settings.php, ключ\ninstallEvents; что каждый обработчик существует, сверяет\ntests\u002Fsettings_test.php.",{"title":144,"path":145,"stem":146,"description":105},"Безопасность логов","\u002Fmodules\u002Fproblems\u002Fsecurity","3.modules\u002F2.problems\u002F10.security",{"title":148,"path":149,"stem":150,"description":151},"Быстрая отладка: `_pr`, `_log`, `_log1`","\u002Fmodules\u002Fproblems\u002Fdeffunctions","3.modules\u002F2.problems\u002F2.deffunctions","Функции объявляет def-functions.php, подключается он из include.php.",{"title":153,"path":154,"stem":155,"description":156},"Уровни логирования","\u002Fmodules\u002Fproblems\u002Floglevel","3.modules\u002F2.problems\u002F3.loglevel","Уровни — стандарт PSR-3, в Monolog это \\Monolog\\Level. Ниже — когда какой брать.",{"title":158,"path":159,"stem":160,"description":105},"[`\\Shef\\Problems\\Integration\\Monolog`] Monolog","\u002Fmodules\u002Fproblems\u002Fmonolog","3.modules\u002F2.problems\u002F4.monolog",{"title":162,"path":163,"stem":164,"description":165},"Ротация логов","\u002Fmodules\u002Fproblems\u002Flogrotate","3.modules\u002F2.problems\u002F5.logrotate","Логи модуля лежат в каталоге логов — по умолчанию на уровень выше корня сайта,\nдля BitrixVM \u002Fhome\u002Fbitrix\u002Fsh_log\u002F*.log, — и сами не чистятся. Ротацию делает\nlogrotate — системная утилита, а не Monolog: Monolog тоже умеет\n(RotatingFileHandler), но тогда за файлами следит каждый PHP-процесс, а не\nодна служба.",{"title":128,"path":167,"stem":168,"description":105},"\u002Fmodules\u002Fproblems\u002Fagent-rules","3.modules\u002F2.problems\u002F6.agent-rules",{"title":82,"path":170,"stem":171,"description":85},"\u002Fmodules\u002Fproblems\u002Fbuild-and-install","3.modules\u002F2.problems\u002F7.build-and-install",{"title":87,"path":173,"stem":174,"description":90},"\u002Fmodules\u002Fproblems\u002Fmodule-structure","3.modules\u002F2.problems\u002F8.module-structure",{"title":92,"path":176,"stem":177,"description":178},"\u002Fmodules\u002Fproblems\u002Fportal-check","3.modules\u002F2.problems\u002F9.portal-check","Всё, что ниже рантайма Битрикса, тестами не закрыть: установка, права, меню,\nраскладка файлов, журнал событий, поведение при обновлении. Проверять это\nприходится руками — и лучше по списку, потому что забытый шаг находит не\nразработчик, а клиент.",{"title":180,"description":6,"path":181,"stem":182,"children":183},"shef.insync","\u002Fmodules\u002Finsync","3.modules\u002F3.insync\u002Findex",[184,186,191,194,198,203,208,213,218,222,227,232,235],{"title":180,"path":181,"stem":182,"description":185},"агенты, импорт, API-клиенты, модели",{"title":187,"path":188,"stem":189,"description":190},"[`\\Shef\\InSync\\Agents`] Агенты","\u002Fmodules\u002Finsync\u002Fagents","3.modules\u002F3.insync\u002F1.agents","Агент импорта — наследник \\Shef\\InSync\\Agents\\AAgent. Описание агента для\nb_agent — \\Shef\\InSync\\Agents\\Entity, установку и управление берёт на себя\n\\Shef\\InSync\\Agents\\Manager.",{"title":87,"path":192,"stem":193,"description":90},"\u002Fmodules\u002Finsync\u002Fmodule-structure","3.modules\u002F3.insync\u002F10.module-structure",{"title":92,"path":195,"stem":196,"description":197},"\u002Fmodules\u002Finsync\u002Fportal-check","3.modules\u002F3.insync\u002F11.portal-check","Всё, что ниже рантайма Битрикса, тестами не закрыть: установка, права, левое\nменю, раскладка компонентов, агенты, таблица импорта, поведение при\nобновлении. Проверять это приходится руками — и лучше по списку, потому что\nзабытый шаг находит не разработчик, а клиент.",{"title":199,"path":200,"stem":201,"description":202},"Безопасность","\u002Fmodules\u002Finsync\u002Fsecurity","3.modules\u002F3.insync\u002F12.security","Модуль даёт другим модулям заготовки для синхронизаций, и самые опасные места\nу него общие с ними: кто может запускать агенты и импорт, что ложится в каталоги\nимпорта, что уходит в SQL и в лог. Ниже — что держит модуль и что остаётся\nпроекту.",{"title":204,"path":205,"stem":206,"description":207},"[`\\Shef\\InSync\\Sync`] Импорт","\u002Fmodules\u002Finsync\u002Fimport","3.modules\u002F3.insync\u002F2.import","Импорт идёт в два шага через таблицу импорта \\Shef\\InSync\\Sync\\Model\\SyncTable\n(shef_insync_model):",{"title":209,"path":210,"stem":211,"description":212},"[`\\Shef\\InSync\\Api`] API","\u002Fmodules\u002Finsync\u002Fapi","3.modules\u002F3.insync\u002F3.api","Обращение к внешнему API по HTTP — наследник \\Shef\\InSync\\Api\\AConnector.",{"title":214,"path":215,"stem":216,"description":217},"[`\\Shef\\InSync\\TraitList\\Xml`] Парсинг XML","\u002Fmodules\u002Finsync\u002Fxml","3.modules\u002F3.insync\u002F4.xml","Разбор XML сделан через SbWereWolf\u002Fxml-navigator\n(статья на Хабре): XMLReader идёт по\nдокументу потоком, а каждый элемент с нужным тегом HierarchyComposer\nпревращает в массив — n имя, v значение, a атрибуты, s вложенные\nэлементы.",{"title":219,"path":220,"stem":221,"description":105},"Компоненты","\u002Fmodules\u002Finsync\u002Fcomponents","3.modules\u002F3.insync\u002F5.components",{"title":223,"path":224,"stem":225,"description":226},"Страницы","\u002Fmodules\u002Finsync\u002Fpage","3.modules\u002F3.insync\u002F6.page","Страницы модуля — в левом меню, штатным разделом intranet\n(Bitrix\\Intranet\\CustomSection): раздел «SH Импорт», код shinsync.\nВерхней панели и shef.uiclear больше нет.",{"title":228,"path":229,"stem":230,"description":231},"[`\\Shef\\InSync\\Main\\Options`] Опции настроек модуля","\u002Fmodules\u002Finsync\u002Foptions","3.modules\u002F3.insync\u002F7.options","Опции для страницы настроек модуля импорта (на ShOptionsConfig из\nshef.options): добавьте их во вкладку своего options_conf.php.",{"title":128,"path":233,"stem":234,"description":105},"\u002Fmodules\u002Finsync\u002Fagent-rules","3.modules\u002F3.insync\u002F8.agent-rules",{"title":82,"path":236,"stem":237,"description":85},"\u002Fmodules\u002Finsync\u002Fbuild-and-install","3.modules\u002F3.insync\u002F9.build-and-install",{"id":239,"title":111,"body":240,"description":105,"extension":522,"meta":523,"navigation":524,"path":112,"rawbody":525,"seo":526,"stem":113,"__hash__":527},"docs\u002F3.modules\u002F1.options\u002F5.components.md",{"type":241,"value":242,"toc":515},"minimark",[243,248,301,305,463,467,480,489,502],[244,245,247],"h2",{"id":246},"соглашение-о-наименовании","Соглашение о наименовании",[249,250,251,279],"ol",{},[252,253,254,255,259],"li",{},"компоненты складываем в папку ",[256,257,258],"code",{},"\u002Flocal\u002Fvendor.modulename\u002Fcustom.name",[249,260,261,267,273],{},[252,262,263,264],{},"namespace ",[256,265,266],{},"Local\\Component\\Vendor\\ModuleName",[252,268,269,270],{},"для компонента class ",[256,271,272],{},"CustomNameComponent",[252,274,275,276],{},"для ajax class ",[256,277,278],{},"CustomNameAjaxController",[252,280,281,282],{},"используем для .js\n",[249,283,284,289,295],{},[252,285,263,286],{},[256,287,288],{},"BX.namespace('BX.VendorModuleName');",[252,290,291,292],{},"class ",[256,293,294],{},"BX.VendorModuleName.CustomNameController",[252,296,297,298],{},"объект ",[256,299,300],{},"BX.VendorModuleName.CustomName",[244,302,304],{"id":303},"классы","Классы",[306,307,308,322],"table",{},[309,310,311],"thead",{},[312,313,314,319],"tr",{},[315,316,318],"th",{"align":317},"right","Класс",[315,320,321],{},"Описание",[323,324,325,341,349,357,365,378,386,394,402,411,419,427,435,447,455],"tbody",{},[312,326,327,331],{},[328,329,330],"td",{"align":317},"Components\\Builder",[328,332,333,334,337,338,340],{},"Класс для работы с компонентами",[335,336],"br",{},"Умеет подключать (просто, через слайдер, автоматически)",[335,339],{},"Умеет создавать объект класса",[312,342,343,346],{},[328,344,345],{"align":317},"Components\\AComponent",[328,347,348],{},"Абстракция для компонента",[312,350,351,354],{},[328,352,353],{"align":317},"Components\\AControllerable",[328,355,356],{},"Абстракция для компонента с поддержкой ajax",[312,358,359,362],{},[328,360,361],{"align":317},"Components\\AjaxProcessor",[328,363,364],{},"Абстракция для обработки ajax запросов вне компонента",[312,366,367,373],{},[328,368,369],{"align":317},[370,371,372],"strong",{},"Components\\Actions",[328,374,375],{},[370,376,377],{},"Набор проверок для ajax запросов",[312,379,380,383],{},[328,381,382],{"align":317},"Components\\Actions\\IActionsFilterList",[328,384,385],{},"Интерфейс для получения действий",[312,387,388,391],{},[328,389,390],{"align":317},"Components\\Actions\\Free",[328,392,393],{},"Без проверки прав доступа",[312,395,396,399],{},[328,397,398],{"align":317},"Components\\Actions\\Normal",[328,400,401],{},"Обычная проверка прав доступа",[312,403,404,409],{},[328,405,406],{"align":317},[370,407,408],{},"Дополнительно",[328,410],{},[312,412,413,416],{},[328,414,415],{"align":317},"Components\\IAutoloader",[328,417,418],{},"Интерфейс для подключения в компоненте механизма автозагрузки",[312,420,421,424],{},[328,422,423],{"align":317},"Components\\IClass",[328,425,426],{},"Интерфейс для указания что компонент содержит файл class.php",[312,428,429,432],{},[328,430,431],{"align":317},"Components\\IAjax",[328,433,434],{},"Интерфейс для указания что компонент содержит файл ajax.php",[312,436,437,442],{},[328,438,439],{"align":317},[370,440,441],{},"Components\\Trait",[328,443,444],{},[370,445,446],{},"Набор трейтов",[312,448,449,452],{},[328,450,451],{"align":317},"Components\\Trait\\ComponentNameTrait",[328,453,454],{},"Trait для обработки названий компонента",[312,456,457,460],{},[328,458,459],{"align":317},"Components\\Trait\\AutoloaderTrait",[328,461,462],{},"Trait для подключения в компоненте механизма автозагрузки",[244,464,466],{"id":465},"использование-механизма-автозагрузчика-в-компоненте","Использование механизма автозагрузчика в компоненте",[468,469,470,471,473,474,476,477,479],"p",{},"Объявляем интерфейс ",[256,472,415],{}," и реализуем его через трейты ",[256,475,451],{}," и ",[256,478,459],{}," .",[481,482,483],"blockquote",{},[468,484,485,486],{},"Отдельно предусматриваем механизм подключения класса из файла ",[256,487,488],{},"ajax.php",[468,490,491,495,496,495,499],{},[492,493,494],"a",{"href":108},"← Утилиты"," | ",[492,497,498],{"href":71},"↑ Содержание",[492,500,501],{"href":116},"Паттерны →",[503,504,505],"note",{},[468,506,507,508,514],{},"Источник: ",[492,509,513],{"href":510,"rel":511},"https:\u002F\u002Fgithub.com\u002Fbx-shef\u002Foptions\u002Fblob\u002Fmain\u002Fdocs\u002F6_components.md",[512],"nofollow","options\u002Fdocs\u002F6_components.md"," — правки туда, сайт пересобирается сам.",{"title":105,"searchDepth":516,"depth":516,"links":517},3,[518,520,521],{"id":246,"depth":519,"text":247},2,{"id":303,"depth":519,"text":304},{"id":465,"depth":519,"text":466},"md",{},true,"---\ntitle: \"[`\\\\Shef\\\\Options\\\\Components`] Работа с компонентами\"\n---\n\n## Соглашение о наименовании\n1. компоненты складываем в папку `\u002Flocal\u002Fvendor.modulename\u002Fcustom.name`\n   1. namespace `Local\\Component\\Vendor\\ModuleName`\n   2. для компонента class `CustomNameComponent`\n   3. для ajax class `CustomNameAjaxController`\n2. используем для .js\n   1. namespace `BX.namespace('BX.VendorModuleName');`\n   2. class `BX.VendorModuleName.CustomNameController`\n   3. объект `BX.VendorModuleName.CustomName`\n\n## Классы\n\n|                                 Класс | Описание                                                                                                                      |\n|--------------------------------------:|-------------------------------------------------------------------------------------------------------------------------------|\n|                    Components\\Builder | Класс для работы с компонентами\u003Cbr\u002F>Умеет подключать (просто, через слайдер, автоматически)\u003Cbr\u002F>Умеет создавать объект класса |\n|                 Components\\AComponent | Абстракция для компонента                                                                                                     |\n|            Components\\AControllerable | Абстракция для компонента с поддержкой ajax                                                                                   |\n|              Components\\AjaxProcessor | Абстракция для обработки ajax запросов вне компонента                                                                         |\n|                **Components\\Actions** | **Набор проверок для ajax запросов**                                                                                          |\n| Components\\Actions\\IActionsFilterList | Интерфейс для получения действий                                                                                              |\n|               Components\\Actions\\Free | Без проверки прав доступа                                                                                                     |\n|             Components\\Actions\\Normal | Обычная проверка прав доступа                                                                                                 |\n|                     **Дополнительно** |                                                                                                                               |\n|                Components\\IAutoloader | Интерфейс для подключения в компоненте механизма автозагрузки                                                                 |\n|                     Components\\IClass | Интерфейс для указания что компонент содержит файл class.php                                                                  |\n|                      Components\\IAjax | Интерфейс для указания что компонент содержит файл ajax.php                                                                   |\n|                  **Components\\Trait** | **Набор трейтов**                                                                                                             |\n|   Components\\Trait\\ComponentNameTrait | Trait для обработки названий компонента                                                                                       |\n|      Components\\Trait\\AutoloaderTrait | Trait для подключения в компоненте механизма автозагрузки                                                                     |\n\n## Использование механизма автозагрузчика в компоненте\nОбъявляем интерфейс `Components\\IAutoloader` и реализуем его через трейты `Components\\Trait\\ComponentNameTrait` и `Components\\Trait\\AutoloaderTrait` .\n> Отдельно предусматриваем механизм подключения класса из файла `ajax.php`\n\n[← Утилиты](\u002Fmodules\u002Foptions\u002Futils) | [↑ Содержание](\u002Fmodules\u002Foptions) | [Паттерны →](\u002Fmodules\u002Foptions\u002Fpattern)\n\n::note\nИсточник: [options\u002Fdocs\u002F6_components.md](https:\u002F\u002Fgithub.com\u002Fbx-shef\u002Foptions\u002Fblob\u002Fmain\u002Fdocs\u002F6_components.md) — правки туда, сайт пересобирается сам.\n::\n\n",{"title":111,"description":105},"2lgqQ5cKDRFzc6My8RiVlhKaMqWKmxFuFan8Ms71CKU",[529,530],{"title":107,"path":108,"stem":109,"description":105,"children":-1},{"title":115,"path":116,"stem":117,"description":118,"children":-1},1790857270859]