← Back to branch summary

~ubuntu-branches/ubuntu/vivid/php-codesniffer/vivid

« back to all changes in this revision

Viewing changes to PHP_CodeSniffer-1.5.4/CodeSniffer/CommentParser/ParserException.php

  • Committer: Package Import Robot
  • Author(s): David Prévot, Greg Sherwood, Alexey, Emily, David Prévot
  • Date: 2014-09-26 13:44:35 UTC
  • mfrom: (1.1.6)
  • Revision ID: package-import@ubuntu.com-20140926134435-wvjq16miqq4d60y0
Tags: 1.5.5-1
[ Greg Sherwood ]
* Improved closure support in Generic ScopeIndentSniff
* Improved indented PHP tag support in Generic ScopeIndentSniff
* Standards can now be located within hidden directories
 (further fix for bug #20323)
* Fixed bug #20373 : Inline comment sniff tab handling way
* Fixed bug #20378 : Report appended to existing file if no errors
  found in run
* Fixed bug #20381 : Invalid "Comment closer must be on a new line"
* PHP tokenizer no longer converts class/function names to special
  tokens types
* Fixed bug #20386 : Squiz.Commenting.ClassComment.SpacingBefore
  thrown if first block comment
* Squiz and PEAR FunctionCommentSnif now support _()
* PEAR ValidFunctionNameSniff no longer throws an error for _()
* Fixed bug #248 : FunctionCommentSniff expects ampersand on param name
* Fixed bug #248 in Squiz sniff as well
* Fixed bug #265 : False positives with type hints in ForbiddenFunctionsSniff
* Prepare for 1.5.5 release

[ Alexey ]
* Allowed single undersored methods and functions

[ Emily ]
* Added var_dump to discouraged functions sniff

[ David Prévot ]
* Revert "Add XS-Testsuite still needed for ci.d.n"
* Add self to uploaders
* Bump standards version to 3.9.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
PHP_CodeSniffer-1.5.4/CodeSniffer/CommentParser/ParserException.php
1
 
<?php
2
 
/**
3
 
 * An exception to be thrown when a DocCommentParser finds an anomaly in a
4
 
 * doc comment.
5
 
 *
6
 
 * PHP version 5
7
 
 *
8
 
 * @category  PHP
9
 
 * @package   PHP_CodeSniffer
10
 
 * @author    Greg Sherwood <gsherwood@squiz.net>
11
 
 * @author    Marc McIntyre <mmcintyre@squiz.net>
12
 
 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
13
 
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
14
 
 * @link      http://pear.php.net/package/PHP_CodeSniffer
15
 
 */
16
 
 
17
 
/**
18
 
 * An exception to be thrown when a DocCommentParser finds an anomaly in a
19
 
 * doc comment.
20
 
 *
21
 
 * @category  PHP
22
 
 * @package   PHP_CodeSniffer
23
 
 * @author    Greg Sherwood <gsherwood@squiz.net>
24
 
 * @author    Marc McIntyre <mmcintyre@squiz.net>
25
 
 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
26
 
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
27
 
 * @version   Release: 1.5.4
28
 
 * @link      http://pear.php.net/package/PHP_CodeSniffer
29
 
 */
30
 
class PHP_CodeSniffer_CommentParser_ParserException extends Exception
31
 
{
32
 
 
33
 
    /**
34
 
     * The line where the exception occurred, in relation to the doc comment.
35
 
     *
36
 
     * @var int
37
 
     */
38
 
    private $_line = 0;
39
 
 
40
 
 
41
 
    /**
42
 
     * Constructs a DocCommentParserException.
43
 
     *
44
 
     * @param string $message The message of the exception.
45
 
     * @param int    $line    The position in comment where the error occurred.
46
 
     *                        A position of 0 indicates that the error occurred
47
 
     *                        at the opening line of the doc comment.
48
 
     */
49
 
    public function __construct($message, $line)
50
 
    {
51
 
        parent::__construct($message);
52
 
        $this->_line = $line;
53
 
 
54
 
    }//end __construct()
55
 
 
56
 
 
57
 
    /**
58
 
     * Returns the line number within the comment where the exception occurred.
59
 
     *
60
 
     * @return int
61
 
     */
62
 
    public function getLineWithinComment()
63
 
    {
64
 
        return $this->_line;
65
 
 
66
 
    }//end getLineWithinComment()
67
 
 
68
 
 
69
 
}//end class
70
 
 
71
 
?>