Download the PHP package imanghafoori/laravel-heyman without Composer

Laravel HeyMan

### Readability Counts. In fact, Readability is the primary value of your code !!! [](https://coveralls.io/github/imanghafoori1/laravel-heyman?branch=master) [](https://codeclimate.com/github/imanghafoori1/laravel-heyman/maintainability) [](https://github.com/imanghafoori1/laravel-heyman/actions/workflows/imports.yml) [](https://github.com/imanghafoori1/laravel-heyman/actions/workflows/tests.yml) [](https://github.styleci.io/repos/139709518) [](https://packagist.org/packages/imanghafoori/laravel-heyman) [](https://packagist.org/packages/imanghafoori/laravel-heyman) [](https://packagist.org/packages/imanghafoori/laravel-heyman) [](https://github.com/chiraggude/awesome-laravel) [](LICENSE.md) ### :ribbon: Heyman continues where the other role-permission packages left off... #### We have used CDD (Creativity Driven Development) alongside the TDD #### Built with :heart: for every smart laravel developer Very well-tested, optimized, and production-ready! We have tackled a lot of `complexity` behind the scenes, to provide you with a lot of `simplicity`. - Integrated with laravel-debugbar package out of the box: laravel debugbar ### Installation: ### Requirements: - PHP v7.0 or above - Laravel v5.1 or above ## Example: Here you can see a good example at: https://github.com/imanghafoori1/council Specially this file: https://github.com/imanghafoori1/council/blob/master/app/Providers/AuthServiceProvider.php This is fork from result of laracasts.com tutorial series refactored to use the Heyman package. ## Heyman, let's fight off zombies

Zombie Http Request =>

#
<= Laravel Heyman



### A story: Imagine your boss comes to you and says : > Write the code for me, just now... But KEEP IN MIND you are not allowed to touch the current code. it is very sensitive and we do not want you to tamper with it. You may break it. And you write code like this in a Service Provider `boot` method to implement what your boss wanted.  #### That is what this package does for you + a lot more... ### Customizable Syntax: You can alias methods like this if you do not like too much verbose syntax provided by default. - Alias Situations (ex. `whenYouMakeView` to `view`) - Alias Conditions (ex. `youShouldBeGuest` to `beGuest`) You should do it in the boot method.  ### Structural Benefits: 1- This way you can fully `decouple` authorization and a lot of guarding code from the rest of your application code and put it in an other place. So your Controllers and Routes become less crowded and you will have a central place where you limit the access of users to your application or perform Request validation. 2- In fact, when you write your code in the way, you are conforming to the famous "`Tell don't ask principle.`" You are telling the framework what to do in certain situations rather than getting information and decide what to do then. > ` Procedural code gets information then makes decisions. > Object-oriented code tells objects to do things. > — Alec Sharp ` 3- This approach is particularly useful when you for example write a package which needs ACL but you want to allow your package users to override and apply they own ACL (or validation) rules into your package routes... And that becomes possible when you use laravel-HeyMan for ACL. The users can easily cancel out the default rules and re-write their favorite acl or validation stuff in a regular ServiceProviders. Hey Man, that is Amazing stuff! To override that we use the `forget` method, within `app/Providers/...` : #### Hey Man, Should I Momorize all the Methods?! You do not need any cheat sheet. > IDE `Auto-completion` is fully supported.  #### Hey Man, Where do I put these `Heyman::` calls? > You may put them in `AuthServiceProvider.php` (or any other service provider) `boot` method.  ## Usage: You should call the following method of the HeyMan Facade class. Again we recommend visiting this file: Working heyman sample rules ## Situations: #### 1- Url is matched #### 2- Route Name is matched #### 3- Controller Action is about to Call #### 4- A View file is about to render Actually it refers to the moment when `view('article.editForm')` is executed. #### 5- Custom Event is Fired Actually it refers to the moment when `event('myEvent')` is executed. #### 6- An Eloquent Model is about to save Actually it refers to the moment when eloquent fires it's internal events like: (saving, deleting, creating, ...) #### Note that the saving model is passed to the Gate of callback in the next chain call. so for example you can check the ID of the model which is saving. ## Conditions: After mentioning the situation, it is time to mention the condition. #### 1- Gates: Then you can use the gate: Passing a Closure as a Gate: #### 2- Authentication stuff: #### 3- Checking A `Closure` or `Method` or `Value`: #### 4- Validate Requests: You can also modify the data before validation by calling `beforeValidationModifyData()`. #### 5- Check points: You can also declare some check points somewhere, within your application code: And put some rules for it #### Other things: You can also use "`always`" and "`sessionShouldHave`" methods: -------------------- #### Define your own conditions: You can extend the conditions and introduce new methods into heyman API like this: Then you can use it like this: Nice, isn't it ?! ## Reactions: ### 1- Deny Access: An `AuthorizationException` will be thrown if needed ### 2- Redirect: In fact the redirect method here is very much like the laravel's `redirect()` helper function. ### 3- Throw Exception: ### 4- Abort: ### 5- Send Response: Calling these functions generate exact same response as calling them on the `response()` helper function: `return response()->json(...);` ### 6- Send custom response: Hey man, You see ? we have just an Http response here. So our controllers are free to handle the right situaltions and do not worry about exceptional ones. ## More Advanced Reactions: Hey man, You may want to call some method or fire an event right before you send the response back. You can do so by `afterCalling()` and `afterFiringEvent()` methods. ### Disabling Heyman: You can disable HeyMan checks like this (useful while testing):  -------------------- ### :raising_hand: Contributing: If you find an issue, or have a better way to do something, feel free to open an issue or a pull request. ### :star: Your Stars Make Us Do More :star: As always if you found this package useful and you want to encourage us to maintain and work on it. Just press the star button to declare your willing. ## Star History [](https://star-history.com/#imanghafoori1/laravel-heyman&Date) ## More from the author: ### Laravel Widgetize :gem: A minimal yet powerful package to give a better structure and caching opportunity for your laravel apps. - https://github.com/imanghafoori1/laravel-widgetize ----------------- ### Laravel Terminator :gem: A minimal yet powerful package to give you opportunity to refactor your controllers. - https://github.com/imanghafoori1/laravel-terminator ----------------- ### Laravel AnyPass :gem: It allows you login with any password in local environment only. - https://github.com/imanghafoori1/laravel-anypass ----------------- ### Laravel Microscope :gem: It automatically checks your laravel application (*new*) - https://github.com/imanghafoori1/laravel-microscope --------------

Great spirits have always encountered violent opposition from mediocre minds. "Albert Einstein"