Download the PHP package macfja/php-kvo without Composer
On this page you can find all versions of the php package macfja/php-kvo. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download macfja/php-kvo
More information about macfja/php-kvo
Files in macfja/php-kvo
Package php-kvo
Short Description The KVO (Key Value Observing) design pattern in PHP
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 php-kvo
PhpKVO
API
What is KVO ?
KVO (Key Value Observing) is a design pattern which allows an object to get notified about changes.
It allow you keep your object synchronized each other without creating a hard link thanks to Subject/Observer design pattern.
KVC (Key Value Coding) and KVO (Key Value Observing) are heavily used in Cocoa Framework (Objective-C)
Installation
The simplest way to install the library is to use Composer:
Usage
A complete examples can be found in the directory examples.
API
API of Observable interface
Implemented in AbstractObservable, Proxy.
A trait for quick implementation is available: ObservableTrait
API of Observable::addObserverForKey method
This method allow you to subscribe to key value changes notification.
| Type | Variable | Description |
|---|---|---|
Listener |
$listener |
The object that subscribe to the changes notification. |
| string | $key |
The key to listen. |
int|0 |
$options optional |
The list of options. (More information below) |
mixed|null |
&$context optional |
The context: data to send with the notification. This value passed by reference. |
API, The Observable::addObserverForKey options list.
-
Observer::OPTION_NEW, Indicates that the change array should provide the new attribute value, if applicable. -
Observer::OPTION_OLD, Indicates that the change array should contain the old attribute value, if applicable. -
Observer::OPTION_INITIAL, If specified, a notification should be sent to the observer immediately, before the observer registration method even returns.The change array in the notification will always contain an
Observer::CHANGE_NEWentry ifObserver::OPTION_NEWis also specified but will never contain anObserver::CHANGE_OLDorObserver::CHANGE_REQUESTEDentry.
(In an initial notification the current value of the observed property may be old, but it's new to the observer.) -
Observer::OPTION_PRIOR, Whether separate notifications should be sent to the observer before and after each change, instead of a single notification after the change.The change array in a notification sent before a change always contains an
Observer::CHANGE_PRIORentry whose value istrue, but never contains anObserver::CHANGE_NEWentry. When this option is specified the change array in a notification sent after a change contains the same entries that it would contain if this option were not specified. You can use this option when the observer's own key-value observing-compliance requires it to invoke thewillChangeValueForKeymethod for one of its own properties, and the value of that property depends on the value of the observed object's property.
API of Observable::willChangeValueForKey method
This method trigger a notification for all Listener that registered for a key with the option Observer::OPTION_PRIOR.
This method should be call before the key value change.
| Type | Variable | Description |
|---|---|---|
| string | $key |
The key that is changed. |
| string | $source |
The source/type of change. (More information below). |
| null|mixed | $oldValue optional |
The current value of the key. |
| null|mixed | $requestedValue optional |
The requested new value of the key. |
API of Observable::didChangeValueForKey method
This method trigger a notification for all Listener that registered for a key without the option Observer::OPTION_PRIOR.
This method should be call after the key value change.
| Type | Variable | Description |
|---|---|---|
| string | $key |
The key that is changed. |
| string | $source |
The source/type of change. (More information below). |
mixed|null |
$oldValue optional |
The value of the key before the change. |
mixed|null |
$requestedValue optional |
The requested new value of the key. |
mixed|null |
$newValue optional |
The current value of the key. |
API of Observer::setValueForKey method
This method change the value of a key and handle the call of methods Observable::willChangeValueForKey and Observable::didChangeValueForKey.
| Type | Variable | Description |
|---|---|---|
| string | $key |
The key to change. |
| mixed | $value |
The new value. |
API, the Observable::willChangeValueForKey and Observable::didChangeValueForKey source value
Observer::SOURCE_SETTER, If the value of the key was changed from a setter method. (Used byProxyclass)Observer::SOURCE_PROPERTY, If the value of the key was changed from a direct property change (public class property). (Used byProxyclass)Observer::SOURCE_CUSTOM, If the value was change without a setter, or from a direct property access.
Note: You can use your own source type, it's just a string.
Note: Observer::SOURCE_INITIAL, If the Listener has the option Observer::OPTION_INITIAL, then when registered, this source is used
API of Listener interface
API of Listener::observeValueForKeyPath method
This method is call every time an observed key is modified.
| Type | Variable | Description |
|---|---|---|
| string | $keyPath |
The modified key. |
| object | $key |
The modified object. |
| array | $change |
The changed data. (More information below) |
| mixed | &$context |
The changed context (provided on subscription). |
API, The Listener::observeValueForKeyPath change array
-
Observer::CHANGE_NEW, If theObserver::OPTION_NEWwas specified when the observer was registered, the value of this key is the new value for the attribute. -
Observer::CHANGE_OLD, If theObserver::OPTION_OLDwas specified when the observer was registered, the value of this key is the value before the attribute was changed. -
Observer::CHANGE_PRIOR, If the optionObserver::OPTION_PRIORwas specified when the observer was registered this notification is sent prior to a change.The change array contains an
Observer::CHANGE_PRIORentry whose value istrueif the nofication is before the change, orfalseif the notification is after.
