fenix440 / model-description
Getter and Setter package for model description. This package is part of a project 'Aedart\Model', visit https://bitbucket.org/aedart/model to learn more about it. Official sub-package website (https://bitbucket.org/fenix440/model-description/).
Requires
- php: >=5.5.9
- aedart/validate: >=0.9.1 <2.0
Requires (Dev)
- aedart/license: 1.*
- aedart/license-file-manager: 1.*
- codeception/codeception: 2.0.*
Suggests
- aedart/model: Collection of getter- / setter-interfaces and traits for various common properties
README
Getter and Setter package for some kind of model description.
This package is part of a project Aedart\Model, visit https://bitbucket.org/aedart/model to learn more about it.
Official sub-package website (https://bitbucket.org/fenix440/model-description)
Contents
[TOC]
When to use this
When your component(s) need to be aware of some kind of a description
How to install
#!console
composer require fenix440/model-description 1.*
This package uses composer. If you do not know what that is or how it works, I recommend that you read a little about, before attempting to use this package.
Quick start
Provided that you have an interface, e.g. for a product, you can extend the description aware interface;
#!php
<?php
use Fenix440\Model\Description\Interfaces\DescriptionAware;
interface IProduct extends DescriptionAware{
// ... Remaining interface implementation not shown
}
In your class implementation, you simple use one of the description traits.
#!php
<?php
use Fenix440\Model\Description\Traits\DescriptionTrait;
class MyProduct implements IProduct {
use DescriptionTrait;
// ... Remaining implementation not shown...
}
License
BSD-3-Clause, Read the LICENSE file included in this package