← Back to branch summary

~ubuntu-branches/ubuntu/utopic/php-codesniffer/utopic-proposed

« back to all changes in this revision

Viewing changes to PHP_CodeSniffer-1.5.3/CodeSniffer/Standards/MySource/Sniffs/Objects/DisallowNewWidgetSniff.php

  • Committer: Package Import Robot
  • Author(s): David Prévot
  • Date: 2014-07-21 14:42:41 UTC
  • mfrom: (1.1.4)
  • Revision ID: package-import@ubuntu.com-20140721144241-g4orlcuk4jzn9mhs
Tags: 1.5.3-1
* Team upload
* Focus on stable release
* Update copyright
* Bump standards version to 3.9.5
* Update Homepage
* Use ${phppear:…} instead of hardcoding them
* Run tests in dh_auto_test
* Update patch with gbp pq
* Simplify configuration installation
* Edit package.xml to move script
* Add DEP-8 tests

Show diffs side-by-side

added added

removed removed

Lines of Context:
PHP_CodeSniffer-1.5.3/CodeSniffer/Standards/MySource/Sniffs/Objects/DisallowNewWidgetSniff.php
 
1
<?php
 
2
/**
 
3
 * Ensures that widgets are not manually created.
 
4
 *
 
5
 * PHP version 5
 
6
 *
 
7
 * @category  PHP
 
8
 * @package   PHP_CodeSniffer_MySource
 
9
 * @author    Greg Sherwood <gsherwood@squiz.net>
 
10
 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
 
11
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 
12
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
13
 */
 
14
 
 
15
/**
 
16
 * Ensures that widgets are not manually created.
 
17
 *
 
18
 * @category  PHP
 
19
 * @package   PHP_CodeSniffer_MySource
 
20
 * @author    Greg Sherwood <gsherwood@squiz.net>
 
21
 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
 
22
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 
23
 * @version   Release: 1.5.3
 
24
 * @link      http://pear.php.net/package/PHP_CodeSniffer
 
25
 */
 
26
class MySource_Sniffs_Objects_DisallowNewWidgetSniff implements PHP_CodeSniffer_Sniff
 
27
{
 
28
 
 
29
 
 
30
    /**
 
31
     * Returns an array of tokens this test wants to listen for.
 
32
     *
 
33
     * @return array
 
34
     */
 
35
    public function register()
 
36
    {
 
37
        return array(T_NEW);
 
38
 
 
39
    }//end register()
 
40
 
 
41
 
 
42
    /**
 
43
     * Processes this test, when one of its tokens is encountered.
 
44
     *
 
45
     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
 
46
     * @param int                  $stackPtr  The position of the current token
 
47
     *                                        in the stack passed in $tokens.
 
48
     *
 
49
     * @return void
 
50
     */
 
51
    public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
 
52
    {
 
53
        $tokens = $phpcsFile->getTokens();
 
54
 
 
55
        $className = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true);
 
56
        if ($tokens[$className]['code'] !== T_STRING) {
 
57
            return;
 
58
        }
 
59
 
 
60
        if (substr(strtolower($tokens[$className]['content']), -10) === 'widgettype') {
 
61
            $widgetType = substr($tokens[$className]['content'], 0, -10);
 
62
            $error      = 'Manual creation of widget objects is banned; use Widget::getWidget(\'%s\'); instead';
 
63
            $data       = array($widgetType);
 
64
            $phpcsFile->addError($error, $stackPtr, 'Found', $data);
 
65
        }
 
66
 
 
67
    }//end process()
 
68
 
 
69
 
 
70
}//end class
 
71
 
 
72
?>