{"id":15792550,"url":"https://github.com/adrenalinkin/visualize-entity-bundle","last_synced_at":"2026-05-04T21:35:13.638Z","repository":{"id":56941124,"uuid":"125910745","full_name":"adrenalinkin/visualize-entity-bundle","owner":"adrenalinkin","description":"Provides possibility for visualize entity data by YAML configuration","archived":false,"fork":false,"pushed_at":"2018-04-10T10:25:58.000Z","size":33,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2023-08-20T07:44:01.577Z","etag":null,"topics":["symfony-bundle","visualize-entity","visualize-entity-data","visualizer","yaml","yaml-configuration"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adrenalinkin.png","metadata":{"files":{"readme":"README.RU.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-19T19:38:17.000Z","updated_at":"2018-04-10T10:25:59.000Z","dependencies_parsed_at":"2022-08-21T07:20:37.786Z","dependency_job_id":null,"html_url":"https://github.com/adrenalinkin/visualize-entity-bundle","commit_stats":null,"previous_names":[],"tags_count":1,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrenalinkin%2Fvisualize-entity-bundle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrenalinkin%2Fvisualize-entity-bundle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrenalinkin%2Fvisualize-entity-bundle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrenalinkin%2Fvisualize-entity-bundle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adrenalinkin","download_url":"https://codeload.github.com/adrenalinkin/visualize-entity-bundle/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrenalinkin%2Fvisualize-entity-bundle/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259123865,"owners_count":22808876,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["symfony-bundle","visualize-entity","visualize-entity-data","visualizer","yaml","yaml-configuration"],"created_at":"2024-10-04T23:01:51.852Z","updated_at":"2026-05-04T21:35:13.607Z","avatar_url":"https://github.com/adrenalinkin.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"Visualize Entity Bundle [![In English](https://img.shields.io/badge/Switch_To-English-green.svg?style=flat-square)](./README.md)\n=======================\n\nВведение\n--------\n\nБандл предоставляет возможность выводить данные сущности для просмотра при помощи YAML конфига.\n\nУстановка\n---------\n\n### Шаг 1: Загрузка бандла\n\nОткройте консоль и, перейдя в директорию проекта, выполните следующую команду для загрузки наиболее подходящей\nстабильной версии этого бандла:\n```bash\n    composer require adrenalinkin/visualize-entity-bundle\n```\n*Эта команда подразумевает что [Composer](https://getcomposer.org) установлен и доступен глобально.*\n\n### Шаг 2: Подключение бандла\n\nПосле включите бандл добавив его в список зарегистрированных бандлов в `app/AppKernel.php` файл вашего проекта:\n\n```php\n\u003c?php\n// app/AppKernel.php\n\nclass AppKernel extends Kernel\n{\n    // ...\n\n    public function registerBundles()\n    {\n        $bundles = [\n            // ...\n\n            new Linkin\\Bundle\\EntityHelperBundle\\LinkinEntityHelperBundle(),\n            new Linkin\\Bundle\\VisualizeEntityBundle\\LinkinVisualizeEntityBundle(),\n        ];\n\n        return $bundles;\n    }\n\n    // ...\n}\n```\n\nКонфигурация\n------------\n\nЧтобы начать использовать бандл вам необходимо создать конфигурационный файл в необходимом бандле вашего проекта.\nПростейшая конфигурация сущности пользователя для вывода трех полей:\n\n```yaml\nlinkin_visualize_entity:\n    acme_user_default:\n        className:    AcmeBundle:User\n        fields:\n            username:   ~\n            firstName:  ~\n            email:      ~\n```\n\nПодробнее с файлом конфигурации можно ознакомиться в разделе\n[Конфигурационный файл visualize_entity.yml](Resources/doc/ru/visualize_entity.md).\n\nИспользование\n-------------\n\nПример использования предполагает использование простейшей конфигурации, составленной в предыдущем разделе.\n\n### Контроллер\n\nЧтобы применить созданную ранее конфигурацию вывода данных сущности достаточно вызвать сервис\n`linkin_visualize_entity.builder` и вызвать построение объекта при помощи метода `buildViewEntity`,\nпередав название конфигурации и идентификатор сущности или саму сущность непосредственно.\n\n```php\n\u003c?php\n\nuse Sensio\\Bundle\\FrameworkExtraBundle\\Configuration\\Method;\nuse Sensio\\Bundle\\FrameworkExtraBundle\\Configuration\\Route;\nuse Sensio\\Bundle\\FrameworkExtraBundle\\Configuration\\Template;\n\nuse Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller;\n\n/**\n * @Route(\"acme_user\")\n */\nclass AcmeController extends Controller\n{\n    /**\n     * @Route(\"/user_view/{id}\", name=\"acme_user_view\")\n     *\n     * @Method(\"GET\")\n     *\n     * @Template()\n     *\n     * @param int $id\n     *\n     * @return array\n     */\n    public function viewAction($id)\n    {\n        $viewEntity = $this-\u003eget('linkin_visualize_entity.builder')-\u003ebuildViewEntity('acme_user_default', $id);\n\n        return [\n            'viewEntity' =\u003e $viewEntity,\n        ];\n    }\n}\n```\n\n### Шаблон TWIG\n\nОбъект класса `ViewEntity` открывает ряд возможностей для работы в twig-шаблоне. \nСамый простой способ - это вывод всех полей, которые еще не отображались. Метод `notDisplayed`.\n\n```twig\n    {# @var viewEntity \\Linkin\\Bundle\\VisualizeEntityBundle\\Entity\\ViewEntity #}\n\n    \u003ctable class=\"striped\"\u003e\n        \u003ctbody\u003e\n        {% for fieldData in viewEntity.notDisplayed %}\n            \u003ctr\u003e\n                \u003ctd\u003e\u003cb\u003e{{ fieldData.label }}:\u003c/b\u003e\u003c/td\u003e\n                \u003ctd\u003e{{ fieldData.value|raw }}\u003c/td\u003e\n            \u003c/tr\u003e\n        {% endfor %}\n        \u003c/tbody\u003e\n    \u003c/table\u003e\n```\n\nПри необходимости вывода некоторых полей в специальном форматировании стоит воспользоваться методом `fieldData`.\nПоследующий вызов метода `notDisplayed` вернет данные которые не будут содержать ранее показанные.\n\n```twig\n    {# @var viewEntity \\Linkin\\Bundle\\VisualizeEntityBundle\\Entity\\ViewEntity #}\n\n    \u003ctable class=\"striped\"\u003e\n        \u003cthead\u003e\n        \u003cth\u003e\n            \u003ctd\u003e{{ viewEntity.fieldData('username').label }}\u003c/td\u003e\n            \u003ctd\u003e{{ viewEntity.fieldData('username').value|raw }}\u003c/td\u003e\n        \u003c/th\u003e\n        \u003c/thead\u003e\n        \u003ctbody\u003e\n        {% for fieldData in viewEntity.notDisplayed %}\n            \u003ctr\u003e\n                \u003ctd\u003e\u003cb\u003e{{ fieldData.label }}:\u003c/b\u003e\u003c/td\u003e\n                \u003ctd\u003e{{ fieldData.value|raw }}\u003c/td\u003e\n            \u003c/tr\u003e\n        {% endfor %}\n        \u003c/tbody\u003e\n    \u003c/table\u003e\n```\n\nТакже можно воспользоваться рядом других методов для более специфичных случаев:\n * `entity` - для получения объекта вывода.\n * `entityId` - для получения идентификатора объекта.\n * `all` - для получения всех полей вывода не учитывая, были ли они уже отображены или нет. При этом можно\n    передать названия полей, которые следует исключить.\n * `alreadyDisplayed` - список всех уже отображенных полей.\n * `resetDisplayed` - сбросить статистику отображенных полей.\n\nВизуализаторы\n-------------\n\nВизуализация различных типов данных регулируется при помощи визуализаторов. Ознакомиться со всеми предустановленными\nвизуализаторами можно в разделе \n[Описание зарегистрированных визуализаторов](Resources/doc/ru/visualizers_description.md).\nПодробнее о создании собственного визуализатора в разделе \n[Добавление нового визуализатора](Resources/doc/ru/visualizer_registration.md).\n\nЗависимости\n-----------\n\n * [EntityHelperBundle](https://github.com/adrenalinkin/entity-helper-bundle)\n\nЛицензия\n--------\n\n[![license](https://img.shields.io/badge/License-MIT-green.svg?style=flat-square)](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrenalinkin%2Fvisualize-entity-bundle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadrenalinkin%2Fvisualize-entity-bundle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrenalinkin%2Fvisualize-entity-bundle/lists"}