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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package Zend_CodeGenerator
* @subpackage PHP
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id: Docblock.php 20096 2010-01-06 02:05:09Z bkarwin $
*/
/**
* @see Zend_CodeGenerator_Php_Abstract
*/
require_once 'Zend/CodeGenerator/Php/Abstract.php';
/**
* @see Zend_CodeGenerator_Php_Docblock_Tag
*/
require_once 'Zend/CodeGenerator/Php/Docblock/Tag.php';
/**
* @category Zend
* @package Zend_CodeGenerator
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_CodeGenerator_Php_Docblock extends Zend_CodeGenerator_Php_Abstract
{
/**
* @var string
*/
protected $_shortDescription = null;
/**
* @var string
*/
protected $_longDescription = null;
/**
* @var array
*/
protected $_tags = array();
/**
* @var string
*/
protected $_indentation = '';
/**
* fromReflection() - Build a docblock generator object from a reflection object
*
* @param Zend_Reflection_Docblock $reflectionDocblock
* @return Zend_CodeGenerator_Php_Docblock
*/
public static function fromReflection(Zend_Reflection_Docblock $reflectionDocblock)
{
$docblock = new self();
$docblock->setSourceContent($reflectionDocblock->getContents());
$docblock->setSourceDirty(false);
$docblock->setShortDescription($reflectionDocblock->getShortDescription());
$docblock->setLongDescription($reflectionDocblock->getLongDescription());
foreach ($reflectionDocblock->getTags() as $tag) {
$docblock->setTag(Zend_CodeGenerator_Php_Docblock_Tag::fromReflection($tag));
}
return $docblock;
}
/**
* setShortDescription()
*
* @param string $shortDescription
* @return Zend_CodeGenerator_Php_Docblock
*/
public function setShortDescription($shortDescription)
{
$this->_shortDescription = $shortDescription;
return $this;
}
/**
* getShortDescription()
*
* @return string
*/
public function getShortDescription()
{
return $this->_shortDescription;
}
/**
* setLongDescription()
*
* @param string $longDescription
* @return Zend_CodeGenerator_Php_Docblock
*/
public function setLongDescription($longDescription)
{
$this->_longDescription = $longDescription;
return $this;
}
/**
* getLongDescription()
*
* @return string
*/
public function getLongDescription()
{
return $this->_longDescription;
}
/**
* setTags()
*
* @param array $tags
* @return Zend_CodeGenerator_Php_Docblock
*/
public function setTags(Array $tags)
{
foreach ($tags as $tag) {
$this->setTag($tag);
}
return $this;
}
/**
* setTag()
*
* @param array|Zend_CodeGenerator_Php_Docblock_Tag $tag
* @return Zend_CodeGenerator_Php_Docblock
*/
public function setTag($tag)
{
if (is_array($tag)) {
$tag = new Zend_CodeGenerator_Php_Docblock_Tag($tag);
} elseif (!$tag instanceof Zend_CodeGenerator_Php_Docblock_Tag) {
require_once 'Zend/CodeGenerator/Php/Exception.php';
throw new Zend_CodeGenerator_Php_Exception(
'setTag() expects either an array of method options or an '
. 'instance of Zend_CodeGenerator_Php_Docblock_Tag'
);
}
$this->_tags[] = $tag;
return $this;
}
/**
* getTags
*
* @return array Array of Zend_CodeGenerator_Php_Docblock_Tag
*/
public function getTags()
{
return $this->_tags;
}
/**
* generate()
*
* @return string
*/
public function generate()
{
if (!$this->isSourceDirty()) {
return $this->_docCommentize($this->getSourceContent());
}
$output = '';
if (null !== ($sd = $this->getShortDescription())) {
$output .= $sd . self::LINE_FEED . self::LINE_FEED;
}
if (null !== ($ld = $this->getLongDescription())) {
$output .= $ld . self::LINE_FEED . self::LINE_FEED;
}
foreach ($this->getTags() as $tag) {
$output .= $tag->generate() . self::LINE_FEED;
}
return $this->_docCommentize(trim($output));
}
/**
* _docCommentize()
*
* @param string $content
* @return string
*/
protected function _docCommentize($content)
{
$indent = $this->getIndentation();
$output = $indent . '/**' . self::LINE_FEED;
$content = wordwrap($content, 80, self::LINE_FEED);
$lines = explode(self::LINE_FEED, $content);
foreach ($lines as $line) {
$output .= $indent . ' * ' . $line . self::LINE_FEED;
}
$output .= $indent . ' */' . self::LINE_FEED;
return $output;
}
}
|
