1<?php
2/**
3 * Squiz_Sniffs_Commenting_EmptyCatchCommentSniff.
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-2014 Squiz Pty Ltd (ABN 77 084 670 600)
12 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
13 * @link      http://pear.php.net/package/PHP_CodeSniffer
14 */
15
16/**
17 * Squiz_Sniffs_Commenting_EmptyCatchCommentSniff.
18 *
19 * Checks for empty Catch clause. Catch clause must at least have 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: @package_version@
28 * @link      http://pear.php.net/package/PHP_CodeSniffer
29 */
30class Squiz_Sniffs_Commenting_EmptyCatchCommentSniff implements PHP_CodeSniffer_Sniff
31{
32
33
34    /**
35     * Returns an array of tokens this test wants to listen for.
36     *
37     * @return array
38     */
39    public function register()
40    {
41        return array(T_CATCH);
42
43    }//end register()
44
45
46    /**
47     * Processes this test, when one of its tokens is encountered.
48     *
49     * @param PHP_CodeSniffer_File $phpcsFile All the tokens found in the document.
50     * @param int                  $stackPtr  The position of the current token in the
51     *                                        stack passed in $tokens.
52     *
53     * @return void
54     */
55    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
56    {
57        $tokens = $phpcsFile->getTokens();
58
59        $scopeStart   = $tokens[$stackPtr]['scope_opener'];
60        $firstContent = $phpcsFile->findNext(T_WHITESPACE, ($scopeStart + 1), $tokens[$stackPtr]['scope_closer'], true);
61
62        if ($firstContent === false) {
63            $error = 'Empty CATCH statement must have a comment to explain why the exception is not handled';
64            $phpcsFile->addError($error, $scopeStart, 'Missing');
65        }
66
67    }//end process()
68
69
70}//end class
71