Download the PHP package webhappens/magic-properties without Composer
On this page you can find all versions of the php package webhappens/magic-properties. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download webhappens/magic-properties
More information about webhappens/magic-properties
Files in webhappens/magic-properties
Package magic-properties
Short Description Add a simple fluid interface for getters, setters, accessors and mutators to any PHP class.
License MIT
Homepage https://github.com/webhappens/magic-properties
Informations about the package magic-properties
Magic properties
Add a simple fluid interface for getters, setters, accessors and mutators to any PHP class.
- Installation
- Getters
- Setters
- Readonly properties
- Chainable setters
- Accessors
- Mutators
- Serialization
Installation
Install via composer:
Insert the MagicProperties
trait into your class:
If your class is already using the __call
method, add the following to it:
Getters
Getters support both "property" and "method" syntax and allow you to get public
and protected
properties.
The Getter "method" name may optionally be prefixed with "get" if you prefer that syntax.
Setters
Setters support both "property" and "method" syntax and allow you to set public
and protected
properties.
The Setter "method" name may optionally be prefixed with "set" if you prefer that syntax.
Readonly properties
If you want to protect specific protected
properties from being set from outside the class, you may list them in an $readonly
array inside your class.
Readonly properties can still be changed from inside the class using the standard php syntax.
Chainable setters
When using the "method" syntax for Setters you may set multiple properties in a single chain.
Accessors
When a Getter is called for a protected
property from outside the class, the value is passed through an Accessor method, giving you a chance to modify it before it is returned.
When called from inside the class, it is only passed through an Accessor method when "method" syntax is used.
public
and private
properties are never passed through an Accessor method.
To add an Accessor method for a protected
property, simply create a protected
method that follows the Accessor naming convention of get{PropertyName}Property
.
The method will receive the stored value as a single argument and should return the modified value.
In this example, the role will be returned with an uppercase first letter.
Mutators
When a Setter is called for a protected
property from outside the class, the value is passed through a Mutator method, giving you a chance to modify it before it is set.
When called from inside the class, it is only passed through a Mutator method when "method" syntax is used.
public
and private
properties are never passed through a Mutator method.
To add a Mutator method for a protected
property, simply create a protected
method that follows the Mutator naming convention of set{PropertyName}Property
.
The method will receive the passed value as a single argument and should return the modified value.
In this example, the role will be stored with an uppercase first letter.
Serialization
Call the getMagicProperties
method to serialize all public
and protected
properties to an array.
Credits
- Sam Leicester: [email protected]
- Ben Gurney: [email protected]
- All Contributors
Our Str
class is just a copy of some functions from Laravel's Str
helper.
License
The MIT License (MIT). Please see License File for more information.