PHP_CodeSniffer
[ class tree: PHP_CodeSniffer ] [ index: PHP_CodeSniffer ] [ all elements ]

Class: PHP_CodeSniffer_CommentParser_ParserException

Source Location: /PHP_CodeSniffer-0.7.0/CodeSniffer/CommentParser/ParserException.php

Class Overview

Exception
   |
   --PHP_CodeSniffer_CommentParser_ParserException

An exception to be thrown when a DocCommentParser finds an anomilty in a doc comment.


Author(s):

Version:

  • Release: 0.7.0

Copyright:

  • 2006 Squiz Pty Ltd (ABN 77 084 670 600)

Methods


Inherited Variables

Class: Exception (Internal Class)

$code
$file
$line
$message
$previous
$string
$trace

Inherited Methods

Class: Exception (Internal Class)

constructor __construct ( [$message = ], [$code = ], [$previous = ] )
getCode ( )
getFile ( )
getLine ( )
getMessage ( )
getPrevious ( )
getTrace ( )
getTraceAsString ( )
__clone ( )
__toString ( )
__wakeup ( )

Class Details

[line 31]
An exception to be thrown when a DocCommentParser finds an anomilty in a doc comment.


[ Top ]


Method Detail

__construct (Constructor)   [line 50]

PHP_CodeSniffer_CommentParser_ParserException __construct( string $message, int $line)

Constructs a DocCommentParserException.
  • Access: public

Overrides Exception::constructor __construct ( [$message = ], [$code = ], [$previous = ] ) (parent method not documented)

Parameters:

string   $message   —  The message of the exception.
int   $line   —  The position in comment where the error occured. A position of 0 indicates that the error occured at the opening line of the doc comment.

[ Top ]

getLineWithinComment   [line 63]

int getLineWithinComment( )

Returns the line number within the comment where the exception occured.
  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:06:36 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.