apishka/easy-extend

Easy extends class implementation for PHP

PHP easy extend

, _(*1)

What is easy extend?

This is composer component which helps developers to write common libraries and extend them in project., _(*2)

Quick start

• Add easy-extend to composer requirements of your library

"require": {
    "apishka/easy-extend": "^1.0.0"
}

• Create .apishka.php (structure documentation). Most common file looks like this:

<?php

return array(
    'easy-extend' => array(
        'finder' => function($finder)
        {
            $finder
                ->in('source/')
                ->files()
                ->name('*.php')
            ;

            return $finder;
        }
    ),
);
 ```
 - Run ``composer update``
 - Implement traits to classes which you want to be easy extendable.

# How to extend?
## Extending classes
Some library has basic implementation of class you want extend and this library implements EasyExtend:
```php
class Library_User_Implementation
{
    /**
     * We have to include trait
     */
    use Apishka\EasyExtend\Helper\ByClassNameTrait;
}

One thing you have to do to extend this class and don't rewrite any library code, or check where new user class should pass is to extends that class:, _(*3)

class My_Library_User_Implementation extends Library_User_Implementation
{
}

One thing you have to do is create new instance of class using, _(*4)

Library_User_Implementation::apishka(); // instanceof My_Library_User_Implementation

All libraries can be easy extended for you custom project with your custom requirements. No need to require tons of code., _(*5)

Items routing

Create router and realize two methods:, _(*6)

class My_Library_ItemsRouter extends \Apishka\EasyExtend\Router\ByKeyAbstract
{
    protected function isCorrectItem(\ReflectionClass $reflector)
    {
        return $reflector->isSubclassOf('My_Library_ItemsInterface');
    }

    protected function getClassVariants(\ReflectionClass $reflector, $item)
    {
        return $item->getAliases();
    }
}

Create item:, _(*7)

class My_Library_ItemApple implements My_Library_ItemsInterface
{
    public function getAliases()
    {
        return array(
            'apple',
            'red_apple',
        );
    }
}

Now you can get class by alias:, _(*8)

var_dump(
    get_class(My_Library_ItemsRouter::apishka()->getItem('apple')
); // My_Library_ItemApple

var_dump(
    get_class(My_Library_ItemsRouter::apishka()->getItem('red_apple')
); // My_Library_ItemApple

Also you can extend your item:, _(*9)

class My_Library_ItemRedApple extends My_Library_ItemApple
{
}

// after ./vendor/bin/easy-extend
var_dump(
    get_class(My_Library_ItemsRouter::apishka()->getItem('apple')
); // My_Library_ItemRedApple