interface/modules/zend_modules/library/Zend/Di/Definition/Builder/PhpClass.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Di\Definition\Builder;
  11
  12 /**
  13  * Object containing definitions for a single class
  14  */
  15 class PhpClass
  16 {
  17     /**
  18      * @var string
  19      */
  20     protected $defaultMethodBuilder = 'Zend\Di\Definition\Builder\InjectionMethod';
  21
  22     /**
  23      * @var null|string
  24      */
  25     protected $name                 = null;
  26
  27     /**
  28      * @var string|\Callable|array
  29      */
  30     protected $instantiator         = '__construct';
  31
  32     /**
  33      * @var InjectionMethod[]
  34      */
  35     protected $injectionMethods     = array();
  36
  37     /**
  38      * @var array
  39      */
  40     protected $superTypes           = array();
  41
  42     /**
  43      * Set name
  44      *
  45      * @param  string   $name
  46      * @return PhpClass
  47      */
  48     public function setName($name)
  49     {
  50         $this->name = $name;
  51
  52         return $this;
  53     }
  54
  55     /**
  56      * Get name
  57      *
  58      * @return string
  59      */
  60     public function getName()
  61     {
  62         return $this->name;
  63     }
  64
  65     /**
  66      * @param  string|\Callable|array $instantiator
  67      * @return PhpClass
  68      */
  69     public function setInstantiator($instantiator)
  70     {
  71         $this->instantiator = $instantiator;
  72
  73         return $this;
  74     }
  75
  76     /**
  77      * @return array|\Callable|string
  78      */
  79     public function getInstantiator()
  80     {
  81         return $this->instantiator;
  82     }
  83
  84     /**
  85      * @param  string   $superType
  86      * @return PhpClass
  87      */
  88     public function addSuperType($superType)
  89     {
  90         $this->superTypes[] = $superType;
  91
  92         return $this;
  93     }
  94
  95     /**
  96      * Get super types
  97      *
  98      * @return array
  99      */
 100     public function getSuperTypes()
 101     {
 102         return $this->superTypes;
 103     }
 104
 105     /**
 106      * Add injection method
 107      *
 108      * @param  InjectionMethod $injectionMethod
 109      * @return PhpClass
 110      */
 111     public function addInjectionMethod(InjectionMethod $injectionMethod)
 112     {
 113         $this->injectionMethods[] = $injectionMethod;
 114
 115         return $this;
 116     }
 117
 118     /**
 119      * Create and register an injection method
 120      *
 121      * Optionally takes the method name.
 122      *
 123      * This method may be used in lieu of addInjectionMethod() in
 124      * order to provide a more fluent interface for building classes with
 125      * injection methods.
 126      *
 127      * @param  null|string     $name
 128      * @return InjectionMethod
 129      */
 130     public function createInjectionMethod($name = null)
 131     {
 132         $builder = $this->defaultMethodBuilder;
 133         /* @var $method InjectionMethod */
 134         $method  = new $builder();
 135         if (null !== $name) {
 136             $method->setName($name);
 137         }
 138         $this->addInjectionMethod($method);
 139
 140         return $method;
 141     }
 142
 143     /**
 144      * Override which class will be used by {@link createInjectionMethod()}
 145      *
 146      * @param  string   $class
 147      * @return PhpClass
 148      */
 149     public function setMethodBuilder($class)
 150     {
 151         $this->defaultMethodBuilder = $class;
 152
 153         return $this;
 154     }
 155
 156     /**
 157      * Determine what class will be used by {@link createInjectionMethod()}
 158      *
 159      * Mainly to provide the ability to temporarily override the class used.
 160      *
 161      * @return string
 162      */
 163     public function getMethodBuilder()
 164     {
 165         return $this->defaultMethodBuilder;
 166     }
 167
 168     /**
 169      * @return InjectionMethod[]
 170      */
 171     public function getInjectionMethods()
 172     {
 173         return $this->injectionMethods;
 174     }
 175 }