{"id":15561370,"url":"https://github.com/cnizzardini/cakephp-yummy","last_synced_at":"2025-08-03T15:38:27.524Z","repository":{"id":56954551,"uuid":"82841921","full_name":"cnizzardini/cakephp-yummy","owner":"cnizzardini","description":"A delightfully tasty plugin for your CakePHP 3 project including a group-based Access Control List (ACL), a search component with an intuitive user-interface, and bootstrap 3 Bake Themes.","archived":false,"fork":false,"pushed_at":"2020-01-26T01:38:30.000Z","size":3468,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-23T21:02:48.344Z","etag":null,"topics":["admin-portal","cakephp","cakephp-acl","cakephp-bake","cakephp-helper","cakephp-plugin","cakephp-search"],"latest_commit_sha":null,"homepage":"https://cnizz.com/yummy-demo","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cnizzardini.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-22T19:02:25.000Z","updated_at":"2021-11-02T16:28:32.000Z","dependencies_parsed_at":"2022-08-21T08:50:07.650Z","dependency_job_id":null,"html_url":"https://github.com/cnizzardini/cakephp-yummy","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cnizzardini%2Fcakephp-yummy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cnizzardini%2Fcakephp-yummy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cnizzardini%2Fcakephp-yummy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cnizzardini%2Fcakephp-yummy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cnizzardini","download_url":"https://codeload.github.com/cnizzardini/cakephp-yummy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250526080,"owners_count":21445128,"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":["admin-portal","cakephp","cakephp-acl","cakephp-bake","cakephp-helper","cakephp-plugin","cakephp-search"],"created_at":"2024-10-02T16:07:44.404Z","updated_at":"2025-04-23T22:29:46.494Z","avatar_url":"https://github.com/cnizzardini.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yummy plugin for CakePHP\n\n[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.txt)\n[![Code Climate](https://codeclimate.com/github/cnizzardini/cakephp-yummy/badges/gpa.svg)](https://codeclimate.com/github/cnizzardini/cakephp-yummy)\n[![Issue Count](https://codeclimate.com/github/cnizzardini/cakephp-yummy/badges/issue_count.svg)](https://codeclimate.com/github/cnizzardini/cakephp-yummy)\n\nA delightfully tasty plugin for your CakePHP 3 project including a group-based \nAccess Control List (ACL), a search component with an intuitive user-interface, \nand boostrap 3 Bake Themes. Each of these components may be used separately.\n\n## Demo \u0026 Docs\n\n[Live Demo available](https://cnizz.com/yummy-demo) and fully documented in the [git wiki](https://github.com/cnizzardini/cakephp-yummy/wiki).\n\n## Supported Versions\n\n| Version  | Supported | Unit Tests | Notes |\n| ------------- | ------------- | ------------- | ------------- |\n| 4.0 | No  | Failing | See cake-4.0 branch, this is a work in progress |\n| 3.8 | Yes  | Passing | - |\n| 3.7 | Yes  | Passing | Tested |\n| 3.6 | Yes  | Passing | - |\n\nNote, unit tests fail on 3.5 and lower. Unit tests were ran against CakePHP `4.0.0-beta3` \nand failed.\n\n## Features\n\n### [YummySearch](https://github.com/cnizzardini/cakephp-yummy/wiki/Yummy-Search)\n\nA search component designed to work with CakePHPs Paginator Component and Cake\\ORM\\Query. It supports searching the \nbase model and other associations such as HasOne, BelongsTo, and HasMany through an intuitive UI in just three easy steps.\n\n![yummy search screenshot](assets/yummy-search.png)\n\n```php\n// Step 1. Basic Controller Usage:\n$query = $this-\u003eModelName-\u003efind();\n\n$this-\u003eloadComponent('Yummy.YummySearch',[\n    'query' =\u003e $query,\n    'allow' =\u003e [\n        'Table.column' =\u003e ['name' =\u003e 'Column Name'],\n    ]\n]);\n\n$results = $this-\u003epaginate($this-\u003eYummySearch-\u003esearch($query));\n\n// Step 2. Basic View Usage:\n$this-\u003ehelpers()-\u003eload('Yummy.YummySearch');\necho $this-\u003eYummySearch-\u003ebasicForm();\n\n// Step 3. Include agnostic JavaScript\n\u003cscript src=\"/yummy/js/yummy-search.js\"\u003e\u003c/script\u003e\n \n```\n\nCheck out the [documentation](https://github.com/cnizzardini/cakephp-yummy/wiki/Yummy-Search) for advanced \nusage and customization. \n\n### [YummyAcl](https://github.com/cnizzardini/cakephp-yummy/wiki/Yummy-ACL)\n\nA component that works with Auth to add group-based access controls to your admin portal.\n\n![yummy acl screenshot](assets/yummy-acl.png)\n\n```php\n// Basic Usage\n$this-\u003eloadComponent('Yummy.YummyAcl',[\n    'group' =\u003e $this-\u003eAuth-\u003euser('group'),\n]);\n\n// Define ACLs (you can also define ACLs in a single config file)\n$this-\u003eYummyAcl-\u003eactions([\n    'login' =\u003e '*', // allow all \n    'view' =\u003e ['Admin','Manager'], // allow Admin + Manager\n    'edit' =\u003e ['Admin'], // allow Admin\n]);\n```\n\nCheck out the [documentation](https://github.com/cnizzardini/cakephp-yummy/wiki/Yummy-ACL) for advanced \nusage and customization. \n\n\n### YummyBake\n\nA series of bootstrap admin themes for your admin portal [(demo)](https://cnizz.com/yummy-demo/teams)\n\n```\nbin/cake bake template \u003cControllerName\u003e -t Yummy\n```\n\n## Installation\n\nYou can install this plugin into your CakePHP application using [composer](http://getcomposer.org).\n\nThe recommended way to install composer packages is:\n\n```\ncomposer require cnizzardini/cakephp-yummy\n```\n\nLoad the plugin in: `config/bootstrap.php`\n\n```\nPlugin::load('Yummy', ['bootstrap' =\u003e false, 'routes' =\u003e true]);\n```\n\nIn newer versions of cake load the plugin via your `src/Application.php` file.\n\n## Documentation\n\nCheckout the [Wiki](https://github.com/cnizzardini/cakephp-yummy/wiki/).\n\nYou can also view the source code for demo project on github:\n\n[https://github.com/cnizzardini/cakephp-yummy-demo](https://github.com/cnizzardini/cakephp-yummy-demo)\n\n## Unit Testing\n```\nvendor/bin/phpunit \n```\n\n## Developers\n\nFork and send a pull request. You can include Yummy in your Cake project \nas a local source to make developing easier use these steps:\n\n- Remove `cnizzardini\\cakephp-yummy` from your `composer.json`\n\n- Add a paths repository to your `composer.json`\n```\n\"repositories\": [\n    {\n        \"type\": \"path\",\n        \"url\": \"/absolute/local-path-to/cakephp-yummy\",\n        \"options\": {\n          \"symlink\": true\n        }\n    }\n]\n```\n- Run `composer require cnizzardini/cakephp-yummy @dev`\n\nUndo these steps when you're done. Read the full composer documentation \non loading from path here: [https://getcomposer.org/doc/05-repositories.md#path](https://getcomposer.org/doc/05-repositories.md#path)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcnizzardini%2Fcakephp-yummy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcnizzardini%2Fcakephp-yummy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcnizzardini%2Fcakephp-yummy/lists"}