Download the PHP package kcs/metadata without Composer
On this page you can find all versions of the php package kcs/metadata. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package metadata
Short Description Class/Attribute metadata management component
License MIT
Informations about the package metadata
Metadata management library in PHP
Overview
This library provides utilities for metadata loading, management and retrieval for PHP classes, methods and properties.
Installation
Install with composer
Usage
A metadata factory responsible for retrieving metadatas for a given class.
To create a metadata factory you can implement MetadataFactoryInterface
on your own class or extend the AbstractMetadataFactory
.
This allows you to specify which implementation of ClassMetadataInterface
will be used for your metadata simply extending the createMetadata
method.
If you extend the AbstractMetadataFactory
class (or use MetadataFactory
class
which creates a ClassMetadata
instance for class metadatas), you have to create
your metadata loader class implementing LoaderInterface
.
If more than one source is available for your metadata (Annotations, YAMLs, XMLs,
etc.) you can use the ChainLoader
class, adding your loaders to it.
Validation
When a metadata is loaded the factory validate
method is called with the newly loaded
metadata as argument and the Kcs\Metadata\Event\ClassMetadataLoadedEvent
event is dispatched
(if an event dispatcher is present).
You can extend validate
or listen for the metadata loaded event and check
for metadata validity. If a validation error occurs you have to throw an
InvalidMetadataException
.
Metadata classes
You can extend the provided classes ClassMetadata
, MethodMetadata
and PropertyMetadata
to build your metadata information.
By default, all the public properties are serialized in cache (if cache is
present). You can customize this behaviour by extending the __sleep
method
of the metadata classes, returning an array of serialized properties.
License
This library is released under the MIT license
Contributions
Contributions are always welcome. Feel free to open an issue or submit a PR to improve this library.