classes/Kohana/Kodoc/Method/Param.php

   1 <?php defined('SYSPATH') or die('No direct script access.');
   2 /**
   3  * Class method parameter documentation generator.
   4  *
   5  * @package    Kohana/Userguide
   6  * @category   Base
   7  * @author     Kohana Team
   8  * @copyright  (c) 2008-2013 Kohana Team
   9  * @license    http://kohanaframework.org/license
  10  */
  11 class Kohana_Kodoc_Method_Param extends Kodoc {
  12
  13         /**
  14          * @var  object  ReflectionParameter for this property
  15          */
  16         public $param;
  17
  18         /**
  19          * @var  string  name of this var
  20          */
  21         public $name;
  22
  23         /**
  24          * @var  string  variable type, retrieved from the comment
  25          */
  26         public $type;
  27
  28         /**
  29          * @var  string  default value of this param
  30          */
  31         public $default;
  32
  33         /**
  34          * @var  string  description of this parameter
  35          */
  36         public $description;
  37
  38         /**
  39          * @var  boolean  is the parameter passed by reference?
  40          */
  41         public $reference = FALSE;
  42
  43         /**
  44          * @var  boolean  is the parameter optional?
  45          */
  46         public $optional = FALSE;
  47
  48         public function __construct($method, $param)
  49         {
  50                 $this->param = new ReflectionParameter($method, $param);
  51
  52                 $this->name = $this->param->name;
  53
  54                 if ($this->param->isDefaultValueAvailable())
  55                 {
  56                         $this->default = Debug::dump($this->param->getDefaultValue());
  57                 }
  58
  59                 if ($this->param->isPassedByReference())
  60                 {
  61                         $this->reference = TRUE;
  62                 }
  63
  64                 if ($this->param->isOptional())
  65                 {
  66                         $this->optional = TRUE;
  67                 }
  68         }
  69
  70         public function __toString()
  71         {
  72                 $display = '';
  73
  74                 if ($this->type)
  75                 {
  76                         $display .= '<small>'.$this->type.'</small> ';
  77                 }
  78
  79                 if ($this->reference)
  80                 {
  81                         $display .= '<small><abbr title="passed by reference">&</abbr></small> ';
  82                 }
  83
  84                 if ($this->description)
  85                 {
  86                         $display .= '<span class="param" title="'.preg_replace('/\s+/', ' ', $this->description).'">$'.$this->name.'</span> ';
  87                 }
  88                 else
  89                 {
  90                         $display .= '$'.$this->name.' ';
  91                 }
  92
  93                 if ($this->default)
  94                 {
  95                         $display .= '<small>= '.$this->default.'</small> ';
  96                 }
  97
  98                 return $display;
  99         }
 100
 101 } // End Kodoc_Method_Param