Download the PHP package phpgears/immutability without Composer
On this page you can find all versions of the php package phpgears/immutability. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download phpgears/immutability
More information about phpgears/immutability
Files in phpgears/immutability
Package immutability
Short Description Object immutability guard for PHP
License MIT
Homepage https://github.com/phpgears/immutability
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 immutability
Object immutability guard for PHP
Truly object immutability in PHP is an impossible task by the nature of the language itself, carefully checking and protecting properties and methods visibility is the closest we can get at this moment in time
Crafting an object to make it as immutable as can be requires expertise, dedication and focus so no mutating mechanism slips through developer's hands into the object, that is the reason behind this library, provide a way to help with the tedious task of ensuring object immutability
Installation
Composer
Usage
Require composer autoload file
Gears\Immutability\ImmutabilityBehaviour trait enforces you to avoid public properties and mutable methods in your class by calling assertImmutable method on object construction, __wakeup method and unserialize methods if Serializable interface is implemented
This mentioned behaviour let alone would run your objects completely useless, you must provide an implementation of the abstract method getAllowedInterfaces, returning a list of interfaces whose public methods will be allowed in your class. Although you can also provide class names, as it can prove useful in some special cases, it is highly discouraged and should be used sparsely
Few PHP magic methods are allowed to be defined as public, namely __construct, __destruct, __get, __isset, __sleep, __wakeup, __serialize, __unserialize, __toString, __set_state, __clone, __debugInfo
As a general rule, your immutable classes should be declared final. In case you really need inheritance, at least your implementation of getAllowedInterfaces method has to be declared final for every instantiable class
Although not mandatory it is advised to make your constructors protected and force developers to create static named constructors
From now on you can focus on those methods defined in your interfaces and make sure they do not mutate your object, with the confidence no other developer would mutate your object by accident or intentionally
Example
If you want to have a look at a working example implementations of immutable objects have a look at phpgears/identity, phpgears/dto or phpgears/cqrs
Contributing
Found a bug or have a feature request? Please open a new issue. Have a look at existing issues before.
See file CONTRIBUTING.md
License
See file LICENSE included with the source code for a copy of the license terms.
