interface/modules/zend_modules/library/Zend/Server/Reflection/ReflectionReturnValue.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\Server\Reflection;
  11
  12 /**
  13  * Return value reflection
  14  *
  15  * Stores the return value type and description
  16  */
  17 class ReflectionReturnValue
  18 {
  19     /**
  20      * Return value type
  21      * @var string
  22      */
  23     protected $type;
  24
  25     /**
  26      * Return value description
  27      * @var string
  28      */
  29     protected $description;
  30
  31     /**
  32      * Constructor
  33      *
  34      * @param string $type Return value type
  35      * @param string $description Return value type
  36      */
  37     public function __construct($type = 'mixed', $description = '')
  38     {
  39         $this->setType($type);
  40         $this->setDescription($description);
  41     }
  42
  43     /**
  44      * Retrieve parameter type
  45      *
  46      * @return string
  47      */
  48     public function getType()
  49     {
  50         return $this->type;
  51     }
  52
  53     /**
  54      * Set parameter type
  55      *
  56      * @param string|null $type
  57      * @throws Exception\InvalidArgumentException
  58      * @return void
  59      */
  60     public function setType($type)
  61     {
  62         if (!is_string($type) && (null !== $type)) {
  63             throw new Exception\InvalidArgumentException('Invalid parameter type');
  64         }
  65
  66         $this->type = $type;
  67     }
  68
  69     /**
  70      * Retrieve parameter description
  71      *
  72      * @return string
  73      */
  74     public function getDescription()
  75     {
  76         return $this->description;
  77     }
  78
  79     /**
  80      * Set parameter description
  81      *
  82      * @param string|null $description
  83      * @throws Exception\InvalidArgumentException
  84      * @return void
  85      */
  86     public function setDescription($description)
  87     {
  88         if (!is_string($description) && (null !== $description)) {
  89             throw new Exception\InvalidArgumentException('Invalid parameter description');
  90         }
  91
  92         $this->description = $description;
  93     }
  94 }