← 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/Standards/PEAR/Tests/Commenting/FileCommentUnitTest.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/Standards/PEAR/Tests/Commenting/FileCommentUnitTest.php
1
 
<?php
2
 
/**
3
 
 * Unit test class for FunctionCommentSniff.
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
 
 * Unit test class for FunctionCommentSniff.
18
 
 *
19
 
 * Verifies that :
20
 
 * <ul>
21
 
 *  <li>A doc comment exists.</li>
22
 
 *  <li>Short description must start with a capital letter and end with a period.</li>
23
 
 *  <li>There must be one blank newline after the short description.</li>
24
 
 *  <li>A PHP version is specified.</li>
25
 
 *  <li>Check the order of the tags.</li>
26
 
 *  <li>Check the indentation of each tag.</li>
27
 
 *  <li>Check required and optional tags and the format of their content.</li>
28
 
 * </ul>
29
 
 *
30
 
 * @category  PHP
31
 
 * @package   PHP_CodeSniffer
32
 
 * @author    Greg Sherwood <gsherwood@squiz.net>
33
 
 * @author    Marc McIntyre <mmcintyre@squiz.net>
34
 
 * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
35
 
 * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
36
 
 * @version   Release: 1.5.4
37
 
 * @link      http://pear.php.net/package/PHP_CodeSniffer
38
 
 */
39
 
class PEAR_Tests_Commenting_FileCommentUnitTest extends AbstractSniffUnitTest
40
 
{
41
 
 
42
 
 
43
 
    /**
44
 
     * Returns the lines where errors should occur.
45
 
     *
46
 
     * The key of the array should represent the line number and the value
47
 
     * should represent the number of errors that should occur on that line.
48
 
     *
49
 
     * @return array<int, int>
50
 
     */
51
 
    public function getErrorList()
52
 
    {
53
 
        return array(
54
 
                6  => 1,
55
 
                8  => 1,
56
 
                21 => 2,
57
 
                23 => 2,
58
 
                24 => 1,
59
 
                26 => 2,
60
 
                28 => 1,
61
 
                29 => 1,
62
 
                30 => 1,
63
 
                31 => 1,
64
 
                32 => 2,
65
 
                33 => 1,
66
 
                35 => 1,
67
 
                36 => 1,
68
 
                37 => 1,
69
 
                40 => 1,
70
 
               );
71
 
 
72
 
    }//end getErrorList()
73
 
 
74
 
 
75
 
    /**
76
 
     * Returns the lines where warnings should occur.
77
 
     *
78
 
     * The key of the array should represent the line number and the value
79
 
     * should represent the number of warnings that should occur on that line.
80
 
     *
81
 
     * @return array<int, int>
82
 
     */
83
 
    public function getWarningList()
84
 
    {
85
 
        return array(
86
 
                29 => 1,
87
 
                30 => 1,
88
 
                34 => 1,
89
 
                40 => 1,
90
 
               );
91
 
 
92
 
    }//end getWarningList()
93
 
 
94
 
 
95
 
}//end class
96
 
 
97
 
?>