| 5 |
aurelien |
1 |
<?php
|
|
|
2 |
/**
|
|
|
3 |
* A DocElement represents a logical element within a Doc Comment.
|
|
|
4 |
*
|
|
|
5 |
* PHP version 5
|
|
|
6 |
*
|
|
|
7 |
* @category PHP
|
|
|
8 |
* @package PHP_CodeSniffer
|
|
|
9 |
* @author Greg Sherwood <gsherwood@squiz.net>
|
|
|
10 |
* @author Marc McIntyre <mmcintyre@squiz.net>
|
|
|
11 |
* @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)
|
|
|
12 |
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
|
|
13 |
* @version CVS: $Id: DocElement.php,v 1.3 2007/01/08 05:07:29 squiz Exp $
|
|
|
14 |
* @link http://pear.php.net/package/PHP_CodeSniffer
|
|
|
15 |
*/
|
|
|
16 |
|
|
|
17 |
/**
|
|
|
18 |
* A DocElement represents a logical element within a Doc Comment.
|
|
|
19 |
*
|
|
|
20 |
* @category PHP
|
|
|
21 |
* @package PHP_CodeSniffer
|
|
|
22 |
* @author Greg Sherwood <gsherwood@squiz.net>
|
|
|
23 |
* @author Marc McIntyre <mmcintyre@squiz.net>
|
|
|
24 |
* @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)
|
|
|
25 |
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
|
|
|
26 |
* @version Release: 1.2.0RC1
|
|
|
27 |
* @link http://pear.php.net/package/PHP_CodeSniffer
|
|
|
28 |
*/
|
|
|
29 |
interface PHP_CodeSniffer_CommentParser_DocElement
|
|
|
30 |
{
|
|
|
31 |
|
|
|
32 |
|
|
|
33 |
/**
|
|
|
34 |
* Returns the name of the tag this element represents, omitting the @ symbol.
|
|
|
35 |
*
|
|
|
36 |
* @return string
|
|
|
37 |
*/
|
|
|
38 |
public function getTag();
|
|
|
39 |
|
|
|
40 |
|
|
|
41 |
/**
|
|
|
42 |
* Returns the whitespace that exists before this element.
|
|
|
43 |
*
|
|
|
44 |
* @return string
|
|
|
45 |
* @see getWhitespaceAfter()
|
|
|
46 |
*/
|
|
|
47 |
public function getWhitespaceBefore();
|
|
|
48 |
|
|
|
49 |
|
|
|
50 |
/**
|
|
|
51 |
* Returns the whitespace that exists after this element.
|
|
|
52 |
*
|
|
|
53 |
* @return string
|
|
|
54 |
* @see getWhitespaceBefore()
|
|
|
55 |
*/
|
|
|
56 |
public function getWhitespaceAfter();
|
|
|
57 |
|
|
|
58 |
|
|
|
59 |
/**
|
|
|
60 |
* Returns the order that this element appears in the doc comment.
|
|
|
61 |
*
|
|
|
62 |
* The first element in the comment should have an order of 1.
|
|
|
63 |
*
|
|
|
64 |
* @return int
|
|
|
65 |
*/
|
|
|
66 |
public function getOrder();
|
|
|
67 |
|
|
|
68 |
|
|
|
69 |
/**
|
|
|
70 |
* Returns the element that appears before this element.
|
|
|
71 |
*
|
|
|
72 |
* @return PHP_CodeSniffer_CommentParser_DocElement
|
|
|
73 |
* @see getNextElement()
|
|
|
74 |
*/
|
|
|
75 |
public function getPreviousElement();
|
|
|
76 |
|
|
|
77 |
|
|
|
78 |
/**
|
|
|
79 |
* Returns the element that appears after this element.
|
|
|
80 |
*
|
|
|
81 |
* @return PHP_CodeSniffer_CommentParser_DocElement
|
|
|
82 |
* @see getPreviousElement()
|
|
|
83 |
*/
|
|
|
84 |
public function getNextElement();
|
|
|
85 |
|
|
|
86 |
|
|
|
87 |
/**
|
|
|
88 |
* Returns the line that this element started on.
|
|
|
89 |
*
|
|
|
90 |
* @return int
|
|
|
91 |
*/
|
|
|
92 |
public function getLine();
|
|
|
93 |
|
|
|
94 |
|
|
|
95 |
/**
|
|
|
96 |
* Returns the raw content of this element, ommiting the tag.
|
|
|
97 |
*
|
|
|
98 |
* @return string
|
|
|
99 |
*/
|
|
|
100 |
public function getRawContent();
|
|
|
101 |
|
|
|
102 |
|
|
|
103 |
}//end interface
|
|
|
104 |
|
|
|
105 |
?>
|