{"id":23439567,"url":"https://github.com/ciricihq/cake-adminlte","last_synced_at":"2025-04-13T07:52:57.460Z","repository":{"id":54360478,"uuid":"58330772","full_name":"ciricihq/cake-adminlte","owner":"ciricihq","description":"[WIP] AdminLTE theme for CakePHP 3","archived":false,"fork":false,"pushed_at":"2023-11-17T14:40:43.000Z","size":76,"stargazers_count":9,"open_issues_count":0,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-13T07:52:52.343Z","etag":null,"topics":["adminlte","cake-plugin","cakephp","knpmenu","menus","plugin","themes"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ciricihq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-05-08T20:49:23.000Z","updated_at":"2023-11-17T14:41:19.000Z","dependencies_parsed_at":"2024-12-23T15:32:17.911Z","dependency_job_id":"2ff55862-1ee5-4cba-90b8-fe639d49601a","html_url":"https://github.com/ciricihq/cake-adminlte","commit_stats":{"total_commits":64,"total_committers":4,"mean_commits":16.0,"dds":0.109375,"last_synced_commit":"92d86d3f63ad28837fe2e3adbcc0bec367115755"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ciricihq%2Fcake-adminlte","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ciricihq%2Fcake-adminlte/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ciricihq%2Fcake-adminlte/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ciricihq%2Fcake-adminlte/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ciricihq","download_url":"https://codeload.github.com/ciricihq/cake-adminlte/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248681493,"owners_count":21144700,"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":["adminlte","cake-plugin","cakephp","knpmenu","menus","plugin","themes"],"created_at":"2024-12-23T15:30:27.762Z","updated_at":"2025-04-13T07:52:57.427Z","avatar_url":"https://github.com/ciricihq.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"AdminLTE theme for CakePHP 3\n============================\n\n[![Build status][build svg]][build status]\n[![Code coverage][coverage svg]][coverage]\n[![License][license svg]][license]\n[![Latest stable version][releases svg]][releases]\n[![Total downloads][downloads svg]][downloads]\n[![Code climate][climate svg]][climate]\n\nInstallation\n------------\n\nYou can install this plugin into your CakePHP application using [composer][composer].\n\nThe recommended way to install composer packages is:\n\n~~~bash\ncomposer require ciricihq/adminlte\n~~~\n\n### Installing dependencies\n\nCurrently this theme uses [NPM][npm] to install external dependencies such as bootstrap,\nfontawesome or the AdminLTE itself.\n\nTo install all the dependencies, just run (within the plugin folder):\n\n~~~bash\nnpm install \u0026\u0026 ./node_modules/gulp/bin/gulp.js\n~~~\n\nConfiguration\n-------------\n\nFirst you need to load the plugin. To do so, edit your `bootstrap.php` file and\nadd line below:\n\n~~~php\nPlugin::load('Cirici/AdminLTE', ['bootstrap' =\u003e true]);\n~~~\n\nAfter that, you can easily use the AdminLTE template making your controllers\nextend the AdminLTE `AppController`:\n\n~~~php\nuse Cirici\\AdminLTE\\Controller\\AppController as BaseController;\n\nclass MyController extends BaseController\n{\n\n}\n~~~\n\nUsage\n-----\n\nFirst of, take a look to the `bootstrap.php` file to see what can you configure\nwith `Configure`.\n\nTo load your custom configurations you can obviously use `Configure::write` where\nyou need, but the recommended way is creating a `adminlte.php` file under your\n`CONFIG` folder (usually `/config`):\n\n~~~php\n\u003c?php\n// /config/adminlte.php\nreturn [\n    'AdminLTE' =\u003e [\n        'texts' =\u003e [\n            'logo' =\u003e '\u003cb\u003eAwesome\u003c/b\u003eAdmin'\n        ]\n    ]\n];\n~~~\n\n### Login template\n\nA login template and layout are included too. To use them, simply render the\nlogin Template from you `login` method:\n\n~~~php\n// some kind of users Controller\npublic function logic()\n{\n    // [...]\n    // Your login logic\n\n    $this-\u003erender('Cirici/AdminLTE./Admin/Users/login');\n}\n~~~\n\n### Menus\n\nThis plugin uses [KnpMenu][KnpMenu] for managing its menus and also includes a\nYaml parser so you can easily create your menus with just three lines of code and\na yaml file:\n\n~~~php\nuse Cake\\Event\\EventManager;\nuse Cirici\\AdminLTE\\Renderer\\YamlMenuParser;\n\nEventManager::instance()-\u003eon('AdminLTE.menu.sidebar', function ($event, $menu) {\n    $yaml = new YamlMenuParser($menu, 'admin_menu_sidebar.yaml');\n});\n~~~\n\nWith a yaml file like this one:\n\n~~~yaml\nSettings:\n  uri: '#'\n  attributes:\n    icon: gears\n  children:\n    Users:\n      uri: /admin/users\n      attributes:\n        icon: users\n      children:\n        Add user:\n          uri: /admin/users/add\n          attributes:\n            icon: user-plus\n    Roles:\n      uri: /admin/roles\n      attributes:\n        icon: suitcase\n~~~\n\n\u003e Currently there's only the `sidebar` menu bar defined in the template.\n\nNote that there's a special attribute `icon` so you can easily display\n[FontAwesome][FontAwesome] icons on your menu. Just use the icon name\nand the `AdminLTERenderer` will do the rest.\n\nIf you're setting menu items using php you would do something like this:\n\n~~~php\n$posts = $menu-\u003eaddChild('Posts', [\n    'uri' =\u003e ['_name' =\u003e 'posts.admin.index'],\n    'icon' =\u003e 'newspaper-o'\n]);\n$posts-\u003eaddChild('Add posts', [\n    'uri' =\u003e ['_name' =\u003e 'posts.admin.add'],\n    'icon' =\u003e 'plus'\n]);\n~~~\n\n### Crumbs\n\nAdd crumbs using the `BreadcrumbsHelper::add` method:\n\n~~~php\n\u003c?php\n$this-\u003eBreadcrumbs-\u003eadd('Posts', '/posts');\n$this-\u003eBreadcrumbs-\u003eadd($yourCurrentPost-\u003etitle);\n~~~\n\n### View blocks\n\nMany sections of the layout can be managed just defining some view blocks.\n\nFor this reason, we recommend creating a custom layout which your views will extend.\n\nCreate an `admin.ctp` file wherever you want, add there your custom AdminLTE\nview blocks, and then make your views extend that layout:\n\n~~~php\n\u003c?php\n// src/Templates/admin.ctp\n$this-\u003estart('AdminLTE.user.sidebar');\necho 'Hello ' . $this-\u003eSession-\u003eread('Auth.User.username') . '!';\n$this-\u003eend('AdminLTE.user.small');\n~~~\n\nAnd then, in your views:\n\n~~~php\n\u003c?php\n$this-\u003eextend('/admin');\n~~~\n\nHere are all the currently defined view blocks:\n\n- `subtitle`\n- `AdminLTE.user.small`\n- `AdminLTE.user.detail`\n- `AdminLTE.user.sidebar`\n- `AdminLTE.sidebar.right`\n\nDon't forget to check out the official AdminLTE repository to know how to\nproperly define each section.\n\nLicense\n-------\n\nCreated by Òscar Casajuana for Cirici New Media\n\n    AdminLTE theme for CakePHP 3\n    Copyright (C) 2016 Òscar Casajuana\n\n    This program is free software: you can redistribute it and/or modify\n    it under the terms of the GNU General Public License as published by\n    the Free Software Foundation, either version 3 of the License, or\n    (at your option) any later version.\n\n    This program is distributed in the hope that it will be useful,\n    but WITHOUT ANY WARRANTY; without even the implied warranty of\n    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n    GNU General Public License for more details.\n\n    You should have received a copy of the GNU General Public License\n    along with this program.  If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n\n[composer]: https://getcomposer.org\n[npm]: https://nodejs.org\n[KnpMenu]: https://github.com/KnpLabs/KnpMenu\n[FontAwesome]: http://fortawesome.github.io/Font-Awesome/icons/\n\n[build status]: https://travis-ci.org/ciricihq/cake-adminlte\n[coverage]: https://codecov.io/gh/ciricihq/cake-adminlte\n[license]: https://github.com/ciricihq/cake-adminlte/blob/master/LICENSE.md\n[releases]: https://github.com/ciricihq/cake-adminlte/releases\n[downloads]: https://packagist.org/packages/ciricihq/adminlte\n[climate]: https://codeclimate.com/github/ciricihq/cake-adminlte\n\n[build svg]: https://img.shields.io/travis/ciricihq/cake-adminlte/master.svg?style=flat-square\n[coverage svg]: https://img.shields.io/codecov/c/github/ciricihq/cake-adminlte/master.svg?style=flat-square\n[license svg]: https://img.shields.io/github/license/ciricihq/cake-adminlte.svg?style=flat-square\n[releases svg]: https://img.shields.io/github/release/ciricihq/cake-adminlte.svg?style=flat-square\n[downloads svg]: https://img.shields.io/packagist/dt/ciricihq/adminlte.svg?style=flat-square\n[climate svg]: https://img.shields.io/codeclimate/github/ciricihq/cake-adminlte.svg?style=flat-square\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fciricihq%2Fcake-adminlte","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fciricihq%2Fcake-adminlte","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fciricihq%2Fcake-adminlte/lists"}