{"id":1358,"date":"2019-03-19T02:00:55","date_gmt":"2019-03-19T05:00:55","guid":{"rendered":"https:\/\/magenteiro.com\/blog\/?p=1358"},"modified":"2023-01-22T21:59:43","modified_gmt":"2023-01-23T00:59:43","slug":"menu-admin-e-controller-no-magento-2","status":"publish","type":"post","link":"https:\/\/www.magenteiro.com\/blog\/magento-2\/menu-admin-e-controller-no-magento-2\/","title":{"rendered":"Criando um menu no admin, com ACL e Controller no Magento 2"},"content":{"rendered":"\n

Como j\u00e1 vimos anteriormente, os controllers<\/em> s\u00e3o classes respons\u00e1veis por tratar uma requisi\u00e7\u00e3o. Neste artigo veremos como criar um controller<\/em> na \u00e1rea administrativa da nossa loja Magento 2, e tamb\u00e9m como definir permiss\u00f5es de quem pode acess\u00e1-lo (ACL). Al\u00e9m disso, ainda vamos adicionar um item no menu do nosso admin para acessar esta nova p\u00e1gina.<\/p>\n\n\n\n

Este \u00e9 um artigo b\u00f4nus da s\u00e9rie sobre controllers<\/em> no Magento 2<\/a> aqui do Magenteiro.<\/p><\/blockquote>\n\n\n\n

No primeiro artigo da s\u00e9rie vimos como criar um controller frontend<\/em> no Magento 2<\/a>. Em seguida vimos como aplicar um Layout XML ao nosso controller<\/em><\/a>.<\/p>\n\n\n\n

Criar um controller <\/em>no backend<\/em> tem algumas diferen\u00e7as em rela\u00e7\u00e3o ao controller<\/em> no frontend<\/em>. Ao decorrer do artigo voc\u00ea perceber\u00e1.
<\/em><\/p>\n\n\n\n

Neste tutorial n\u00f3s vamos ver:<\/p>\n\n\n\n

  1. Como criar um item no menu do admin<\/em> do Magento 2<\/a><\/li>
  2. Como criar a classe do nosso controller<\/em><\/a><\/li>
  3. Como definir o arquivo de rotas do admin (routes.xml)<\/a><\/li>
  4. Definindo o ACL (Quem pode acessar esta \u00e1rea no admin)<\/a><\/li>
  5. Testar nosso link no admin<\/a><\/li><\/ol>\n\n\n\n

    Premissa:<\/strong> Partirei do princ\u00edpio que voc\u00ea j\u00e1 criou a estrutura b\u00e1sica de um m\u00f3dulo de Magento 2. Neste exemplo nosso m\u00f3dulo se chamar\u00e1 Magenteiro_Admin<\/code>.<\/p>\n\n\n\n

    <\/a>1. Criando um item no menu do admin<\/h2>\n\n\n\n

    Vamos criar um item de menu principal chamado Magenteiro Menu<\/strong> e dentro dele um Item Menu<\/strong> que ir\u00e1 redirecionar para uma o meu Index.php<\/code>.<\/p>\n\n\n\n

    <?xml version=\"1.0\"?>\n<config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"urn:magento:module:Magento_Backend:etc\/menu.xsd\">\n    <menu>\n        <add id=\"Magenteiro_Admin::menu\" title=\"Magenteiro Menu\" module=\"Magenteiro_Admin\" resource=\"Magenteiro_Admin::menu\" sortOrder=\"10\"\/>\n        <add id=\"Magenteiro_Admin::item\" title=\"Item Menu\" module=\"Magenteiro_Admin\" resource=\"Magenteiro_Admin::item\" parent=\"Magenteiro_Admin::menu\" action=\"magenteiroadmin\/item\"\/>\n    <\/menu>\n<\/config><\/pre>\n\n\n\n
    A esta altura, se limparmos o cache da loja, j\u00e1 podemos ver nosso menu por l\u00e1.<\/p>\n\n\n\n
    \"Menu<\/h2>\n\n\n\n
    2. <\/a>Criando a classe do nosso Controller<\/em><\/h2>\n\n\n\n
    Como vimos no primeiro artigo da s\u00e9rie, cada action<\/em> tem um controller<\/em> espec\u00edfico com um m\u00e9todo execute(). No admin<\/em> n\u00e3o \u00e9 diferente, com algumas pequenas diferen\u00e7as na classe.<\/p>\n\n\n\n
    <?php\nnamespace Magenteiro\\Admin\\Controller\\Adminhtml\\Item;\n\n\nclass Index extends \\Magento\\Backend\\App\\Action\n{\n    \/**\n     * @var \\Magento\\Framework\\View\\Result\\PageFactory\n     *\/\n    protected $resultPageFactory;\n\n    public function __construct(\n        \\Magento\\Backend\\App\\Action\\Context $context,\n        \\Magento\\Framework\\View\\Result\\PageFactory $resultPageFactory)\n    {\n        parent::__construct($context);\n        $this->resultPageFactory = $resultPageFactory;\n    }\n\n    \/**\n     * @return \\Magento\\Framework\\App\\ResponseInterface|\\Magento\\Framework\\Controller\\ResultInterface|void\n     *\/\n    public function execute()\n    {\n        return  $resultPage = $this->resultPageFactory->create();\n    }\n\n    protected function _isAllowed()\n    {\n        return $this->_authorization->isAllowed('Magenteiro_Admin::item');\n    }\n}<\/pre>\n\n\n\n
    <\/a>3. Definindo o arquivo de rotas (routes.xml)<\/h2>\n\n\n\n
    Nosso arquivo de rotas tamb\u00e9m tem algumas diferen\u00e7as do arquivo de rotas do front end<\/em>. Note que o router id agora \u00e9 “admin” e o nosso route id<\/code> e frontName<\/code> possuem o mesmo nome.<\/p>\n\n\n\n
    <config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"urn:magento:framework:App\/etc\/routes.xsd\">\n    <router id=\"admin\">\n        <route id=\"magenteiroadmin\" frontName=\"magenteiroadmin\">\n            <module name=\"Magenteiro_Admin\"\/>\n        <\/route>\n    <\/router>\n<\/config><\/pre>\n\n\n\n
    <\/a>4. Definindo o ACL<\/h2>\n\n\n\n
    Note que no passo 2, n\u00f3s criamos um m\u00e9todo chamado _isAllowed<\/code>, respons\u00e1vel por checar se a pessoa que est\u00e1 acessando nosso controller<\/em> est\u00e1 autorizada a ver esta p\u00e1gina.<\/p>\n\n\n\n
    Agora temos que declarar isso no arquivo acl.xml<\/code> para que esta op\u00e7\u00e3o apare\u00e7a no gerenciamento de acesso administrativo do Magento.<\/p>\n\n\n\n
    <?xml version=\"1.0\"?>\n<config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"urn:magento:framework:Acl\/etc\/acl.xsd\">\n    <acl>\n        <resources>\n            <resource id=\"Magento_Backend::admin\">\n                <resource id=\"Magenteiro_Admin::menu\" sortOrder=\"10\" disabled=\"false\" title=\"Magenteiro Menu\">\n                    <resource id=\"Magenteiro_Admin::item\" sortOrder=\"20\" disabled=\"false\" title=\"Menu Item\"\/>\n                <\/resource>\n            <\/resource>\n        <\/resources>\n    <\/acl>\n<\/config><\/pre>\n\n\n\n
    Lembre-se de adicionar Magento_Backend::admin<\/code> no come\u00e7o da hierarquia.<\/p>\n\n\n\n
    Se editarmos um dos grupos de acesso em System > Permission > User Roles<\/em>, veremos:<\/p>\n\n\n\n
    \"Editando<\/a><\/a>5. Testando tudo<\/h2>\n\n\n\n
    Ap\u00f3s limpar caches e ativar o m\u00f3dulo (caso n\u00e3o tenha feito isso ainda), s\u00f3 precisamos testar.<\/p>\n\n\n\n
    Se n\u00e3o estiver trabalhando no modo desenvolvedor<\/a>, provavelmente precisar\u00e1 atualizar as inje\u00e7\u00f5es de depend\u00eancias<\/a> com o comando bin\/magento setup:upgrade<\/code>.<\/p>\n\n\n\n
    \"Magento<\/a><\/figure>\n\n\n\n
    Conclus\u00e3o<\/h2>\n\n\n\n
    Se voc\u00ea trabalhou com Magento 1, p\u00f4de ver que ficou at\u00e9 mais f\u00e1cil criar um item no menu e uma p\u00e1gina no admin do Magento, n\u00e3o \u00e9 mesmo?<\/p>\n\n\n\n
    Apesar de termos criado um item novo no menu, voc\u00ea pode criar apenas um submenu em um dos contextos j\u00e1 existentes. Basta us\u00e1-lo como parent<\/code> no passo 1 ao inv\u00e9s do Magenteiro_Admin::menu<\/code> e n\u00e3o adicionar o primeiro item (sem parent).<\/p>\n\n\n\n
    Se quiser ver esta e muitas outras explica\u00e7\u00f5es com mais detalhes, e fazer parte de um grupo de pessoas famintas por aprender Magento 2, junte-se \u00e0 n\u00f3s no Curso de desenvolvimento para Magento 2<\/a>.<\/p>\n\n\n\n
     <\/h2>\n\n\n\n
    N\u00e3o deu certo pra voc\u00ea? Perdeu alguma coisa no caminho?<\/h2>\n\n\n\n
    \u00c0s vezes n\u00e3o conseguimos ver onde erramos. Se quiser, coloque seu e-mail abaixo e receba o m\u00f3dulo que acabamos de criar aqui<\/strong>.<\/p>\n\n\n\n