PhpClass.php 3.57 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
<?php
/**
 * Zend Framework (http://framework.zend.com/)
 *
 * @link      http://github.com/zendframework/zf2 for the canonical source repository
 * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
 * @license   http://framework.zend.com/license/new-bsd New BSD License
 */

namespace Zend\Di\Definition\Builder;

/**
 * Object containing definitions for a single class
 */
class PhpClass
{
    /**
     * @var string
     */
    protected $defaultMethodBuilder = 'Zend\Di\Definition\Builder\InjectionMethod';

    /**
     * @var null|string
     */
    protected $name                 = null;

    /**
     * @var string|\Callable|array
     */
    protected $instantiator         = '__construct';

    /**
     * @var InjectionMethod[]
     */
    protected $injectionMethods     = [];

    /**
     * @var array
     */
    protected $superTypes           = [];

    /**
     * Set name
     *
     * @param  string   $name
     * @return PhpClass
     */
    public function setName($name)
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Get name
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @param  string|\Callable|array $instantiator
     * @return PhpClass
     */
    public function setInstantiator($instantiator)
    {
        $this->instantiator = $instantiator;

        return $this;
    }

    /**
     * @return array|\Callable|string
     */
    public function getInstantiator()
    {
        return $this->instantiator;
    }

    /**
     * @param  string   $superType
     * @return PhpClass
     */
    public function addSuperType($superType)
    {
        $this->superTypes[] = $superType;

        return $this;
    }

    /**
     * Get super types
     *
     * @return array
     */
    public function getSuperTypes()
    {
        return $this->superTypes;
    }

    /**
     * Add injection method
     *
     * @param  InjectionMethod $injectionMethod
     * @return PhpClass
     */
    public function addInjectionMethod(InjectionMethod $injectionMethod)
    {
        $this->injectionMethods[] = $injectionMethod;

        return $this;
    }

    /**
     * Create and register an injection method
     *
     * Optionally takes the method name.
     *
     * This method may be used in lieu of addInjectionMethod() in
     * order to provide a more fluent interface for building classes with
     * injection methods.
     *
     * @param  null|string     $name
     * @return InjectionMethod
     */
    public function createInjectionMethod($name = null)
    {
        $builder = $this->defaultMethodBuilder;
        /* @var $method InjectionMethod */
        $method  = new $builder();
        if (null !== $name) {
            $method->setName($name);
        }
        $this->addInjectionMethod($method);

        return $method;
    }

    /**
     * Override which class will be used by {@link createInjectionMethod()}
     *
     * @param  string   $class
     * @return PhpClass
     */
    public function setMethodBuilder($class)
    {
        $this->defaultMethodBuilder = $class;

        return $this;
    }

    /**
     * Determine what class will be used by {@link createInjectionMethod()}
     *
     * Mainly to provide the ability to temporarily override the class used.
     *
     * @return string
     */
    public function getMethodBuilder()
    {
        return $this->defaultMethodBuilder;
    }

    /**
     * @return InjectionMethod[]
     */
    public function getInjectionMethods()
    {
        return $this->injectionMethods;
    }
}