Download the PHP package chocochaos/propel-rulable-behavior without Composer
On this page you can find all versions of the php package chocochaos/propel-rulable-behavior. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download chocochaos/propel-rulable-behavior
More information about chocochaos/propel-rulable-behavior
Files in chocochaos/propel-rulable-behavior
Package propel-rulable-behavior
Short Description Allows defining buisiness rules in centralised classes and adding them to your models and query classes.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package propel-rulable-behavior
Rulable behavior for Propel 2
When writing real-world applications, you often have to deal with complex business rules. Maintaining these rules can be tedious and prone to errors, especially if they have to be checked in multiple places. It is easy to miss one implementation of a rule while making changes.
In propel you can already add your own methods to query and object classes. Even then, you are still defining the same logic in multiple places: in the query classes to filter your query results based on a rule, and in the models themselves, to check if a specific object meets a certain rule.
This behavior allows you to define business rules in centralised classes. Both your query filters and your model checks can be defined in one place. Upon building the schemas, convenient methods for checking these rules are added to the query and model classes, resulting in cleaner and more easily maintainable code.
Installation
composer require chocochaos/propel-rulable-behaviorUsage
Defining a rule
To define a rule, first create a new directory in your models directory called Rules. This directory should be on the same level as the Base and Map directories generated by Propel.
Next, create a new class for your rule in this directory (with proper namespacing of course). For example:
As you can see, there are three methods you need to implement:
objectMeetsRule: checks whether an object meets the rule.filterByMeetsRule: apply filters to a query to only find items which meet the rule.filterByFailsRule: apply filters to a query to only find items which do not meet the rule.
In the example above, RuleInterface was implemented. This is not required, I would actually recommend not doing so in most cases, as not implementing the interface allows you to apply proper type hinting instead of having to check the types manually in your methods. The example above could be simplified to:
Add behavior to your schema and build
Finally, add the rulable behavior to your schema, and set the correct parameters:
- The
nameparameter defines the PHPName for your rule, this name will be used for method generation. - The
valueparameter defined the rule class to be used. - Don't forget to build your schemas after adding or updating the behavior.
Use the generated methods
In the example above, Active was supplied as the PHPName for the rule. The following method will now be available:
->isActive()onUserGroupFunction.->filterByIsActive()onUserGroupFunctionQuery.->filterByIsNotActive()onUserGroupFunctionQuery.
Other options
There are a few things not yet covered above:
- You can add multiple parameters to add multiple rules to a model.
- Instead of specifying a short class name in the XML, you can also specify a fully qualified class name (including namespace). This removes the requirement to put the rules in a `Rules' directory with your models, which can be useful when writing rules that apply to multiple entities.
- Your rules class can have a constructor to pass extra parameters. These parameters will then be available as parameters on the generated functions, including type hints and default values. Variadics and constants as default values are not (yet) supported though.
License
See the LICENSE file.
