Download the PHP package robertogallea/laravel-visitor without Composer
On this page you can find all versions of the php package robertogallea/laravel-visitor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download robertogallea/laravel-visitor
More information about robertogallea/laravel-visitor
Files in robertogallea/laravel-visitor
Package laravel-visitor
Short Description Visitor pattern implementation for Laravel
License MIT
Informations about the package laravel-visitor
LaravelVisitor
1. Introduction
LaravelVisitor is a Visitor Design Pattern implementation for Laravel. It allows to easily execute processing of collections of arbitrary elements, without requiring to use repeated conditionals, thus improving code abstraction.
Without Visitor:
With Visitor:
All of the complexity is hidden in the MyVisitor
class, which must define methods for processing classes. In the previous example, MyVisitor
would be implemented as:
Additionally this enforces SRP principle, since Domain Objects don't have to implement representational methods, which are only responsibility of the Visitor classes implementation (especially if several are required).
2. Installation
Install the package via composer:
composer require robertogallea/laravel-visitor
3. Usage
For using the package, you need to define at least one Visitor
and some Visitee
classes.
3.1. Visitee
s implementation
The only requirement for Visitee
s is to use the Visitable
trait, so you can make any class visitable.
3.2. Visitor
s implementation
A Visitor
class must impelemnt the CanVisit
interface and subclass the Visitor
abstract class, by defining the getResult()
method.
Additionally, for each defined Visitee
's you have to implement a processing method of your choice. For example, if you have a Book
Visitee, you must define the method:
3.3. Visitor
s generation
To generate Visitor
, you can launch the following artisan commands:
php artisan make:visitor MyVisitor
which by default creates classes in the Visitors
folder.
4. Example usage:
4.1. Visitee
implementation
Magazine.php
4.2. Visitor
implementation
XMLVisitor.php
4.3. Client code
will produce the following output:
5. Issues, Questions and Pull Requests
You can report issues and ask questions in the issues section. Please start your issue with ISSUE:
and your question with QUESTION:
If you have a question, check the closed issues first.
To submit a Pull Request, please fork this repository, create a new branch and commit your new/updated code in there. Then open a Pull Request from your new branch. Refer to this guide for more info.