package.xml0000644000076700000240000145410312647543456013111 0ustar gsherwoodstaff PHP_CodeSniffer pear.php.net PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files to detect and fix violations of a defined set of coding standards. PHP_CodeSniffer is a set of two PHP scripts; the main phpcs script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second phpcbf script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent. Greg Sherwood squiz gsherwood@squiz.net yes 2016-01-19 2.5.1 2.5.1 stable stable BSD 3-Clause License - The PHP-supplied T_SPACESHIP token has been replicated for PHP versions before 7.0 - T_SPACESHIP is now correctly identified as an operator -- Thanks to Alexander Obuhovich for the patch - Generic LowerCaseKeyword now ensures array type hints are lowercase as well -- Thanks to Mathieu Rochette for the patch - Squiz ComparisonOperatorUsageSniff no longer hangs on JS FOR loops that don't use semicolons - PHP_CodesSniffer now includes the composer autoload.php file, if there is one -- Thanks to Klaus Purer for the patch -- Added error Squiz.Commenting.FunctionComment.ScalarTypeHintMissing for PHP7 only (request #858) -- These errors were previously reported as Squiz.Commenting.FunctionComment.TypeHintMissing on PHP7 -- Disable this error message in a ruleset.xml file if your code needs to run on both PHP5 and PHP7 - The PHP 5.6 __debugInfo magic method no longer produces naming convention errors -- Thanks to Michael Nowack for the patch - PEAR and Squiz FunctionComment sniffs now support variadic functions (request #841) - Fixed bug #622 : Wrong detection of Squiz.CSS.DuplicateStyleDefinition with media queries - Fixed bug #752 : The missing exception error is reported in first found DocBlock - Fixed bug #794 : PSR2 MultiLineFunctionDeclaration forbids comments after opening parenthesis of a multiline call - Fixed bug #820 : PEAR/PSR2 FunctionCallSignature sniffs suggest wrong indent when there are multiple arguments on a line - Fixed bug #822 : Ruleset hard-coded file paths are not used if not running from the same directory as the ruleset - Fixed bug #825 : FunctionCallArgumentSpacing sniff complains about more than one space before comment in multi-line function call - Fixed bug #828 : Null classname is tokenized as T_NULL instead of T_STRING - Fixed bug #829 : Short array argument not fixed correctly when multiple function arguments are on the same line - Fixed bug #831 : PHPCS freezes in an infinite loop under Windows if no standard is passed - Fixed bug #832 : Tokenizer does not support context sensitive parsing -- Thanks to Jaroslav Hanslík for the patch - Fixed bug #835 : PEAR.Functions.FunctionCallSignature broken when closure uses return types - Fixed bug #838 : CSS indentation fixer changes color codes -- Thanks to Klaus Purer for the patch - Fixed bug #839 : "__()" method is marked as not camel caps -- Thanks to Tim Bezhashvyly for the patch - Fixed bug #852 : Generic.Commenting.DocComment not finding errors when long description is omitted - Fixed bug #854 : Return typehints in interfaces are not reported as T_RETURN_TYPE -- Thanks to Jaroslav Hanslík for the patch - Fixed bug #855 : Capital letter detection for multibyte strings doesn't work correctly - Fixed bug #857 : PSR2.ControlStructure.SwitchDeclaration shouldn't check indent of curly brace closers - Fixed bug #859 : Switch statement indention issue when returning function call with closure - Fixed bug #861 : Single-line arrays and function calls can generate incorrect indentation errors - Fixed bug #867 : Squiz.Strings.DoubleQuoteUsage broken for some escape codes -- Thanks to Jack Blower for the help with the fix - Fixed bug #21005 : Incorrect indent detection when multiple properties are initialized to arrays - Fixed bug #21010 : Incorrect missing colon detection in CSS when first style is not on new line - Fixed bug #21011 : Incorrect error message text when newline found after opening brace 5.1.2 1.4.0b1 windows 2.5.1 2.5.1 stable stable 2016-01-20 BSD License - The PHP-supplied T_SPACESHIP token has been replicated for PHP versions before 7.0 - T_SPACESHIP is now correctly identified as an operator -- Thanks to Alexander Obuhovich for the patch - Generic LowerCaseKeyword now ensures array type hints are lowercase as well -- Thanks to Mathieu Rochette for the patch - Squiz ComparisonOperatorUsageSniff no longer hangs on JS FOR loops that don't use semicolons - PHP_CodesSniffer now includes the composer autoload.php file, if there is one -- Thanks to Klaus Purer for the patch -- Added error Squiz.Commenting.FunctionComment.ScalarTypeHintMissing for PHP7 only (request #858) -- These errors were previously reported as Squiz.Commenting.FunctionComment.TypeHintMissing on PHP7 -- Disable this error message in a ruleset.xml file if your code needs to run on both PHP5 and PHP7 - The PHP 5.6 __debugInfo magic method no longer produces naming convention errors -- Thanks to Michael Nowack for the patch - PEAR and Squiz FunctionComment sniffs now support variadic functions (request #841) - Fixed bug #622 : Wrong detection of Squiz.CSS.DuplicateStyleDefinition with media queries - Fixed bug #752 : The missing exception error is reported in first found DocBlock - Fixed bug #794 : PSR2 MultiLineFunctionDeclaration forbids comments after opening parenthesis of a multiline call - Fixed bug #820 : PEAR/PSR2 FunctionCallSignature sniffs suggest wrong indent when there are multiple arguments on a line - Fixed bug #822 : Ruleset hard-coded file paths are not used if not running from the same directory as the ruleset - Fixed bug #825 : FunctionCallArgumentSpacing sniff complains about more than one space before comment in multi-line function call - Fixed bug #828 : Null classname is tokenized as T_NULL instead of T_STRING - Fixed bug #829 : Short array argument not fixed correctly when multiple function arguments are on the same line - Fixed bug #831 : PHPCS freezes in an infinite loop under Windows if no standard is passed - Fixed bug #832 : Tokenizer does not support context sensitive parsing -- Thanks to Jaroslav Hanslík for the patch - Fixed bug #835 : PEAR.Functions.FunctionCallSignature broken when closure uses return types - Fixed bug #838 : CSS indentation fixer changes color codes -- Thanks to Klaus Purer for the patch - Fixed bug #839 : "__()" method is marked as not camel caps -- Thanks to Tim Bezhashvyly for the patch - Fixed bug #852 : Generic.Commenting.DocComment not finding errors when long description is omitted - Fixed bug #854 : Return typehints in interfaces are not reported as T_RETURN_TYPE -- Thanks to Jaroslav Hanslík for the patch - Fixed bug #855 : Capital letter detection for multibyte strings doesn't work correctly - Fixed bug #857 : PSR2.ControlStructure.SwitchDeclaration shouldn't check indent of curly brace closers - Fixed bug #859 : Switch statement indention issue when returning function call with closure - Fixed bug #861 : Single-line arrays and function calls can generate incorrect indentation errors - Fixed bug #867 : Squiz.Strings.DoubleQuoteUsage broken for some escape codes -- Thanks to Jack Blower for the help with the fix - Fixed bug #21005 : Incorrect indent detection when multiple properties are initialized to arrays - Fixed bug #21010 : Incorrect missing colon detection in CSS when first style is not on new line - Fixed bug #21011 : Incorrect error message text when newline found after opening brace 2.5.0 2.5.0 stable stable 2015-12-11 BSD License - PHPCS will now look for a phpcs.xml file in parent directories as well as the current directory (request #626) - PHPCS will now use a phpcs.xml file even if files are specified on the command line -- This file is still only used if no standard is specified on the command line - Added support for a phpcs.xml.dist file (request #583) -- If both a phpcs.xml and phpcs.xml.dist file are present, the phpcs.xml file will be used - Added support for setting PHP ini values in ruleset.xml files (request #560) -- Setting the value of the new ini tags to name="memory_limit" value="32M" is the same as -d memory_limit=32M - Added support for one or more bootstrap files to be run before processing begins -- Use the --bootstrap=file,file,file command line argument to include bootstrap files -- Useful if you want to override some of the high-level settings of PHPCS or PHPCBF -- Thanks to John Maguire for the patch - Added additional verbose output for CSS tokenizing - Squiz ComparisonOperatorUsageSniff now checks FOR, WHILE and DO-WHILE statements -- Thanks to Arnout Boks for the patch - Fixed bug #660 : Syntax checks can fail on Windows with PHP5.6 - Fixed bug #784 : $this->trait is seen as a T_TRAIT token - Fixed bug #786 : Switch indent issue with short array notation - Fixed bug #787 : SpacingAfterDefaultBreak confused by multi-line statements - Fixed bug #797 : Parsing CSS url() value breaks further parsing - Fixed bug #805 : Squiz.Commenting.FunctionComment.InvalidTypeHint on Scalar types on PHP7 - Fixed bug #807 : Cannot fix line endings when open PHP tag is not on the first line - Fixed bug #808 : JS tokeniser incorrectly setting some function and class names to control structure tokens - Fixed bug #809 : PHPCBF can break a require_once statement with a space before the open parenthesis - Fixed bug #813 : PEAR FunctionCallSignature checks wrong indent when first token on line is part of a multi-line string 2.4.0 2.4.0 stable stable 2015-11-24 BSD License - Added support for PHP 7 anonymous classes -- Anonymous classes are now tokenized as T_ANON_CLASS and ignored by normal class sniffs - Added support for PHP 7 function return type declarations -- Return types are now tokenized as T_RETURN_TYPE - Fixed tokenizing of the XOR operator, which was incorrectly identified as a power operator (bug #765) -- The T_POWER token has been removed and replaced by the T_BITWISE_XOR token -- The PHP-supplied T_POW token has been replicated for PHP versions before 5.6 - Traits are now tokenized in PHP versions before 5.4 to make testing easier - Improved regular expression detection in JS files - PEAR FunctionCallSignatureSniff now properly detects indents in more mixed HTML/PHP code blocks - Full report now properly indents lines when newlines are found inside error messages - Generating documentation without specifying a standard now uses the default standard instead -- Thanks to Ken Guest for the patch - Generic InlineControlStructureSniff now supports braceless do/while loops in JS -- Thanks to Pieter Frenssen for the patch - Added more guard code for function declarations with syntax errors -- Thanks to Yun Young-jin for the patch - Added more guard code for foreach declarations with syntax errors -- Thanks to Johan de Ruijter for the patch - Added more guard code for class declarations with syntax errors - Squiz ArrayDeclarationSniff now has guard code for arrays with syntax errors - Generic InlineControlStructureSniff now correctly fixes ELSEIF statements - Fixed bug #601 : Expected type hint int[]; found array in Squiz FunctionCommentSniff -- Thanks to Scato Eggen for the patch - Fixed bug #625 : Consider working around T_HASHBANG in HHVM 3.5.x and 3.6.x -- Thanks to Kunal Mehta for the patch - Fixed bug #692 : Comment tokenizer can break when using mbstring function overloading - Fixed bug #694 : Long sniff codes can cause PHP warnings in source report when showing error codes - Fixed bug #698 : PSR2.Methods.FunctionCallSignature.Indent forces exact indent of ternary operator parameters - Fixed bug #704 : ScopeIndent can fail when an opening parenthesis is on a line by itself - Fixed bug #707 : Squiz MethodScopeSniff doesn't handle nested functions - Fixed bug #709 : Squiz.Sniffs.Whitespace.ScopeClosingBraceSniff marking indented endif in mixed inline HTML blocks - Fixed bug #711 : Sniffing from STDIN shows Generic.Files.LowercasedFilename.NotFound error - Fixed bug #714 : Fixes suppression of errors using docblocks -- Thanks to Andrzej Karmazyn for the patch - Fixed bug #716 : JSON report is invalid when messages contain newlines or tabs -- Thanks to Pieter Frenssen for the patch - Fixed bug #723 : ScopeIndent can fail when multiple array closers are on the same line - Fixed bug #730 : ScopeIndent can fail when a short array opening square bracket is on a line by itself - Fixed bug #732 : PHP Notice if @package name is made up of all invalid characters -- Adds new error code PEAR.Commenting.FileComment.InvalidPackageValue - Fixed bug #748 : Auto fix for Squiz.Commenting.BlockComment.WrongEnd is incorrect -- Thanks to J.D. Grimes for the patch - Fixed bug #753 : PSR2 standard shouldn't require space after USE block when next code is a closing tag - Fixed bug #768 : PEAR FunctionCallSignature sniff forbids comments after opening parenthesis of a multiline call - Fixed bug #769 : Incorrect detection of variable reference operator when used with short array syntax -- Thanks to Klaus Purer for the patch - Fixed bug #772 : Syntax error when using PHPCBF on alternative style foreach loops - Fixed bug #773 : Syntax error when stripping trailing PHP close tag and previous statement has no semicolon - Fixed bug #778 : PHPCBF creates invalid PHP for inline FOREACH containing multiple control structures - Fixed bug #781 : Incorrect checking for PHP7 return types on multi-line function declartions - Fixed bug #782 : Conditional function declarations cause fixing conflicts in Squiz standard -- Squiz.ControlStructures.ControlSignature no longer enforces a single newline after open brace -- Squiz.WhiteSpace.ControlStructureSpacing can be used to checl spacing at the start/end of control structures 2.3.4 2.3.4 stable stable 2015-09-09 BSD License - JSON report format now includes the fixable status for each error message and the total number of fixable errors - Added more guard code for function declarations with syntax errors - Added tokenizer support for the PHP declare construct -- Thanks to Andy Blyler for the patch - Generic UnnecessaryStringConcatSniff can now allow strings concatenated over multiple lines -- Set the allowMultiline property to TRUE (default is FALSE) in your ruleset.xml file to enable this -- By default, concat used only for getting around line length limits still generates an error -- Thanks to Stefan Lenselink for the contribution - Invalid byte sequences no longer throw iconv_strlen() errors (request #639) -- Thanks to Willem Stuursma for the patch - Generic TodoSniff and FixmeSniff are now better at processing strings with invalid characters - PEAR FunctionCallSignatureSniff now ignores indentation of inline HTML content - Squiz ControlSignatureSniff now supports control structures with only inline HTML content - Fixed bug #636 : Some class names cause CSS tokenizer to hang - Fixed bug #638 : VCS blame reports output error content from the blame commands for files not under VC - Fixed bug #642 : Method params incorrectly detected when default value uses short array syntax -- Thanks to Josh Davis for the patch - Fixed bug #644 : PEAR ScopeClosingBrace sniff does not work with mixed HTML/PHP - Fixed bug #645 : FunctionSignature and ScopeIndent sniffs don't detect indents correctly when PHP open tag is not on a line by itself - Fixed bug #648 : Namespace not tokenized correctly when followed by multiple use statements - Fixed bug #654 : Comments affect indent check for BSDAllman brace style - Fixed bug #658 : Squiz.Functions.FunctionDeclarationSpacing error for multi-line declarations with required spaces greater than zero -- Thanks to J.D. Grimes for the patch - Fixed bug #663 : No space after class name generates: Class name "" is not in camel caps format - Fixed bug #667 : Scope indent check can go into infinite loop due to some parse errors - Fixed bug #670 : Endless loop in PSR1 SideEffects sniffer if no semicolon after last statement -- Thanks to Thomas Jarosch for the patch - Fixed bug #672 : Call-time pass-by-reference false positive - Fixed bug #683 : Comments are incorrectly reported by PSR2.ControlStructures.SwitchDeclaration sniff - Fixed bug #687 : ScopeIndent does not check indent correctly for method prefixes like public and abstract - Fixed bug #689 : False error on some comments after class closing brace 2.3.3 2.3.3 stable stable 2015-06-24 BSD License - Improved the performance of the CSS tokenizer, especially on very large CSS files (thousands of lines) -- Thanks to Klaus Purer for the patch - Defined tokens for lower PHP versions are now phpcs-specific strings instead of ints -- Stops conflict with other projects, like PHP_CodeCoverage - Added more guard code for syntax errors to various sniffs - Improved support for older HHVM versions -- Thanks to Kunal Mehta for the patch - Squiz ValidLogicalOperatorsSniff now ignores XOR as type casting is different when using the ^ operator (request #567) - Squiz CommentedOutCodeSniff is now better at ignoring URLs inside comments - Squiz ControlSignatureSniff is now better at checking embedded PHP code - Squiz ScopeClosingBraceSniff is now better at checking embedded PHP code - Fixed bug #584 : Squiz.Arrays.ArrayDeclaration sniff gives incorrect NoComma error for multiline string values - Fixed bug #589 : PEAR.Functions.FunctionCallSignature sniff not checking all function calls - Fixed bug #592 : USE statement tokenising can sometimes result in mismatched scopes - Fixed bug #594 : Tokenizer issue on closure that returns by reference - Fixed bug #595 : Colons in CSS selectors within media queries throw false positives -- Thanks to Klaus Purer for the patch - Fixed bug #598 : PHPCBF can break function/use closure brace placement - Fixed bug #603 : Squiz ControlSignatureSniff hard-codes opener type while fixing - Fixed bug #605 : Auto report-width specified in ruleset.xml ignored - Fixed bug #611 : Invalid numeric literal on CSS files under PHP7 - Fixed bug #612 : Multi-file diff generating incorrectly if files do not end with EOL char - Fixed bug #615 : Squiz OperatorBracketSniff incorrectly reports and fixes operations using self:: - Fixed bug #616 : Squiz DisallowComparisonAssignmentSniff inconsistent errors with inline IF statements - Fixed bug #617 : Space after switch keyword in PSR-2 is not being enforced - Fixed bug #621 : PSR2 SwitchDeclaration sniff doesn't detect, or correctly fix, case body on same line as statement 2.3.2 2.3.2 stable stable 2015-04-29 BSD License - The error message for PSR2.ControlStructures.SwitchDeclaration.WrongOpenercase is now clearer (request #579) - Fixed bug #545 : Long list of CASE statements can cause tokenizer to reach a depth limit - Fixed bug #565 : Squiz.WhiteSpace.OperatorSpacing reports negative number in short array -- Thanks to Vašek Purchart for the patch -- Same fix also applied to Squiz.Formatting.OperatorBracket - Fixed bug #569 : Generic ScopeIndentSniff throws PHP notices in JS files - Fixed bug #570 : Phar class fatals in PHP less than 5.3 2.3.1 2.3.1 stable stable 2015-04-23 BSD License - PHPCS can now exit with 0 even if errors are found -- Set the ignore_errors_on_exit config variable to 1 to set this behaviour -- Use with the ignore_warnings_on_exit config variable to never return a non-zero exit code - Added Generic DisallowLongArraySyntaxSniff to enforce the use of the PHP short array syntax (request #483) -- Thanks to Xaver Loppenstedt for helping with tests - Added Generic DisallowShortArraySyntaxSniff to ban the use of the PHP short array syntax (request #483) -- Thanks to Xaver Loppenstedt for helping with tests - Generic ScopeIndentSniff no longer does exact checking for content inside parenthesis (request #528) -- Only applies to custom coding standards that set the "exact" flag to TRUE - Squiz ConcatenationSpacingSniff now has a setting to ignore newline characters around operators (request #511) -- Default remains FALSE, so newlines are not allowed -- Override the "ignoreNewlines" setting in a ruleset.xml file to change - Squiz InlineCommentSniff no longer checks the last char of a comment if the first char is not a letter (request #505) - The Squiz standard has increased the max padding for statement alignment from 12 to 20 - Fixed bug #479 : Yielded values are not recognised as returned values in Squiz FunctionComment sniff - Fixed bug #512 : Endless loop whilst parsing mixture of control structure styles - Fixed bug #515 : Spaces in JS block incorrectly flagged as indentation error - Fixed bug #523 : Generic ScopeIndent errors for IF in FINALLY - Fixed bug #527 : Closure inside IF statement is not tokenized correctly - Fixed bug #529 : Squiz.Strings.EchoedStrings gives false positive when echo'ing using an inline condition - Fixed bug #537 : Using --config-set is breaking phpcs.phar - Fixed bug #543 : SWITCH with closure in condition generates inline control structure error - Fixed bug #551 : Multiple catch blocks not checked in Squiz.ControlStructures.ControlSignature sniff - Fixed bug #554 : ScopeIndentSniff causes errors when encountering an unmatched parenthesis - Fixed bug #558 : PHPCBF adds brace for ELSE IF split over multiple lines - Fixed bug #564 : Generic MultipleStatementAlignment sniff reports incorrect errors for multiple assignments on a single line 2.3.0 2.3.0 stable stable 2015-03-04 BSD License - The existence of the main config file is now cached to reduce is_file() calls when it doesn't exist (request #486) - Abstract classes inside the Sniffs directory are now ignored even if they are named [Name]Sniff.php (request #476) -- Thanks to David Vernet for the patch - PEAR and Squiz FileComment sniffs no longer have @ in their error codes -- e.g., PEAR.Commenting.FileComment.Duplicate@categoryTag becomes PEAR.Commenting.FileComment.DuplicateCategoryTag -- e.g., Squiz.Commenting.FileComment.Missing@categoryTag becomes Squiz.Commenting.FileComment.MissingCategoryTag - PEAR MultiLineConditionSniff now allows comment lines inside multi-line IF statement conditions -- Thanks to Klaus Purer for the patch - Generic ForbiddenFunctionsSniff now supports setting null replacements in ruleset files (request #263) - Generic opening function brace sniffs now support checking of closures -- Set the checkClosures property to TRUE (default is FALSE) in your ruleset.xml file to enable this -- Can also set the checkFunctions property to FALSE (default is TRUE) in your ruleset.xml file to only check closures -- Affects OpeningFunctionBraceBsdAllmanSniff and OpeningFunctionBraceKernighanRitchieSniff - Generic OpeningFunctionBraceKernighanRitchieSniff can now fix all the errors it finds - Generic OpeningFunctionBraceKernighanRitchieSniff now allows empty functions with braces next to each other - Generic OpeningFunctionBraceBsdAllmanSniff now allows empty functions with braces next to each other - Improved auto report width for the "full" report - Improved conflict detection during auto fixing - Generic ScopeIndentSniff is no longer confused by empty closures - Squiz ControlSignatureSniff now always ignores comments (fixes bug #490) -- Include the Squiz.Commenting.PostStatementComment sniff in your ruleset.xml to ban these comments again - Squiz OperatorSpacingSniff no longer throws errors for code in the form ($foo || -1 === $bar) - Fixed errors tokenizing T_ELSEIF tokens on HHVM 3.5 - Squiz ArrayDeclarationSniff is no longer tricked by comments after array values - PEAR IncludingFileSniff no longer produces invalid code when removing parenthesis from require/include statements - Fixed bug #415 : The @codingStandardsIgnoreStart has no effect during fixing - Fixed bug #432 : Properties of custom sniffs cannot be configured - Fixed bug #453 : PSR2 standard does not allow closing tag for mixed PHP/HTML files - Fixed bug #457 : FunctionCallSignature sniffs do not support here/nowdoc syntax and can cause syntax error when fixing - Fixed bug #466 : PropertyLabelSpacing JS fixer issue when there is no space after colon - Fixed bug #473 : Writing a report for an empty folder to existing file includes the existing contents - Fixed bug #485 : PHP notice in Squiz.Commenting.FunctionComment when checking malformed @throws comment - Fixed bug #491 : Generic InlineControlStructureSniff can correct with missing semicolon -- Thanks to Jesse Donat for the patch - Fixed bug #492 : Use statements don't increase the scope indent - Fixed bug #493 : PSR1_Sniffs_Methods_CamelCapsMethodNameSniff false positives for some magic method detection -- Thanks to Andreas Möller for the patch - Fixed bug #496 : Closures in PSR2 are not checked for a space after the function keyword - Fixed bug #497 : Generic InlineControlStructureSniff does not support alternative SWITCH syntax - Fixed bug #500 : Functions not supported as values in Squiz ArrayDeclaration sniff - Fixed bug #501 : ScopeClosingBrace and ScopeIndent conflict with closures used as array values -- Generic ScopeIndentSniff may now report fewer errors for closures, but perform the same fixes - Fixed bug #502 : PSR1 SideEffectsSniff sees declare() statements as side effects 2.2.0 2.2.0 stable stable 2015-01-22 BSD License - Added (hopefully) tastefully used colors to report and progress output for the phpcs command -- Use the --colors command line argument to use colors in output -- Use the command "phpcs --config-set colors true" to turn colors on by default -- Use the --no-colors command line argument to turn colors off when the config value is set - Added support for using the full terminal width for report output -- Use the --report-width=auto command line argument to auto-size the reports -- Use the command "phpcs --config-set report_width auto" to use auto-sizing by default - Reports will now size to fit inside the report width setting instead of always using padding to fill the space - If no files or standards are specified, PHPCS will now look for a phpcs.xml file in the current directory -- This file has the same format as a standard ruleset.xml file -- The phpcs.xml file should specify (at least) files to process and a standard/sniffs to use -- Useful for running the phpcs and phpcbf commands without any arguments at the top of a repository - Default file paths can now be specified in a ruleset.xml file using the "file" tag -- File paths are only processed if no files were specified on the command line - Extensions specified on the CLI are now merged with those set in ruleset.xml files -- Previously, the ruleset.xml file setting replaced the CLI setting completely - Squiz coding standard now requires lowercase PHP constants (true, false and null) -- Removed Squiz.NamingConventions.ConstantCase sniff as the rule is now consistent across PHP and JS files - Squiz FunctionOpeningBraceSpaceSniff no longer does additional checks for JS functions -- PHP and JS functions and closures are now treated the same way - Squiz MultiLineFunctionDeclarationSniff now supports JS files - Interactive mode no longer breaks if you also specify a report type on the command line - PEAR InlineCommentSniff now fixes the Perl-style comments that it finds (request #375) - PSR2 standard no longer fixes the placement of docblock open tags as comments are excluded from this standard - PSR2 standard now sets a default tab width of 4 spaces - Generic DocCommentSniff now only disallows lowercase letters at the start of a long/short comment (request #377) -- All non-letter characters are now allowed, including markdown special characters and numbers - Generic DisallowMultipleStatementsSniff now allows multiple open/close tags on the same line (request #423) - Generic CharacterBeforePHPOpeningTagSniff now only checks the first PHP tag it finds (request #423) - Generic CharacterBeforePHPOpeningTagSniff now allows a shebang line at the start of the file (request #20481) - Generic InlineHTMLUnitTest now allows a shebang line at the start of the file (request #20481) - PEAR ObjectOperatorIndentSniff now only checks object operators at the start of a line - PEAR FileComment and ClassComment sniffs no longer have @ in their error codes -- E.g., PEAR.Commenting.FileComment.Missing@categoryTag becomes PEAR.Commenting.FileComment.MissingCategoryTag -- Thanks to Grzegorz Rygielski for the patch - Squiz ControlStructureSpacingSniff no longer enforces a blank line before CATCH statements - Squiz FunctionCommentSniff now fixes the return type in the @return tag (request #392) - Squiz BlockCommentSniff now only disallows lowercase letters at the start of the comment - Squiz InlineCommentSniff now only disallows lowercase letters at the start of the comment - Squiz OperatorSpacingSniff now has a setting to ignore newline characters around operators (request #348) -- Default remains FALSE, so newlines are not allowed -- Override the "ignoreNewlines" setting in a ruleset.xml file to change - PSR2 ControlStructureSpacingSniff now checks for, and fixes, newlines after the opening parenthesis - Added a markdown document generator (--generator=markdown to use) -- Thanks to Stefano Kowalke for the contribution - Fixed bug #379 : Squiz.Arrays.ArrayDeclaration.NoCommaAfterLast incorrectly detects comments - Fixed bug #382 : JS tokenizer incorrect for inline conditionally created immediately invoked anon function - Fixed bug #383 : Squiz.Arrays.ArrayDeclaration.ValueNoNewline incorrectly detects nested arrays - Fixed bug #386 : Undefined offset in Squiz.FunctionComment sniff when param has no comment - Fixed bug #390 : Indentation of non-control structures isn't adjusted when containing structure is fixed - Fixed bug #400 : InlineControlStructureSniff fails to fix when statement has no semicolon - Fixed bug #401 : PHPCBF no-patch option shows an error when there are no fixable violations in a file - Fixed bug #405 : The "Squiz.WhiteSpace.FunctionSpacing" sniff removes class "}" during fixing - Fixed bug #407 : PEAR.ControlStructures.MultiLineCondition doesn't account for comments at the end of lines - Fixed bug #410 : The "Squiz.WhiteSpace.MemberVarSpacing" not respecting "var" - Fixed bug #411 : Generic.WhiteSpace.ScopeIndent.Incorrect - false positive with multiple arrays in argument list - Fixed bug #412 : PSR2 multi-line detection doesn't work for inline IF and string concats - Fixed bug #414 : Squiz.WhiteSpace.MemberVarSpacing - inconsistent checking of member vars with comment - Fixed bug #433 : Wrong detection of Squiz.Arrays.ArrayDeclaration.KeyNotAligned when key contains space - Fixed bug #434 : False positive for spacing around "=>" in inline array within foreach - Fixed bug #452 : Ruleset exclude-pattern for specific sniff code ignored when using CLI --ignore option - Fixed bug #20482 : Scope indent sniff can get into infinite loop when processing a parse error 2.1.0 2.1.0 stable stable 2014-12-18 BSD License - Time and memory output is now shown if progress information is also shown (request #335) - A tilde can now be used to reference a user's home directory in a path to a standard (request #353) - Added PHP_CodeSniffer_File::findStartOfStatement() to find the first non-whitespace token in a statement -- Possible alternative for code using PHP_CodeSniffer_File::findPrevious() with the local flag set - Added PHP_CodeSniffer_File::findEndOfStatement() to find the last non-whitespace token in a statement -- Possible alternative for code using PHP_CodeSniffer_File::findNext() with the local flag set - Generic opening function brace sniffs now ensure the opening brace is the last content on the line -- Affects OpeningFunctionBraceBsdAllmanSniff and OpeningFunctionBraceKernighanRitchieSniff -- Also enforced in PEAR FunctionDeclarationSniff and Squiz MultiLineFunctionDeclarationSniff - Generic DisallowTabIndentSniff now replaces tabs everywhere it finds them, except in strings and here/now docs - Generic EmptyStatementSniff error codes now contain the type of empty statement detected (request #314) -- All messages generated by this sniff are now errors (empty CATCH was previously a warning) -- Message code Generic.CodeAnalysis.EmptyStatement.NotAllowed has been removed -- Message code Generic.CodeAnalysis.EmptyStatement.NotAllowedWarning has been removed -- New message codes have the format Generic.CodeAnalysis.EmptyStatement.Detected[TYPE] -- Example code is Generic.CodeAnalysis.EmptyStatement.DetectedCATCH -- You can now use a custom ruleset to change messages to warnings and to exclude them - PEAR and Squiz FunctionCommentSniffs no longer ban @return tags for constructors and destructors -- Removed message PEAR.Commenting.FunctionComment.ReturnNotRequired -- Removed message Squiz.Commenting.FunctionComment.ReturnNotRequired -- Change initiated by request #324 and request #369 - Squiz EmptyStatementSniff has been removed -- Squiz standard now includes Generic EmptyStatementSniff and turns off the empty CATCH error - Squiz ControlSignatureSniff fixes now retain comments between the closing parenthesis and open brace - Squiz SuperfluousWhitespaceSniff now checks for extra blank lines inside closures -- Thanks to Sertan Danis for the patch - Squiz ArrayDeclarationSniff now skips function calls while checking multi-line arrays - Fixed bug #337 : False positive with anonymous functions in Generic_Sniffs_WhiteSpace_ScopeIndentSniff - Fixed bug #339 : reformatting brace location can result in broken code - Fixed bug #342 : Nested ternary operators not tokenized correctly - Fixed bug #345 : Javascript regex not tokenized when inside array - Fixed bug #346 : PHP path can't be determined in some cases in "phpcs.bat" (on Windows XP) - Fixed bug #358 : False positives for Generic_Sniffs_WhiteSpace_ScopeIndentSniff - Fixed bug #361 : Sniff-specific exclude patterns don't work for Windows - Fixed bug #364 : Don't interpret "use function" as declaration - Fixed bug #366 : phpcbf with PSR2 errors on control structure alternative syntax - Fixed bug #367 : Nested Anonymous Functions Causing False Negative - Fixed bug #371 : Shorthand binary cast causes tokenizer errors -- New token T_BINARY_CAST added for the b"string" cast format (the 'b' is the T_BINARY_CAST token) - Fixed bug #372 : phpcbf parse problem, wrong brace placement for inline IF - Fixed bug #373 : Double quote usage fix removing too many double quotes - Fixed bug #20196 : 1.5.2 breaks scope_closer position 2.0.0 2.0.0 stable stable 2014-12-05 BSD License - JS tokenizer now sets functions as T_CLOSUREs if the function is anonymous - JS tokenizer now sets all objects to T_OBJECT -- Object end braces are set to a new token T_CLOSE_OBJECT -- T_OBJECT tokens no longer act like scopes; i.e., they have no condition/opener/closer -- T_PROPERTY tokens no longer act like scopes; i.e., they have no condition/opener/closer -- T_OBJECT tokens have a bracket_closer instead, which can be used to find the ending -- T_CLOSE_OBJECT tokens have a bracket_opener - Improved regular expression detection in the JS tokenizer - You can now get PHP_CodeSniffer to ignore a single line by putting @codingStandardsIgnoreLine in a comment -- When the comment is found, the comment line and the following line will be ignored -- Thanks to Andy Bulford for the contribution - PHPCBF now prints output when it is changing into directories - Improved conflict detection during auto fixing - The -vvv command line argument will now output the current file content for each loop during fixing - Generic ScopeIndentSniff now checks that open/close PHP tags are aligned to the correct column - PEAR FunctionCallSignatureSniff now checks indent of closing parenthesis even if it is not on a line by itself - PEAR FunctionCallSignatureSniff now supports JS files - PEAR MultiLineConditionSniff now supports JS files - Squiz DocCommentAlignmentSniff now supports JS files - Fixed a problem correcting the closing brace line in Squiz ArrayDeclarationSniff - Fixed a problem auto-fixing the Squiz.WhiteSpace.FunctionClosingBraceSpace.SpacingBeforeNestedClose error - Squiz EmbeddedPhpSniff no longer reports incorrect alignment of tags when they are not on new lines - Squiz EmbeddedPhpSniff now aligns open tags correctly when moving them onto a new line - Improved fixing of arrays with multiple values in Squiz ArrayDeclarationSniff - Improved detection of function comments in Squiz FunctionCommentSpacingSniff - Improved fixing of lines after cases statements in Squiz SwitchDeclarationSniff - Fixed bug #311 : Suppression of function prototype breaks checking of lines within function - Fixed bug #320 : Code sniffer identation issue - Fixed bug #333 : Nested ternary operators causing problems 2.0.0RC4 2.0.0RC4 beta beta 2014-11-07 BSD License - JS tokenizer now detects xor statements correctly - Improved detection of properties and objects in the JS tokenizer - Generic ScopeIndentSniff can now fix indents using tabs instead of spaces -- Set the tabIndent property to TRUE in your ruleset.xml file to enable this -- It is important to also set a tab-width setting, either in the ruleset or on the command line, for accuracy - Generic ScopeIndentSniff now checks and auto-fixes JS files - Generic DisallowSpaceIndentSniff is now able to replace space indents with tab indents during fixing - Support for phpcs-only and phpcbf-only attributes has been added to all ruleset.xml elements -- Allows parts of the ruleset to only apply when using a specific tool -- Useful for doing things like excluding indent fixes but still reporting indent errors - Unit tests can now set command line arguments during a test run -- Override getCliValues() and pass an array of CLI arguments for each file being tested - File-wide sniff properties can now be set using T_INLINE_HTML content during unit test runs -- Sniffs that start checking at the open tag can only, normally, have properties set using a ruleset - Generic ConstructorNameSniff no longer errors for PHP4 style constructors when __construct() is present -- Thanks to Thibaud Fabre for the patch - Generic DocCommentSniff now checks that the end comment tag is on a new line - Generic MultipleStatementAlignmentSniff no longer skips assignments for closures - Squiz DocCommentAlignment sniff now has better checking for single line doc block - Running unit tests with the -v CLI argument no longer generates PHP errors - Fixed bug #295 : ScopeIndentSniff hangs when processing nested closures - Fixed bug #298 : False positive in ScopeIndentSniff when anonymous functions are used with method chaining - Fixed bug #302 : Fixing code in Squiz InlineComment sniff can remove some comment text - Fixed bug #303 : Open and close tag on same line can cause a PHP notice checking scope indent - Fixed bug #306 : File containing only a namespace declaration raises undefined index notice - Fixed bug #307 : Conditional breaks in case statements get incorrect indentions - Fixed bug #308 : Squiz InlineIfDeclarationSniff fails on ternary operators inside closure - Fixed bug #310 : Variadics not recognized by tokenizer 2.0.0RC3 2.0.0RC3 beta beta 2014-10-16 BSD License - Improved default output for PHPCBF and removed the options to print verbose and progress output - If a .fixed file is supplied for a unit test file, the auto fixes will be checked against it during testing -- See Generic ScopeIndentUnitTest.inc and ScopeIndentUnitTest.inc.fixed for an example - Fixer token replacement methods now return TRUE if the change was accepted and FALSE if rejected - The --config-show command now pretty-prints the config values -- Thanks to Ken Guest for the patch - Setting and removing config values now catches exceptions if the config file is not writable -- Thanks to Ken Guest for the patch - Setting and removing config values now prints a message to confirm the action and show old values - Generic ScopeIndentSniff has been completely rewritten to improve fixing and embedded PHP detection - Generic DisallowTabIndent and DisallowSpaceIndent sniffs now detect indents at the start of block comments - Generic DisallowTabIndent and DisallowSpaceIndent sniffs now detect indents inside multi-line strings - Generic DisallowTabIndentSniff now replaces tabs inside doc block comments - Squiz ControlStructureSpacingSniff error codes have been corrected; they were reversed - Squiz EmbeddedPhpSniff now checks open and close tag indents and fixes some errors - Squiz FileCommentSniff no longer throws incorrect blank line before comment errors in JS files - Squiz ClassDeclarationSniff now has better checking for blank lines after a closing brace - Removed error Squiz.Classes.ClassDeclaration.NoNewlineAfterCloseBrace (request #285) -- Already handled by Squiz.Classes.ClassDeclaration.CloseBraceSameLine - Fixed bug #280 : The --config-show option generates error when there is no config file 2.0.0RC2 2.0.0RC2 beta beta 2014-09-26 BSD License - Minified JS and CSS files are now detected and skipped (fixes bug #252 and bug #19899) -- A warning will be added to the file so it can be found in the report and ignored in the future - Fixed incorrect length of JS object operator tokens - PHP tokenizer no longer converts class/function names to special tokens types -- Class/function names such as parent and true would become special tokens such as T_PARENT and T_TRUE - PHPCS can now exit with 0 if only warnings were found (request #262) -- Set the ignore_warnings_on_exit config variable to 1 to set this behaviour -- Default remains at exiting with 0 only if no errors and no warnings were found -- Also changes return value of PHP_CodeSniffer_Reporting::printReport() - Rulesets can now set associative array properties -- property name="[property]" type="array" value="foo=>bar,baz=>qux" - Generic ForbiddenFunctionsSniff now has a public property called forbiddenFunctions (request #263) -- Override the property in a ruleset.xml file to define forbidden functions and their replacements -- A replacement of NULL indicates that no replacement is available -- e.g., value="delete=>unset,print=>echo,create_function=>null" -- Custom sniffs overriding this one will need to change the visibility of their member var - Improved closure support in Generic ScopeIndentSniff - Improved indented PHP tag support in Generic ScopeIndentSniff - Improved fixing of mixed line indents in Generic ScopeIndentSniff - Added conflict detection to the file fixer -- If 2 sniffs look to be conflicting, one change will be ignored to allow a fix to occur - Generic CamelCapsFunctionNameSniff now ignores a single leading underscore -- Thanks to Alex Slobodiskiy for the patch - Standards can now be located within hidden directories (further fix for bug #20323) -- Thanks to Klaus Purer for the patch - Sniff ignore patterns now replace Win dir separators like file ignore patterns already did - Exclude patterns now use backtick delimiters, allowing all special characters to work correctly again -- Thanks to Jeremy Edgell for the patch - Errors converted to warnings in a ruleset (and vice versa) now retain their fixable status -- Thanks to Alexander Obuhovich for the patch - Squiz ConcatenationSpacingSniff now has a setting to specify how many spaces there should around concat operators -- Default remains at 0 -- Override the "spacing" setting in a ruleset.xml file to change - Added auto-fixes for Squiz InlineCommentSniff - Generic DocCommentSniff now correctly fixes additional blank lines at the end of a comment - Squiz OperatorBracketSniff now correctly fixes operations that include arrays - Zend ClosingTagSniff fix now correctly leaves closing tags when followed by HTML - Added Generic SyntaxSniff to check for syntax errors in PHP files -- Thanks to Blaine Schmeisser for the contribution - Added Generic OneTraitPerFileSniff to check that only one trait is defined in each file -- Thanks to Alexander Obuhovich for the contribution - Squiz DiscouragedFunctionsSniff now warns about var_dump() - PEAR ValidFunctionNameSniff no longer throws an error for _() - Squiz and PEAR FunctionCommentSniffs now support _() - Generic DisallowTabIndentSniff now checks for, and fixes, mixed indents again - Generic UpperCaseConstantSniff and LowerCaseConstantSniff now ignore function names - Fixed bug #243 : Missing DocBlock not detected - Fixed bug #248 : FunctionCommentSniff expects ampersand on param name - Fixed bug #265 : False positives with type hints in ForbiddenFunctionsSniff - Fixed bug #20373 : Inline comment sniff tab handling way - Fixed bug #20377 : Error when trying to execute phpcs with report=json - 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" -- Thanks to Brad Kent for the patch - Fixed bug #20402 : SVN pre-commit hook fails due to unknown argument error 2.0.0RC1 2.0.0RC1 beta beta 2014-08-06 BSD License - PHPCBF will now fix incorrect newline characters in a file - PHPCBF now exists cleanly when there are no errors to fix - Added phpcbf.bat file for Windows - Verbose option no longer errors when using a phar file with a space in the path - Fixed a reporting error when using HHVM -- Thanks to Martins Sipenko for the patch - addFixableError() and addFixableWarning() now only return true if the fixer is enabled -- Saves checking ($phpcsFile->fixer->enabled === true) before every fix - Added addErrorOnLine() and addWarningOnLine() to add a non-fixable violation to a line at column 1 -- Useful if you are generating errors using an external tool or parser and only know line numbers -- Thanks to Ondřej Mirtes for the patch - CSS tokenizer now identifies embedded PHP code using the new T_EMBEDDED_PHP token type -- The entire string of PHP is contained in a single token - PHP tokenizer contains better detection of short array syntax - Unit test runner now also test any standards installed under the installed_paths config var - Exclude patterns now use {} delimiters, allowing the | special character to work correctly again - The filtering component of the --extensions argument is now ignored again when passing filenames -- Can still be used to specify a custom tokenizer for each extension when passing filenames -- If no tokenizer is specified, default values will be used for common file extensions - Diff report now produces relative paths on Windows, where possible (further fix for bug #20234) - If a token's content has been modified by the tab-width setting, it will now have an orig_content in the tokens array - Generic DisallowSpaceIndent and DisallowTabIndent sniffs now check original indent content even when tab-width is set -- Previously, setting --tab-width would force both to check the indent as spaces - Fixed a problem where PHPCBF could replace tabs with too many spaces when changing indents - Fixed a problem that could occur with line numbers when using HHVM to check files with Windows newline characters - Removed use of sys_get_temp_dir() as this is not supported by the min PHP version - Squiz ArrayDeclarationSniff now supports short array syntax - Squiz ControlSignatureSniff no longer uses the Abstract Pattern sniff -- If you are extending this sniff, you'll need to rewrite your code -- The rewrite allows this sniff to fix all control structure formatting issues it finds - The installed_paths config var now accepts relative paths -- The paths are relative to the PHP_CodeSniffer install directory -- Thanks to Weston Ruter for the patch - Generic ScopeIndentSniff now accounts for different open tag indents - PEAR FunctionDeclarationSniff now ignores short arrays when checking indent -- Thanks to Daniel Tschinder for the patch - PSR2 FunctionCallSignatureSniff now treats multi-line strings as a single-line argument, like arrays and closures -- Thanks to Dawid Nowak for the patch - PSR2 UseDeclarationSniff now checks for a single space after the USE keyword - Generic ForbiddenFunctionsSniff now detects calls to functions in the global namespace -- Thanks to Ole Martin Handeland for the patch - Generic LowerCaseConstantSniff and UpperCaseConstantSniff now ignore namespaces beginning with TRUE/FALSE/NULL -- Thanks to Renan Gonçalves for the patch - Squiz InlineCommentSniff no longer requires a blank line after post-statement comments (request #20299) - Squiz SelfMemberReferenceSniff now works correctly with namespaces - Squiz FunctionCommentSniff is now more relaxed when checking namespaced type hints - Tab characters are now encoded in abstract pattern errors messages -- Thanks to Blaine Schmeisser for the patch - Invalid sniff codes passed to --sniffs now show a friendly error message (request #20313) - Generic LineLengthSniff now shows a warning if the iconv module is disabled (request #20314) - Source report no longer shows errors if category or sniff names ends in an uppercase error -- Thanks to Jonathan Marcil for the patch - Fixed bug #20261 : phpcbf has an endless fixing loop - Fixed bug #20268 : Incorrect documentation titles in PEAR documentation - Fixed bug #20296 : new array notion in function comma check fails - Fixed bug #20297 : phar does not work when renamed it to phpcs - Fixed bug #20307 : PHP_CodeSniffer_Standards_AbstractVariableSniff analyze traits - Fixed bug #20308 : Squiz.ValidVariableNameSniff - wrong variable usage - Fixed bug #20309 : Use "member variable" term in sniff "processMemberVar" method - Fixed bug #20310 : PSR2 does not check for space after function name - Fixed bug #20322 : Display rules set to type=error even when suppressing warnings - Fixed bug #20323 : PHPCS tries to load sniffs from hidden directories - Fixed bug #20346 : Fixer endless loop with Squiz.CSS sniffs - Fixed bug #20355 : No sniffs are registered with PHAR on Windows 2.0.0a2 2.0.0a2 alpha alpha 2014-05-01 BSD License - Added report type --report=info to show information about the checked code to make building a standard easier -- Checks a number of things, such as what line length you use, and spacing are brackets, but not everything -- Still highly experimental - Generic LineLengthSniff now shows warnings for long lines referring to licence and VCS information -- It previously ignored these lines, but at the expense of performance - Generic DisallowTabIndent and DisallowSpaceIndent sniffs no longer error when detecting mixed indent types -- Only the first type of indent found on a line (space or indent) is considered - Lots of little performance improvements that can add up to a substantial saving over large code bases -- Added a "length" array index to tokens so you don't need to call strlen() of them, or deal with encoding -- Can now use isset() to find tokens inside the PHP_CodeSniffer_Tokens static vars instead of in_array() - Custom reports can now specify a $recordErrors member var; this previously only worked for built-in reports -- When set to FALSE, error messages will not be recorded and only totals will be returned -- This can save significant memory while processing a large code base - Removed dependence on PHP_Timer - PHP tokenizer now supports DEFAULT statements opened with a T_SEMICOLON - The Squiz and PHPCS standards have increased the max padding for statement alignment from 8 to 12 - Squiz EchoedStringsSniff now supports statments without a semicolon, such as PHP embedded in HTML - Squiz DoubleQuoteUsageSniff now properly replaces escaped double quotes when fixing a doubled quoted string - Improved detection of nested IF statements that use the alternate IF/ENDIF syntax - PSR1 CamelCapsMethodNameSniff now ignores magic methods -- Thanks to Eser Ozvataf for the patch - PSR1 SideEffectsSniff now ignores methods named define() - PSR1 and PEAR ClassDeclarationSniffs now support traits (request #20208) - PSR2 ControlStructureSpacingSniff now allows newlines before/after parentheses -- Thanks to Maurus Cuelenaere for the patch - PSR2 ControlStructureSpacingSniff now checks TRY and CATCH statements - Squiz SuperfluousWhitespaceSniff now detects whitespace at the end of block comment lines -- Thanks to Klaus Purer for the patch - Squiz LowercasePHPFunctionsSniff no longer reports errors for namespaced functions -- Thanks to Max Galbusera for the patch - Squiz SwitchDeclarationSniff now allows exit() as a breaking statement for case/default - Squiz ValidVariableNameSniff and Zend ValidVariableNameSniff now ignore additional PHP reserved vars -- Thanks to Mikuláš Dítě and Adrian Crepaz for the patch - Sniff code Squiz.WhiteSpace.MemberVarSpacing.After changed to Squiz.WhiteSpace.MemberVarSpacing.Incorrect (request #20241) - Fixed bug #20200 : Invalid JSON produced with specific error message - Fixed bug #20204 : Ruleset exclude checks are case sensitive - Fixed bug #20213 : Invalid error, Inline IF must be declared on single line - Fixed bug #20225 : array_merge() that takes more than one line generates error - Fixed bug #20230 : Squiz ControlStructureSpacing sniff assumes specific condition formatting - Fixed bug #20234 : phpcbf patch command absolute paths - Fixed bug #20240 : Squiz block comment sniff fails when newline present - Fixed bug #20247 : The Squiz.WhiteSpace.ControlStructureSpacing sniff and do-while -- Thanks to Alexander Obuhovich for the patch - Fixed bug #20248 : The Squiz_Sniffs_WhiteSpace_ControlStructureSpacingSniff sniff and empty scope - Fixed bug #20252 : Unitialized string offset when package name starts with underscore 2.0.0a1 2.0.0a1 alpha alpha 2014-02-05 BSD License - Added the phpcbf script to automatically fix many errors found by the phpcs script - Added report type --report=diff to show suggested changes to fix coding standard violations - The --report argument now allows for custom reports to be used -- Use the full path to your custom report class as the report name - The --extensions argument is now respected when passing filenames; not just with directories - The --extensions argument now allows you to specify the tokenizer for each extension -- e.g., --extensions=module/php,es/js - Command line arguments can now be set in ruleset files -- e.g., arg name="report" value="summary" (print summary report; same as --report=summary) -- e.g., arg value="sp" (print source and progress information; same as -sp) -- The -vvv, --sniffs, --standard and -l command line arguments cannot be set in this way - Sniff process() methods can not optionally return a token to ignore up to -- If returned, the sniff will not be executed again until the passed token is reached in the file -- Useful if you are looking for tokens like T_OPEN_TAG but only want to process the first one - Removed the comment parser classes and replaced it with a simple comment tokenier -- T_DOC_COMMENT tokens are now tokenized into T_DOC_COMMENT_* tokens so they can be used more easily -- This change requires a significant rewrite of sniffs that use the comment parser -- This change requires minor changes to sniffs that listen for T_DOC_COMMENT tokens directly - Added Generic DocCommentSniff to check generic doc block formatting -- Removed doc block formatting checks from PEAR ClassCommentSniff -- Removed doc block formatting checks from PEAR FileCommentSniff -- Removed doc block formatting checks from PEAR FunctionCommentSniff -- Removed doc block formatting checks from Squiz ClassCommentSniff -- Removed doc block formatting checks from Squiz FileCommentSniff -- Removed doc block formatting checks from Squiz FunctionCommentSniff -- Removed doc block formatting checks from Squiz VariableCommentSniff - Squiz DocCommentAlignmentSniff has had its error codes changed -- NoSpaceBeforeTag becomes NoSpaceAfterStar -- SpaceBeforeTag becomes SpaceAfterStar -- SpaceBeforeAsterisk becomes SpaceBeforeStar - Generic MultipleStatementAlignment now aligns assignments within a block so they fit within their max padding setting -- The sniff previously requested the padding as 1 space if max padding was exceeded -- It now aligns the assignment with surrounding assignments if it can -- Removed property ignoreMultiline as multi-line assignments are now handled correctly and should not be ignored - Squiz FunctionClosingBraceSpaceSniff now requires a blank line before the brace in all cases except function args - Added error Squiz.Commenting.ClassComment.SpacingAfter to ensure there are no blank lines after a class comment - Added error Squiz.WhiteSpace.MemberVarSpacing.AfterComment to ensure there are no blank lines after a member var comment -- Fixes have also been corrected to not strip the member var comment or indent under some circumstances -- Thanks to Mark Scherer for help with this fix - Added error Squiz.Commenting.FunctionCommentThrowTag.Missing to ensure a throw is documented - Removed error Squiz.Commenting.FunctionCommentThrowTag.WrongType - Content passed via STDIN can now specify the filename to use so that sniffs can run the correct filename checks -- Ensure the first line of the content is: phpcs_input_file: /path/to/file - Squiz coding standard now enforces no closing PHP tag at the end of a pure PHP file - Squiz coding standard now enforces a single newline character at the end of the file - Squiz ClassDeclarationSniff no longer checks for a PHP ending tag after a class definition - Squiz ControlStructureSpacingSniff now checks TRY and CATCH statements as well - Removed MySource ChannelExceptionSniff 1.5.6 1.5.6 stable stable 2014-12-05 BSD License - JS tokenizer now detects xor statements correctly - The --config-show command now pretty-prints the config values -- Thanks to Ken Guest for the patch - Setting and removing config values now catches exceptions if the config file is not writable -- Thanks to Ken Guest for the patch - Setting and removing config values now prints a message to confirm the action and show old values - You can now get PHP_CodeSniffer to ignore a single line by putting @codingStandardsIgnoreLine in a comment -- When the comment is found, the comment line and the following line will be ignored -- Thanks to Andy Bulford for the contribution - Generic ConstructorNameSniff no longer errors for PHP4 style constructors when __construct() is present -- Thanks to Thibaud Fabre for the patch - Fixed bug #280 : The --config-show option generates error when there is no config file - Fixed bug #306 : File containing only a namespace declaration raises undefined index notice - Fixed bug #308 : Squiz InlineIfDeclarationSniff fails on ternary operators inside closure - Fixed bug #310 : Variadics not recognized by tokenizer - Fixed bug #311 : Suppression of function prototype breaks checking of lines within function 1.5.5 1.5.5 stable stable 2014-09-25 BSD License - PHP tokenizer no longer converts class/function names to special tokens types -- Class/function names such as parent and true would become special tokens such as T_PARENT and T_TRUE - Improved closure support in Generic ScopeIndentSniff - Improved indented PHP tag support in Generic ScopeIndentSniff - Generic CamelCapsFunctionNameSniff now ignores a single leading underscore -- Thanks to Alex Slobodiskiy for the patch - Standards can now be located within hidden directories (further fix for bug #20323) -- Thanks to Klaus Purer for the patch - Added Generic SyntaxSniff to check for syntax errors in PHP files -- Thanks to Blaine Schmeisser for the contribution - Squiz DiscouragedFunctionsSniff now warns about var_dump() - PEAR ValidFunctionNameSniff no longer throws an error for _() - Squiz and PEAR FunctionCommentSnif now support _() - Generic UpperCaseConstantSniff and LowerCaseConstantSniff now ignore function names - Fixed bug #248 : FunctionCommentSniff expects ampersand on param name - Fixed bug #265 : False positives with type hints in ForbiddenFunctionsSniff - 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" -- Thanks to Brad Kent for the patch - Fixed bug #20386 : Squiz.Commenting.ClassComment.SpacingBefore thrown if first block comment 1.5.4 1.5.4 stable stable 2014-08-06 BSD License - Removed use of sys_get_temp_dir() as this is not supported by the min PHP version - The installed_paths config var now accepts relative paths -- The paths are relative to the PHP_CodeSniffer install directory -- Thanks to Weston Ruter for the patch - Generic ScopeIndentSniff now accounts for different open tag indents - PEAR FunctionDeclarationSniff now ignores short arrays when checking indent -- Thanks to Daniel Tschinder for the patch - PSR2 FunctionCallSignatureSniff now treats multi-line strings as a single-line argument, like arrays and closures -- Thanks to Dawid Nowak for the patch - Generic ForbiddenFunctionsSniff now detects calls to functions in the global namespace -- Thanks to Ole Martin Handeland for the patch - Generic LowerCaseConstantSniff and UpperCaseConstantSniff now ignore namespaces beginning with TRUE/FALSE/NULL -- Thanks to Renan Gonçalves for the patch - Squiz InlineCommentSniff no longer requires a blank line after post-statement comments (request #20299) - Squiz SelfMemberReferenceSniff now works correctly with namespaces - Tab characters are now encoded in abstract pattern errors messages -- Thanks to Blaine Schmeisser for the patch - Invalid sniff codes passed to --sniffs now show a friendly error message (request #20313) - Generic LineLengthSniff now shows a warning if the iconv module is disabled (request #20314) - Source report no longer shows errors if category or sniff names ends in an uppercase error -- Thanks to Jonathan Marcil for the patch - Fixed bug #20268 : Incorrect documentation titles in PEAR documentation - Fixed bug #20296 : new array notion in function comma check fails - Fixed bug #20307 : PHP_CodeSniffer_Standards_AbstractVariableSniff analyze traits - Fixed bug #20308 : Squiz.ValidVariableNameSniff - wrong variable usage - Fixed bug #20309 : Use "member variable" term in sniff "processMemberVar" method - Fixed bug #20310 : PSR2 does not check for space after function name - Fixed bug #20322 : Display rules set to type=error even when suppressing warnings - Fixed bug #20323 : PHPCS tries to load sniffs from hidden directories 1.5.3 1.5.3 stable stable 2014-05-01 BSD License - Improved detection of nested IF statements that use the alternate IF/ENDIF syntax - PHP tokenizer now supports DEFAULT statements opened with a T_SEMICOLON - PSR1 CamelCapsMethodNameSniff now ignores magic methods -- Thanks to Eser Ozvataf for the patch - PSR1 SideEffectsSniff now ignores methods named define() - PSR1 and PEAR ClassDeclarationSniffs now support traits (request #20208) - PSR2 ControlStructureSpacingSniff now allows newlines before/after parentheses -- Thanks to Maurus Cuelenaere for the patch - Squiz LowercasePHPFunctionsSniff no longer reports errors for namespaced functions -- Thanks to Max Galbusera for the patch - Squiz SwitchDeclarationSniff now allows exit() as a breaking statement for case/default - Squiz ValidVariableNameSniff and Zend ValidVariableNameSniff now ignore additional PHP reserved vars -- Thanks to Mikuláš Dítě and Adrian Crepaz for the patch - Sniff code Squiz.WhiteSpace.MemberVarSpacing.After changed to Squiz.WhiteSpace.MemberVarSpacing.Incorrect (request #20241) - Fixed bug #20200 : Invalid JSON produced with specific error message - Fixed bug #20204 : Ruleset exclude checks are case sensitive - Fixed bug #20213 : Invalid error, Inline IF must be declared on single line - Fixed bug #20225 : array_merge() that takes more than one line generates error - Fixed bug #20230 : Squiz ControlStructureSpacing sniff assumes specific condition formatting - Fixed bug #20240 : Squiz block comment sniff fails when newline present - Fixed bug #20247 : The Squiz.WhiteSpace.ControlStructureSpacing sniff and do-while -- Thanks to Alexander Obuhovich for the patch - Fixed bug #20248 : The Squiz_Sniffs_WhiteSpace_ControlStructureSpacingSniff sniff and empty scope - Fixed bug #20252 : Unitialized string offset when package name starts with underscore 1.5.2 1.5.2 stable stable 2014-02-05 BSD License - Improved support for the PHP 5.5. classname::class syntax -- PSR2 SwitchDeclarationSniff no longer throws errors when this syntax is used in CASE conditions - Improved support for negative checks of instanceOf in Squiz ComparisonOperatorUsageSniff -- Thanks to Martin Winkel for the patch - Generic FunctionCallArgumentSpacingSniff now longer complains about space before comma when using here/nowdocs -- Thanks to Richard van Velzen for the patch - Generic LowerCaseConstantSniff and UpperCaseConstantSniff now ignore class constants -- Thanks to Kristopher Wilson for the patch - PEAR FunctionCallSignatureSniff now has settings to specify how many spaces should appear before/after parentheses -- Override the 'requiredSpacesAfterOpen' and 'requiredSpacesBeforeClose' settings in a ruleset.xml file to change -- Default remains at 0 for both -- Thanks to Astinus Eberhard for the patch - PSR2 ControlStructureSpacingSniff now has settings to specify how many spaces should appear before/after parentheses -- Override the 'requiredSpacesAfterOpen' and 'requiredSpacesBeforeClose' settings in a ruleset.xml file to change -- Default remains at 0 for both -- Thanks to Astinus Eberhard for the patch - Squiz ForEachLoopDeclarationSniff now has settings to specify how many spaces should appear before/after parentheses -- Override the 'requiredSpacesAfterOpen' and 'requiredSpacesBeforeClose' settings in a ruleset.xml file to change -- Default remains at 0 for both -- Thanks to Astinus Eberhard for the patch - Squiz ForLoopDeclarationSniff now has settings to specify how many spaces should appear before/after parentheses -- Override the 'requiredSpacesAfterOpen' and 'requiredSpacesBeforeClose' settings in a ruleset.xml file to change -- Default remains at 0 for both -- Thanks to Astinus Eberhard for the patch - Squiz FunctionDeclarationArgumentSpacingSniff now has settings to specify how many spaces should appear before/after parentheses -- Override the 'requiredSpacesAfterOpen' and 'requiredSpacesBeforeClose' settings in a ruleset.xml file to change -- Default remains at 0 for both -- Thanks to Astinus Eberhard for the patch - Removed UnusedFunctionParameter, CyclomaticComplexity and NestingLevel from the Squiz standard - Generic FixmeSniff and TodoSniff now work correctly with accented characters - Fixed bug #20145 : Custom ruleset preferences directory over installed standard - Fixed bug #20147 : phpcs-svn-pre-commit - no more default error report - Fixed bug #20151 : Problem handling "if(): ... else: ... endif;" syntax - Fixed bug #20190 : Invalid regex in Squiz_Sniffs_WhiteSpace_SuperfluousWhitespaceSniff 1.5.1 1.5.1 stable stable 2013-12-12 BSD License - Config values can now be set at runtime using the command line argument [--runtime-set key value] -- Runtime values are the same as config values, but are not written to the main config file -- Thanks to Wim Godden for the patch - Config values can now be set in ruleset files -- e.g., config name="zend_ca_path" value="/path/to/ZendCodeAnalyzer" -- Can not be used to set config values that override command line values, such as show_warnings -- Thanks to Jonathan Marcil for helping with the patch - Added a new installed_paths config value to allow for the setting of directories that contain standards -- By default, standards have to be installed into the CodeSniffer/Standards directory to be considered installed -- New config value allows a list of paths to be set in addition to this internal path -- Installed standards appear when using the -i arg, and can be referenced in rulesets using only their name -- Set paths by running: phpcs --config-set installed_paths /path/one,/path/two,... - PSR2 ClassDeclarationSniff now allows a list of extended interfaces to be split across multiple lines - Squiz DoubleQuoteUsageSniff now allows \b in double quoted strings - Generic ForbiddenFunctionsSniff now ignores object creation -- This is a further fix for bug #20100 : incorrect Function mysql() has been deprecated report - Fixed bug #20136 : Squiz_Sniffs_WhiteSpace_ScopeKeywordSpacingSniff and Traits - Fixed bug #20138 : Protected property underscore and camel caps issue (in trait with Zend) -- Thanks to Gaetan Rousseau for the patch - Fixed bug #20139 : No report file generated on success 1.5.0 1.5.0 stable stable 2013-11-28 BSD License - Doc generation is now working again for installed standards -- Includes a fix for limiting the docs to specific sniffs - Generic ScopeIndentSniff now allows for ignored tokens to be set via ruleset.xml files -- E.g., to ignore comments, override a property using: -- name="ignoreIndentationTokens" type="array" value="T_COMMENT,T_DOC_COMMENT" - PSR2 standard now ignores comments when checking indentation rules - Generic UpperCaseConstantNameSniff no longer reports errors where constants are used (request #20090) -- It still reports errors where constants are defined - Individual messages can now be excluded in ruleset.xml files using the exclude tag (request #20091) -- Setting message severity to 0 continues to be supported - Squiz OperatorSpacingSniff no longer throws errors for the ?: short ternary operator -- Thanks to Antoine Musso for the patch - Comment parser now supports non-English characters when splitting comment lines into words -- Thanks to Nik Sun for the patch - Exit statements are now recognised as valid closers for CASE and DEFAULT blocks -- Thanks to Maksim Kochkin for the patch - PHP_CodeSniffer_CLI::process() can now be passed an incomplete array of CLI values -- Missing values will be set to the CLI defaults -- Thanks to Maksim Kochkin for the patch - Fixed bug #20093 : Bug with ternary operator token - Fixed bug #20097 : CLI.php throws error in php 5.2 - Fixed bug #20100 : incorrect Function mysql() has been deprecated report - Fixed bug #20119 : PHP warning: invalid argument to str_repeat() in SVN blame report with -s - Fixed bug #20123 : PSR2 complains about an empty second statement in for-loop - Fixed bug #20131 : PHP errors in svnblame report, if there are files not under version control - Fixed bug #20133 : Allow "HG: hg_id" as value for @version tag 1.5.0RC4 1.5.0RC4 beta beta 2013-09-26 BSD License - You can now restrict violations to individual sniff codes using the --sniffs command line argument -- Previously, this only restricted violations to an entire sniff and not individual messages -- If you have scripts calling PHP_CodeSniffer::process() or creating PHP_CodeSniffer_File objects, you must update your code -- The array of restrictions passed to PHP_CodeSniffer::process() must now be an array of sniff codes instead of class names -- The PHP_CodeSniffer_File::__construct() method now requires an array of restrictions to be passed - Doc generation is now working again - Progress information now shows the percentage complete at the end of each line - Added report type --report=junit to show the error list in a JUnit compatible format -- Thanks to Oleg Lobach for the contribution - Added support for the PHP 5.4 callable type hint - Fixed problem where some file content could be ignored when checking STDIN - Version information is now printed when installed via composer or run from a Git clone (request #20050) - Added Squiz DisallowBooleanStatementSniff to ban boolean operators outside of control structure conditions - The CSS tokenizer is now more reliable when encountering 'list' and 'break' strings - Coding standard ignore comments can now appear instead doc blocks as well as inline comments -- Thanks to Stuart Langley for the patch - Generic LineLengthSniff now ignores SVN URL and Head URL comments -- Thanks to Karl DeBisschop for the patch - PEAR MultiLineConditionSniff now has a setting to specify how many spaces code should be indented -- Default remains at 4; override the 'indent' setting in a ruleset.xml file to change -- Thanks to Szabolcs Sulik for the patch - PEAR MultiLineAssignmentSniff now has a setting to specify how many spaces code should be indented -- Default remains at 4; override the 'indent' setting in a ruleset.xml file to change -- Thanks to Szabolcs Sulik for the patch - PEAR FunctionDeclarationSniff now has a setting to specify how many spaces code should be indented -- Default remains at 4; override the 'indent' setting in a ruleset.xml file to change -- Thanks to Szabolcs Sulik for the patch - Squiz SwitchDeclarationSniff now has a setting to specify how many spaces code should be indented -- Default remains at 4; override the 'indent' setting in a ruleset.xml file to change -- Thanks to Szabolcs Sulik for the patch - Squiz CSS IndentationSniff now has a setting to specify how many spaces code should be indented -- Default remains at 4; override the 'indent' setting in a ruleset.xml file to change -- Thanks to Hugo Fonseca for the patch - Squiz and MySource File and Function comment sniffs now allow all tags and don't require a particular licence - Squiz standard now allows lines to be 120 characters long before warning; up from 85 - Squiz LowercaseStyleDefinitionSniff no longer throws errors for class names in nested style definitions - Squiz ClassFileNameSniff no longer throws errors when checking STDIN - Squiz CSS sniffs no longer generate errors for IE filters - Squiz CSS IndentationSniff no longer sees comments as blank lines - Squiz LogicalOperatorSpacingSniff now ignores whitespace at the end of a line - Squiz.Scope.MethodScope.Missing error message now mentions 'visibility' instead of 'scope modifier' -- Thanks to Renat Akhmedyanov for the patch - Added support for the PSR2 multi-line arguments errata - The PSR2 standard no longer throws errors for additional spacing after a type hint - PSR UseDeclarationSniff no longer throws errors for USE statements inside TRAITs - Fixed cases where code was incorrectly assigned the T_GOTO_LABEL token when used in a complex CASE condition - Fixed bug #20026 : Check for multi-line arrays that should be single-line is slightly wrong -- Adds new error message for single-line arrays that end with a comma - Fixed bug #20029 : ForbiddenFunction sniff incorrectly recognizes methods in USE clauses - Fixed bug #20043 : Mis-interpretation of Foo::class - Fixed bug #20044 : PSR1 camelCase check does not ignore leading underscores - Fixed bug #20045 : Errors about indentation for closures with multi-line 'use' in functions - Fixed bug #20051 : Undefined index: scope_opener / scope_closer -- Thanks to Anthon Pang for the patch 1.5.0RC3 1.5.0RC3 beta beta 2013-07-25 BSD License - Added report type --report=json to show the error list and total counts for all checked files -- Thanks to Jeffrey Fisher for the contribution - PHP_CodeSniffer::isCamelCaps now allows for acronyms at the start of a string if the strict flag is FALSE -- acronyms are defined as at least 2 uppercase characters in a row -- e.g., the following is now valid camel caps with strict set to FALSE: XMLParser - The PHP tokenizer now tokenizes goto labels as T_GOTO_LABEL instead of T_STRING followed by T_COLON - The JS tokenizer now has support for the T_THROW token - Symlinked directories inside CodeSniffer/Standards and in ruleset.xml files are now supported -- Only available since PHP 5.2.11 and 5.3.1 -- Thanks to Maik Penz for the patch - The JS tokenizer now correctly identifies T_INLINE_ELSE tokens instead of leaving them as T_COLON -- Thanks to Arnout Boks for the patch - Explaining a standard (phpcs -e) that uses namespaces now works correctly - Restricting a check to specific sniffs (phpcs --sniffs=...) now works correctly with namespaced sniffs -- Thanks to Maik Penz for the patch - Docs added for the entire Generic standard, and many sniffs from other standards are now documented as well -- Thanks to Spencer Rinehart for the contribution - Clearer error message for when the sniff class name does not match the directory structure - Generated HTML docs now correctly show the open PHP tag in code comparison blocks - Added Generic InlineHTMLSniff to ensure a file only contains PHP code - Added Squiz ShorthandSizeSniff to check that CSS sizes are using shorthand notation only when 1 or 2 values are used - Added Squiz ForbiddenStylesSniff to ban the use of some deprecated browser-specific styles - Added Squiz NamedColoursSniff to ban the use of colour names - PSR2 standard no longer enforces no whitespace between the closing parenthesis of a function call and the semicolon - PSR2 ClassDeclarationSniff now ignores empty classes when checking the end brace position - PSR2 SwitchDeclarationSniff no longer reports errors for empty lines between CASE statements - PEAR ObjectOperatorIndentSniff now has a setting to specify how many spaces code should be indented -- Default remains at 4; override the indent setting in a ruleset.xml file to change -- Thanks to Andrey Mindubaev for the patch - Squiz FileExtensionSniff now supports traits -- Thanks to Lucas Green for the patch - Squiz ArrayDeclarationSniff no longer reports errors for no comma at the end of a line that contains a function call - Squiz SwitchDeclarationSniff now supports T_CONTINUE and T_THROW as valid case/default breaking statements - Squiz CommentedOutCodeSniff is now better at ignoring commented out HTML, XML and regular expressions - Squiz DisallowComparisonAssignmentSniff no longer throws errors for the third expression in a FOR statement - Squiz ColourDefinitionSniff no longer throws errors for some CSS class names - Squiz ControlStructureSpacingSniff now supports all types of CASE/DEFAULT breaking statements - Generic CallTimePassByReferenceSniff now reports errors for functions called using a variable -- Thanks to Maik Penz for the patch - Generic ConstructorNameSniff no longer throws a notice for abstract constructors inside abstract classes -- Thanks to Spencer Rinehart for the patch - Squiz ComparisonOperatorUsageSniff now checks inside elseif statements -- Thanks to Arnout Boks for the patch - Squiz OperatorSpacingSniff now reports errors for no spacing around inline then and else tokens -- Thanks to Arnout Boks for the patch - Fixed bug #19811 : Comments not ignored in all cases in AbstractPatternSniff -- Thanks to Erik Wiffin for the patch - Fixed bug #19892 : ELSE with no braces causes incorrect SWITCH break statement indentation error - Fixed bug #19897 : Indenting warnings in templates not consistent - Fixed bug #19908 : PEAR MultiLineCondition Does Not Apply elseif - Fixed bug #19930 : option --report-file generate an empty file - Fixed bug #19935 : notify-send reports do not vanish in gnome-shell -- Thanks to Christian Weiske for the patch - Fixed bug #19944 : docblock squiz sniff "return void" trips over return in lambda function - Fixed bug #19953 : PSR2 - Spaces before interface name for abstract class - Fixed bug #19956 : phpcs warns for Type Hint missing Resource - Fixed bug #19957 : Does not understand trait method aliasing - Fixed bug #19968 : Permission denied on excluded directory - Fixed bug #19969 : Sniffs with namespace not recognized in reports - Fixed bug #19997 : Class names incorrectly detected as constants 1.5.0RC2 1.5.0RC2 beta beta 2013-04-04 BSD License - Ruleset processing has been rewritten to be more predictable -- Provides much better support for relative paths inside ruleset files -- May mean that sniffs that were previously ignored are now being included when importing external rulesets -- Ruleset processing output can be seen by using the -vv command line argument -- Internal sniff registering functions have all changed, so please review custom scripts - You can now pass multiple coding standards on the command line, comma separated (request #19144) -- Works with built-in or custom standards and rulesets, or a mix of both - You can now exclude directories or whole standards in a ruleset XML file (request #19731) -- e.g., exclude "Generic.Commenting" or just "Generic" -- You can also pass in a path to a directory instead, if you know it - Added Generic LowerCaseKeywordSniff to ensure all PHP keywords are defined in lowercase -- The PSR2 and Squiz standards now use this sniff - Added Generic SAPIUsageSniff to ensure the PHP_SAPI constant is used instead of php_sapi_name() (request #19863) - Squiz FunctionSpacingSniff now has a setting to specify how many lines there should between functions (request #19843) -- Default remains at 2 -- Override the "spacing" setting in a ruleset.xml file to change - Squiz LowercasePHPFunctionSniff no longer throws errors for the limited set of PHP keywords it was checking -- Add a rule for Generic.PHP.LowerCaseKeyword to your ruleset to replicate this functionality - Added support for the PHP 5.4 T_CALLABLE token so it can be used in lower PHP versions - Generic EndFileNoNewlineSniff now supports checking of CSS and JS files - PSR2 SwitchDeclarationSniff now has a setting to specify how many spaces code should be indented -- Default remains at 4; override the indent setting in a ruleset.xml file to change -- Thanks to Asher Snyder for the patch - Generic ScopeIndentSniff now has a setting to specify a list of tokens that should be ignored -- The first token on the line is checked and the whole line is ignored if the token is in the array -- Thanks to Eloy Lafuente for the patch - Squiz LowercaseClassKeywordsSniff now checks for the TRAIT keyword -- Thanks to Anthon Pang for the patch - If you create your own PHP_CodeSniffer object, PHPCS will no longer exit when an unknown argument is found -- This allows you to create wrapper scripts for PHPCS more easily - PSR2 MethodDeclarationSniff no longer generates a notice for methods named "_" -- Thanks to Bart S for the patch - Squiz BlockCommentSniff no longer reports that a blank line between a scope closer and block comment is invalid - Generic DuplicateClassNameSniff no longer reports an invalid error if multiple PHP open tags exist in a file - Generic DuplicateClassNameSniff no longer reports duplicate errors if multiple PHP open tags exist in a file - Fixed bug #19819 : Freeze with syntax error in use statement - Fixed bug #19820 : Wrong message level in Generic_Sniffs_CodeAnalysis_EmptyStatementSniff - Fixed bug #19859 : CodeSniffer::setIgnorePatterns API changed - Fixed bug #19871 : findExtendedClassName doesn't return FQCN on namespaced classes - Fixed bug #19879 : bitwise and operator interpreted as reference by value 1.5.0RC1 1.5.0RC1 beta beta 2013-02-08 BSD License - Reports have been completely rewritten to consume far less memory -- Each report is incrementally written to the file system during a run and then printed out when the run ends -- There is no longer a need to keep the list of errors and warnings in memory during a run - Multi-file sniff support has been removed because they are too memory intensive -- If you have a custom multi-file sniff, you can convert it into a standard sniff quite easily -- See CodeSniffer/Standards/Generic/Sniffs/Classes/DuplicateClassNameSniff.php for an example 1.4.8 1.4.8 stable stable 2013-11-26 BSD License - Generic ScopeIndentSniff now allows for ignored tokens to be set via ruleset.xml files -- E.g., to ignore comments, override a property using: -- name="ignoreIndentationTokens" type="array" value="T_COMMENT,T_DOC_COMMENT" - PSR2 standard now ignores comments when checking indentation rules - Squiz OperatorSpacingSniff no longer throws errors for the ?: short ternary operator -- Thanks to Antoine Musso for the patch - Comment parser now supports non-English characters when splitting comment lines into words -- Thanks to Nik Sun for the patch - Exit statements are now recognised as valid closers for CASE and DEFAULT blocks -- Thanks to Maksim Kochkin for the patch - PHP_CodeSniffer_CLI::process() can now be passed an incomplete array of CLI values -- Missing values will be set to the CLI defaults -- Thanks to Maksim Kochkin for the patch - Fixed bug #20097 : CLI.php throws error in php 5.2 - Fixed bug #20100 : incorrect Function mysql() has been deprecated report - Fixed bug #20119 : PHP warning: invalid argument to str_repeat() in SVN blame report with -s - Fixed bug #20123 : PSR2 complains about an empty second statement in for-loop - Fixed bug #20131 : PHP errors in svnblame report, if there are files not under version control - Fixed bug #20133 : Allow "HG: hg_id" as value for @version tag 1.4.7 1.4.7 stable stable 2013-09-26 BSD License - Added report type --report=junit to show the error list in a JUnit compatible format -- Thanks to Oleg Lobach for the contribution - Added support for the PHP 5.4 callable type hint - Fixed problem where some file content could be ignored when checking STDIN - Version information is now printed when installed via composer or run from a Git clone (request #20050) - The CSS tokenizer is now more reliable when encountering 'list' and 'break' strings - Coding standard ignore comments can now appear instead doc blocks as well as inline comments -- Thanks to Stuart Langley for the patch - Generic LineLengthSniff now ignores SVN URL and Head URL comments -- Thanks to Karl DeBisschop for the patch - PEAR MultiLineConditionSniff now has a setting to specify how many spaces code should be indented -- Default remains at 4; override the 'indent' setting in a ruleset.xml file to change -- Thanks to Szabolcs Sulik for the patch - PEAR MultiLineAssignmentSniff now has a setting to specify how many spaces code should be indented -- Default remains at 4; override the 'indent' setting in a ruleset.xml file to change -- Thanks to Szabolcs Sulik for the patch - PEAR FunctionDeclarationSniff now has a setting to specify how many spaces code should be indented -- Default remains at 4; override the 'indent' setting in a ruleset.xml file to change -- Thanks to Szabolcs Sulik for the patch - Squiz SwitchDeclarationSniff now has a setting to specify how many spaces code should be indented -- Default remains at 4; override the 'indent' setting in a ruleset.xml file to change -- Thanks to Szabolcs Sulik for the patch - Squiz CSS IndentationSniff now has a setting to specify how many spaces code should be indented -- Default remains at 4; override the 'indent' setting in a ruleset.xml file to change -- Thanks to Hugo Fonseca for the patch - Squiz and MySource File and Function comment sniffs now allow all tags and don't require a particular licence - Squiz LowercaseStyleDefinitionSniff no longer throws errors for class names in nested style definitions - Squiz ClassFileNameSniff no longer throws errors when checking STDIN - Squiz CSS sniffs no longer generate errors for IE filters - Squiz CSS IndentationSniff no longer sees comments as blank lines - Squiz LogicalOperatorSpacingSniff now ignores whitespace at the end of a line - Squiz.Scope.MethodScope.Missing error message now mentions 'visibility' instead of 'scope modifier' -- Thanks to Renat Akhmedyanov for the patch - Added support for the PSR2 multi-line arguments errata - The PSR2 standard no longer throws errors for additional spacing after a type hint - PSR UseDeclarationSniff no longer throws errors for USE statements inside TRAITs - Fixed bug #20026 : Check for multi-line arrays that should be single-line is slightly wrong -- Adds new error message for single-line arrays that end with a comma - Fixed bug #20029 : ForbiddenFunction sniff incorrectly recognizes methods in USE clauses - Fixed bug #20043 : Mis-interpretation of Foo::class - Fixed bug #20044 : PSR1 camelCase check does not ignore leading underscores - Fixed bug #20045 : Errors about indentation for closures with multi-line 'use' in functions 1.4.6 1.4.6 stable stable 2013-07-25 BSD License - Added report type --report=json to show the error list and total counts for all checked files -- Thanks to Jeffrey Fisher for the contribution - The JS tokenizer now has support for the T_THROW token - Symlinked directories inside CodeSniffer/Standards and in ruleset.xml files are now supported -- Only available since PHP 5.2.11 and 5.3.1 -- Thanks to Maik Penz for the patch - The JS tokenizer now correctly identifies T_INLINE_ELSE tokens instead of leaving them as T_COLON -- Thanks to Arnout Boks for the patch - Explaining a standard (phpcs -e) that uses namespaces now works correctly - Restricting a check to specific sniffs (phpcs --sniffs=...) now works correctly with namespaced sniffs -- Thanks to Maik Penz for the patch - Docs added for the entire Generic standard, and many sniffs from other standards are now documented as well -- Thanks to Spencer Rinehart for the contribution - Clearer error message for when the sniff class name does not match the directory structure - Generated HTML docs now correctly show the open PHP tag in code comparison blocks - Added Generic InlineHTMLSniff to ensure a file only contains PHP code - Added Squiz ShorthandSizeSniff to check that CSS sizes are using shorthand notation only when 1 or 2 values are used - Added Squiz ForbiddenStylesSniff to ban the use of some deprecated browser-specific styles - Added Squiz NamedColoursSniff to ban the use of colour names - PSR2 standard no longer enforces no whitespace between the closing parenthesis of a function call and the semicolon - PSR2 ClassDeclarationSniff now ignores empty classes when checking the end brace position - PSR2 SwitchDeclarationSniff no longer reports errors for empty lines between CASE statements - PEAR ObjectOperatorIndentSniff now has a setting to specify how many spaces code should be indented -- Default remains at 4; override the indent setting in a ruleset.xml file to change -- Thanks to Andrey Mindubaev for the patch - Squiz FileExtensionSniff now supports traits -- Thanks to Lucas Green for the patch - Squiz ArrayDeclarationSniff no longer reports errors for no comma at the end of a line that contains a function call - Squiz SwitchDeclarationSniff now supports T_CONTINUE and T_THROW as valid case/default breaking statements - Squiz CommentedOutCodeSniff is now better at ignoring commented out HTML, XML and regular expressions - Squiz DisallowComparisonAssignmentSniff no longer throws errors for the third expression in a FOR statement - Squiz ColourDefinitionSniff no longer throws errors for some CSS class names - Squiz ControlStructureSpacingSniff now supports all types of CASE/DEFAULT breaking statements - Generic CallTimePassByReferenceSniff now reports errors for functions called using a variable -- Thanks to Maik Penz for the patch - Generic ConstructorNameSniff no longer throws a notice for abstract constructors inside abstract classes -- Thanks to Spencer Rinehart for the patch - Squiz ComparisonOperatorUsageSniff now checks inside elseif statements -- Thanks to Arnout Boks for the patch - Squiz OperatorSpacingSniff now reports errors for no spacing around inline then and else tokens -- Thanks to Arnout Boks for the patch - Fixed bug #19811 : Comments not ignored in all cases in AbstractPatternSniff -- Thanks to Erik Wiffin for the patch - Fixed bug #19892 : ELSE with no braces causes incorrect SWITCH break statement indentation error - Fixed bug #19897 : Indenting warnings in templates not consistent - Fixed bug #19908 : PEAR MultiLineCondition Does Not Apply elseif - Fixed bug #19913 : Running phpcs in interactive mode causes warnings -- Thanks to Harald Franndorfer for the patch - Fixed bug #19935 : notify-send reports do not vanish in gnome-shell -- Thanks to Christian Weiske for the patch - Fixed bug #19944 : docblock squiz sniff "return void" trips over return in lambda function - Fixed bug #19953 : PSR2 - Spaces before interface name for abstract class - Fixed bug #19956 : phpcs warns for Type Hint missing Resource - Fixed bug #19957 : Does not understand trait method aliasing - Fixed bug #19968 : Permission denied on excluded directory - Fixed bug #19969 : Sniffs with namespace not recognized in reports - Fixed bug #19997 : Class names incorrectly detected as constants 1.4.5 1.4.5 stable stable 2013-04-04 BSD License - Added Generic LowerCaseKeywordSniff to ensure all PHP keywords are defined in lowercase -- The PSR2 and Squiz standards now use this sniff - Added Generic SAPIUsageSniff to ensure the PHP_SAPI constant is used instead of php_sapi_name() (request #19863) - Squiz FunctionSpacingSniff now has a setting to specify how many lines there should between functions (request #19843) -- Default remains at 2 -- Override the "spacing" setting in a ruleset.xml file to change - Squiz LowercasePHPFunctionSniff no longer throws errors for the limited set of PHP keywords it was checking -- Add a rule for Generic.PHP.LowerCaseKeyword to your ruleset to replicate this functionality - Added support for the PHP 5.4 T_CALLABLE token so it can be used in lower PHP versions - Generic EndFileNoNewlineSniff now supports checking of CSS and JS files - PSR2 SwitchDeclarationSniff now has a setting to specify how many spaces code should be indented -- Default remains at 4; override the indent setting in a ruleset.xml file to change -- Thanks to Asher Snyder for the patch - Generic ScopeIndentSniff now has a setting to specify a list of tokens that should be ignored -- The first token on the line is checked and the whole line is ignored if the token is in the array -- Thanks to Eloy Lafuente for the patch - Squiz LowercaseClassKeywordsSniff now checks for the TRAIT keyword -- Thanks to Anthon Pang for the patch - If you create your own PHP_CodeSniffer object, PHPCS will no longer exit when an unknown argument is found -- This allows you to create wrapper scripts for PHPCS more easily - PSR2 MethodDeclarationSniff no longer generates a notice for methods named "_" -- Thanks to Bart S for the patch - Squiz BlockCommentSniff no longer reports that a blank line between a scope closer and block comment is invalid - Generic DuplicateClassNameSniff no longer reports an invalid error if multiple PHP open tags exist in a file - Generic DuplicateClassNameSniff no longer reports duplicate errors if multiple PHP open tags exist in a file - Fixed bug #19819 : Freeze with syntax error in use statement - Fixed bug #19820 : Wrong message level in Generic_Sniffs_CodeAnalysis_EmptyStatementSniff - Fixed bug #19859 : CodeSniffer::setIgnorePatterns API changed - Fixed bug #19871 : findExtendedClassName doesn't return FQCN on namespaced classes - Fixed bug #19879 : bitwise and operator interpreted as reference by value 1.4.4 1.4.4 stable stable 2013-02-07 BSD License - Ignored lines no longer cause the summary report to show incorrect error and warning counts -- Thanks to Bert Van Hauwaert for the patch - Added Generic CSSLintSniff to run CSSLint over a CSS file and report warnings -- Set full command to run CSSLint using phpcs --config-set csslint_path /path/to/csslint -- Thanks to Roman Levishchenko for the contribution - Added PSR2 ControlStructureSpacingSniff to ensure there are no spaces before and after parenthesis in control structures -- Fixes bug #19732 : PSR2: some control structures errors not reported - Squiz commenting sniffs now support non-English characters when checking for capital letters -- Thanks to Roman Levishchenko for the patch - Generic EndFileNewlineSniff now supports JS and CSS files -- Thanks to Denis Ryabkov for the patch - PSR1 SideEffectsSniff no longer reports constant declarations as side effects - Notifysend report now supports notify-send versions before 0.7.3 -- Thanks to Ken Guest for the patch - PEAR and Squiz FunctionCommentSniffs no longer report errors for misaligned argument comments when they are blank -- Thanks to Thomas Peterson for the patch - Squiz FunctionDeclarationArgumentSpacingSniff now works correctly for equalsSpacing values greater than 0 -- Thanks to Klaus Purer for the patch - Squiz SuperfluousWhitespaceSniff no longer throws errors for CSS files with no newline at the end - Squiz SuperfluousWhitespaceSniff now allows a single newline at the end of JS and CSS files - Fixed bug #19755 : Token of T_CLASS type has no scope_opener and scope_closer keys - Fixed bug #19759 : Squiz.PHP.NonExecutableCode fails for return function()... - Fixed bug #19763 : Use statements for traits not recognised correctly for PSR2 code style - Fixed bug #19764 : Instead of for traits throws uppercase constant name errors - Fixed bug #19772 : PSR2_Sniffs_Namespaces_UseDeclarationSniff does not properly recognize last use - Fixed bug #19775 : False positive in NonExecutableCode sniff when not using curly braces - Fixed bug #19782 : Invalid found size functions in loop when using object operator - Fixed bug #19799 : config folder is not created automatically - Fixed bug #19804 : JS Tokenizer wrong /**/ parsing 1.4.3 1.4.3 stable stable 2012-12-04 BSD License - Added support for the PHP 5.5 T_FINALLY token to detect try/catch/finally statements - Added empty CodeSniffer.conf to enable config settings for Composer installs - Added Generic EndFileNoNewlineSniff to ensure there is no newline at the end of a file - Autoloader can now load PSR-0 compliant classes -- Thanks to Maik Penz for the patch - Squiz NonExecutableCodeSniff no longer throws error for multi-line RETURNs inside CASE statements -- Thanks to Marc Ypes for the patch - Squiz OperatorSpacingSniff no longer reports errors for negative numbers inside inline THEN statements -- Thanks to Klaus Purer for the patch - Squiz OperatorSpacingSniff no longer reports errors for the assignment of operations involving negative numbers - Squiz SelfMemberReferenceSniff can no longer get into an infinite loop when checking a static call with a namespace -- Thanks to Andy Grunwald for the patch - Fixed bug #19699 : Generic.Files.LineLength giving false positives when tab-width is used - Fixed bug #19726 : Wrong number of spaces expected after instanceof static - Fixed bug #19727 : PSR2: no error reported when using } elseif { 1.4.2 1.4.2 stable stable 2012-11-09 BSD License - PHP_CodeSniffer can now be installed using Composer -- Require squizlabs/php_codesniffer in your composer.json file -- Thanks to Rob Bast, Stephen Rees-Carter, Stefano Kowalke and Ivan Habunek for help with this - Squiz BlockCommentSniff and InlineCommentSniff no longer report errors for trait block comments - Squiz SelfMemberReferenceSniff now supports namespaces -- Thanks to Andy Grunwald for the patch - Squiz FileCommentSniff now uses tag names inside the error codes for many messages -- This allows you to exclude specific missing, out of order etc., tags - Squiz SuperfluousWhitespaceSniff now has an option to ignore blank lines -- This will stop errors being reported for lines that contain only whitespace -- Set the ignoreBlankLines property to TRUE in your ruleset.xml file to enable this - PSR2 no longer reports errors for whitespace at the end of blank lines - Fixed gitblame report not working on Windows -- Thanks to Rogerio Prado de Jesus - Fixed an incorrect error in Squiz OperatorSpacingSniff for default values inside a closure definition - Fixed bug #19691 : SubversionPropertiesSniff fails to find missing properties -- Thanks to Kevin Winahradsky for the patch - Fixed bug #19692 : DisallowMultipleAssignments is triggered by a closure - Fixed bug #19693 : exclude-patterns no longer work on specific messages - Fixed bug #19694 : Squiz.PHP.LowercasePHPFunctions incorrectly matches return by ref functions 1.4.1 1.4.1 stable stable 2012-11-02 BSD License - All ignore patterns have been reverted to being checked against the absolute path of a file -- Patterns can be specified to be relative in a rulset.xml file, but nowhere else -- e.g., [exclude-pattern type="relative"]^tests/*[/exclude-pattern] (with angle brackets, not square brackets) - Added support for PHP tokenizing of T_INLINE_ELSE colons, so this token type is now available -- Custom sniffs that rely on looking for T_COLON tokens inside inline if statements must be changed to use the new token -- Fixes bug #19666 : PSR1.Files.SideEffects throws a notice Undefined index: scope_closer - Messages can now be changed from errors to warnings (and vice versa) inside ruleset.xml files -- As you would with "message" and "severity", specify a "type" tag under a "rule" tag and set the value to "error" or "warning" - PHP_CodeSniffer will now generate a warning on files that it detects have mixed line endings -- This warning has the code Internal.LineEndings.Mixed and can be overriden in a ruleset.xml file -- Thanks to Vit Brunner for help with this - Sniffs inside PHP 5.3 namespaces are now supported, along with the existing underscore-style emulated namespaces -- For example: namespace MyStandard\Sniffs\Arrays; class ArrayDeclarationSniff implements \PHP_CodeSniffer_Sniff { ... -- Thanks to Till Klampaeckel for the patch - Generic DuplicateClassNameSniff is no longer a multi-file sniff, so it won't max out your memory -- Multi-file sniff support should be considered deprecated as standard sniffs can now do the same thing - Added Generic DisallowSpaceIndent to check that files are indented using tabs - Added Generic OneClassPerFileSniff to check that only one class is defined in each file -- Thanks to Andy Grunwald for the contribution - Added Generic OneInterfacePerFileSniff to check that only one interface is defined in each file -- Thanks to Andy Grunwald for the contribution - Added Generic LowercasedFilenameSniff to check that filenames are lowercase -- Thanks to Andy Grunwald for the contribution - Added Generic ClosingPHPTagSniff to check that each open PHP tag has a corresponding close tag -- Thanks to Andy Grunwald for the contribution - Added Generic CharacterBeforePHPOpeningTagSniff to check that the open PHP tag is the first content in a file -- Thanks to Andy Grunwald for the contribution - Fixed incorrect errors in Squiz OperatorBracketSniff and OperatorSpacingSniff for negative numbers in CASE statements -- Thanks to Arnout Boks for the patch - Generic CamelCapsFunctionNameSniff no longer enforces exact case matching for PHP magic methods - Generic CamelCapsFunctionNameSniff no longer throws errors for overridden SOAPClient methods prefixed with double underscores -- Thanks to Dorian Villet for the patch - PEAR ValidFunctionNameSniff now supports traits - PSR1 ClassDeclarationSniff no longer throws an error for non-namespaced code if PHP version is less than 5.3.0 - Fixed bug #19616 : Nested switches cause false error in PSR2 - Fixed bug #19629 : PSR2 error for inline comments on multi-line argument lists - Fixed bug #19644 : Alternative syntax, e.g. if/endif triggers Inline Control Structure error - Fixed bug #19655 : Closures reporting as multi-line when they are not - Fixed bug #19675 : Improper indent of nested anonymous function bodies in a call - Fixed bug #19685 : PSR2 catch-22 with empty third statement in for loop - Fixed bug #19687 : Anonymous functions inside arrays marked as indented incorrectly in PSR2 1.4.0 1.4.0 stable stable 2012-09-26 BSD License - Added PSR1 and PSR2 coding standards that can be used to check your code against these guidelines - PHP 5.4 short array syntax is now detected and tokens are assigned to the open and close characters -- New tokens are T_OPEN_SHORT_ARRAY and T_CLOSE_SHORT_ARRAY as PHP does not define its own - Added the ability to explain a coding standard by listing the sniffs that it includes -- The sniff list includes all imported and native sniffs -- Explain a standard by using the -e and --standard=[standard] command line arguments -- E.g., phpcs -e --standard=Squiz -- Thanks to Ben Selby for the idea - Added report to show results using notify-send -- Use --report=notifysend to generate the report -- Thanks to Christian Weiske for the contribution - The JS tokenizer now recognises RETURN as a valid closer for CASE and DEFAULT inside switch statements - AbstractPatternSniff now sets the ignoreComments option using a public var rather than through the constructor -- This allows the setting to be overwritten in ruleset.xml files -- Old method remains for backwards compatibility - Generic LowerCaseConstantSniff and UpperCaseConstantSniff no longer report errors on classes named True, False or Null - PEAR ValidFunctionNameSniff no longer enforces exact case matching for PHP magic methods - Squiz SwitchDeclarationSniff now allows RETURN statements to close a CASE or DEFAULT statement - Squiz BlockCommentSniff now correctly reports an error for blank lines before blocks at the start of a control structure - Fixed a PHP notice generated when loading custom array settings from a rulset.xml file - Fixed bug #17908 : CodeSniffer does not recognise optional @params -- Thanks to Pete Walker for the patch - Fixed bug #19538 : Function indentation code sniffer checks inside short arrays - Fixed bug #19565 : Non-Executable Code Sniff Broken for Case Statements with both return and break - Fixed bug #19612 : Invalid @package suggestion 1.3.6 1.3.6 stable stable 2012-08-08 BSD License - Memory usage has been dramatically reduced when using the summary report -- Reduced memory is only available when displaying a single summary report to the screen -- PHP_CodeSniffer will not generate any messages in this case, storing only error counts instead -- Impact is most notable with very high error and warning counts - Significantly improved the performance of Squiz NonExecutableCodeSniff - Ignore patterns now check the relative path of a file based on the dir being checked -- Allows ignore patterns to become more generic as the path to the code is no longer included when checking -- Thanks to Kristof Coomans for the patch - Sniff settings can now be changed by specifying a special comment format inside a file -- e.g., // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature allowMultipleArguments false -- If you change a setting, don't forget to change it back - Added Generic EndFileNewlineSniff to ensure PHP files end with a newline character - PEAR FunctionCallSignatureSniff now includes a setting to force one argument per line in multi-line calls -- Set allowMultipleArguments to false - Squiz standard now enforces one argument per line in multi-line function calls - Squiz FunctionDeclarationArgumentSpacingSniff now supports closures - Squiz OperatorSpacingSniff no longer throws an error for negative values inside an inline THEN statement -- Thanks to Klaus Purer for the patch - Squiz FunctionCommentSniff now throws an error for not closing a comment with */ -- Thanks to Klaus Purer for the patch - Summary report no longer shows two lines of PHP_Timer output when showing sources - Fixed undefined variable error in PEAR FunctionCallSignatureSniff for lines with no indent - Fixed bug #19502 : Generic.Files.LineEndingsSniff fails if no new-lines in file - Fixed bug #19508 : switch+return: Closing brace indented incorrectly - Fixed bug #19532 : The PSR-2 standard don't recognize Null in class names - Fixed bug #19546 : Error thrown for __call() method in traits 1.3.5 1.3.5 stable stable 2012-07-12 BSD License - Added Generic CamelCapsFunctionNameSniff to just check if function and method names use camel caps -- Does not allow underscore prefixes for private/protected methods -- Defaults to strict checking, where two uppercase characters can not be next to each other -- Strict checking can be disabled in a ruleset.xml file - Squiz FunctionDeclarationArgumentSpacing now has a setting to specify how many spaces should surround equals signs -- Default remains at 0 -- Override the equalsSpacing setting in a ruleset.xml file to change - Squiz ClassDeclarationSniff now throws errors for > 1 space before extends/implements class name with ns seperator - Squiz standard now warns about deprecated functions using Generic DeprecatedFunctionsSniff - PEAR FunctionDeclarationSniff now reports an error for multiple spaces after the FUNCTION keyword and around USE - PEAR FunctionDeclarationSniff now supports closures - Squiz MultiLineFunctionDeclarationSniff now supports closures - Exclude rules written for Unix systems will now work correctly on Windows -- Thanks to Walter Tamboer for the patch - The PHP tokenizer now recognises T_RETURN as a valid closer for T_CASE and T_DEFAULT inside switch statements - Fixed duplicate message codes in Generic OpeningFunctionBraceKernighanRitchieSniff - Fixed bug #18651 : PHPunit Test cases for custom standards are not working on Windows - Fixed bug #19416 : Shorthand arrays cause bracket spacing errors - Fixed bug #19421 : phpcs doesn't recognize ${x} as equivalent to $x - Fixed bug #19428 : PHPCS Report "hgblame" doesn't support windows paths -- Thanks to Justin Rovang for the patch - Fixed bug #19448 : Problem with detecting remote standards - Fixed bug #19463 : Anonymous functions incorrectly being flagged by NonExecutableCodeSniff - Fixed bug #19469 : PHP_CodeSniffer_File::getMemberProperties() sets wrong scope - Fixed bug #19471 : phpcs on Windows, when using Zend standard, doesn't catch problems -- Thanks to Ivan Habunek for the patch - Fixed bug #19478 : Incorrect indent detection in PEAR standard -- Thanks to Shane Auckland for the patch - Fixed bug #19483 : Blame Reports fail with space in directory name 1.3.4 1.3.4 stable stable 2012-05-17 BSD License - Added missing package.xml entries for new Generic FixmeSniff -- Thanks to Jaroslav Hanslík for the patch - Expected indents for PEAR ScopeClosingBraceSniff and FunctionCallSignatureSniff can now be set in ruleset files -- Both sniffs use a variable called "indent" -- Thanks to Thomas Despoix for the patch - Standards designed to be installed in the PHPCS Standards dir will now work outside this dir as well -- In particular, allows the Drupal CS to work without needing to symlink it into the PHPCS install -- Thanks to Peter Philipp for the patch - Rule references for standards, directories and specific sniffs can now be relative in ruleset.xml files -- For example: ref="../MyStandard/Sniffs/Commenting/DisallowHashCommentsSniff.php" - Symlinked standards now work correctly, allowing aliasing of installed standards (request #19417) -- Thanks to Tom Klingenberg for the patch - Squiz ObjectInstantiationSniff now allows objects to be returned without assinging them to a variable - Added Squiz.Commenting.FileComment.MissingShort error message for file comments that only contains tags -- Also stops undefined index errors being generated for these comments - Debug option -vv now shows tokenizer status for CSS files - Added support for new gjslint error formats -- Thanks to Meck for the patch - Generic ScopeIndentSniff now allows comment indents to not be exact even if the exact flag is set -- The start of the comment is still checked for exact indentation as normal - Fixed an issue in AbstractPatternSniff where comments were not being ignored in some cases - Fixed an issue in Zend ClosingTagSniff where the closing tag was not always being detected correctly -- Thanks to Jonathan Robson for the patch - Fixed an issue in Generic FunctionCallArgumentSpacingSniff where closures could cause incorrect errors - Fixed an issue in Generic UpperCaseConstantNameSniff where errors were incorrectly reported on goto statements -- Thanks to Tom Klingenberg for the patch - PEAR FileCommentSniff and ClassCommentSniff now support author emails with a single character in the local part -- E.g., a@me.com -- Thanks to Denis Shapkin for the patch - Fixed bug #19290 : Generic indent sniffer fails for anonymous functions - Fixed bug #19324 : Setting show_warnings configuration option does not work - Fixed bug #19354 : Not recognizing references passed to method - Fixed bug #19361 : CSS tokenzier generates errors when PHP embedded in CSS file - Fixed bug #19374 : HEREDOC/NOWDOC Indentation problems - Fixed bug #19381 : traits and indetations in traits are not handled properly - Fixed bug #19394 : Notice in NonExecutableCodeSniff - Fixed bug #19402 : Syntax error when executing phpcs on Windows with parens in PHP path -- Thanks to Tom Klingenberg for the patch - Fixed bug #19411 : magic method error on __construct() -- The fix required a rewrite of AbstractScopeSniff, so please test any sniffs that extend this class - Fixed bug #19412 : Incorrect error about assigning objects to variables when inside inline IF - Fixed bug #19413 : php_cs thinks I haven't used a parameter when I have - Fixed bug #19414 : php_cs seems to not track variables correctly in heredocs 1.3.3 1.3.3 stable stable 2012-02-17 BSD License - Added new Generic FixmeSniff that shows error messages for all FIXME comments left in your code -- Thanks to Sam Graham for the contribution - The maxPercentage setting in the Squiz CommentedOutCodeSniff can now be overriden in a rulset.xml file -- Thanks to Volker Dusch for the patch - The Checkstyle and XML reports now use XMLWriter -- Only change in output is that empty file tags are no longer produced for files with no violations -- Thanks to Sebastian Bergmann for the patch - Added PHP_CodeSniffer_Tokens::$bracketTokens to give sniff writers fast access to open and close bracket tokens - Fixed an issue in AbstractPatternSniff where EOL tokens were not being correctly checked in some cases - PHP_CodeSniffer_File::getTokensAsString() now detects incorrect length value (request #19313) - Fixed bug #19114 : CodeSniffer checks extension even for single file - Fixed bug #19171 : Show sniff codes option is ignored by some report types -- Thanks to Dominic Scheirlinck for the patch - Fixed bug #19188 : Lots of PHP Notices when analyzing the Symfony framework -- First issue was list-style.. lines in CSS files not properly adjusting open/close bracket positions -- Second issue was notices caused by bug #19137 - Fixed bug #19208 : UpperCaseConstantName reports class members -- Was also a problem with LowerCaseConstantName as well - Fixed bug #19256 : T_DOC_COMMENT in CSS files breaks ClassDefinitionNameSpacingSniff -- Thanks to Klaus Purer for the patch - Fixed bug #19264 : Squiz.PHP.NonExecutableCode does not handle RETURN in CASE without BREAK - Fixed bug #19270 : DuplicateClassName does not handle namespaces correctly - Fixed bug #19283 : CSS @media rules cause false positives -- Thanks to Klaus Purer for the patch 1.3.2 1.3.2 stable stable 2011-12-01 BSD License - Added Generic JSHintSniff to run jshint.js over a JS file and report warnings -- Set jshint path using phpcs --config-set jshint_path /path/to/jshint-rhino.js -- Set rhino path using phpcs --config-set rhino_path /path/to/rhino -- Thanks to Alexander Weiß for the contribution - Nowdocs are now tokenized using PHP_CodeSniffer specific T_NOWDOC tokens for easier identification - Generic UpperCaseConstantNameSniff no longer throws errors for namespaces -- Thanks to Jaroslav Hanslík for the patch - Squiz NonExecutableCodeSniff now detects code after thrown exceptions -- Thanks to Jaroslav Hanslík for the patch - Squiz OperatorSpacingSniff now ignores references -- Thanks to Jaroslav Hanslík for the patch - Squiz FunctionCommentSniff now reports a missing function comment if it finds a standard code comment instead - Squiz FunctionCommentThrownTagSniff no longer reports errors if it can't find a function comment - Fixed unit tests not running under Windows -- Thanks to Jaroslav Hanslík for the patch - Fixed bug #18964 : "$stackPtr must be of type T_VARIABLE" on heredocs and nowdocs - Fixed bug #18973 : phpcs is looking for variables in a nowdoc - Fixed bug #18974 : Blank line causes "Multi-line function call not indented correctly" -- Adds new error message to ban empty lines in multi-line function calls - Fixed bug #18975 : "Closing parenthesis must be on a line by itself" also causes indentation error 1.3.1 1.3.1 stable stable 2011-11-03 BSD License - All report file command line arguments now work with relative paths (request #17240) - The extensions command line argument now supports multi-part file extensions (request #17227) - Added report type --report=hgblame to show number of errors/warnings committed by authors in a Mercurial repository -- Has the same functionality as the svnblame report -- Thanks to Ben Selby for the patch - Added T_BACKTICK token type to make detection of backticks easier (request #18799) - Added pattern matching support to Generic ForbiddenFunctionsSniff -- If you are extending it and overriding register() or addError() you will need to review your sniff - Namespaces are now recognised as scope openers, although they do not require braces (request #18043) - Added new ByteOrderMarkSniff to Generic standard (request #18194) -- Throws an error if a byte order mark is found in any PHP file -- Thanks to Piotr Karas for the contribution - PHP_Timer output is no longer included in reports when being written to a file (request #18252) -- Also now shown for all report types if nothing is being printed to the screen - Generic DeprecatedFunctionSniff now reports functions as deprecated and not simply forbidden (request #18288) - PHPCS now accepts file contents from STDIN (request #18447) -- Example usage: cat temp.php | phpcs [options] -OR- phpcs [options] < temp.php -- Not every sniff will work correctly due to the lack of a valid file path - PHP_CodeSniffer_Exception no longer extends PEAR_Exception (request #18483) -- PEAR_Exception added a requirement that PEAR had to be installed -- PHP_CodeSniffer is not used as a library, so unlikely to have any impact - PEAR FileCommentSniff now allows GIT IDs in the version tag (request #14874) - AbstractVariableSniff now supports heredocs -- Also includes some variable detection fixes -- Thanks to Sam Graham for the patch - Squiz FileCommentSniff now enforces rule that package names cannot start with the word Squiz - MySource AssignThisSniff now allows "this" to be assigned to the private var _self - Fixed issue in Squiz FileCommentSniff where suggested package name was the same as the incorrect package name - Fixed some issues with Squiz ArrayDeclarationSniff when using function calls in array values - Fixed doc generation so it actually works again -- Also now works when being run from an SVN checkout as well as when installed as a PEAR package -- Should fix bug #18949 : Call to private method from static - PEAR ClassDeclaration sniff now supports indentation checks when using the alternate namespace syntax -- PEAR.Classes.ClassDeclaration.SpaceBeforeBrace message now contains 2 variables instead of 1 -- Sniff allows overriding of the default indent level, which is set to 4 -- Fixes bug #18933 : Alternative namespace declaration syntax confuses scope sniffs - Fixed bug #18465 : "self::" does not work in lambda functions -- Also corrects conversion of T_FUNCTION tokens to T_CLOSURE, which was not fixing token condition arrays - Fixed bug #18543 : CSS Tokenizer deletes too many # - Fixed bug #18624 : @throws namespace problem -- Thanks to Gavin Davies for the patch - Fixed bug #18628 : Generic.Files.LineLength gives incorrect results with Windows line-endings - Fixed bug #18633 : CSS Tokenizer doesn't replace T_LIST tokens inside some styles - Fixed bug #18657 : anonymous functions wrongly indented - Fixed bug #18670 : UpperCaseConstantNameSniff fails on dynamic retrieval of class constant - Fixed bug #18709 : Code sniffer sniffs file if even if it's in --ignore -- Thanks to Artem Lopata for the patch - Fixed bug #18762 : Incorrect handling of define and constant in UpperCaseConstantNameSniff -- Thanks to Thomas Baker for the patch - Fixed bug #18769 : CSS Tokenizer doesn't replace T_BREAK tokens inside some styles - Fixed bug #18835 : Unreachable errors of inline returns of closure functions -- Thanks to Patrick Schmidt for the patch - Fixed bug #18839 : Fix miscount of warnings in AbstractSniffUnitTest.php -- Thanks to Sam Graham for the patch - Fixed bug #18844 : Generic_Sniffs_CodeAnalysis_UnusedFunctionParameterSniff with empty body -- Thanks to Dmitri Medvedev for the patch - Fixed bug #18847 : Running Squiz_Sniffs_Classes_ClassDeclarationSniff results in PHP notice - Fixed bug #18868 : jslint+rhino: errors/warnings not detected -- Thanks to Christian Weiske for the patch - Fixed bug #18879 : phpcs-svn-pre-commit requires escapeshellarg -- Thanks to Bjorn Katuin for the patch - Fixed bug #18951 : weird behaviour with closures and multi-line use () params 1.3.0 1.3.0 stable stable 2011-03-17 BSD License - Add a new token T_CLOSURE that replaces T_FUNCTION if the function keyword is anonymous - Many Squiz sniffs no longer report errors when checking closures; they are now ignored - Fixed some error messages in PEAR MultiLineConditionSniff that were not using placeholders for message data - AbstractVariableSniff now correctly finds variable names wrapped with curly braces inside double quoted strings - PEAR FunctionDeclarationSniff now ignores arrays in argument default values when checking multi-line declarations - Fixed bug #18200 : Using custom named ruleset file as standard no longer works - Fixed bug #18196 : PEAR MultiLineCondition.SpaceBeforeOpenBrace not consistent with newline chars - Fixed bug #18204 : FunctionCommentThrowTag picks wrong exception type when throwing function call - Fixed bug #18222 : Add __invoke method to PEAR standard - Fixed bug #18235 : Invalid error generation in Squiz.Commenting.FunctionCommentThrowTag - Fixed bug #18250 : --standard with relative path skips Standards' "implicit" sniffs - Fixed bug #18274 : Multi-line IF and function call indent rules conflict - Fixed bug #18282 : Squiz doesn't handle final keyword before function comments -- Thanks to Dave Perrett for the patch - Fixed bug #18336 : Function isUnderscoreName gives php notices 1.3.0RC2 1.3.0RC2 beta beta 2011-01-14 BSD License - You can now print multiple reports for each run and print each to the screen or a file (request #12434) -- Format is --report-[report][=file] (e.g., --report-xml=out.xml) -- Printing to screen is done by leaving [file] empty (e.g., --report-xml) -- Multiple reports can be specified in this way (e.g., --report-summary --report-xml=out.xml) -- The standard --report and --report-file command line arguments are unchanged - Added -d command line argument to set php.ini settings while running (request #17244) -- Usage is: phpcs -d memory_limit=32M -d ... -- Thanks to Ben Selby for the patch - Added -p command line argument to show progress during a run -- Dot means pass, E means errors found, W means only warnings found and S means skipped file -- Particularly good for runs where you are checking more than 100 files -- Enable by default with --config-set show_progress 1 -- Will not print anything if you are already printing verbose output -- This has caused a big change in the way PHP_CodeSniffer processes files (API changes around processing) - You can now add exclude rules for individual sniffs or error messages (request #17903) -- Only available when using a ruleset.xml file to specify rules -- Uses the same exclude-pattern tags as normal but allows them inside rule tags - Using the -vvv option will now print a list of sniffs executed for each file and how long they took to process - Added Generic ClosureLinterSniff to run Google's gjslint over your JS files - The XML and CSV reports now include the severity of the error (request #18165) -- The Severity column in the CSV report has been renamed to Type, and a new Severity column added for this - Fixed issue with Squiz FunctionCommentSniff reporting incorrect type hint when default value uses namespace -- Thanks to Anti Veeranna for the patch - Generic FileLengthSniff now uses iconv_strlen to check line length if an encoding is specified (request #14237) - Generic UnnecessaryStringConcatSniff now allows strings to be combined to form a PHP open or close tag - Squiz SwitchDeclarationSniff no longer reports indentation errors for BREAK statements inside IF conditions - Interactive mode now always prints the full error report (ignores command line) - Improved regular expression detection in JavaScript files -- Added new T_TYPEOF token that can be used to target the typeof JS operator -- Fixes bug #17611 : Regular expression tokens not recognised - Squiz ScopeIndentSniff removed -- Squiz standard no longer requires additional indents between ob_* methods -- Also removed Squiz OutputBufferingIndentSniff that was checking the same thing - PHP_CodeSniffer_File::getMemberProperties() performance improved significantly -- Improves performance of Squiz ValidVariableNameSniff significantly - Squiz OperatorSpacingSniff performance improved significantly - Squiz NonExecutableCodeSniff performance improved significantly -- Will throw duplicate errors in some cases now, but these should be rare - MySource IncludeSystemSniff performance improved significantly - MySource JoinStringsSniff no longer reports an error when using join() on a named JS array - Warnings are now reported for each file when they cannot be opened instead of stopping the script -- Hide warnings with the -n command line argument -- Can override the warnings using the code Internal.DetectLineEndings - Fixed bug #17693 : issue with pre-commit hook script with filenames that start with v - Fixed bug #17860 : isReference function fails with references in array -- Thanks to Lincoln Maskey for the patch - Fixed bug #17902 : Cannot run tests when tests are symlinked into tests dir -- Thanks to Matt Button for the patch - Fixed bug #17928 : Improve error message for Generic_Sniffs_PHP_UpperCaseConstantSniff -- Thanks to Stefano Kowalke for the patch - Fixed bug #18039 : JS Tokenizer crash when ] is last character in file - Fixed bug #18047 : Incorrect handling of namespace aliases as constants -- Thanks to Dmitri Medvedev for the patch - Fixed bug #18072 : Impossible to exclude path from processing when symlinked - Fixed bug #18073 : Squiz.PHP.NonExecutableCode fault - Fixed bug #18117 : PEAR coding standard: Method constructor not sniffed as a function - Fixed bug #18135 : Generic FunctionCallArgumentSpacingSniff reports function declaration errors - Fixed bug #18140 : Generic scope indent in exact mode: strange expected/found values for switch - Fixed bug #18145 : Sniffs are not loaded for custom ruleset file -- Thanks to Scott McCammon for the patch - Fixed bug #18152 : While and do-while with AbstractPatternSniff - Fixed bug #18191 : Squiz.PHP.LowercasePHPFunctions does not work with new Date() - Fixed bug #18193 : CodeSniffer doesn't reconize CR (\r) line endings 1.3.0RC1 1.3.0RC1 beta beta 2010-09-03 BSD License - Added exclude pattern support to ruleset.xml file so you can specify ignore patterns in a standard (request #17683) -- Use new exclude-pattern tags to include the ignore rules into your ruleset.xml file -- See CodeSniffer/Standards/PHPCS/ruleset.xml for an example - Added new --encoding command line argument to specify the encoding of the files being checked -- When set to utf-8, stops the XML-based reports from double-encoding -- When set to something else, helps the XML-based reports encode to utf-8 -- Default value is iso-8859-1 but can be changed with --config-set encoding [value] - The report is no longer printed to screen when using the --report-file command line option (request #17467) -- If you want to print it to screen as well, use the -v command line argument - The SVN and GIT blame reports now also show percentage of reported errors per author (request #17606) -- Thanks to Ben Selby for the patch - Updated the SVN pre-commit hook to work with the new severity levels feature - Generic SubversionPropertiesSniff now allows properties to have NULL values (request #17682) -- A null value indicates that the property should exist but the value should not be checked - Generic UpperCaseConstantName Sniff now longer complains about the PHPUnit_MAIN_METHOD constant (request #17798) - Squiz FileComment sniff now checks JS files as well as PHP files - Squiz FunctionCommentSniff now supports namespaces in type hints - Fixed a problem in Squiz OutputBufferingIndentSniff where block comments were reported as not indented - Fixed bug #17092 : Problems with utf8_encode and htmlspecialchars with non-ascii chars -- Use the new --encoding=utf-8 command line argument if your files are utf-8 encoded - Fixed bug #17629 : PHP_CodeSniffer_Tokens::$booleanOperators missing T_LOGICAL_XOR -- Thanks to Matthew Turland for the patch - Fixed bug #17699 : Fatal error generating code coverage with PHPUnit 5.3.0RC1 - Fixed bug #17718 : Namespace 'use' statement: used global class name is recognized as constant - Fixed bug #17734 : Generic SubversionPropertiesSniff complains on non SVN files - Fixed bug #17742 : EmbeddedPhpSniff reacts negatively to file without closing php tag - Fixed bug #17823 : Notice: Please no longer include PHPUnit/Framework.php 1.3.0a1 1.3.0a1 alpha alpha 2010-07-15 BSD License - All CodingStandard.php files have been replaced by ruleset.xml files -- Custom standards will need to be converted over to this new format to continue working - You can specify a path to your own custom ruleset.xml file by using the --standard command line arg -- e.g., phpcs --standard=/path/to/my/ruleset.xml - Added a new report type --report=gitblame to show how many errors and warnings were committed by each author -- Has the same functionality as the svnblame report -- Thanks to Ben Selby for the patch - A new token type T_DOLLAR has been added to allow you to sniff for variable variables (feature request #17095) -- Thanks to Ian Young for the patch - JS tokenizer now supports T_POWER (^) and T_MOD_EQUAL (%=) tokens (feature request #17441) - If you have PHP_Timer installed, you'll now get a time/memory summary at the end of a script run -- Only happens when printing reports that are designed to be read on the command line - Added Generic DeprecatedFunctionsSniff to warn about the use of deprecated functions (feature request #16694) -- Thanks to Sebastian Bergmann for the patch - Added Squiz LogicalOperatorSniff to ensure that logical operators are surrounded by single spaces - Added MySource ChannelExceptionSniff to ensure action files only throw ChannelException - Added new method getClassProperties() for sniffs to use to determine if a class is abstract and/or final -- Thanks to Christian Kaps for the patch - Generic UpperCaseConstantSniff no longer throws errors about namespaces -- Thanks to Christian Kaps for the patch - Squiz OperatorBracketSniff now correctly checks value assignmnets in arrays - Squiz LongConditionClosingCommentSniff now requires a comment for long CASE statements that use curly braces - Squiz LongConditionClosingCommentSniff now requires an exact comment match on the brace - MySource IncludeSystemSniff now ignores DOMDocument usage - MySource IncludeSystemSniff no longer requires inclusion of systems that are being implemented - Removed found and expected messages from Squiz ConcatenationSpacingSniff because they were messy and not helpful - Fixed a problem where Generic CodeAnalysisSniff could show warnings if checking multi-line strings - Fixed error messages in Squiz ArrayDeclarationSniff reporting incorrect number of found and expected spaces - Fixed bug #17048 : False positive in Squiz_WhiteSpace_ScopeKeywordSpacingSniff - Fixed bug #17054 : phpcs more strict than PEAR CS regarding function parameter spacing - Fixed bug #17096 : Notice: Undefined index: scope_condition in ScopeClosingBraceSniff.php -- Moved PEAR.Functions.FunctionCallArgumentSpacing to Generic.Functions.FunctionCallArgumentSpacing - Fixed bug #17144 : Deprecated: Function eregi() is deprecated - Fixed bug #17236 : PHP Warning due to token_get_all() in DoubleQuoteUsageSniff - Fixed bug #17243 : Alternate Switch Syntax causes endless loop of Notices in SwitchDeclaration - Fixed bug #17313 : Bug with switch case struture - Fixed bug #17331 : Possible parse error: interfaces may not include member vars - Fixed bug #17337 : CSS tokenizer fails on quotes urls - Fixed bug #17420 : Uncaught exception when comment before function brace - Fixed bug #17503 : closures formatting is not supported 1.2.2 1.2.2 stable stable 2010-01-27 BSD License - The core PHP_CodeSniffer_File methods now understand the concept of closures (feature request #16866) -- Thanks to Christian Kaps for the sample code - Sniffs can now specify violation codes for each error and warning they add -- Future versions will allow you to override messages and severities using these codes -- Specifying a code is optional, but will be required if you wish to support overriding - All reports have been broken into separate classes -- Command line usage and report output remains the same -- Thanks to Gabriele Santini for the patch - Added an interactive mode that can be enabled using the -a command line argument -- Scans files and stops when it finds a file with errors -- Waits for user input to recheck the file (hopefully you fixed the errors) or skip the file -- Useful for very large code bases where full rechecks take a while - The reports now show the correct number of errors and warnings found - The isCamelCaps method now allows numbers in class names - The JS tokenizer now correctly identifies boolean and bitwise AND and OR tokens - The JS tokenzier now correctly identifies regular expressions used in conditions - PEAR ValidFunctionNameSniff now ignores closures - Squiz standard now uses the PEAR setting of 85 chars for LineLengthSniff - Squiz ControlStructureSpacingSniff now ensure there are no spaces around parentheses - Squiz LongConditionClosingCommentSniff now checks for comments at the end of try/catch statements - Squiz LongConditionClosingCommentSniff now checks validity of comments for short structures if they exist - Squiz IncrementDecrementUsageSniff now has better checking to ensure it only looks at simple variable assignments - Squiz PostStatementCommentSniff no longer throws errors for end function comments - Squiz InlineCommentSniff no longer throws errors for end function comments - Squiz OperatorBracketSniff now allows simple arithmetic operations in SWITCH conditions - Squiz ValidFunctionNameSniff now ignores closures - Squiz MethodScopeSniff now ignores closures - Squiz ClosingDeclarationCommentSniff now ignores closures - Squiz GlobalFunctionSniff now ignores closures - Squiz DisallowComparisonAssignmentSniff now ignores the assigning of arrays - Squiz DisallowObjectStringIndexSniff now allows indexes that contain dots and reserved words - Squiz standard now throws nesting level and cyclomatic complexity errors at much higher levels - Squiz CommentedOutCodeSniff now ignores common comment framing chacacters - Squiz ClassCommentSniff now ensures the open comment tag is the only content on the first line - Squiz FileCommentSniff now ensures the open comment tag is the only content on the first line - Squiz FunctionCommentSniff now ensures the open comment tag is the only content on the first line - Squiz VariableCommentSniff now ensures the open comment tag is the only content on the first line - Squiz NonExecutableCodeSniff now warns about empty return statements that are not required - Removed ForbiddenStylesSniff from Squiz standard -- It is now in in the MySource standard as BrowserSpecificStylesSniff -- New BrowserSpecificStylesSniff ignores files with browser-specific suffixes - MySource IncludeSystemSniff no longer throws errors when extending the Exception class - MySource IncludeSystemSniff no longer throws errors for the abstract widget class - MySource IncludeSystemSniff and UnusedSystemSniff now allow includes inside IF statements - MySource IncludeSystemSniff no longer throws errors for included widgets inside methods - MySource GetRequestDataSniff now throws errors for using $_FILES - MySource CreateWidgetTypeCallbackSniff now allows return statements in nested functions - MySource DisallowSelfActionsSniff now ignores abstract classes - Fixed a problem with the SVN pre-commit hook for PHP versions without vertical whitespace regex support - Fixed bug #16740 : False positives for heredoc strings and unused parameter sniff - Fixed bug #16794 : ValidLogicalOperatorsSniff doesn't report operators not in lowercase - Fixed bug #16804 : Report filename is shortened too much - Fixed bug #16821 : Bug in Squiz_Sniffs_WhiteSpace_OperatorSpacingSniff -- Thanks to Jaroslav Hanslík for the patch - Fixed bug #16836 : Notice raised when using semicolon to open case - Fixed bug #16855 : Generic standard sniffs incorrectly for define() method - Fixed bug #16865 : Two bugs in Squiz_Sniffs_WhiteSpace_OperatorSpacingSniff -- Thanks to Jaroslav Hanslík for the patch - Fixed bug #16902 : Inline If Declaration bug - Fixed bug #16960 : False positive for late static binding in Squiz/ScopeKeywordSpacingSniff -- Thanks to Jakub Tománek for the patch - Fixed bug #16976 : The phpcs attempts to process symbolic links that don't resolve to files - Fixed bug #17017 : Including one file in the files sniffed alters errors reported for another file 1.2.1 1.2.1 stable stable 2009-11-17 BSD License - Added a new report type --report=svnblame to show how many errors and warnings were committed by each author -- Also shows the percentage of their code that are errors and warnings -- Requires you to have the SVN command in your path -- Make sure SVN is storing usernames and passwords (if required) or you will need to enter them for each file -- You can also use the -s command line argument to see the different types of errors authors are committing -- You can use the -v command line argument to see all authors, even if they have no errors or warnings - Added a new command line argument --report-width to allow you to set the column width of screen reports -- Reports wont accept values less than 70 or else they get too small -- Can also be set via a config var: phpcs --config-set report_width 100 - You can now get PHP_CodeSniffer to ignore a whole file by adding @codingStandardsIgnoreFile in the content -- If you put it in the first two lines the file wont even be tokenized, so it will be much quicker - Reports now print their file lists in alphabetical order - PEAR FunctionDeclarationSniff now reports error for incorrect closing bracket placement in multi-line definitions - Added Generic CallTimePassByRefenceSniff to prohibit the passing of variables into functions by reference -- Thanks to Florian Grandel for the contribution - Added Squiz DisallowComparisonAssignmentSniff to ban the assignment of comparison values to a variable - Added Squiz DuplicateStyleDefinitionSniff to check for duplicate CSS styles in a single class block - Squiz ArrayDeclarationSniff no longer checks the case of array indexes because that is not its job - Squiz PostStatementCommentSniff now allows end comments for class member functions - Squiz InlineCommentSniff now supports the checking of JS files - MySource CreateWidgetTypeCallbackSniff now allows the callback to be passed to another function - MySource CreateWidgetTypeCallbackSniff now correctly ignores callbacks used inside conditions - Generic MultipleStatementAlignmentSniff now enforces a single space before equals sign if max padding is reached - Fixed a problem in the JS tokenizer where regular expressions containing \// were not converted correctly - Fixed a problem tokenizing CSS files where multiple ID targets on a line would look like comments - Fixed a problem tokenizing CSS files where class names containing a colon looked like style definitions - Fixed a problem tokenizing CSS files when style statements had empty url() calls - Fixed a problem tokenizing CSS colours with the letter E in first half of the code - Squiz ColonSpacingSniff now ensures it is only checking style definitions in CSS files and not class names - Squiz DisallowComparisonAssignmentSniff no longer reports errors when assigning the return value of a function - CSS tokenizer now correctly supports multi-line comments - When only the case of var names differ for function comments, the error now indicates the case is different - Fixed an issue with Generic UnnecessaryStringConcatSniff where it incorrectly suggested removing a concat - Fixed bug #16530 : ScopeIndentSniff reports false positive - Fixed bug #16533 : Duplicate errors and warnings - Fixed bug #16563 : Check file extensions problem in phpcs-svn-pre-commit -- Thanks to Kaijung Chen for the patch - Fixed bug #16592 : Object operator indentation incorrect when first operator is on a new line - Fixed bug #16641 : Notice output - Fixed bug #16682 : Squiz_Sniffs_Strings_DoubleQuoteUsageSniff reports string "\0" as invalid - Fixed bug #16683 : Typing error in PHP_CodeSniffer_CommentParser_AbstractParser - Fixed bug #16684 : Bug in Squiz_Sniffs_PHP_NonExecutableCodeSniff - Fixed bug #16692 : Spaces in paths in Squiz_Sniffs_Debug_JavaScriptLintSniff -- Thanks to Jaroslav Hanslík for the patch - Fixed bug #16696 : Spelling error in MultiLineConditionSniff - Fixed bug #16697 : MultiLineConditionSniff incorrect result with inline IF - Fixed bug #16698 : Notice in JavaScript Tokenizer - Fixed bug #16736 : Multi-files sniffs aren't processed when FILE is a single directory -- Thanks to Alexey Shein for the patch - Fixed bug #16792 : Bug in Generic_Sniffs_PHP_ForbiddenFunctionsSniff 1.2.0 1.2.0 stable stable 2009-08-17 BSD License - Installed standards are now favoured over custom standards when using the cmd line arg with relative paths - Unit tests now use a lot less memory while running - Squiz standard now uses Generic EmptyStatementSniff but throws errors instead of warnings - Squiz standard now uses Generic UnusedFunctionParameterSniff - Removed unused ValidArrayIndexNameSniff from the Squiz standard - Fixed bug #16424 : SubversionPropertiesSniff print PHP Warning - Fixed bug #16450 : Constant PHP_CODESNIFFER_VERBOSITY already defined (unit tests) - Fixed bug #16453 : function declaration long line splitted error - Fixed bug #16482 : phpcs-svn-pre-commit ignores extensions parameter 1.2.0RC3 1.2.0RC3 beta beta 2009-07-07 BSD License - You can now use @codingStandardsIgnoreStart and @...End comments to suppress messages (feature request #14002) - A warning is now included for files without any code when short_open_tag is set to Off (feature request #12952) - You can now use relative paths to your custom standards with the --standard cmd line arg (feature request #14967) - You can now override magic methods and functions in PEAR ValidFunctionNameSniff (feature request #15830) - MySource IncludeSystemSniff now recognises widget action classes - MySource IncludeSystemSniff now knows about unit test classes and changes rules accordingly 1.2.0RC2 1.2.0RC2 beta beta 2009-05-25 BSD License - Test suite can now be run using the full path to AllTests.php (feature request #16179) - Fixed bug #15980 : PHP_CodeSniffer change php current directory -- Thanks to Dolly Aswin Harahap for the patch - Fixed bug #16001 : Notice triggered - Fixed bug #16054 : phpcs-svn-pre-commit not showing any errors - Fixed bug #16071 : Fatal error: Uncaught PHP_CodeSniffer_Exception - Fixed bug #16170 : Undefined Offset -1 in MultiLineConditionSniff.php on line 68 - Fixed bug #16175 : Bug in Squiz-IncrementDecrementUsageSniff 1.2.0RC1 1.2.0RC1 beta beta 2009-03-09 BSD License - Reports that are output to a file now include a trailing newline at the end of the file - Fixed sniff names not shown in -vvv token processing output - Added Generic SubversionPropertiesSniff to check that specific svn props are set for files -- Thanks to Jack Bates for the contribution - The PHP version check can now be overridden in classes that extend PEAR FileCommentSniff -- Thanks to Helgi Þormar Þorbjörnsson for the suggestion - Added Generic ConstructorNameSniff to check for PHP4 constructor name usage -- Thanks to Leif Wickland for the contribution - Squiz standard now supports multi-line function and condition sniffs from PEAR standard - Squiz standard now uses Generic ConstructorNameSniff - Added MySource GetRequestDataSniff to ensure REQUEST, GET and POST are not accessed directly - Squiz OperatorBracketSniff now allows square brackets in simple unbracketed operations - Fixed the incorrect tokenizing of multi-line block comments in CSS files - Fixed bug #15383 : Uncaught PHP_CodeSniffer_Exception - Fixed bug #15408 : An unexpected exception has been caught: Undefined offset: 2 - Fixed bug #15519 : Uncaught PHP_CodeSniffer_Exception - Fixed bug #15624 : Pre-commit hook fails with PHP errors - Fixed bug #15661 : Uncaught PHP_CodeSniffer_Exception - Fixed bug #15722 : "declare(encoding = 'utf-8');" leads to "Missing file doc comment" - Fixed bug #15910 : Object operator indention not calculated correctly 1.2.0a1 1.2.0a1 alpha alpha 2008-12-18 BSD License - PHP_CodeSniffer now has a CSS tokenizer for checking CSS files - Added support for a new multi-file sniff that sniffs all processed files at once - Added new output format --report=emacs to output errors using the emacs standard compile output format -- Thanks to Len Trigg for the contribution - Reports can now be written to a file using the --report-file command line argument (feature request #14953) -- The report is also written to screen when using this argument - The CheckStyle, CSV and XML reports now include a source for each error and warning (feature request #13242) -- A new report type --report=source can be used to show you the most common errors in your files - Added new command line argument -s to show error sources in all reports - Added new command line argument --sniffs to specify a list of sniffs to restrict checking to -- Uses the sniff source codes that are optionally displayed in reports - Changed the max width of error lines from 80 to 79 chars to stop blank lines in the default windows cmd window - PHP_CodeSniffer now has a token for an asperand (@ symbol) so sniffs can listen for them -- Thanks to Andy Brockhurst for the patch - Added Generic DuplicateClassNameSniff that will warn if the same class name is used in multiple files -- Not currently used by any standard; more of a multi-file sniff sample than anything useful - Added Generic NoSilencedErrorsSniff that warns if PHP errors are being silenced using the @ symbol -- Thanks to Andy Brockhurst for the contribution - Added Generic UnnecessaryStringConcatSniff that checks for two strings being concatenated - Added PEAR FunctionDeclarationSniff to enforce the new multi-line function declaration PEAR standard - Added PEAR MultiLineAssignmentSniff to enforce the correct indentation of multi-line assignments - Added PEAR MultiLineConditionSniff to enforce the new multi-line condition PEAR standard - Added PEAR ObjectOperatorIndentSniff to enforce the new chained function call PEAR standard - Added MySource DisallowSelfActionSniff to ban the use of self::method() calls in Action classes - Added MySource DebugCodeSniff to ban the use of Debug::method() calls - Added MySource CreateWidgetTypeCallback sniff to check callback usage in widget type create methods - Added Squiz DisallowObjectStringIndexSniff that forces object dot notation in JavaScript files -- Thanks to Sertan Danis for the contribution - Added Squiz DiscouragedFunctionsSniff to warn when using debug functions - Added Squiz PropertyLabelSniff to check whitespace around colons in JS property and label declarations - Added Squiz DuplicatePropertySniff to check for duplicate property names in JS classes - Added Squiz ColonSpacingSniff to check for spacing around colons in CSS style definitions - Added Squiz SemicolonSpacingSniff to check for spacing around semicolons in CSS style definitions - Added Squiz IdentationSniff to check for correct indentation of CSS files - Added Squiz ColourDefinitionSniff to check that CSS colours are defined in uppercase and using shorthand - Added Squiz EmptyStyleDefinitionSniff to check for CSS style definitions without content - Added Squiz EmptyClassDefinitionSniff to check for CSS class definitions without content - Added Squiz ClassDefinitionOpeningBraceSpaceSniff to check for spaces around opening brace of CSS class definitions - Added Squiz ClassDefinitionClosingBraceSpaceSniff to check for a single blank line after CSS class definitions - Added Squiz ClassDefinitionNameSpacingSniff to check for a blank lines inside CSS class definition names - Added Squiz DisallowMultipleStyleDefinitionsSniff to check for multiple style definitions on a single line - Added Squiz DuplicateClassDefinitionSniff to check for duplicate CSS class blocks that can be merged - Added Squiz ForbiddenStylesSniff to check for usage of browser specific styles - Added Squiz OpacitySniff to check for incorrect opacity values in CSS - Added Squiz LowercaseStyleDefinitionSniff to check for styles that are not defined in lowercase - Added Squiz MissingColonSniff to check for style definitions where the colon has been forgotten - Added Squiz MultiLineFunctionDeclarationSniff to check that multi-line declarations contain one param per line - Added Squiz JSLintSniff to check for JS errors using the jslint.js script through Rhino -- Set jslint path using phpcs --config-set jslint_path /path/to/jslint.js -- Set rhino path using phpcs --config-set rhino_path /path/to/rhino - Added Generic TodoSniff that warns about comments that contain the word TODO - Removed MultipleStatementAlignmentSniff from the PEAR standard as alignment is now optional - Generic ForbiddenFunctionsSniff now has protected member var to specify if it should use errors or warnings - Generic MultipleStatementAlignmentSniff now has correct error message if assignment is on a new line - Generic MultipleStatementAlignmentSniff now has protected member var to allow it to ignore multi-line assignments - Generic LineEndingsSniff now supports checking of JS files - Generic LineEndingsSniff now supports checking of CSS files - Generic DisallowTabIndentSniff now supports checking of CSS files - Squiz DoubleQuoteUsageSniff now bans the use of variables in double quoted strings in favour of concatenation - Squiz SuperfluousWhitespaceSniff now supports checking of JS files - Squiz SuperfluousWhitespaceSniff now supports checking of CSS files - Squiz DisallowInlineIfSniff now supports checking of JS files - Squiz SemicolonSpacingSniff now supports checking of JS files - Squiz PostStatementCommentSniff now supports checking of JS files - Squiz FunctionOpeningBraceSpacingSniff now supports checking of JS files - Squiz FunctionClosingBraceSpacingSniff now supports checking of JS files -- Empty JS functions must have their opening and closing braces next to each other - Squiz ControlStructureSpacingSniff now supports checking of JS files - Squiz LongConditionClosingCommentSniff now supports checking of JS files - Squiz OperatorSpacingSniff now supports checking of JS files - Squiz SwitchDeclarationSniff now supports checking of JS files - Squiz CommentedOutCodeSniff now supports checking of CSS files - Squiz DisallowSizeFunctionsInLoopsSniff now supports checking of JS files for the use of object.length - Squiz DisallowSizeFunctionsInLoopsSniff no longer complains about size functions outside of the FOR condition - Squiz ControlStructureSpacingSniff now bans blank lines at the end of a control structure - Squiz ForLoopDeclarationSniff no longer throws errors for JS FOR loops without semicolons - Squiz MultipleStatementAlignmentSniff no longer throws errors if a statement would take more than 8 spaces to align - Squiz standard now uses Genric TodoSniff - Squiz standard now uses Genric UnnecessaryStringConcatSniff - Squiz standard now uses PEAR MultiLineAssignmentSniff - Squiz standard now uses PEAR MultiLineConditionSniff - Zend standard now uses OpeningFunctionBraceBsdAllmanSniff (feature request #14647) - MySource JoinStringsSniff now bans the use of inline array joins and suggests the + operator - Fixed incorrect errors that can be generated from abstract scope sniffs when moving to a new file - Core tokenizer now matches orphaned curly braces in the same way as square brackets - Whitespace tokens at the end of JS files are now added to the token stack - JavaScript tokenizer now identifies properties and labels as new token types - JavaScript tokenizer now identifies object definitions as a new token type and matches curly braces for them - JavaScript tokenizer now identifies DIV_EQUAL and MUL_EQUAL tokens - Improved regular expression detection in the JavaScript tokenizer - Improve AbstractPatternSniff support so it can listen for any token type, not just weighted tokens - Fixed Squiz DoubleQuoteUsageSniff so it works correctly with short_open_tag=Off - Fixed bug #14409 : Output of warnings to log file - Fixed bug #14520 : Notice: Undefined offset: 1 in /usr/share/php/PHP/CodeSniffer/File.php on line - Fixed bug #14637 : Call to processUnknownArguments() misses second parameter $pos -- Thanks to Peter Buri for the patch - Fixed bug #14889 : Lack of clarity: licence or license - Fixed bug #15008 : Nested Parentheses in Control Structure Sniffs - Fixed bug #15091 : pre-commit hook attempts to sniff folders -- Thanks to Bruce Weirdan for the patch - Fixed bug #15124 : AbstractParser.php uses deprecated split() function -- Thanks to Sebastian Bergmann for the patch - Fixed bug #15188 : PHPCS vs HEREDOC strings - Fixed bug #15231 : Notice: Uninitialized string offset: 0 in FileCommentSniff.php on line 555 - Fixed bug #15336 : Notice: Undefined offset: 2 in /usr/share/php/PHP/CodeSniffer/File.php on line 1.1.0 1.1.0 stable stable 2008-07-14 BSD License - PEAR FileCommentSniff now allows tag orders to be overridden in child classes -- Thanks to Jeff Hodsdon for the patch - Added Generic DisallowMultipleStatementsSniff to ensure there is only one statement per line - Squiz standard now uses DisallowMultipleStatementsSniff - Fixed error in Zend ValidVariableNameSniff when checking vars in form: $class->{$var} - Fixed bug #14077 : Fatal error: Uncaught PHP_CodeSniffer_Exception: $stackPtr is not a class member - Fixed bug #14168 : Global Function -> Static Method and __autoload() - Fixed bug #14238 : Line length not checket at last line of a file - Fixed bug #14249 : wrong detection of scope_opener - Fixed bug #14250 : ArrayDeclarationSniff emit warnings at malformed array - Fixed bug #14251 : --extensions option doesn't work 1.1.0RC3 1.1.0RC3 beta beta 2008-07-03 BSD License - PEAR FileCommentSniff now allows tag orders to be overridden in child classes -- Thanks to Jeff Hodsdon for the patch - Added Generic DisallowMultipleStatementsSniff to ensure there is only one statement per line - Squiz standard now uses DisallowMultipleStatementsSniff - Fixed error in Zend ValidVariableNameSniff when checking vars in form: $class->{$var} - Fixed bug #14077 : Fatal error: Uncaught PHP_CodeSniffer_Exception: $stackPtr is not a class member - Fixed bug #14168 : Global Function -> Static Method and __autoload() - Fixed bug #14238 : Line length not checket at last line of a file - Fixed bug #14249 : wrong detection of scope_opener - Fixed bug #14250 : ArrayDeclarationSniff emit warnings at malformed array - Fixed bug #14251 : --extensions option doesn't work 1.1.0RC2 1.1.0RC2 beta beta 2008-06-13 BSD License - Permission denied errors now stop script execution but still display current errors (feature request #14076) - Added Squiz ValidArrayIndexNameSniff to ensure array indexes do not use camel case - Squiz ArrayDeclarationSniff now ensures arrays are not declared with camel case index values - PEAR ValidVariableNameSniff now alerts about a possible parse error for member vars inside an interface - Fixed bug #13921 : js parsing fails for comments on last line of file - Fixed bug #13922 : crash in case of malformed (but tokenized) php file -- PEAR and Squiz ClassDeclarationSniff now throw warnings for possible parse errors -- Squiz ValidClassNameSniff now throws warning for possible parse errors -- Squiz ClosingDeclarationCommentSniff now throws additonal warnings for parse errors 1.1.0RC1 1.1.0RC1 beta beta 2008-05-13 BSD License - Added support for multiple tokenizers so PHP_CodeSniffer can check more than just PHP files -- PHP_CodeSniffer now has a JS tokenizer for checking JavaScript files -- Sniffs need to be updated to work with additional tokenizers, or new sniffs written for them - phpcs now exits with status 2 if the tokenier extension has been disabled (feature request #13269) - Added scripts/phpcs-svn-pre-commit that can be used as an SVN pre-commit hook -- Also reworked the way the phpcs script works to make it easier to wrap it with other functionality -- Thanks to Jack Bates for the contribution - Fixed error in phpcs error message when a supplied file does not exist - Fixed a cosmetic error in AbstractPatternSniff where the "found" string was missing some content - Added sniffs that implement part of the PMD rule catalog to the Generic standard -- Thanks to Manuel Pichler for the contribution of all these sniffs. - Squiz FunctionCommentThrowTagSniff no longer throws errors for function that only throw variables - Generic ScopeIndentSniff now has private member to enforce exact indent matching - Replaced Squiz DisallowCountInLoopsSniff with Squiz DisallowSizeFunctionsInLoopsSniff -- Thanks to Jan Miczaika for the sniff - Squiz BlockCommentSniff now checks inline doc block comments - Squiz InlineCommentSniff now checks inline doc block comments - Squiz BlockCommentSniff now checks for no blank line before first comment in a function - Squiz DocCommentAlignmentSniff now ignores inline doc block comments - Squiz ControlStructureSpacingSniff now ensures no blank lines at the start of control structures - Squiz ControlStructureSpacingSniff now ensures no blank lines between control structure closing braces - Squiz IncrementDecrementUsageSniff now ensures inc/dec ops are bracketed in string concats - Squiz IncrementDecrementUsageSniff now ensures inc/dec ops are not used in arithmetic operations - Squiz FunctionCommentSniff no longer throws errors if return value is mixed but function returns void somewhere - Squiz OperatorBracketSniff no allows function call brackets to count as operator brackets - Squiz DoubleQuoteUsageSniff now supports \x \f and \v (feature request #13365) - Squiz ComparisonOperatorUsageSniff now supports JS files - Squiz ControlSignatureSniff now supports JS files - Squiz ForLoopDeclarationSniff now supports JS files - Squiz OperatorBracketSniff now supports JS files - Squiz InlineControlStructureSniff now supports JS files - Generic LowerCaseConstantSniff now supports JS files - Generic DisallowTabIndentSniff now supports JS files - Generic MultipleStatementAlignmentSniff now supports JS files - Added Squiz ObjectMemberCommaSniff to ensure the last member of a JS object is not followed by a comma - Added Squiz ConstantCaseSniff to ensure the PHP constants are uppercase and JS lowercase - Added Squiz JavaScriptLintSniff to check JS files with JSL -- Set path using phpcs --config-set jsl_path /path/to/jsl - Added MySource FirebugConsoleSniff to ban the use of "console" for JS variable and function names - Added MySource JoinStringsSniff to enforce the use of join() to concatenate JS strings - Added MySource AssignThisSniff to ensure this is only assigned to a var called self - Added MySource DisallowNewWidgetSniff to ban manual creation of widget objects - Removed warning shown in Zend CodeAnalyzerSniff when the ZCA path is not set - Fixed error in Squiz ValidVariableNameSniff when checking vars in the form $obj->$var - Fixed error in Squiz DisallowMultipleAssignmentsSniff when checking vars in the form $obj->$var - Fixed error in Squiz InlineCommentSniff where comments for class constants were seen as inline - Fixed error in Squiz BlockCommentSniff where comments for class constants were not ignored - Fixed error in Squiz OperatorBracketSniff where negative numbers were ignored during comparisons - Fixed error in Squiz FunctionSpacingSniff where functions after member vars reported incorrect spacing - Fixed bug #13062 : Interface comments aren't handled in PEAR standard -- Thanks to Manuel Pichler for the path - Fixed bug #13119 : php minimum requirement need to be fix - Fixed bug #13156 : Bug in Squiz_Sniffs_PHP_NonExecutableCodeSniff - Fixed bug #13158 : Strange behaviour in AbstractPatternSniff - Fixed bug #13169 : Undefined variables - Fixed bug #13178 : Catch exception in File.php - Fixed bug #13254 : Notices output in checkstyle report causes XML issues - Fixed bug #13446 : crash with src of phpMyAdmin -- Thanks to Manuel Pichler for the path 1.1.0a1 1.1.0a1 alpha alpha 2008-04-21 BSD License - Fixed error in PEAR ValidClassNameSniff when checking class names with double underscores - Moved Squiz InlineControlStructureSniff into Generic standard - PEAR standard now throws warnings for inline control structures - Squiz OutputBufferingIndentSniff now ignores the indentation of inline HTML - MySource IncludeSystemSniff now ignores usage of ZipArchive - Removed "function" from error messages for Generic function brace sniffs (feature request #13820) - Generic UpperCaseConstantSniff no longer throws errors for delcare(ticks = ...) -- Thanks to Josh Snyder for the patch - Squiz ClosingDeclarationCommentSniff and AbstractVariableSniff now throw warnings for possible parse errors - Fixed bug #13827 : AbstractVariableSniff throws "undefined index" - Fixed bug #13846 : Bug in Squiz.NonExecutableCodeSniff - Fixed bug #13849 : infinite loop in PHP_CodeSniffer_File::findNext() 1.0.1 1.0.1 stable stable 2008-02-04 BSD License - Squiz ArrayDeclarationSniff now throws error if the array keyword is followed by a space - Squiz ArrayDeclarationSniff now throws error for empty multi-line arrays - Squiz ArrayDeclarationSniff now throws error for multi-line arrays with a single value - Squiz DocCommentAlignmentSniff now checks for a single space before tags inside docblocks - Squiz ForbiddenFunctionsSniff now disallows is_null() to force use of (=== NULL) instead - Squiz VariableCommentSniff now continues throwing errors after the first one is found - Squiz SuperfluousWhitespaceSniff now throws errors for multiple blank lines inside functions - MySource IncludedSystemSniff now checks extended class names - MySource UnusedSystemSniff now checks extended and implemented class names - MySource IncludedSystemSniff now supports includeWidget() - MySource UnusedSystemSniff now supports includeWidget() - Added PEAR ValidVariableNameSniff to check that only private member vars are prefixed with an underscore - Added Squiz DisallowCountInLoopsSniff to check for the use of count() in FOR and WHILE loop conditions - Added MySource UnusedSystemSniff to check for included classes that are never used - Fixed a problem that caused the parentheses map to sometimes contain incorrect values - Fixed bug #12767 : Cant run phpcs from dir with PEAR subdir - Fixed bug #12773 : Reserved variables are not detected in strings -- Thanks to Wilfried Loche for the patch - Fixed bug #12832 : Tab to space conversion does not work - Fixed bug #12888 : extra space indentation = Notice: Uninitialized string offset... - Fixed bug #12909 : Default generateDocs function does not work under linux -- Thanks to Paul Smith for the patch - Fixed bug #12957 : PHP 5.3 magic method __callStatic -- Thanks to Manuel Pichler for the patch 1.0.0 1.0.0 stable stable 2007-12-21 BSD License - You can now specify the full path to a coding standard on the command line (feature request #11886) -- This allows you to use standards that are stored outside of PHP_CodeSniffer's own Standard dir -- You can also specify full paths in the CodingStandard.php include and exclude methods -- Classes, dirs and files need to be names as if the standard was part of PHP_CodeSniffer -- Thanks to Dirk Thomas for the doc generator patch and testing - Modified the scope map to keep checking after 3 lines for some tokens (feature request #12561) -- Those tokens that must have an opener (like T_CLASS) now keep looking until EOF -- Other tokens (like T_FUNCTION) still stop after 3 lines for performance - You can now esacpe commas in ignore patterns so they can be matched in file names -- Thanks to Carsten Wiedmann for the patch - Config data is now cached in a global var so the file system is not hit so often -- You can also set config data temporarily for the script if you are using your own external script -- Pass TRUE as the third argument to PHP_CodeSniffer::setConfigData() - PEAR ClassDeclarationSniff no longer throws errors for multi-line class declarations - Squiz ClassDeclarationSniff now ensures there is one blank line after a class closing brace - Squiz ClassDeclarationSniff now throws errors for a missing end PHP tag after the end class tag - Squiz IncrementDecrementUsageSniff no longer throws errors when -= and += are being used with vars - Squiz SwitchDeclarationSniff now throws errors for switch statements that do not contain a case statement -- Thanks to Sertan Danis for the patch - MySource IncludeSystemSniff no longer throws errors for the Util package - Fixed bug #12621 : "space after AS" check is wrong -- Thanks to Satoshi Oikawa for the patch - Fixed bug #12645 : error message is wrong -- Thanks to Renoiv for the patch - Fixed bug #12651 : Increment/Decrement Operators Usage at -1 1.0.0RC3 1.0.0RC3 beta beta 2007-11-30 BSD License - Added new command line argument --tab-width that will convert tabs to spaces before testing -- This allows you to use the existing sniffs that check for spaces even when you use tabs -- Can also be set via a config var: phpcs --config-set tab_width 4 -- A value of zero (the default) tells PHP_CodeSniffer not to replace tabs with spaces - You can now change the default report format from "full" to something else -- Run: phpcs --config-set report_format [format] - Improved performance by optimising the way the scope map is created during tokenising - Added new Squiz DisallowInlineIfSniff to disallow the usage of inline IF statements - Fixed incorrect errors being thrown for nested switches in Squiz SwitchDeclarationSniff - PEAR FunctionCommentSniff no longer complains about missing comments for @throws tags - PEAR FunctionCommentSniff now throws error for missing exception class name for @throws tags - PHP_CodeSniffer_File::isReference() now correctly returns for functions that return references - Generic LineLengthSniff no longer warns about @version lines with CVS or SVN id tags - Generic LineLengthSniff no longer warns about @license lines with long URLs - Squiz FunctionCommentThrowTagSniff no longer complains about throwing variables - Squiz ComparisonOperatorUsageSniff no longer throws incorrect errors for inline IF statements - Squiz DisllowMultipleAssignmentsSniff no longer throws errors for assignments in inline IF statements - Fixed bug #12455 : CodeSniffer treats content inside heredoc as PHP code - Fixed bug #12471 : Checkstyle report is broken - Fixed bug #12476 : PHP4 destructors are reported as error - Fixed bug #12513 : Checkstyle XML messages need to be utf8_encode()d -- Thanks to Sebastian Bergmann for the patch. - Fixed bug #12517 : getNewlineAfter() and dos files 1.0.0RC2 1.0.0RC2 beta beta 2007-11-14 BSD License - Added a new Checkstyle report format -- Like the current XML format but modified to look like Checkstyle output -- Thanks to Manuel Pichler for helping get the format correct - You can now hide warnings by default -- Run: phpcs --config-set show_warnings 0 -- If warnings are hidden by default, use the new -w command line argument to override - Added new command line argument --config-delete to delete a config value and revert to the default - Improved overall performance by optimising tokenising and next/prev methods (feature request #12421) -- Thanks to Christian Weiske for the patch - Added FunctionCallSignatureSniff to Squiz standard - Added @subpackage support to file and class comment sniffs in PEAR standard (feature request #12382) -- Thanks to Carsten Wiedmann for the patch - An error is now displayed if you use a PHP version less than 5.1.0 (feature request #12380) -- Thanks to Carsten Wiedmann for the patch - phpcs now exits with status 2 if it receives invalid input (feature request #12380) -- This is distinct from status 1, which indicates errors or warnings were found - Added new Squiz LanguageConstructSpacingSniff to throw errors for additional whitespace after echo etc. - Removed Squiz ValidInterfaceNameSniff - PEAR FunctionCommentSniff no longer complains about unknown tags - Fixed incorrect errors about missing function comments in PEAR FunctionCommentSniff - Fixed incorrect function docblock detection in Squiz FunctionCommentSniff - Fixed incorrect errors for list() in Squiz DisallowMultipleAssignmentsSniff - Errors no longer thrown if control structure is followed by a CASE's BREAK in Squiz ControlStructureSpacingSniff - Fixed bug #12368 : Autoloader cannot be found due to include_path override -- Thanks to Richard Quadling for the patch - Fixed bug #12378 : equal sign alignments problem with while() 1.0.0RC1 1.0.0RC1 beta beta 2007-11-01 BSD License - Main phpcs script can now be run from a CVS checkout without installing the package - Added a new CSV report format -- Header row indicates what position each element is in -- Always use the header row to determine positions rather than assuming the format, as it may change - XML and CSV report formats now contain information about which column the error occurred at -- Useful if you want to highlight the token that caused the error in a custom application - Square bracket tokens now have bracket_opener and bracket_closer set - Added new Squiz SemicolonSpacingSniff to throw errors if whitespace is found before a semicolon - Added new Squiz ArrayBracketSpacingSniff to throw errors if whitespace is found around square brackets - Added new Squiz ObjectOperatorSpacingSniff to throw errors if whitespace is found around object operators - Added new Squiz DisallowMultipleAssignmentsSniff to throw errors if multiple assignments are on the same line - Added new Squiz ScopeKeywordSpacingSniff to throw errors if there is not a single space after a scope modifier - Added new Squiz ObjectInstantiationSniff to throw errors if new objects are not assigned to a variable - Added new Squiz FunctionDuplicateArgumentSniff to throw errors if argument is declared multiple times in a function - Added new Squiz FunctionOpeningBraceSpaceSniff to ensure there are no blank lines after a function open brace - Added new Squiz CommentedOutCodeSniff to warn about comments that looks like they are commented out code blocks - Added CyclomaticComplexitySniff to Squiz standard - Added NestingLevelSniff to Squiz standard - Squiz ForbiddenFunctionsSniff now recommends echo() instead of print() - Squiz ValidLogicalOperatorsSniff now recommends ^ instead of xor - Squiz SwitchDeclarationSniff now contains more checks -- A single space is required after the case keyword -- No space is allowed before the colon in a case or default statement -- All switch statements now require a default case -- Default case must contain a break statement -- Empty default case must contain a comment describing why the default is ignored -- Empty case statements are not allowed -- Case and default statements must not be followed by a blank line -- Break statements must be followed by a blank line or the closing brace -- There must be no blank line before a break statement - Squiz standard is now using the PEAR IncludingFileSniff - PEAR ClassCommentSniff no longer complains about unknown tags - PEAR FileCommentSniff no longer complains about unknown tags - PEAR FileCommentSniff now accepts multiple @copyright tags - Squiz BlockCommentSniff now checks that comment starts with a capital letter - Squiz InlineCommentSniff now has better checking to ensure comment starts with a capital letter - Squiz ClassCommentSniff now checks that short and long comments start with a capital letter - Squiz FunctionCommentSniff now checks that short, long and param comments start with a capital letter - Squiz VariableCommentSniff now checks that short and long comments start with a capital letter - Fixed error with multi-token array indexes in Squiz ArrayDeclarationSniff - Fixed error with checking shorthand IF statements without a semicolon in Squiz InlineIfDeclarationSniff - Fixed error where constants used as defulat values in function declarations were seen as type hints - Fixed bug #12316 : PEAR is no longer the default standard - Fixed bug #12321 : wrong detection of missing function docblock 0.9.0 0.9.0 beta beta 2007-09-24 BSD License - Added a config system for setting config data across phpcs runs - You can now change the default coding standard from PEAR to something else -- Run: phpcs --config-set default_standard [standard] - Added new Zend coding standard to check code against the Zend Framework standards -- The complete standard is not yet implemented -- Specify --standard=Zend to use -- Thanks to Johann-Peter Hartmann for the contribution of some sniffs -- Thanks to Holger Kral for the Code Analyzer sniff 0.8.0 0.8.0 beta beta 2007-08-08 BSD License - Added new XML report format; --report=xml (feature request #11535) -- Thanks to Brett Bieber for the patch - Added new command line argument --ignore to specify a list of files to skip (feature request #11556) - Added PHPCS and MySource coding standards into the core install - Scope map no longer gets confused by curly braces that act as string offsets - Removed CodeSniffer/SniffException.php as it is no longer used - Unit tests can now be run directly from a CVS checkout - Made private vars and functions protected in PHP_CodeSniffer class so this package can be overridden - Added new Metrics category to Generic coding standard -- Contains Cyclomatic Complexity and Nesting Level sniffs -- Thanks to Johann-Peter Hartmann for the contribution - Added new Generic DisallowTabIndentSniff to throw errors if tabs are used for indentation (feature request #11738) -- PEAR and Squiz standards use this new sniff to throw more specific indentation errors - Generic MultipleStatementAlignmentSniff has new private var to set a padding size limit (feature request #11555) - Generic MultipleStatementAlignmentSniff can now handle assignments that span multiple lines (feature request #11561) - Generic LineLengthSniff now has a max line length after which errors are thrown instead of warnings -- BC BREAK: Override the protected member var absoluteLineLimit and set it to zero in custom LineLength sniffs -- Thanks to Johann-Peter Hartmann for the contribution - Comment sniff errors about incorrect tag orders are now more descriptive (feature request #11693) - Fixed bug #11473 : Invalid CamelCaps name when numbers used in names 0.7.0 0.7.0 beta beta 2007-07-02 BSD License - BC BREAK: EOL character is now auto-detected and used instead of hard-coded \n -- Pattern sniffs must now specify "EOL" instead of "\n" or "\r\n" to use auto-detection -- Please use $phpcsFile->eolChar to check for newlines instead of hard-coding "\n" or "\r\n" -- Comment parser classes now require you to pass $phpcsFile as an additional argument - BC BREAK: Included and excluded sniffs now require .php extension -- Please update your coding standard classes and add ".php" to all sniff entries -- See CodeSniffer/Standards/PEAR/PEARCodingStandard.php for an example - Fixed error where including a directory of sniffs in a coding standard class did not work - Coding standard classes can now specify a list of sniffs to exclude as well as include (feature request #11056) - Two uppercase characters can now be placed side-by-side in class names in Squiz ValidClassNameSniff - SVN tags now allowed in PEAR file doc blocks (feature request #11038) -- Thanks to Torsten Roehr for the patch - Private methods in commenting sniffs and comment parser are now protected (feature request #11087) - Added Generic LineEndingsSniff to check the EOL character of a file - PEAR standard now only throws one error per file for incorrect line endings (eg. /r/n) - Command line arg -v now shows number of registered sniffs - Command line arg -vvv now shows list of registered sniffs - Squiz ControlStructureSpacingSniff no longer throws errors if the control structure is at the end of the script - Squiz FunctionCommentSniff now throws error for "return void" if function has return statement - Squiz FunctionCommentSniff now throws error for functions that return void but specify something else - Squiz ValidVariableNameSniff now allows multiple uppercase letters in a row - Squiz ForEachLoopDeclarationSniff now throws error for AS keyword not being lowercase - Squiz SwitchDeclarationSniff now throws errors for CASE/DEFAULT/BREAK keywords not being lowercase - Squiz ArrayDeclarationSniff now handles multi-token array values when checking alignment - Squiz standard now enforces a space after cast tokens - Generic MultipleStatementAlignmentSniff no longer gets confused by assignments inside FOR conditions - Generic MultipleStatementAlignmentSniff no longer gets confused by the use of list() - Added Generic SpaceAfterCastSniff to ensure there is a single space after a cast token - Added Generic NoSpaceAfterCastSniff to ensure there is no whitespace after a cast token - Added PEAR ClassDeclarationSniff to ensure the opening brace of a class is on the line after the keyword - Added Squiz ScopeClosingBraceSniff to ensure closing braces are aligned correctly - Added Squiz EvalSniff to discourage the use of eval() - Added Squiz LowercaseDeclarationSniff to ensure all declaration keywords are lowercase - Added Squiz LowercaseClassKeywordsSniff to ensure all class declaration keywords are lowercase - Added Squiz LowercaseFunctionKeywordsSniff to ensure all function declaration keywords are lowercase - Added Squiz LowercasePHPFunctionsSniff to ensure all calls to inbuilt PHP functions are lowercase - Added Squiz CastSpacingSniff to ensure cast statements dont contain whitespace - Errors no longer thrown when checking 0 length files with verbosity on - Fixed bug #11105 : getIncludedSniffs() not working anymore -- Thanks to Blair Robertson for the patch - Fixed bug #11120 : Uninitialized string offset in AbstractParser.php on line 200 0.6.0 0.6.0 beta beta 2007-05-15 BSD License - The number of errors and warnings found is now shown for each file while checking the file if verbosity is enabled - Now using PHP_EOL instead of hard-coded \n so output looks good on Windows (feature request #10761) - Thanks to Carsten Wiedmann for the patch. - phpcs now exits with status 0 (no errors) or 1 (errors found) (feature request #10348) - Added new -l command line argument to stop recursion into directories (feature request #10979) - Fixed variable name error causing incorrect error message in Squiz ValidVariableNameSniff - Fixed bug #10757 : Error in ControlSignatureSniff - Fixed bugs #10751, #10777 : Sniffer class paths handled incorrectly in Windows - Thanks to Carsten Wiedmann for the patch. - Fixed bug #10961 : Error "Last parameter comment requires a blank newline after it" thrown - Fixed bug #10983 : phpcs outputs notices when checking invalid PHP - Fixed bug #10980 : Incorrect warnings for equals sign 0.5.0 0.5.0 beta beta 2007-04-17 BSD License - BC BREAK: Coding standards now require a class to be added so PHP_CodeSniffer can get information from them - Please read the end user docs for info about the new class required for all coding standards - Coding standards can now include sniffs from other standards, or whole standards, without writing new sniff files - PHP_CodeSniffer_File::isReference() now correctly returns for references in function declarations - PHP_CodeSniffer_File::isReference() now returns false if you don't pass it a T_BITWISE_AND token - PHP_CodeSniffer_File now stores the absolute path to the file so sniffs can check file locations correctly - Fixed undefined index error in AbstractVariableSniff for variables inside an interface function definition - Added MemberVarSpacingSniff to Squiz standard to enforce one-line spacing between member vars - Add FunctionCommentThrowTagSniff to Squiz standard to check that @throws tags are correct - Fixed problems caused by references and type hints in Squiz FunctionDeclarationArgumentSpacingSniff - Fixed problems with errors not being thrown for some misaligned @param comments in Squiz FunctionCommentSniff - Fixed badly spaced comma error being thrown for "extends" class in Squiz ClassDeclarationSniff - Errors no longer thrown for class method names in Generic ForbiddenFunctionsSniff - Errors no longer thrown for type hints in front of references in Generic UpperCaseConstantNameSniff - Errors no longer thrown for correctly indented buffered lines in Squiz ScopeIndexSniff - Errors no longer thrown for user-defined functions named as forbidden functions in Generic ForbiddenFunctionsSniff - Errors no longer thrown on __autoload functions in PEAR ValidFunctionNameSniff - Errors now thrown for __autoload methods in PEAR ValidFunctionNameSniff - Errors now thrown if constructors or destructors have @return tags in Squiz FunctionCommentSniff - Errors now thrown if @throws tags dont start with a capital and end with a full stop in Squiz FunctionCommentSniff - Errors now thrown for invalid @var tag values in Squiz VariableCommentSniff - Errors now thrown for missing doc comment in Squiz VariableCommentSniff - Errors now thrown for unspaced operators in FOR loop declarations in Squiz OperatorSpacingSniff - Errors now thrown for using ob_get_clean/flush functions to end buffers in Squiz OutputBufferingIndentSniff - Errors now thrown for all missing member variable comments in Squiz VariableCommentSniff 0.4.0 0.4.0 beta beta 2007-02-19 BSD License - Standard name specified with --standard command line argument is no longer case sensitive - Long error and warning messages are now wrapped to 80 characters in the full error report (thanks Endre Czirbesz) - Shortened a lot of error and warning messages so they don't take up so much room - Squiz FunctionCommentSniff now checks that param comments start with a capital letter and end with a full stop - Squiz FunctionSpacingSniff now reports incorrect lines below function on closing brace, not function keyword - Squiz FileCommentSniff now checks that there are no blank lines between the open PHP tag and the comment - PHP_CodeSniffer_File::isReference() now returns correctly when checking refs on right side of => - Fixed incorrect error with switch closing brace in Squiz SwitchDeclarationSniff - Fixed missing error when multiple statements are not aligned correctly with object operators - Fixed incorrect errors for some PHP special variables in Squiz ValidVariableNameSniff - Fixed incorrect errors for arrays that only contain other arrays in Squiz ArrayDeclarationSniff - Fixed bug #9844 : throw new Exception(\n accidently reported as error but it ain't 0.3.0 0.3.0 beta beta 2007-01-11 BSD License - Updated package.xml to version 2 - Specifying coding standard on command line is now optional, even if you have multiple standards installed - PHP_CodeSniffer uses the PEAR coding standard by default if no standard is specified - New command line option, --extensions, to specify a comma separated list of file extensions to check - Converted all unit tests to PHPUnit 3 format - Added new coding standard, Squiz, that can be used as an alternative to PEAR - also contains more examples of sniffs - some may be moved into the Generic coding standard if required - Added MultipleStatementAlignmentSniff to Generic standard - Added ScopeIndentSniff to Generic standard - Added ForbiddenFunctionsSniff to Generic standard - Added FileCommentSniff to PEAR standard - Added ClassCommentSniff to PEAR standard - Added FunctionCommentSniff to PEAR standard - Change MultipleStatementSniff to MultipleStatementAlignmentSniff in PEAR standard - Replaced Methods directory with Functions directory in Generic and PEAR standards - also renamed some of the sniffs in those directories - Updated file, class and method comments for all files - Fixed bug #9274 : nested_parenthesis element not set for open and close parenthesis tokens - Fixed bug #9411 : too few pattern characters cause incorrect error report 0.2.1 0.2.1 alpha alpha 2006-11-09 BSD License - Fixed bug #9274 : nested_parenthesis element not set for open and close parenthesis tokens 0.2.0 0.2.0 alpha alpha 2006-10-13 BSD License - Added a generic standards package that will contain generic sniffs to be used in specific coding standards - thanks to Frederic Poeydomenge for the idea - Changed PEAR standard to use generic sniffs where available - Added LowerCaseConstantSniff to Generic standard - Added UpperCaseConstantSniff to Generic standard - Added DisallowShortOpenTagSniff to Generic standard - Added LineLengthSniff to Generic standard - Added UpperCaseConstantNameSniff to Generic standard - Added OpeningMethodBraceBsdAllmanSniff to Generic standard (contrib by Frederic Poeydomenge) - Added OpeningMethodBraceKernighanRitchieSniff to Generic standard (contrib by Frederic Poeydomenge) - Added framework for core PHP_CodeSniffer unit tests - Added unit test for PHP_CodeSniffer:isCamelCaps method - ScopeClosingBraceSniff now checks indentation of BREAK statements - Added new command line arg (-vv) to show developer debug output - Fixed some coding standard errors - Fixed bug #8834 : Massive memory consumption - Fixed bug #8836 : path case issues in package.xml - Fixed bug #8843 : confusion on nested switch() - Fixed bug #8841 : comments taken as whitespace - Fixed bug #8884 : another problem with nested switch() statements 0.1.1 0.1.1 alpha alpha 2006-09-25 BSD License - Added unit tests for all PEAR sniffs - Exception class now extends from PEAR_Exception - Fixed summary report so files without errors but with warnings are not shown when warnings are hidden 0.1.0 0.1.0 alpha alpha 2006-09-19 BSD License - Reorganised package contents to conform to PEAR standards - Changed version numbering to conform to PEAR standards - Removed duplicate require_once() of Exception.php from CodeSniffer.php 0.0.5 0.0.5 alpha alpha 2006-09-18 BSD License - Fixed .bat file for situation where php.ini cannot be found so include_path is not set 0.0.4 0.0.4 alpha alpha 2006-08-28 BSD License - Added .bat file for easier running of PHP_CodeSniffer on Windows - Sniff that checks method names now works for PHP4 style code where there is no scope keyword - Sniff that checks method names now works for PHP4 style constructors - Sniff that checks method names no longer incorrectly reports error with magic methods - Sniff that checks method names now reports errors with non-magic methods prefixed with __ - Sniff that checks for constant names no longer incorrectly reports errors with heredoc strings - Sniff that checks for constant names no longer incorrectly reports errors with created objects - Sniff that checks indentation no longer incorrectly reports errors with heredoc strings - Sniff that checks indentation now correctly reports errors with improperly indented multi-line strings - Sniff that checks function declarations now checks for spaces before and after an equals sign for default values - Sniff that checks function declarations no longer incorrectly reports errors with multi-line declarations - Sniff that checks included code no longer incorrectly reports errors when return value is used conditionally - Sniff that checks opening brace of function no longer incorrectly reports errors with multi-line declarations - Sniff that checks spacing after commas in function calls no longer reports too many errors for some code - Sniff that checks control structure declarations now gives more descriptive error message 0.0.3 0.0.3 alpha alpha 2006-08-22 BSD License - Added sniff to check for invalid class and interface names - Added sniff to check for invalid function and method names - Added sniff to warn if line is greater than 85 characters - Added sniff to check that function calls are in the correct format - Fixed error where comments were not allowed on the same line as a control structure declaration - Added command line arg to print current version (--version) 0.0.2 0.0.2 alpha alpha 2006-07-25 BSD License - Removed the including of checked files to stop errors caused by parsing them - Removed the use of reflection so checked files do not have to be included - Memory usage has been greatly reduced - Much faster tokenising and checking times - Reworked the PEAR coding standard sniffs (much faster now) - Fix some bugs with the PEAR scope indentation standard - Better checking for installed coding standards - Can now accept multiple files and dirs on the command line - Added an option to list installed coding standards - Added an option to print a summary report (number of errors and warnings shown for each file) - Added an option to hide warnings from reports - Added an option to print verbose output (so you know what is going on) - Reordered command line args to put switches first (although order is not enforced) - Switches can now be specified together (eg. php -nv) as well as separately (phpcs -n -v) 0.0.1 0.0.1 alpha alpha 2006-07-19 BSD License Initial preview release. PHP_CodeSniffer-2.5.1/scripts/phpcbf0000755000076700000240000000120012647543456017173 0ustar gsherwoodstaff#!/usr/bin/env php * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (is_file(dirname(__FILE__).'/../CodeSniffer/CLI.php') === true) { include_once dirname(__FILE__).'/../CodeSniffer/CLI.php'; } else { include_once 'PHP/CodeSniffer/CLI.php'; } $cli = new PHP_CodeSniffer_CLI(); $cli->runphpcbf(); PHP_CodeSniffer-2.5.1/scripts/phpcs0000755000076700000240000000136612647543456017063 0ustar gsherwoodstaff#!/usr/bin/env php * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (is_file(dirname(__FILE__).'/../CodeSniffer/CLI.php') === true) { include_once dirname(__FILE__).'/../CodeSniffer/CLI.php'; } else { include_once 'PHP/CodeSniffer/CLI.php'; } $cli = new PHP_CodeSniffer_CLI(); $cli->runphpcs(); PHP_CodeSniffer-2.5.1/scripts/phpcs-svn-pre-commit0000755000076700000240000001654512647543456021746 0ustar gsherwoodstaff#!@php_bin@ * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (is_file(dirname(__FILE__).'/../CodeSniffer/CLI.php') === true) { include_once dirname(__FILE__).'/../CodeSniffer/CLI.php'; } else { include_once 'PHP/CodeSniffer/CLI.php'; } define('PHP_CODESNIFFER_SVNLOOK', '/usr/bin/svnlook'); /** * A class to process command line options. * * @category PHP * @package PHP_CodeSniffer * @author Jack Bates * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: @package_version@ * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_SVN_Hook extends PHP_CodeSniffer_CLI { /** * Get a list of default values for all possible command line arguments. * * @return array */ public function getDefaults() { $defaults = parent::getDefaults(); $defaults['svnArgs'] = array(); return $defaults; }//end getDefaults() /** * Processes an unknown command line argument. * * Assumes all unknown arguments are files and folders to check. * * @param string $arg The command line argument. * @param int $pos The position of the argument on the command line. * * @return void */ public function processUnknownArgument($arg, $pos) { $this->values['svnArgs'][] = escapeshellarg($arg); }//end processUnknownArgument() /** * Runs PHP_CodeSniffer over files are directories. * * @param array $values An array of values determined from CLI args. * * @return int The number of error and warning messages shown. * @see getCommandLineValues() */ public function process($values=array()) { if (empty($values) === true) { $values = $this->getCommandLineValues(); } else { $values = array_merge($this->getDefaults(), $values); $this->values = $values; } // Get list of files in this transaction. $command = PHP_CODESNIFFER_SVNLOOK.' changed '.implode(' ', $values['svnArgs']); $handle = popen($command, 'r'); if ($handle === false) { echo 'ERROR: Could not execute "'.$command.'"'.PHP_EOL.PHP_EOL; exit(2); } $contents = stream_get_contents($handle); fclose($handle); // Do not check deleted paths. $contents = preg_replace('/^D.*/m', null, $contents); // Drop the four characters representing the action which precede the path on // each line. $contents = preg_replace('/^.{4}/m', null, $contents); $values['standard'] = $this->validateStandard($values['standard']); foreach ($values['standard'] as $standard) { if (PHP_CodeSniffer::isInstalledStandard($standard) === false) { // They didn't select a valid coding standard, so help them // out by letting them know which standards are installed. echo 'ERROR: the "'.$standard.'" coding standard is not installed. '; $this->printInstalledStandards(); exit(2); } } $phpcs = new PHP_CodeSniffer( $values['verbosity'], $values['tabWidth'], $values['encoding'] ); // Set file extensions if they were specified. Otherwise, // let PHP_CodeSniffer decide on the defaults. if (empty($values['extensions']) === false) { $phpcs->setAllowedFileExtensions($values['extensions']); } else { $phpcs->setAllowedFileExtensions(array_keys($phpcs->defaultFileExtensions)); } // Set ignore patterns if they were specified. if (empty($values['ignored']) === false) { $phpcs->setIgnorePatterns($values['ignored']); } // Set some convenience member vars. if ($values['errorSeverity'] === null) { $this->errorSeverity = PHPCS_DEFAULT_ERROR_SEV; } else { $this->errorSeverity = $values['errorSeverity']; } if ($values['warningSeverity'] === null) { $this->warningSeverity = PHPCS_DEFAULT_WARN_SEV; } else { $this->warningSeverity = $values['warningSeverity']; } if (empty($values['reports']) === true) { $this->values['reports']['full'] = $values['reportFile']; } // Initialize PHP_CodeSniffer listeners but don't process any files. $phpcs->setCli($this); $phpcs->initStandard($values['standard'], $values['sniffs']); // Need double quotes around the following regex beause the vertical whitespace // char is not always treated correctly for whatever reason. foreach (preg_split("/\v|\n/", $contents, -1, PREG_SPLIT_NO_EMPTY) as $path) { // No need to process folders as each changed file is checked. if (substr($path, -1) === '/') { continue; } // We need to check ignore rules ourself because they are // not checked when processing a single file. if ($phpcs->shouldProcessFile($path, dirname($path)) === false) { continue; } // Get the contents of each file, as it would be after this transaction. $command = PHP_CODESNIFFER_SVNLOOK.' cat '.implode(' ', $values['svnArgs']).' '.escapeshellarg($path); $handle = popen($command, 'r'); if ($handle === false) { echo 'ERROR: Could not execute "'.$command.'"'.PHP_EOL.PHP_EOL; exit(2); } $contents = stream_get_contents($handle); fclose($handle); $phpcs->processFile($path, $contents); }//end foreach return $this->printErrorReport( $phpcs, $values['reports'], $values['showSources'], $values['reportFile'], $values['reportWidth'] ); }//end process() /** * Prints out the usage information for this script. * * @return void */ public function printUsage() { parent::printUsage(); echo PHP_EOL; echo ' Each additional argument is passed to the `svnlook changed ...`'.PHP_EOL; echo ' and `svnlook cat ...` commands. The report is printed on standard output,'.PHP_EOL; echo ' however Subversion displays only standard error to the user, so in a'.PHP_EOL; echo ' pre-commit hook, this script should be invoked as follows:'.PHP_EOL; echo PHP_EOL; echo ' '.basename($_SERVER['argv'][0]).' ... "$REPOS" -t "$TXN" >&2 || exit 1'.PHP_EOL; }//end printUsage() }//end class $phpcs = new PHP_CodeSniffer_SVN_Hook(); PHP_CodeSniffer_Reporting::startTiming(); $phpcs->checkRequirements(); $numErrors = $phpcs->process(); if ($numErrors !== 0) { exit(1); } PHP_CodeSniffer-2.5.1/scripts/phpcs.bat0000755000076700000240000000131312647543456017620 0ustar gsherwoodstaff@echo off REM PHP_CodeSniffer tokenizes PHP code and detects violations of a REM defined set of coding standards. REM REM PHP version 5 REM REM @category PHP REM @package PHP_CodeSniffer REM @author Greg Sherwood REM @author Marc McIntyre REM @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) REM @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence REM @link http://pear.php.net/package/PHP_CodeSniffer if "%PHPBIN%" == "" set PHPBIN=@php_bin@ if not exist "%PHPBIN%" if "%PHP_PEAR_PHP_BIN%" neq "" goto USE_PEAR_PATH GOTO RUN :USE_PEAR_PATH set PHPBIN=%PHP_PEAR_PHP_BIN% :RUN "%PHPBIN%" "@bin_dir@\phpcs" %*PHP_CodeSniffer-2.5.1/scripts/phpcbf.bat0000644000076700000240000000112312647543456017741 0ustar gsherwoodstaff@echo off REM PHP Code Beautifier and Fixer REM REM PHP version 5 REM REM @category PHP REM @package PHP_CodeSniffer REM @author Greg Sherwood REM @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) REM @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence REM @link http://pear.php.net/package/PHP_CodeSniffer if "%PHPBIN%" == "" set PHPBIN=@php_bin@ if not exist "%PHPBIN%" if "%PHP_PEAR_PHP_BIN%" neq "" goto USE_PEAR_PATH GOTO RUN :USE_PEAR_PATH set PHPBIN=%PHP_PEAR_PHP_BIN% :RUN "%PHPBIN%" "@bin_dir@\phpcbf" %*PHP_CodeSniffer-2.5.1/tests/Core/File/GetMethodParametersTest.php0000644000076700000240000001764112647543456024522 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Tests for the PHP_CodeSniffer_File:getMethodParameters method. * * @category PHP * @package PHP_CodeSniffer * @author Anti Veeranna * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Core_File_GetMethodParametersTest extends PHPUnit_Framework_TestCase { /** * The PHP_CodeSniffer_File object containing parsed contents of this file. * * @var PHP_CodeSniffer_File */ private $_phpcsFile; /** * Initialize & tokenize PHP_CodeSniffer_File with code from this file. * * Methods used for these tests can be found at the bottom of * this file. * * @return void */ public function setUp() { $phpcs = new PHP_CodeSniffer(); $this->_phpcsFile = new PHP_CodeSniffer_File( __FILE__, array(), array(), $phpcs ); $contents = file_get_contents(__FILE__); $this->_phpcsFile->start($contents); }//end setUp() /** * Clean up after finished test. * * @return void */ public function tearDown() { unset($this->_phpcsFile); }//end tearDown() /** * Verify pass-by-reference parsing. * * @return void */ public function testPassByReference() { $expected = array(); $expected[0] = array( 'name' => '$var', 'pass_by_reference' => true, 'variable_length' => false, 'type_hint' => '', ); $start = ($this->_phpcsFile->numTokens - 1); $function = $this->_phpcsFile->findPrevious( T_COMMENT, $start, null, false, '/* testPassByReference */' ); $found = $this->_phpcsFile->getMethodParameters(($function + 2)); $this->assertSame($expected, $found); }//end testPassByReference() /** * Verify array hint parsing. * * @return void */ public function testArrayHint() { $expected = array(); $expected[0] = array( 'name' => '$var', 'pass_by_reference' => false, 'variable_length' => false, 'type_hint' => 'array', ); $start = ($this->_phpcsFile->numTokens - 1); $function = $this->_phpcsFile->findPrevious( T_COMMENT, $start, null, false, '/* testArrayHint */' ); $found = $this->_phpcsFile->getMethodParameters(($function + 2)); $this->assertSame($expected, $found); }//end testArrayHint() /** * Verify type hint parsing. * * @return void */ public function testTypeHint() { $expected = array(); $expected[0] = array( 'name' => '$var1', 'pass_by_reference' => false, 'variable_length' => false, 'type_hint' => 'foo', ); $expected[1] = array( 'name' => '$var2', 'pass_by_reference' => false, 'variable_length' => false, 'type_hint' => 'bar', ); $start = ($this->_phpcsFile->numTokens - 1); $function = $this->_phpcsFile->findPrevious( T_COMMENT, $start, null, false, '/* testTypeHint */' ); $found = $this->_phpcsFile->getMethodParameters(($function + 2)); $this->assertSame($expected, $found); }//end testTypeHint() /** * Verify variable. * * @return void */ public function testVariable() { $expected = array(); $expected[0] = array( 'name' => '$var', 'pass_by_reference' => false, 'variable_length' => false, 'type_hint' => '', ); $start = ($this->_phpcsFile->numTokens - 1); $function = $this->_phpcsFile->findPrevious( T_COMMENT, $start, null, false, '/* testVariable */' ); $found = $this->_phpcsFile->getMethodParameters(($function + 2)); $this->assertSame($expected, $found); }//end testVariable() /** * Verify default value parsing with a single function param. * * @return void */ public function testSingleDefaultValue() { $expected = array(); $expected[0] = array( 'name' => '$var1', 'default' => 'self::CONSTANT', 'pass_by_reference' => false, 'variable_length' => false, 'type_hint' => '', ); $start = ($this->_phpcsFile->numTokens - 1); $function = $this->_phpcsFile->findPrevious( T_COMMENT, $start, null, false, '/* testSingleDefaultValue */' ); $found = $this->_phpcsFile->getMethodParameters(($function + 2)); $this->assertSame($expected, $found); }//end testSingleDefaultValue() /** * Verify default value parsing. * * @return void */ public function testDefaultValues() { $expected = array(); $expected[0] = array( 'name' => '$var1', 'default' => '1', 'pass_by_reference' => false, 'variable_length' => false, 'type_hint' => '', ); $expected[1] = array( 'name' => '$var2', 'default' => "'value'", 'pass_by_reference' => false, 'variable_length' => false, 'type_hint' => '', ); $start = ($this->_phpcsFile->numTokens - 1); $function = $this->_phpcsFile->findPrevious( T_COMMENT, $start, null, false, '/* testDefaultValues */' ); $found = $this->_phpcsFile->getMethodParameters(($function + 2)); $this->assertSame($expected, $found); }//end testDefaultValues() }//end class // @codingStandardsIgnoreStart /* testPassByReference */ function passByReference(&$var) {} /* testArrayHint */ function arrayHint(array $var) {} /* testVariable */ function variable($var) {} /* testSingleDefaultValue */ function defaultValue($var1=self::CONSTANT) {} /* testDefaultValues */ function defaultValues($var1=1, $var2='value') {} /* testTypeHint */ function typeHint(foo $var1, bar $var2) {} // @codingStandardsIgnoreEnd ?> PHP_CodeSniffer-2.5.1/tests/Core/AllTests.php0000644000076700000240000000412712647543456020625 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (defined('PHP_CODESNIFFER_IN_TESTS') === false) { define('PHP_CODESNIFFER_IN_TESTS', true); } require_once 'IsCamelCapsTest.php'; require_once 'ErrorSuppressionTest.php'; require_once 'File/GetMethodParametersTest.php'; if (is_file(dirname(__FILE__).'/../../CodeSniffer.php') === true) { // We are not installed. include_once dirname(__FILE__).'/../../CodeSniffer.php'; } else { include_once 'PHP/CodeSniffer.php'; } /** * A test class for testing the core. * * Do not run this file directly. Run the AllSniffs.php file in the root * testing directory of PHP_CodeSniffer. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Core_AllTests { /** * Prepare the test runner. * * @return void */ public static function main() { PHPUnit2_TextUI_TestRunner::run(self::suite()); }//end main() /** * Add all core unit tests into a test suite. * * @return PHPUnit_Framework_TestSuite */ public static function suite() { $suite = new PHPUnit_Framework_TestSuite('PHP CodeSniffer Core'); $suite->addTestSuite('Core_IsCamelCapsTest'); $suite->addTestSuite('Core_ErrorSuppressionTest'); $suite->addTestSuite('Core_File_GetMethodParametersTest'); return $suite; }//end suite() }//end class ?> PHP_CodeSniffer-2.5.1/tests/Core/ErrorSuppressionTest.php0000644000076700000240000003000712647543456023272 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Tests for PHP_CodeSniffer error suppression tags. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Core_ErrorSuppressionTest extends PHPUnit_Framework_TestCase { /** * Test suppressing a single error. * * @return void */ public function testSuppressError() { $phpcs = new PHP_CodeSniffer(); $phpcs->initStandard('PEAR', array('Generic.PHP.LowerCaseConstant')); // Process without suppression. $content = 'processFile('noSuppressionTest.php', $content); $errors = $file->getErrors(); $numErrors = $file->getErrorCount(); $this->assertEquals(1, $numErrors); $this->assertEquals(1, count($errors)); // Process with inline comment suppression. $content = 'processFile('suppressionTest.php', $content); $errors = $file->getErrors(); $numErrors = $file->getErrorCount(); $this->assertEquals(0, $numErrors); $this->assertEquals(0, count($errors)); // Process with block comment suppression. $content = 'processFile('suppressionTest.php', $content); $errors = $file->getErrors(); $numErrors = $file->getErrorCount(); $this->assertEquals(0, $numErrors); $this->assertEquals(0, count($errors)); // Process with a docblock suppression. $content = 'processFile('suppressionTest.php', $content); $errors = $file->getErrors(); $numErrors = $file->getErrorCount(); $this->assertEquals(0, $numErrors); $this->assertEquals(0, count($errors)); }//end testSuppressError() /** * Test suppressing 1 out of 2 errors. * * @return void */ public function testSuppressSomeErrors() { $phpcs = new PHP_CodeSniffer(); $phpcs->initStandard('Generic', array('Generic.PHP.LowerCaseConstant')); // Process without suppression. $content = 'processFile('noSuppressionTest.php', $content); $errors = $file->getErrors(); $numErrors = $file->getErrorCount(); $this->assertEquals(2, $numErrors); $this->assertEquals(2, count($errors)); // Process with suppression. $content = 'processFile('suppressionTest.php', $content); $errors = $file->getErrors(); $numErrors = $file->getErrorCount(); $this->assertEquals(1, $numErrors); $this->assertEquals(1, count($errors)); // Process with a PHPDoc block suppression. $content = 'processFile('suppressionTest.php', $content); $errors = $file->getErrors(); $numErrors = $file->getErrorCount(); $this->assertEquals(1, $numErrors); $this->assertEquals(1, count($errors)); }//end testSuppressSomeErrors() /** * Test suppressing a single warning. * * @return void */ public function testSuppressWarning() { $phpcs = new PHP_CodeSniffer(); $phpcs->initStandard('Generic', array('Generic.Commenting.Todo')); // Process without suppression. $content = 'processFile('noSuppressionTest.php', $content); $warnings = $file->getWarnings(); $numWarnings = $file->getWarningCount(); $this->assertEquals(1, $numWarnings); $this->assertEquals(1, count($warnings)); // Process with suppression. $content = 'processFile('suppressionTest.php', $content); $warnings = $file->getWarnings(); $numWarnings = $file->getWarningCount(); $this->assertEquals(0, $numWarnings); $this->assertEquals(0, count($warnings)); // Process with a PHPDoc block suppression. $content = 'processFile('suppressionTest.php', $content); $warnings = $file->getWarnings(); $numWarnings = $file->getWarningCount(); $this->assertEquals(0, $numWarnings); $this->assertEquals(0, count($warnings)); }//end testSuppressWarning() /** * Test suppressing a single error using a single line ignore. * * @return void */ public function testSuppressLine() { $phpcs = new PHP_CodeSniffer(); $phpcs->initStandard('Generic', array('Generic.PHP.LowerCaseConstant')); // Process without suppression. $content = 'processFile('noSuppressionTest.php', $content); $errors = $file->getErrors(); $numErrors = $file->getErrorCount(); $this->assertEquals(2, $numErrors); $this->assertEquals(2, count($errors)); // Process with suppression. $content = 'processFile('suppressionTest.php', $content); $errors = $file->getErrors(); $numErrors = $file->getErrorCount(); $this->assertEquals(1, $numErrors); $this->assertEquals(1, count($errors)); }//end testSuppressLine() /** * Test that using a single line ignore does not interfere with other suppressions. * * @return void */ public function testNestedSuppressLine() { $phpcs = new PHP_CodeSniffer(); $phpcs->initStandard('Generic', array('Generic.PHP.LowerCaseConstant')); // Process with codingStandardsIgnore[Start|End] suppression and no single line suppression. $content = 'processFile('oneSuppressionTest.php', $content); $errors = $file->getErrors(); $numErrors = $file->getErrorCount(); $this->assertEquals(0, $numErrors); $this->assertEquals(0, count($errors)); // Process with codingStandardsIgnoreLine suppression // nested within codingStandardsIgnore[Start|End] suppression. $content = 'processFile('nestedSuppressionTest.php', $content); $errors = $file->getErrors(); $numErrors = $file->getErrorCount(); $this->assertEquals(0, $numErrors); $this->assertEquals(0, count($errors)); }//end testNestedSuppressLine() /** * Test suppressing a scope opener. * * @return void */ public function testSuppressScope() { $phpcs = new PHP_CodeSniffer(); $phpcs->initStandard('PEAR', array('PEAR.NamingConventions.ValidVariableName')); // Process without suppression. $content = 'foo();'.PHP_EOL.'}'.PHP_EOL.'}'; $file = $phpcs->processFile('noSuppressionTest.php', $content); $errors = $file->getErrors(); $numErrors = $file->getErrorCount(); $this->assertEquals(0, $numErrors); $this->assertEquals(0, count($errors)); // Process with suppression. $content = 'foo();'.PHP_EOL.'}'.PHP_EOL.'}'; $file = $phpcs->processFile('suppressionTest.php', $content); $errors = $file->getErrors(); $numErrors = $file->getErrorCount(); $this->assertEquals(0, $numErrors); $this->assertEquals(0, count($errors)); // Process with a PhpDoc Block suppression. $content = 'foo();'.PHP_EOL.'}'.PHP_EOL.'}'; $file = $phpcs->processFile('suppressionTest.php', $content); $errors = $file->getErrors(); $numErrors = $file->getErrorCount(); $this->assertEquals(0, $numErrors); $this->assertEquals(0, count($errors)); }//end testSuppressScope() /** * Test suppressing a whole file. * * @return void */ public function testSuppressFile() { $phpcs = new PHP_CodeSniffer(); $phpcs->initStandard('Generic', array('Generic.Commenting.Todo')); // Process without suppression. $content = 'processFile('suppressionTest.php', $content); $warnings = $file->getWarnings(); $numWarnings = $file->getWarningCount(); $this->assertEquals(1, $numWarnings); $this->assertEquals(1, count($warnings)); // Process with suppression. $content = 'processFile('suppressionTest.php', $content); $warnings = $file->getWarnings(); $numWarnings = $file->getWarningCount(); $this->assertEquals(0, $numWarnings); $this->assertEquals(0, count($warnings)); // Process with a block comment suppression. $content = 'processFile('suppressionTest.php', $content); $warnings = $file->getWarnings(); $numWarnings = $file->getWarningCount(); $this->assertEquals(0, $numWarnings); $this->assertEquals(0, count($warnings)); // Process with docblock suppression. $content = 'processFile('suppressionTest.php', $content); $warnings = $file->getWarnings(); $numWarnings = $file->getWarningCount(); $this->assertEquals(0, $numWarnings); $this->assertEquals(0, count($warnings)); }//end testSuppressFile() }//end class ?> PHP_CodeSniffer-2.5.1/tests/Core/IsCamelCapsTest.php0000644000076700000240000001270412647543456022056 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Tests for the PHP_CodeSniffer:isCamelCaps method. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Core_IsCamelCapsTest extends PHPUnit_Framework_TestCase { /** * Test valid public function/method names. * * @return void */ public function testValidNotClassFormatPublic() { $this->assertTrue(PHP_CodeSniffer::isCamelCaps('thisIsCamelCaps', false, true, true)); $this->assertTrue(PHP_CodeSniffer::isCamelCaps('thisISCamelCaps', false, true, false)); }//end testValidNotClassFormatPublic() /** * Test invalid public function/method names. * * @return void */ public function testInvalidNotClassFormatPublic() { $this->assertFalse(PHP_CodeSniffer::isCamelCaps('_thisIsCamelCaps', false, true, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('thisISCamelCaps', false, true, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('ThisIsCamelCaps', false, true, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('3thisIsCamelCaps', false, true, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('*thisIsCamelCaps', false, true, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('-thisIsCamelCaps', false, true, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('this*IsCamelCaps', false, true, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('this-IsCamelCaps', false, true, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('this_IsCamelCaps', false, true, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('this_is_camel_caps', false, true, true)); }//end testInvalidNotClassFormatPublic() /** * Test valid private method names. * * @return void */ public function testValidNotClassFormatPrivate() { $this->assertTrue(PHP_CodeSniffer::isCamelCaps('_thisIsCamelCaps', false, false, true)); $this->assertTrue(PHP_CodeSniffer::isCamelCaps('_thisISCamelCaps', false, false, false)); $this->assertTrue(PHP_CodeSniffer::isCamelCaps('_i18N', false, false, true)); $this->assertTrue(PHP_CodeSniffer::isCamelCaps('_i18n', false, false, true)); }//end testValidNotClassFormatPrivate() /** * Test invalid private method names. * * @return void */ public function testInvalidNotClassFormatPrivate() { $this->assertFalse(PHP_CodeSniffer::isCamelCaps('thisIsCamelCaps', false, false, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('_thisISCamelCaps', false, false, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('_ThisIsCamelCaps', false, false, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('__thisIsCamelCaps', false, false, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('__thisISCamelCaps', false, false, false)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('3thisIsCamelCaps', false, false, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('*thisIsCamelCaps', false, false, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('-thisIsCamelCaps', false, false, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('_this_is_camel_caps', false, false, true)); }//end testInvalidNotClassFormatPrivate() /** * Test valid class names. * * @return void */ public function testValidClassFormatPublic() { $this->assertTrue(PHP_CodeSniffer::isCamelCaps('ThisIsCamelCaps', true, true, true)); $this->assertTrue(PHP_CodeSniffer::isCamelCaps('ThisISCamelCaps', true, true, false)); $this->assertTrue(PHP_CodeSniffer::isCamelCaps('This3IsCamelCaps', true, true, false)); }//end testValidClassFormatPublic() /** * Test invalid class names. * * @return void */ public function testInvalidClassFormat() { $this->assertFalse(PHP_CodeSniffer::isCamelCaps('thisIsCamelCaps', true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('This-IsCamelCaps', true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('This_Is_Camel_Caps', true)); }//end testInvalidClassFormat() /** * Test invalid class names with the private flag set. * * Note that the private flag is ignored if the class format * flag is set, so these names are all invalid. * * @return void */ public function testInvalidClassFormatPrivate() { $this->assertFalse(PHP_CodeSniffer::isCamelCaps('_ThisIsCamelCaps', true, true)); $this->assertFalse(PHP_CodeSniffer::isCamelCaps('_ThisIsCamelCaps', true, false)); }//end testInvalidClassFormatPrivate() }//end class ?> PHP_CodeSniffer-2.5.1/tests/Standards/AbstractSniffUnitTest.php0000644000076700000240000003522612647543456024362 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * An abstract class that all sniff unit tests must extend. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings that are not found, or * warnings and errors that are not expected, are considered test failures. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ abstract class AbstractSniffUnitTest extends PHPUnit_Framework_TestCase { /** * Enable or disable the backup and restoration of the $GLOBALS array. * Overwrite this attribute in a child class of TestCase. * Setting this attribute in setUp() has no effect! * * @var boolean */ protected $backupGlobals = false; /** * The PHP_CodeSniffer object used for testing. * * @var PHP_CodeSniffer */ protected static $phpcs = null; /** * The path to the directory under which the sniff's standard lives. * * @var string */ public $standardsDir = null; /** * Sets up this unit test. * * @return void */ protected function setUp() { if (self::$phpcs === null) { self::$phpcs = new PHP_CodeSniffer(); } $class = get_class($this); $this->standardsDir = $GLOBALS['PHP_CODESNIFFER_STANDARD_DIRS'][$class]; }//end setUp() /** * Should this test be skipped for some reason. * * @return void */ protected function shouldSkipTest() { return false; }//end shouldSkipTest() /** * Tests the extending classes Sniff class. * * @return void * @throws PHPUnit_Framework_Error */ public final function testSniff() { // Skip this test if we can't run in this environment. if ($this->shouldSkipTest() === true) { $this->markTestSkipped(); } // The basis for determining file locations. $basename = substr(get_class($this), 0, -8); // The name of the coding standard we are testing. $standardName = substr($basename, 0, strpos($basename, '_')); // The code of the sniff we are testing. $parts = explode('_', $basename); $sniffCode = $parts[0].'.'.$parts[2].'.'.$parts[3]; $testFileBase = $this->standardsDir.DIRECTORY_SEPARATOR.str_replace('_', DIRECTORY_SEPARATOR, $basename).'UnitTest.'; // Get a list of all test files to check. These will have the same base // name but different extensions. We ignore the .php file as it is the class. $testFiles = array(); $dir = substr($testFileBase, 0, strrpos($testFileBase, DIRECTORY_SEPARATOR)); $di = new DirectoryIterator($dir); foreach ($di as $file) { $path = $file->getPathname(); if (substr($path, 0, strlen($testFileBase)) === $testFileBase) { if ($path !== $testFileBase.'php' && substr($path, -5) !== 'fixed') { $testFiles[] = $path; } } } // Get them in order. sort($testFiles); self::$phpcs->initStandard($standardName, array($sniffCode)); self::$phpcs->setIgnorePatterns(array()); $failureMessages = array(); foreach ($testFiles as $testFile) { $filename = basename($testFile); try { $cliValues = $this->getCliValues($filename); self::$phpcs->cli->setCommandLineValues($cliValues); $phpcsFile = self::$phpcs->processFile($testFile); } catch (Exception $e) { $this->fail('An unexpected exception has been caught: '.$e->getMessage()); } $failures = $this->generateFailureMessages($phpcsFile); $failureMessages = array_merge($failureMessages, $failures); if ($phpcsFile->getFixableCount() > 0) { // Attempt to fix the errors. $phpcsFile->fixer->fixFile(); $fixable = $phpcsFile->getFixableCount(); if ($fixable > 0) { $failureMessages[] = "Failed to fix $fixable fixable violations in $filename"; } // Check for a .fixed file to check for accuracy of fixes. $fixedFile = $testFile.'.fixed'; if (file_exists($fixedFile) === true) { $diff = $phpcsFile->fixer->generateDiff($fixedFile); if (trim($diff) !== '') { $filename = basename($testFile); $fixedFilename = basename($fixedFile); $failureMessages[] = "Fixed version of $filename does not match expected version in $fixedFilename; the diff is\n$diff"; } } } }//end foreach if (empty($failureMessages) === false) { $this->fail(implode(PHP_EOL, $failureMessages)); } }//end runTest() /** * Generate a list of test failures for a given sniffed file. * * @param PHP_CodeSniffer_File $file The file being tested. * * @return array * @throws PHP_CodeSniffer_Exception */ public function generateFailureMessages(PHP_CodeSniffer_File $file) { $testFile = $file->getFilename(); $foundErrors = $file->getErrors(); $foundWarnings = $file->getWarnings(); $expectedErrors = $this->getErrorList(basename($testFile)); $expectedWarnings = $this->getWarningList(basename($testFile)); if (is_array($expectedErrors) === false) { throw new PHP_CodeSniffer_Exception('getErrorList() must return an array'); } if (is_array($expectedWarnings) === false) { throw new PHP_CodeSniffer_Exception('getWarningList() must return an array'); } /* We merge errors and warnings together to make it easier to iterate over them and produce the errors string. In this way, we can report on errors and warnings in the same line even though it's not really structured to allow that. */ $allProblems = array(); $failureMessages = array(); foreach ($foundErrors as $line => $lineErrors) { foreach ($lineErrors as $column => $errors) { if (isset($allProblems[$line]) === false) { $allProblems[$line] = array( 'expected_errors' => 0, 'expected_warnings' => 0, 'found_errors' => array(), 'found_warnings' => array(), ); } $foundErrorsTemp = array(); foreach ($allProblems[$line]['found_errors'] as $foundError) { $foundErrorsTemp[] = $foundError; } $errorsTemp = array(); foreach ($errors as $foundError) { $errorsTemp[] = $foundError['message'].' ('.$foundError['source'].')'; $source = $foundError['source']; if (in_array($source, $GLOBALS['PHP_CODESNIFFER_SNIFF_CODES']) === false) { $GLOBALS['PHP_CODESNIFFER_SNIFF_CODES'][] = $source; } if ($foundError['fixable'] === true && in_array($source, $GLOBALS['PHP_CODESNIFFER_FIXABLE_CODES']) === false ) { $GLOBALS['PHP_CODESNIFFER_FIXABLE_CODES'][] = $source; } } $allProblems[$line]['found_errors'] = array_merge($foundErrorsTemp, $errorsTemp); }//end foreach if (isset($expectedErrors[$line]) === true) { $allProblems[$line]['expected_errors'] = $expectedErrors[$line]; } else { $allProblems[$line]['expected_errors'] = 0; } unset($expectedErrors[$line]); }//end foreach foreach ($expectedErrors as $line => $numErrors) { if (isset($allProblems[$line]) === false) { $allProblems[$line] = array( 'expected_errors' => 0, 'expected_warnings' => 0, 'found_errors' => array(), 'found_warnings' => array(), ); } $allProblems[$line]['expected_errors'] = $numErrors; } foreach ($foundWarnings as $line => $lineWarnings) { foreach ($lineWarnings as $column => $warnings) { if (isset($allProblems[$line]) === false) { $allProblems[$line] = array( 'expected_errors' => 0, 'expected_warnings' => 0, 'found_errors' => array(), 'found_warnings' => array(), ); } $foundWarningsTemp = array(); foreach ($allProblems[$line]['found_warnings'] as $foundWarning) { $foundWarningsTemp[] = $foundWarning; } $warningsTemp = array(); foreach ($warnings as $warning) { $warningsTemp[] = $warning['message'].' ('.$warning['source'].')'; } $allProblems[$line]['found_warnings'] = array_merge($foundWarningsTemp, $warningsTemp); }//end foreach if (isset($expectedWarnings[$line]) === true) { $allProblems[$line]['expected_warnings'] = $expectedWarnings[$line]; } else { $allProblems[$line]['expected_warnings'] = 0; } unset($expectedWarnings[$line]); }//end foreach foreach ($expectedWarnings as $line => $numWarnings) { if (isset($allProblems[$line]) === false) { $allProblems[$line] = array( 'expected_errors' => 0, 'expected_warnings' => 0, 'found_errors' => array(), 'found_warnings' => array(), ); } $allProblems[$line]['expected_warnings'] = $numWarnings; } // Order the messages by line number. ksort($allProblems); foreach ($allProblems as $line => $problems) { $numErrors = count($problems['found_errors']); $numWarnings = count($problems['found_warnings']); $expectedErrors = $problems['expected_errors']; $expectedWarnings = $problems['expected_warnings']; $errors = ''; $foundString = ''; if ($expectedErrors !== $numErrors || $expectedWarnings !== $numWarnings) { $lineMessage = "[LINE $line]"; $expectedMessage = 'Expected '; $foundMessage = 'in '.basename($testFile).' but found '; if ($expectedErrors !== $numErrors) { $expectedMessage .= "$expectedErrors error(s)"; $foundMessage .= "$numErrors error(s)"; if ($numErrors !== 0) { $foundString .= 'error(s)'; $errors .= implode(PHP_EOL.' -> ', $problems['found_errors']); } if ($expectedWarnings !== $numWarnings) { $expectedMessage .= ' and '; $foundMessage .= ' and '; if ($numWarnings !== 0) { if ($foundString !== '') { $foundString .= ' and '; } } } } if ($expectedWarnings !== $numWarnings) { $expectedMessage .= "$expectedWarnings warning(s)"; $foundMessage .= "$numWarnings warning(s)"; if ($numWarnings !== 0) { $foundString .= 'warning(s)'; if (empty($errors) === false) { $errors .= PHP_EOL.' -> '; } $errors .= implode(PHP_EOL.' -> ', $problems['found_warnings']); } } $fullMessage = "$lineMessage $expectedMessage $foundMessage."; if ($errors !== '') { $fullMessage .= " The $foundString found were:".PHP_EOL." -> $errors"; } $failureMessages[] = $fullMessage; }//end if }//end foreach return $failureMessages; }//end generateFailureMessages() /** * Get a list of CLI values to set before the file is tested. * * @param string $filename The name of the file being tested. * * @return array */ public function getCliValues($filename) { return array(); }//end getCliValues() /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array(int => int) */ protected abstract function getErrorList(); /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array(int => int) */ protected abstract function getWarningList(); }//end class PHP_CodeSniffer-2.5.1/tests/Standards/AllSniffs.php0000644000076700000240000001075212647543456022007 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ // Require this here so that the unit tests don't have to try and find the // abstract class once it is installed into the PEAR tests directory. require_once dirname(__FILE__).'/AbstractSniffUnitTest.php'; /** * A test class for testing all sniffs for installed standards. * * Usage: phpunit AllSniffs.php * * This test class loads all unit tests for all installed standards into a * single test suite and runs them. Errors are reported on the command line. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Standards_AllSniffs { /** * Prepare the test runner. * * @return void */ public static function main() { PHPUnit_TextUI_TestRunner::run(self::suite()); }//end main() /** * Add all sniff unit tests into a test suite. * * Sniff unit tests are found by recursing through the 'Tests' directory * of each installed coding standard. * * @return PHPUnit_Framework_TestSuite */ public static function suite() { $suite = new PHPUnit_Framework_TestSuite('PHP CodeSniffer Standards'); $isInstalled = !is_file(dirname(__FILE__).'/../../CodeSniffer.php'); $installedPaths = PHP_CodeSniffer::getInstalledStandardPaths(); foreach ($installedPaths as $path) { $path = realpath($path); $origPath = $path; $standards = PHP_CodeSniffer::getInstalledStandards(true, $path); // If the test is running PEAR installed, the built-in standards // are split into different directories; one for the sniffs and // a different file system location for tests. if ($isInstalled === true && is_dir($path.DIRECTORY_SEPARATOR.'Generic') === true ) { $path = dirname(__FILE__); } foreach ($standards as $standard) { $testsDir = $path.DIRECTORY_SEPARATOR.$standard.DIRECTORY_SEPARATOR.'Tests'.DIRECTORY_SEPARATOR; if (is_dir($testsDir) === false) { // No tests for this standard. continue; } $di = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($testsDir)); foreach ($di as $file) { // Skip hidden files. if (substr($file->getFilename(), 0, 1) === '.') { continue; } // Tests must have the extension 'php'. $parts = explode('.', $file); $ext = array_pop($parts); if ($ext !== 'php') { continue; } $filePath = $file->getPathname(); $className = str_replace($path.DIRECTORY_SEPARATOR, '', $filePath); $className = substr($className, 0, -4); $className = str_replace(DIRECTORY_SEPARATOR, '_', $className); // Include the sniff here so tests can use it in their setup() methods. $parts = explode('_', $className); $sniffPath = $origPath.DIRECTORY_SEPARATOR.$parts[0].DIRECTORY_SEPARATOR.'Sniffs'.DIRECTORY_SEPARATOR.$parts[2].DIRECTORY_SEPARATOR.$parts[3]; $sniffPath = substr($sniffPath, 0, -8).'Sniff.php'; include_once $sniffPath; include_once $filePath; $GLOBALS['PHP_CODESNIFFER_STANDARD_DIRS'][$className] = $path; $suite->addTestSuite($className); }//end foreach }//end foreach }//end foreach return $suite; }//end suite() }//end class PHP_CodeSniffer-2.5.1/tests/AllTests.php0000644000076700000240000000504312647543456017733 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (defined('PHP_CODESNIFFER_IN_TESTS') === false) { define('PHP_CODESNIFFER_IN_TESTS', true); } require_once 'TestSuite.php'; if (is_file(dirname(__FILE__).'/../CodeSniffer.php') === true) { // We are not installed. include_once 'Core/AllTests.php'; include_once 'Standards/AllSniffs.php'; include_once dirname(__FILE__).'/../CodeSniffer.php'; } else { include_once 'CodeSniffer/Core/AllTests.php'; include_once 'CodeSniffer/Standards/AllSniffs.php'; include_once 'PHP/CodeSniffer.php'; } /** * A test class for running all PHP_CodeSniffer unit tests. * * Usage: phpunit AllTests.php * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_AllTests { /** * Prepare the test runner. * * @return void */ public static function main() { PHPUnit_TextUI_TestRunner::run(self::suite()); }//end main() /** * Add all PHP_CodeSniffer test suites into a single test suite. * * @return PHPUnit_Framework_TestSuite */ public static function suite() { $GLOBALS['PHP_CODESNIFFER_STANDARD_DIRS'] = array(); // Use a special PHP_CodeSniffer test suite so that we can // unset our autoload function after the run. $suite = new PHP_CodeSniffer_TestSuite('PHP CodeSniffer'); $suite->addTest(PHP_CodeSniffer_Core_AllTests::suite()); $suite->addTest(PHP_CodeSniffer_Standards_AllSniffs::suite()); // Unregister this here because the PEAR tester loads // all package suites before running then, so our autoloader // will cause problems for the packages included after us. spl_autoload_unregister(array('PHP_CodeSniffer', 'autoload')); return $suite; }//end suite() }//end class PHP_CodeSniffer-2.5.1/tests/TestSuite.php0000644000076700000240000000417112647543456020132 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * A PHP_CodeSniffer specific test suite for PHPUnit. * * Unregisters the PHP_CodeSniffer autoload function after the run. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_TestSuite extends PHPUnit_Framework_TestSuite { /** * Runs the tests and collects their result in a TestResult. * * @param PHPUnit_Framework_TestResult $result A test result. * @param mixed $filter The filter passed to each test. * * @return PHPUnit_Framework_TestResult */ public function run(PHPUnit_Framework_TestResult $result=null, $filter=false) { $GLOBALS['PHP_CODESNIFFER_SNIFF_CODES'] = array(); $GLOBALS['PHP_CODESNIFFER_FIXABLE_CODES'] = array(); spl_autoload_register(array('PHP_CodeSniffer', 'autoload')); $result = parent::run($result, $filter); spl_autoload_unregister(array('PHP_CodeSniffer', 'autoload')); $codes = count($GLOBALS['PHP_CODESNIFFER_SNIFF_CODES']); echo PHP_EOL.PHP_EOL; echo "Tests generated $codes unique error codes"; if ($codes > 0) { $fixes = count($GLOBALS['PHP_CODESNIFFER_FIXABLE_CODES']); $percent = round(($fixes / $codes * 100), 2); echo "; $fixes were fixable ($percent%)"; } return $result; }//end run() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/DocGenerators/Generator.php0000644000076700000240000001273212647543456023715 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * The base class for all PHP_CodeSniffer documentation generators. * * Documentation generators are used to print documentation about code sniffs * in a standard. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ abstract class PHP_CodeSniffer_DocGenerators_Generator { /** * The name of the coding standard we are generating docs for. * * @var string */ private $_standard = ''; /** * An array of sniffs that we are limiting the generated docs to. * * If this array is empty, docs are generated for all sniffs in the * supplied coding standard. * * @var string */ private $_sniffs = array(); /** * Constructs a PHP_CodeSniffer_DocGenerators_Generator object. * * @param string $standard The name of the coding standard to generate * docs for. * @param array $sniffs An array of sniffs that we are limiting the * generated docs to. * * @see generate() */ public function __construct($standard, array $sniffs=array()) { $this->_standard = $standard; $this->_sniffs = $sniffs; }//end __construct() /** * Retrieves the title of the sniff from the DOMNode supplied. * * @param DOMNode $doc The DOMNode object for the sniff. * It represents the "documentation" tag in the XML * standard file. * * @return string */ protected function getTitle(DOMNode $doc) { return $doc->getAttribute('title'); }//end getTitle() /** * Retrieves the name of the standard we are generating docs for. * * @return string */ protected function getStandard() { return $this->_standard; }//end getStandard() /** * Generates the documentation for a standard. * * It's probably wise for doc generators to override this method so they * have control over how the docs are produced. Otherwise, the processSniff * method should be overridden to output content for each sniff. * * @return void * @see processSniff() */ public function generate() { $standardFiles = $this->getStandardFiles(); foreach ($standardFiles as $standard) { $doc = new DOMDocument(); $doc->load($standard); $documentation = $doc->getElementsByTagName('documentation')->item(0); $this->processSniff($documentation); } }//end generate() /** * Returns a list of paths to XML standard files for all sniffs in a standard. * * Any sniffs that do not have an XML standard file are obviously not included * in the returned array. If documentation is only being generated for some * sniffs (ie. $this->_sniffs is not empty) then all others sniffs will * be filtered from the results as well. * * @return string[] */ protected function getStandardFiles() { $phpcs = new PHP_CodeSniffer(); $phpcs->process(array(), $this->_standard); $sniffs = $phpcs->getSniffs(); $standardFiles = array(); foreach ($sniffs as $className => $sniffClass) { $object = new ReflectionObject($sniffClass); $sniff = $object->getFilename(); if (empty($this->_sniffs) === false) { // We are limiting the docs to certain sniffs only, so filter // out any unwanted sniffs. $parts = explode('_', $className); $sniffName = $parts[0].'.'.$parts[2].'.'.substr($parts[3], 0, -5); if (in_array($sniffName, $this->_sniffs) === false) { continue; } } $standardFile = str_replace( DIRECTORY_SEPARATOR.'Sniffs'.DIRECTORY_SEPARATOR, DIRECTORY_SEPARATOR.'Docs'.DIRECTORY_SEPARATOR, $sniff ); $standardFile = str_replace('Sniff.php', 'Standard.xml', $standardFile); if (is_file($standardFile) === true) { $standardFiles[] = $standardFile; } }//end foreach return $standardFiles; }//end getStandardFiles() /** * Process the documentation for a single sniff. * * Doc generators must implement this function to produce output. * * @param DOMNode $doc The DOMNode object for the sniff. * It represents the "documentation" tag in the XML * standard file. * * @return void * @see generate() */ protected abstract function processSniff(DOMNode $doc); }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/DocGenerators/HTML.php0000644000076700000240000002245112647543456022532 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_DocGenerators_Generator', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_DocGenerators_Generator not found'); } /** * A doc generator that outputs documentation in one big HTML file. * * Output is in one large HTML file and is designed for you to style with * your own stylesheet. It contains a table of contents at the top with anchors * to each sniff. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_DocGenerators_HTML extends PHP_CodeSniffer_DocGenerators_Generator { /** * Generates the documentation for a standard. * * @return void * @see processSniff() */ public function generate() { ob_start(); $this->printHeader(); $standardFiles = $this->getStandardFiles(); $this->printToc($standardFiles); foreach ($standardFiles as $standard) { $doc = new DOMDocument(); $doc->load($standard); $documentation = $doc->getElementsByTagName('documentation')->item(0); $this->processSniff($documentation); } $this->printFooter(); $content = ob_get_contents(); ob_end_clean(); echo $content; }//end generate() /** * Print the header of the HTML page. * * @return void */ protected function printHeader() { $standard = $this->getStandard(); echo ''.PHP_EOL; echo ' '.PHP_EOL; echo " $standard Coding Standards".PHP_EOL; echo ' '.PHP_EOL; echo ' '.PHP_EOL; echo ' '.PHP_EOL; echo "

$standard Coding Standards

".PHP_EOL; }//end printHeader() /** * Print the table of contents for the standard. * * The TOC is just an unordered list of bookmarks to sniffs on the page. * * @param array $standardFiles An array of paths to the XML standard files. * * @return void */ protected function printToc($standardFiles) { echo '

Table of Contents

'.PHP_EOL; echo '
    '.PHP_EOL; foreach ($standardFiles as $standard) { $doc = new DOMDocument(); $doc->load($standard); $documentation = $doc->getElementsByTagName('documentation')->item(0); $title = $this->getTitle($documentation); echo '
  • $title
  • ".PHP_EOL; } echo '
'.PHP_EOL; }//end printToc() /** * Print the footer of the HTML page. * * @return void */ protected function printFooter() { // Turn off errors so we don't get timezone warnings if people // don't have their timezone set. $errorLevel = error_reporting(0); echo '
'; echo 'Documentation generated on '.date('r'); echo ' by PHP_CodeSniffer '.PHP_CodeSniffer::VERSION.''; echo '
'.PHP_EOL; error_reporting($errorLevel); echo ' '.PHP_EOL; echo ''.PHP_EOL; }//end printFooter() /** * Process the documentation for a single sniff. * * @param DOMNode $doc The DOMNode object for the sniff. * It represents the "documentation" tag in the XML * standard file. * * @return void */ public function processSniff(DOMNode $doc) { $title = $this->getTitle($doc); echo ' '.PHP_EOL; echo "

$title

".PHP_EOL; foreach ($doc->childNodes as $node) { if ($node->nodeName === 'standard') { $this->printTextBlock($node); } else if ($node->nodeName === 'code_comparison') { $this->printCodeComparisonBlock($node); } } }//end processSniff() /** * Print a text block found in a standard. * * @param DOMNode $node The DOMNode object for the text block. * * @return void */ protected function printTextBlock($node) { $content = trim($node->nodeValue); $content = htmlspecialchars($content); // Allow em tags only. $content = str_replace('<em>', '', $content); $content = str_replace('</em>', '', $content); echo "

$content

".PHP_EOL; }//end printTextBlock() /** * Print a code comparison block found in a standard. * * @param DOMNode $node The DOMNode object for the code comparison block. * * @return void */ protected function printCodeComparisonBlock($node) { $codeBlocks = $node->getElementsByTagName('code'); $firstTitle = $codeBlocks->item(0)->getAttribute('title'); $first = trim($codeBlocks->item(0)->nodeValue); $first = str_replace('', $first); $first = str_replace(' ', ' ', $first); $first = str_replace('', '', $first); $first = str_replace('', '', $first); $secondTitle = $codeBlocks->item(1)->getAttribute('title'); $second = trim($codeBlocks->item(1)->nodeValue); $second = str_replace('', $second); $second = str_replace(' ', ' ', $second); $second = str_replace('', '', $second); $second = str_replace('', '', $second); echo ' '.PHP_EOL; echo ' '.PHP_EOL; echo " ".PHP_EOL; echo " ".PHP_EOL; echo ' '.PHP_EOL; echo ' '.PHP_EOL; echo " ".PHP_EOL; echo " ".PHP_EOL; echo ' '.PHP_EOL; echo '
$firstTitle$secondTitle
$first$second
'.PHP_EOL; }//end printCodeComparisonBlock() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/DocGenerators/Markdown.php0000644000076700000240000001202212647543456023541 0ustar gsherwoodstaff * @copyright 2014 Arroba IT * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_DocGenerators_Generator', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_DocGenerators_Generator not found'); } /** * A doc generator that outputs documentation in Markdown format. * * @category PHP * @package PHP_CodeSniffer * @author Stefano Kowalke * @copyright 2014 Arroba IT * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_DocGenerators_Markdown extends PHP_CodeSniffer_DocGenerators_Generator { /** * Generates the documentation for a standard. * * @return void * @see processSniff() */ public function generate() { ob_start(); $this->printHeader(); $standardFiles = $this->getStandardFiles(); foreach ($standardFiles as $standard) { $doc = new DOMDocument(); $doc->load($standard); $documentation = $doc->getElementsByTagName('documentation')->item(0); $this->processSniff($documentation); } $this->printFooter(); $content = ob_get_contents(); ob_end_clean(); echo $content; }//end generate() /** * Print the markdown header. * * @return void */ protected function printHeader() { $standard = $this->getStandard(); echo "# $standard Coding Standard".PHP_EOL; }//end printHeader() /** * Print the markdown footer. * * @return void */ protected function printFooter() { // Turn off errors so we don't get timezone warnings if people // don't have their timezone set. error_reporting(0); echo 'Documentation generated on '.date('r'); echo ' by [PHP_CodeSniffer '.PHP_CodeSniffer::VERSION.'](https://github.com/squizlabs/PHP_CodeSniffer)'; }//end printFooter() /** * Process the documentation for a single sniff. * * @param DOMNode $doc The DOMNode object for the sniff. * It represents the "documentation" tag in the XML * standard file. * * @return void */ protected function processSniff(DOMNode $doc) { $title = $this->getTitle($doc); echo "## $title".PHP_EOL; foreach ($doc->childNodes as $node) { if ($node->nodeName === 'standard') { $this->printTextBlock($node); } else if ($node->nodeName === 'code_comparison') { $this->printCodeComparisonBlock($node); } } }//end processSniff() /** * Print a text block found in a standard. * * @param DOMNode $node The DOMNode object for the text block. * * @return void */ protected function printTextBlock(DOMNode $node) { $content = trim($node->nodeValue); $content = htmlspecialchars($content); $content = str_replace('<em>', '*', $content); $content = str_replace('</em>', '*', $content); echo $content.PHP_EOL; }//end printTextBlock() /** * Print a code comparison block found in a standard. * * @param DOMNode $node The DOMNode object for the code comparison block. * * @return void */ protected function printCodeComparisonBlock(DOMNode $node) { $codeBlocks = $node->getElementsByTagName('code'); $firstTitle = $codeBlocks->item(0)->getAttribute('title'); $first = trim($codeBlocks->item(0)->nodeValue); $first = str_replace("\n", "\n ", $first); $first = str_replace('', '', $first); $first = str_replace('', '', $first); $secondTitle = $codeBlocks->item(1)->getAttribute('title'); $second = trim($codeBlocks->item(1)->nodeValue); $second = str_replace("\n", "\n ", $second); $second = str_replace('', '', $second); $second = str_replace('', '', $second); echo ' '.PHP_EOL; echo ' '.PHP_EOL; echo " ".PHP_EOL; echo " ".PHP_EOL; echo ' '.PHP_EOL; echo ' '.PHP_EOL; echo ''.PHP_EOL; echo ''.PHP_EOL; echo ' '.PHP_EOL; echo '
$firstTitle$secondTitle
'.PHP_EOL.PHP_EOL; echo " $first".PHP_EOL.PHP_EOL; echo ''.PHP_EOL.PHP_EOL; echo " $second".PHP_EOL.PHP_EOL; echo '
'.PHP_EOL; }//end printCodeComparisonBlock() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/DocGenerators/Text.php0000644000076700000240000002121312647543456022705 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_DocGenerators_Generator', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_DocGenerators_Generator not found'); } /** * A doc generator that outputs text-based documentation. * * Output is designed to be displayed in a terminal and is wrapped to 100 characters. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_DocGenerators_Text extends PHP_CodeSniffer_DocGenerators_Generator { /** * Process the documentation for a single sniff. * * @param DOMNode $doc The DOMNode object for the sniff. * It represents the "documentation" tag in the XML * standard file. * * @return void */ public function processSniff(DOMNode $doc) { $this->printTitle($doc); foreach ($doc->childNodes as $node) { if ($node->nodeName === 'standard') { $this->printTextBlock($node); } else if ($node->nodeName === 'code_comparison') { $this->printCodeComparisonBlock($node); } } }//end processSniff() /** * Prints the title area for a single sniff. * * @param DOMNode $doc The DOMNode object for the sniff. * It represents the "documentation" tag in the XML * standard file. * * @return void */ protected function printTitle(DOMNode $doc) { $title = $this->getTitle($doc); $standard = $this->getStandard(); echo PHP_EOL; echo str_repeat('-', (strlen("$standard CODING STANDARD: $title") + 4)); echo strtoupper(PHP_EOL."| $standard CODING STANDARD: $title |".PHP_EOL); echo str_repeat('-', (strlen("$standard CODING STANDARD: $title") + 4)); echo PHP_EOL.PHP_EOL; }//end printTitle() /** * Print a text block found in a standard. * * @param DOMNode $node The DOMNode object for the text block. * * @return void */ protected function printTextBlock($node) { $text = trim($node->nodeValue); $text = str_replace('', '*', $text); $text = str_replace('', '*', $text); $lines = array(); $tempLine = ''; $words = explode(' ', $text); foreach ($words as $word) { if (strlen($tempLine.$word) >= 99) { if (strlen($tempLine.$word) === 99) { // Adding the extra space will push us to the edge // so we are done. $lines[] = $tempLine.$word; $tempLine = ''; } else if (strlen($tempLine.$word) === 100) { // We are already at the edge, so we are done. $lines[] = $tempLine.$word; $tempLine = ''; } else { $lines[] = rtrim($tempLine); $tempLine = $word.' '; } } else { $tempLine .= $word.' '; } }//end foreach if ($tempLine !== '') { $lines[] = rtrim($tempLine); } echo implode(PHP_EOL, $lines).PHP_EOL.PHP_EOL; }//end printTextBlock() /** * Print a code comparison block found in a standard. * * @param DOMNode $node The DOMNode object for the code comparison block. * * @return void */ protected function printCodeComparisonBlock($node) { $codeBlocks = $node->getElementsByTagName('code'); $first = trim($codeBlocks->item(0)->nodeValue); $firstTitle = $codeBlocks->item(0)->getAttribute('title'); $firstTitleLines = array(); $tempTitle = ''; $words = explode(' ', $firstTitle); foreach ($words as $word) { if (strlen($tempTitle.$word) >= 45) { if (strlen($tempTitle.$word) === 45) { // Adding the extra space will push us to the edge // so we are done. $firstTitleLines[] = $tempTitle.$word; $tempTitle = ''; } else if (strlen($tempTitle.$word) === 46) { // We are already at the edge, so we are done. $firstTitleLines[] = $tempTitle.$word; $tempTitle = ''; } else { $firstTitleLines[] = $tempTitle; $tempTitle = $word; } } else { $tempTitle .= $word.' '; } }//end foreach if ($tempTitle !== '') { $firstTitleLines[] = $tempTitle; } $first = str_replace('', '', $first); $first = str_replace('', '', $first); $firstLines = explode("\n", $first); $second = trim($codeBlocks->item(1)->nodeValue); $secondTitle = $codeBlocks->item(1)->getAttribute('title'); $secondTitleLines = array(); $tempTitle = ''; $words = explode(' ', $secondTitle); foreach ($words as $word) { if (strlen($tempTitle.$word) >= 45) { if (strlen($tempTitle.$word) === 45) { // Adding the extra space will push us to the edge // so we are done. $secondTitleLines[] = $tempTitle.$word; $tempTitle = ''; } else if (strlen($tempTitle.$word) === 46) { // We are already at the edge, so we are done. $secondTitleLines[] = $tempTitle.$word; $tempTitle = ''; } else { $secondTitleLines[] = $tempTitle; $tempTitle = $word; } } else { $tempTitle .= $word.' '; } }//end foreach if ($tempTitle !== '') { $secondTitleLines[] = $tempTitle; } $second = str_replace('', '', $second); $second = str_replace('', '', $second); $secondLines = explode("\n", $second); $maxCodeLines = max(count($firstLines), count($secondLines)); $maxTitleLines = max(count($firstTitleLines), count($secondTitleLines)); echo str_repeat('-', 41); echo ' CODE COMPARISON '; echo str_repeat('-', 42).PHP_EOL; for ($i = 0; $i < $maxTitleLines; $i++) { if (isset($firstTitleLines[$i]) === true) { $firstLineText = $firstTitleLines[$i]; } else { $firstLineText = ''; } if (isset($secondTitleLines[$i]) === true) { $secondLineText = $secondTitleLines[$i]; } else { $secondLineText = ''; } echo '| '; echo $firstLineText.str_repeat(' ', (46 - strlen($firstLineText))); echo ' | '; echo $secondLineText.str_repeat(' ', (47 - strlen($secondLineText))); echo ' |'.PHP_EOL; }//end for echo str_repeat('-', 100).PHP_EOL; for ($i = 0; $i < $maxCodeLines; $i++) { if (isset($firstLines[$i]) === true) { $firstLineText = $firstLines[$i]; } else { $firstLineText = ''; } if (isset($secondLines[$i]) === true) { $secondLineText = $secondLines[$i]; } else { $secondLineText = ''; } echo '| '; echo $firstLineText.str_repeat(' ', (47 - strlen($firstLineText))); echo '| '; echo $secondLineText.str_repeat(' ', (48 - strlen($secondLineText))); echo '|'.PHP_EOL; }//end for echo str_repeat('-', 100).PHP_EOL.PHP_EOL; }//end printCodeComparisonBlock() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Cbf.php0000644000076700000240000001161312647543456021355 0ustar gsherwoodstaff * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * CBF report for PHP_CodeSniffer. * * This report implements the various auto-fixing features of the * PHPCBF script and is not intended (or allowed) to be selected as a * report from the command line. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Cbf implements PHP_CodeSniffer_Report { /** * Generate a partial report for a single processed file. * * Function should return TRUE if it printed or stored data about the file * and FALSE if it ignored the file. Returning TRUE indicates that the file and * its data should be counted in the grand totals. * * @param array $report Prepared report data. * @param PHP_CodeSniffer_File $phpcsFile The file being reported on. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ) { $cliValues = $phpcsFile->phpcs->cli->getCommandLineValues(); $errors = $phpcsFile->getFixableCount(); if ($errors !== 0) { if (empty($cliValues['files']) === false) { ob_end_clean(); $errors = $phpcsFile->getFixableCount(); $startTime = microtime(true); echo "\t=> Fixing file: $errors/$errors violations remaining"; } $fixed = $phpcsFile->fixer->fixFile(); } if (empty($cliValues['files']) === true) { // Replacing STDIN, so output current file to STDOUT // even if nothing was fixed. Exit here because we // can't process any more than 1 file in this setup. echo $phpcsFile->fixer->getContents(); ob_end_flush(); exit(1); } if ($errors === 0) { return false; } if ($fixed === false) { echo 'ERROR'; } else { echo 'DONE'; } $timeTaken = ((microtime(true) - $startTime) * 1000); if ($timeTaken < 1000) { $timeTaken = round($timeTaken); echo " in {$timeTaken}ms".PHP_EOL; } else { $timeTaken = round(($timeTaken / 1000), 2); echo " in $timeTaken secs".PHP_EOL; } if ($fixed === true) { $newFilename = $report['filename'].$cliValues['phpcbf-suffix']; $newContent = $phpcsFile->fixer->getContents(); file_put_contents($newFilename, $newContent); if ($newFilename === $report['filename']) { echo "\t=> File was overwritten".PHP_EOL; } else { echo "\t=> Fixed file written to ".basename($newFilename).PHP_EOL; } } ob_start(); return $fixed; }//end generateFileReport() /** * Prints all errors and warnings for each file processed. * * @param string $cachedData Any partial report data that was returned from * generateFileReport during the run. * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * @param int $totalFixable Total number of problems that can be fixed. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ) { echo $cachedData; echo "Fixed $totalFiles files".PHP_EOL; }//end generate() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Checkstyle.php0000644000076700000240000001054612647543456022765 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Checkstyle report for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Gabriele Santini * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Checkstyle implements PHP_CodeSniffer_Report { /** * Generate a partial report for a single processed file. * * Function should return TRUE if it printed or stored data about the file * and FALSE if it ignored the file. Returning TRUE indicates that the file and * its data should be counted in the grand totals. * * @param array $report Prepared report data. * @param PHP_CodeSniffer_File $phpcsFile The file being reported on. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ) { $out = new XMLWriter; $out->openMemory(); $out->setIndent(true); if ($report['errors'] === 0 && $report['warnings'] === 0) { // Nothing to print. return false; } $out->startElement('file'); $out->writeAttribute('name', $report['filename']); foreach ($report['messages'] as $line => $lineErrors) { foreach ($lineErrors as $column => $colErrors) { foreach ($colErrors as $error) { $error['type'] = strtolower($error['type']); if (PHP_CODESNIFFER_ENCODING !== 'utf-8') { $error['message'] = iconv(PHP_CODESNIFFER_ENCODING, 'utf-8', $error['message']); } $out->startElement('error'); $out->writeAttribute('line', $line); $out->writeAttribute('column', $column); $out->writeAttribute('severity', $error['type']); $out->writeAttribute('message', $error['message']); $out->writeAttribute('source', $error['source']); $out->endElement(); } } }//end foreach $out->endElement(); echo $out->flush(); return true; }//end generateFileReport() /** * Prints all violations for processed files, in a Checkstyle format. * * @param string $cachedData Any partial report data that was returned from * generateFileReport during the run. * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * @param int $totalFixable Total number of problems that can be fixed. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ) { echo ''.PHP_EOL; echo ''.PHP_EOL; echo $cachedData; echo ''.PHP_EOL; }//end generate() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Csv.php0000644000076700000240000000740012647543456021415 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Csv report for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Gabriele Santini * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Csv implements PHP_CodeSniffer_Report { /** * Generate a partial report for a single processed file. * * Function should return TRUE if it printed or stored data about the file * and FALSE if it ignored the file. Returning TRUE indicates that the file and * its data should be counted in the grand totals. * * @param array $report Prepared report data. * @param PHP_CodeSniffer_File $phpcsFile The file being reported on. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ) { if ($report['errors'] === 0 && $report['warnings'] === 0) { // Nothing to print. return false; } foreach ($report['messages'] as $line => $lineErrors) { foreach ($lineErrors as $column => $colErrors) { foreach ($colErrors as $error) { $filename = str_replace('"', '\"', $report['filename']); $message = str_replace('"', '\"', $error['message']); $type = strtolower($error['type']); $source = $error['source']; $severity = $error['severity']; $fixable = (int) $error['fixable']; echo "\"$filename\",$line,$column,$type,\"$message\",$source,$severity,$fixable".PHP_EOL; } } } return true; }//end generateFileReport() /** * Generates a csv report. * * @param string $cachedData Any partial report data that was returned from * generateFileReport during the run. * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * @param int $totalFixable Total number of problems that can be fixed. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ) { echo 'File,Line,Column,Type,Message,Source,Severity,Fixable'.PHP_EOL; echo $cachedData; }//end generate() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Diff.php0000644000076700000240000001061512647543456021534 0ustar gsherwoodstaff * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Diff report for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Diff implements PHP_CodeSniffer_Report { /** * Generate a partial report for a single processed file. * * Function should return TRUE if it printed or stored data about the file * and FALSE if it ignored the file. Returning TRUE indicates that the file and * its data should be counted in the grand totals. * * @param array $report Prepared report data. * @param PHP_CodeSniffer_File $phpcsFile The file being reported on. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ) { $errors = $phpcsFile->getFixableCount(); if ($errors === 0) { return false; } if (PHP_CODESNIFFER_VERBOSITY > 1) { ob_end_clean(); echo "\t*** START FILE FIXING ***".PHP_EOL; } if (PHP_CODESNIFFER_CBF === true) { ob_end_clean(); $startTime = microtime(true); echo "\t=> Fixing file: $errors/$errors violations remaining"; } $fixed = $phpcsFile->fixer->fixFile(); if (PHP_CODESNIFFER_CBF === true) { if ($fixed === false) { echo "\033[31mERROR\033[0m"; } else { echo "\033[32mDONE\033[0m"; } $timeTaken = ((microtime(true) - $startTime) * 1000); if ($timeTaken < 1000) { $timeTaken = round($timeTaken); echo " in {$timeTaken}ms".PHP_EOL; } else { $timeTaken = round(($timeTaken / 1000), 2); echo " in $timeTaken secs".PHP_EOL; } ob_start(); } if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** END FILE FIXING ***".PHP_EOL; ob_start(); } if ($fixed === false) { return false; } if (PHP_CODESNIFFER_CBF === true) { // Diff without colours. $diff = $phpcsFile->fixer->generateDiff(null, false); } else { $diff = $phpcsFile->fixer->generateDiff(); } if ($diff === '') { // Nothing to print. return false; } echo $diff.PHP_EOL; return true; }//end generateFileReport() /** * Prints all errors and warnings for each file processed. * * @param string $cachedData Any partial report data that was returned from * generateFileReport during the run. * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * @param int $totalFixable Total number of problems that can be fixed. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ) { echo $cachedData; if ($toScreen === true) { echo PHP_EOL; } }//end generate() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Emacs.php0000644000076700000240000000706112647543456021715 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Emacs report for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Gabriele Santini * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Emacs implements PHP_CodeSniffer_Report { /** * Generate a partial report for a single processed file. * * Function should return TRUE if it printed or stored data about the file * and FALSE if it ignored the file. Returning TRUE indicates that the file and * its data should be counted in the grand totals. * * @param array $report Prepared report data. * @param PHP_CodeSniffer_File $phpcsFile The file being reported on. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ) { if ($report['errors'] === 0 && $report['warnings'] === 0) { // Nothing to print. return false; } foreach ($report['messages'] as $line => $lineErrors) { foreach ($lineErrors as $column => $colErrors) { foreach ($colErrors as $error) { $message = $error['message']; if ($showSources === true) { $message .= ' ('.$error['source'].')'; } $type = strtolower($error['type']); echo $report['filename'].':'.$line.':'.$column.': '.$type.' - '.$message.PHP_EOL; } } } return true; }//end generateFileReport() /** * Generates an emacs report. * * @param string $cachedData Any partial report data that was returned from * generateFileReport during the run. * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * @param int $totalFixable Total number of problems that can be fixed. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ) { echo $cachedData; }//end generate() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Full.php0000644000076700000240000001747012647543456021574 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Full report for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Gabriele Santini * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Full implements PHP_CodeSniffer_Report { /** * Generate a partial report for a single processed file. * * Function should return TRUE if it printed or stored data about the file * and FALSE if it ignored the file. Returning TRUE indicates that the file and * its data should be counted in the grand totals. * * @param array $report Prepared report data. * @param PHP_CodeSniffer_File $phpcsFile The file being reported on. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ) { if ($report['errors'] === 0 && $report['warnings'] === 0) { // Nothing to print. return false; } // The length of the word ERROR or WARNING; used for padding. if ($report['warnings'] > 0) { $typeLength = 7; } else { $typeLength = 5; } // Work out the max line number length for formatting. $maxLineNumLength = max(array_map('strlen', array_keys($report['messages']))); // The padding that all lines will require that are // printing an error message overflow. $paddingLine2 = str_repeat(' ', ($maxLineNumLength + 1)); $paddingLine2 .= ' | '; $paddingLine2 .= str_repeat(' ', $typeLength); $paddingLine2 .= ' | '; if ($report['fixable'] > 0) { $paddingLine2 .= ' '; } $paddingLength = strlen($paddingLine2); // Make sure the report width isn't too big. $maxErrorLength = 0; foreach ($report['messages'] as $line => $lineErrors) { foreach ($lineErrors as $column => $colErrors) { foreach ($colErrors as $error) { $length = strlen($error['message']); if ($showSources === true) { $length += (strlen($error['source']) + 3); } $maxErrorLength = max($maxErrorLength, ($length + 1)); } } } $file = $report['filename']; $fileLength = strlen($file); $maxWidth = max(($fileLength + 6), ($maxErrorLength + $paddingLength)); $width = min($width, $maxWidth); if ($width < 70) { $width = 70; } echo PHP_EOL."\033[1mFILE: "; if ($fileLength <= ($width - 6)) { echo $file; } else { echo '...'.substr($file, ($fileLength - ($width - 6))); } echo "\033[0m".PHP_EOL; echo str_repeat('-', $width).PHP_EOL; echo "\033[1m".'FOUND '.$report['errors'].' ERROR'; if ($report['errors'] !== 1) { echo 'S'; } if ($report['warnings'] > 0) { echo ' AND '.$report['warnings'].' WARNING'; if ($report['warnings'] !== 1) { echo 'S'; } } echo ' AFFECTING '.count($report['messages']).' LINE'; if (count($report['messages']) !== 1) { echo 'S'; } echo "\033[0m".PHP_EOL; echo str_repeat('-', $width).PHP_EOL; // The maximum amount of space an error message can use. $maxErrorSpace = ($width - $paddingLength - 1); if ($showSources === true) { // Account for the chars used to print colors. $maxErrorSpace += 8; } foreach ($report['messages'] as $line => $lineErrors) { foreach ($lineErrors as $column => $colErrors) { foreach ($colErrors as $error) { $message = $error['message']; $message = str_replace("\n", "\n".$paddingLine2, $message); if ($showSources === true) { $message = "\033[1m".$message."\033[0m".' ('.$error['source'].')'; } // The padding that goes on the front of the line. $padding = ($maxLineNumLength - strlen($line)); $errorMsg = wordwrap( $message, $maxErrorSpace, PHP_EOL.$paddingLine2 ); echo ' '.str_repeat(' ', $padding).$line.' | '; if ($error['type'] === 'ERROR') { echo "\033[31mERROR\033[0m"; if ($report['warnings'] > 0) { echo ' '; } } else { echo "\033[33mWARNING\033[0m"; } echo ' | '; if ($report['fixable'] > 0) { echo '['; if ($error['fixable'] === true) { echo 'x'; } else { echo ' '; } echo '] '; } echo $errorMsg.PHP_EOL; }//end foreach }//end foreach }//end foreach echo str_repeat('-', $width).PHP_EOL; if ($report['fixable'] > 0) { echo "\033[1m".'PHPCBF CAN FIX THE '.$report['fixable'].' MARKED SNIFF VIOLATIONS AUTOMATICALLY'."\033[0m".PHP_EOL; echo str_repeat('-', $width).PHP_EOL; } echo PHP_EOL; return true; }//end generateFileReport() /** * Prints all errors and warnings for each file processed. * * @param string $cachedData Any partial report data that was returned from * generateFileReport during the run. * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * @param int $totalFixable Total number of problems that can be fixed. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ) { if ($cachedData === '') { return; } echo $cachedData; if ($toScreen === true && PHP_CODESNIFFER_INTERACTIVE === false) { PHP_CodeSniffer_Reporting::printRunTime(); } }//end generate() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Gitblame.php0000644000076700000240000000653712647543456022420 0ustar gsherwoodstaff * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Gitblame report for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Ben Selby * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 1.2.2 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Gitblame extends PHP_CodeSniffer_Reports_VersionControl { /** * The name of the report we want in the output * * @var string */ protected $reportName = 'GIT'; /** * Extract the author from a blame line. * * @param string $line Line to parse. * * @return mixed string or false if impossible to recover. */ protected function getAuthor($line) { $blameParts = array(); $line = preg_replace('|\s+|', ' ', $line); preg_match( '|\(.+[0-9]{4}-[0-9]{2}-[0-9]{2}\s+[0-9]+\)|', $line, $blameParts ); if (isset($blameParts[0]) === false) { return false; } $parts = explode(' ', $blameParts[0]); if (count($parts) < 2) { return false; } $parts = array_slice($parts, 0, (count($parts) - 2)); $author = preg_replace('|\(|', '', implode($parts, ' ')); return $author; }//end getAuthor() /** * Gets the blame output. * * @param string $filename File to blame. * * @return array */ protected function getBlameContent($filename) { $cwd = getcwd(); if (PHP_CODESNIFFER_VERBOSITY > 0) { echo 'Getting GIT blame info for '.basename($filename).'... '; } $fileParts = explode(DIRECTORY_SEPARATOR, $filename); $found = false; $location = ''; while (empty($fileParts) === false) { array_pop($fileParts); $location = implode($fileParts, DIRECTORY_SEPARATOR); if (is_dir($location.DIRECTORY_SEPARATOR.'.git') === true) { $found = true; break; } } if ($found === true) { chdir($location); } else { echo 'ERROR: Could not locate .git directory '.PHP_EOL.PHP_EOL; exit(2); } $command = 'git blame --date=short "'.$filename.'" 2>&1'; $handle = popen($command, 'r'); if ($handle === false) { echo 'ERROR: Could not execute "'.$command.'"'.PHP_EOL.PHP_EOL; exit(2); } $rawContent = stream_get_contents($handle); fclose($handle); if (PHP_CODESNIFFER_VERBOSITY > 0) { echo 'DONE'.PHP_EOL; } $blames = explode("\n", $rawContent); chdir($cwd); return $blames; }//end getBlameContent() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Hgblame.php0000644000076700000240000000653612647543456022232 0ustar gsherwoodstaff * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Mercurial report for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Ben Selby * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Hgblame extends PHP_CodeSniffer_Reports_VersionControl { /** * The name of the report we want in the output * * @var string */ protected $reportName = 'MERCURIAL'; /** * Extract the author from a blame line. * * @param string $line Line to parse. * * @return mixed string or false if impossible to recover. */ protected function getAuthor($line) { $blameParts = array(); $line = preg_replace('|\s+|', ' ', $line); preg_match( '|(.+[0-9]{2}:[0-9]{2}:[0-9]{2}\s[0-9]{4}\s.[0-9]{4}:)|', $line, $blameParts ); if (isset($blameParts[0]) === false) { return false; } $parts = explode(' ', $blameParts[0]); if (count($parts) < 6) { return false; } $parts = array_slice($parts, 0, (count($parts) - 6)); return trim(preg_replace('|<.+>|', '', implode($parts, ' '))); }//end getAuthor() /** * Gets the blame output. * * @param string $filename File to blame. * * @return array */ protected function getBlameContent($filename) { $cwd = getcwd(); if (PHP_CODESNIFFER_VERBOSITY > 0) { echo 'Getting MERCURIAL blame info for '.basename($filename).'... '; } $fileParts = explode(DIRECTORY_SEPARATOR, $filename); $found = false; $location = ''; while (empty($fileParts) === false) { array_pop($fileParts); $location = implode($fileParts, DIRECTORY_SEPARATOR); if (is_dir($location.DIRECTORY_SEPARATOR.'.hg') === true) { $found = true; break; } } if ($found === true) { chdir($location); } else { echo 'ERROR: Could not locate .hg directory '.PHP_EOL.PHP_EOL; exit(2); } $command = 'hg blame -u -d -v "'.$filename.'" 2>&1'; $handle = popen($command, 'r'); if ($handle === false) { echo 'ERROR: Could not execute "'.$command.'"'.PHP_EOL.PHP_EOL; exit(2); } $rawContent = stream_get_contents($handle); fclose($handle); if (PHP_CODESNIFFER_VERBOSITY > 0) { echo 'DONE'.PHP_EOL; } $blames = explode("\n", $rawContent); chdir($cwd); return $blames; }//end getBlameContent() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Info.php0000644000076700000240000001206312647543456021556 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Info report for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Info implements PHP_CodeSniffer_Report { /** * TRUE if this report needs error messages instead of just totals. * * @var boolean */ public $recordErrors = false; /** * A cache of metrics collected during the run. * * @var array */ private $_metricCache = array(); /** * Generate a partial report for a single processed file. * * Function should return TRUE if it printed or stored data about the file * and FALSE if it ignored the file. Returning TRUE indicates that the file and * its data should be counted in the grand totals. * * @param array $report Prepared report data. * @param PHP_CodeSniffer_File $phpcsFile The file being reported on. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ) { $metrics = $phpcsFile->getMetrics(); foreach ($metrics as $metric => $data) { if (isset($this->_metricCache[$metric]) === false) { $this->_metricCache[$metric] = array(); } foreach ($data['values'] as $value => $locations) { $locations = array_unique($locations); $count = count($locations); if (isset($this->_metricCache[$metric][$value]) === false) { $this->_metricCache[$metric][$value] = $count; } else { $this->_metricCache[$metric][$value] += $count; } } }//end foreach return true; }//end generateFileReport() /** * Prints the source of all errors and warnings. * * @param string $cachedData Any partial report data that was returned from * generateFileReport during the run. * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * @param int $totalFixable Total number of problems that can be fixed. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ) { if (empty($this->_metricCache) === true) { // Nothing to show. return; } ksort($this->_metricCache); echo PHP_EOL."\033[1m".'PHP CODE SNIFFER INFORMATION REPORT'."\033[0m".PHP_EOL; echo str_repeat('-', 70).PHP_EOL; foreach ($this->_metricCache as $metric => $values) { $winner = ''; $winnerCount = 0; $totalCount = 0; foreach ($values as $value => $count) { $totalCount += $count; if ($count > $winnerCount) { $winner = $value; $winnerCount = $count; } } $winPercent = round(($winnerCount / $totalCount * 100), 2); echo "$metric: \033[4m$winner\033[0m [$winnerCount/$totalCount, $winPercent%]".PHP_EOL; asort($values); $values = array_reverse($values, true); foreach ($values as $value => $count) { if ($value === $winner) { continue; } $percent = round(($count / $totalCount * 100), 2); echo "\t$value => $count ($percent%)".PHP_EOL; } echo PHP_EOL; }//end foreach echo str_repeat('-', 70).PHP_EOL; if ($toScreen === true && PHP_CODESNIFFER_INTERACTIVE === false) { PHP_CodeSniffer_Reporting::printRunTime(); } }//end generate() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Json.php0000644000076700000240000001127112647543456021574 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Json report for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Jeffrey Fisher * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Json implements PHP_CodeSniffer_Report { /** * Generate a partial report for a single processed file. * * Function should return TRUE if it printed or stored data about the file * and FALSE if it ignored the file. Returning TRUE indicates that the file and * its data should be counted in the grand totals. * * @param array $report Prepared report data. * @param PHP_CodeSniffer_File $phpcsFile The file being reported on. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ) { $filename = str_replace('\\', '\\\\', $report['filename']); $filename = str_replace('"', '\"', $filename); $filename = str_replace('/', '\/', $filename); echo '"'.$filename.'":{'; echo '"errors":'.$report['errors'].',"warnings":'.$report['warnings'].',"messages":['; $messages = ''; foreach ($report['messages'] as $line => $lineErrors) { foreach ($lineErrors as $column => $colErrors) { foreach ($colErrors as $error) { $error['message'] = str_replace('\\', '\\\\', $error['message']); $error['message'] = str_replace('"', '\"', $error['message']); $error['message'] = str_replace('/', '\/', $error['message']); $error['message'] = str_replace("\n", '\n', $error['message']); $error['message'] = str_replace("\r", '\r', $error['message']); $error['message'] = str_replace("\t", '\t', $error['message']); $fixable = 'false'; if ($error['fixable'] === true) { $fixable = 'true'; } $messages .= '{"message":"'.$error['message'].'",'; $messages .= '"source":"'.$error['source'].'",'; $messages .= '"severity":'.$error['severity'].','; $messages .= '"type":"'.$error['type'].'",'; $messages .= '"line":'.$line.','; $messages .= '"column":'.$column.','; $messages .= '"fixable":'.$fixable; $messages .= '},'; }//end foreach }//end foreach }//end foreach echo rtrim($messages, ','); echo ']},'; return true; }//end generateFileReport() /** * Generates a JSON report. * * @param string $cachedData Any partial report data that was returned from * generateFileReport during the run. * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * @param int $totalFixable Total number of problems that can be fixed. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ) { echo '{"totals":{"errors":'.$totalErrors.',"warnings":'.$totalWarnings.',"fixable":'.$totalFixable.'},"files":{'; echo rtrim($cachedData, ','); echo "}}"; }//end generate() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Junit.php0000644000076700000240000001210512647543456021751 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * JUnit report for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Oleg Lobach * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Junit implements PHP_CodeSniffer_Report { /** * A count of tests that have been performed. * * @var int */ private $_tests = 0; /** * Generate a partial report for a single processed file. * * Function should return TRUE if it printed or stored data about the file * and FALSE if it ignored the file. Returning TRUE indicates that the file and * its data should be counted in the grand totals. * * @param array $report Prepared report data. * @param PHP_CodeSniffer_File $phpcsFile The file being reported on. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ) { if (count($report['messages']) === 0) { $this->_tests++; } else { $this->_tests += ($report['errors'] + $report['warnings']); } $out = new XMLWriter; $out->openMemory(); $out->setIndent(true); $out->startElement('testsuite'); $out->writeAttribute('name', $report['filename']); if (count($report['messages']) === 0) { $out->writeAttribute('tests', 1); $out->writeAttribute('failures', 0); $out->startElement('testcase'); $out->writeAttribute('name', $report['filename']); $out->endElement(); } else { $failures = ($report['errors'] + $report['warnings']); $out->writeAttribute('tests', $failures); $out->writeAttribute('failures', $failures); foreach ($report['messages'] as $line => $lineErrors) { foreach ($lineErrors as $column => $colErrors) { foreach ($colErrors as $error) { $out->startElement('testcase'); $out->writeAttribute('name', $error['source'].' at '.$report['filename']." ($line:$column)"); $error['type'] = strtolower($error['type']); if (PHP_CODESNIFFER_ENCODING !== 'utf-8') { $error['message'] = iconv(PHP_CODESNIFFER_ENCODING, 'utf-8', $error['message']); } $out->startElement('failure'); $out->writeAttribute('type', $error['type']); $out->writeAttribute('message', $error['message']); $out->endElement(); $out->endElement(); } } } }//end if $out->endElement(); echo $out->flush(); return true; }//end generateFileReport() /** * Prints all violations for processed files, in a proprietary XML format. * * @param string $cachedData Any partial report data that was returned from * generateFileReport during the run. * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * @param int $totalFixable Total number of problems that can be fixed. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ) { $failures = ($totalErrors + $totalWarnings); echo ''.PHP_EOL; echo ''.PHP_EOL; echo $cachedData; echo ''.PHP_EOL; }//end generate() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Notifysend.php0000644000076700000240000001656312647543456023016 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2012-2014 Christian Weiske * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Notify-send report for PHP_CodeSniffer. * * Supported configuration parameters: * - notifysend_path - Full path to notify-send cli command * - notifysend_timeout - Timeout in milliseconds * - notifysend_showok - Show "ok, all fine" messages (0/1) * * @category PHP * @package PHP_CodeSniffer * @author Christian Weiske * @author Greg Sherwood * @copyright 2012-2014 Christian Weiske * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Notifysend implements PHP_CodeSniffer_Report { /** * Notification timeout in milliseconds. * * @var integer */ protected $timeout = 3000; /** * Path to notify-send command. * * @var string */ protected $path = 'notify-send'; /** * Show "ok, all fine" messages. * * @var boolean */ protected $showOk = true; /** * Version of installed notify-send executable. * * @var string */ protected $version = null; /** * A record of the last file checked. * * This is used in case we only checked one file and need to print * the name/path of the file. We wont have access to the checked file list * after the run has been completed. * * @var string */ private $_lastCheckedFile = ''; /** * Load configuration data. */ public function __construct() { $path = PHP_CodeSniffer::getConfigData('notifysend_path'); if ($path !== null) { $this->path = $path; } $timeout = PHP_CodeSniffer::getConfigData('notifysend_timeout'); if ($timeout !== null) { $this->timeout = (int) $timeout; } $showOk = PHP_CodeSniffer::getConfigData('notifysend_showok'); if ($showOk !== null) { $this->showOk = (boolean) $showOk; } $this->version = str_replace( 'notify-send ', '', exec($this->path.' --version') ); }//end __construct() /** * Generate a partial report for a single processed file. * * Function should return TRUE if it printed or stored data about the file * and FALSE if it ignored the file. Returning TRUE indicates that the file and * its data should be counted in the grand totals. * * @param array $report Prepared report data. * @param PHP_CodeSniffer_File $phpcsFile The file being reported on. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ) { // We don't need to print anything, but we want this file counted // in the total number of checked files even if it has no errors. $this->_lastCheckedFile = $report['filename']; return true; }//end generateFileReport() /** * Generates a summary of errors and warnings for each file processed. * * @param string $cachedData Any partial report data that was returned from * generateFileReport during the run. * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * @param int $totalFixable Total number of problems that can be fixed. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ) { $msg = $this->generateMessage($totalFiles, $totalErrors, $totalWarnings); if ($msg === null) { if ($this->showOk === true) { $this->notifyAllFine(); } } else { $this->notifyErrors($msg); } }//end generate() /** * Generate the error message to show to the user. * * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * * @return string Error message or NULL if no error/warning found. */ protected function generateMessage($totalFiles, $totalErrors, $totalWarnings) { if ($totalErrors === 0 && $totalWarnings === 0) { // Nothing to print. return null; } $msg = ''; if ($totalFiles > 1) { $msg .= 'Checked '.$totalFiles.' files'.PHP_EOL; } else { $msg .= $this->_lastCheckedFile.PHP_EOL; } if ($totalWarnings > 0) { $msg .= $totalWarnings.' warnings'.PHP_EOL; } if ($totalErrors > 0) { $msg .= $totalErrors.' errors'.PHP_EOL; } return $msg; }//end generateMessage() /** * Tell the user that all is fine and no error/warning has been found. * * @return void */ protected function notifyAllFine() { $cmd = $this->getBasicCommand(); $cmd .= ' -i info'; $cmd .= ' "PHP CodeSniffer: Ok"'; $cmd .= ' "All fine"'; exec($cmd); }//end notifyAllFine() /** * Tell the user that errors/warnings have been found. * * @param string $msg Message to display. * * @return void */ protected function notifyErrors($msg) { $cmd = $this->getBasicCommand(); $cmd .= ' -i error'; $cmd .= ' "PHP CodeSniffer: Error"'; $cmd .= ' '.escapeshellarg(trim($msg)); exec($cmd); }//end notifyErrors() /** * Generate and return the basic notify-send command string to execute. * * @return string Shell command with common parameters. */ protected function getBasicCommand() { $cmd = escapeshellcmd($this->path); $cmd .= ' --category dev.validate'; $cmd .= ' -h int:transient:1'; $cmd .= ' -t '.(int) $this->timeout; if (version_compare($this->version, '0.7.3', '>=') === true) { $cmd .= ' -a phpcs'; } return $cmd; }//end getBasicCommand() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Source.php0000644000076700000240000002613012647543456022123 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Source report for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Gabriele Santini * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Source implements PHP_CodeSniffer_Report { /** * A cache of source stats collected during the run. * * @var array */ private $_sourceCache = array(); /** * Generate a partial report for a single processed file. * * Function should return TRUE if it printed or stored data about the file * and FALSE if it ignored the file. Returning TRUE indicates that the file and * its data should be counted in the grand totals. * * @param array $report Prepared report data. * @param PHP_CodeSniffer_File $phpcsFile The file being reported on. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ) { if ($report['errors'] === 0 && $report['warnings'] === 0) { // Nothing to print. return false; } foreach ($report['messages'] as $line => $lineErrors) { foreach ($lineErrors as $column => $colErrors) { foreach ($colErrors as $error) { $source = $error['source']; if (isset($this->_sourceCache[$source]) === false) { if ($showSources === true) { $parts = null; $sniff = $source; } else { $parts = explode('.', $source); if ($parts[0] === 'Internal') { $parts[2] = $parts[1]; $parts[1] = ''; } $parts[1] = $this->makeFriendlyName($parts[1]); $sniff = $this->makeFriendlyName($parts[2]); if (isset($parts[3]) === true) { $name = $this->makeFriendlyName($parts[3]); $name[0] = strtolower($name[0]); $sniff .= ' '.$name; unset($parts[3]); } $parts[2] = $sniff; }//end if $this->_sourceCache[$source] = array( 'count' => 1, 'fixable' => $error['fixable'], 'parts' => $parts, 'strlen' => strlen($sniff), ); } else { $this->_sourceCache[$source]['count']++; }//end if }//end foreach }//end foreach }//end foreach return true; }//end generateFileReport() /** * Prints the source of all errors and warnings. * * @param string $cachedData Any partial report data that was returned from * generateFileReport during the run. * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * @param int $totalFixable Total number of problems that can be fixed. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ) { if (empty($this->_sourceCache) === true) { // Nothing to show. return; } // Make sure the report width isn't too big. $maxLength = 0; foreach ($this->_sourceCache as $source => $data) { $maxLength = max($maxLength, $data['strlen']); } if ($showSources === true) { $width = min($width, ($maxLength + 11)); } else { $width = min($width, ($maxLength + 41)); } $width = max($width, 70); asort($this->_sourceCache); $this->_sourceCache = array_reverse($this->_sourceCache); echo PHP_EOL."\033[1mPHP CODE SNIFFER VIOLATION SOURCE SUMMARY\033[0m".PHP_EOL; echo str_repeat('-', $width).PHP_EOL."\033[1m"; if ($showSources === true) { if ($totalFixable > 0) { echo ' SOURCE'.str_repeat(' ', ($width - 15)).'COUNT'.PHP_EOL; } else { echo 'SOURCE'.str_repeat(' ', ($width - 11)).'COUNT'.PHP_EOL; } } else { if ($totalFixable > 0) { echo ' STANDARD CATEGORY SNIFF'.str_repeat(' ', ($width - 44)).'COUNT'.PHP_EOL; } else { echo 'STANDARD CATEGORY SNIFF'.str_repeat(' ', ($width - 40)).'COUNT'.PHP_EOL; } } echo "\033[0m".str_repeat('-', $width).PHP_EOL; $fixableSources = 0; if ($showSources === true) { $maxSniffWidth = ($width - 7); } else { $maxSniffWidth = ($width - 37); } if ($totalFixable > 0) { $maxSniffWidth -= 4; } foreach ($this->_sourceCache as $source => $sourceData) { if ($totalFixable > 0) { echo '['; if ($sourceData['fixable'] === true) { echo 'x'; $fixableSources++; } else { echo ' '; } echo '] '; } if ($showSources === true) { if ($sourceData['strlen'] > $maxSniffWidth) { $source = substr($source, 0, $maxSniffWidth); } echo $source; if ($totalFixable > 0) { echo str_repeat(' ', ($width - 9 - strlen($source))); } else { echo str_repeat(' ', ($width - 5 - strlen($source))); } } else { $parts = $sourceData['parts']; if (strlen($parts[0]) > 8) { $parts[0] = substr($parts[0], 0, ((strlen($parts[0]) - 8) * -1)); } echo $parts[0].str_repeat(' ', (10 - strlen($parts[0]))); $category = $parts[1]; if (strlen($category) > 18) { $category = substr($category, 0, ((strlen($category) - 18) * -1)); } echo $category.str_repeat(' ', (20 - strlen($category))); $sniff = $parts[2]; if (strlen($sniff) > $maxSniffWidth) { $sniff = substr($sniff, 0, $maxSniffWidth); } if ($totalFixable > 0) { echo $sniff.str_repeat(' ', ($width - 39 - strlen($sniff))); } else { echo $sniff.str_repeat(' ', ($width - 35 - strlen($sniff))); } }//end if echo $sourceData['count'].PHP_EOL; }//end foreach echo str_repeat('-', $width).PHP_EOL; echo "\033[1m".'A TOTAL OF '.($totalErrors + $totalWarnings).' SNIFF VIOLATION'; if (($totalErrors + $totalWarnings) > 1) { echo 'S'; } echo ' WERE FOUND IN '.count($this->_sourceCache).' SOURCE'; if (count($this->_sourceCache) !== 1) { echo 'S'; } echo "\033[0m"; if ($totalFixable > 0) { echo PHP_EOL.str_repeat('-', $width).PHP_EOL; echo "\033[1mPHPCBF CAN FIX THE $fixableSources MARKED SOURCES AUTOMATICALLY ($totalFixable VIOLATIONS IN TOTAL)\033[0m"; } echo PHP_EOL.str_repeat('-', $width).PHP_EOL.PHP_EOL; if ($toScreen === true && PHP_CODESNIFFER_INTERACTIVE === false) { PHP_CodeSniffer_Reporting::printRunTime(); } }//end generate() /** * Converts a camel caps name into a readable string. * * @param string $name The camel caps name to convert. * * @return string */ public function makeFriendlyName($name) { if (trim($name) === '') { return ''; } $friendlyName = ''; $length = strlen($name); $lastWasUpper = false; $lastWasNumeric = false; for ($i = 0; $i < $length; $i++) { if (is_numeric($name[$i]) === true) { if ($lastWasNumeric === false) { $friendlyName .= ' '; } $lastWasUpper = false; $lastWasNumeric = true; } else { $lastWasNumeric = false; $char = strtolower($name[$i]); if ($char === $name[$i]) { // Lowercase. $lastWasUpper = false; } else { // Uppercase. if ($lastWasUpper === false) { $friendlyName .= ' '; if ($i < ($length - 1)) { $next = $name[($i + 1)]; if (strtolower($next) === $next) { // Next char is lowercase so it is a word boundary. $name[$i] = strtolower($name[$i]); } } } $lastWasUpper = true; } }//end if $friendlyName .= $name[$i]; }//end for $friendlyName = trim($friendlyName); $friendlyName[0] = strtoupper($friendlyName[0]); return $friendlyName; }//end makeFriendlyName() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Summary.php0000644000076700000240000001371212647543456022322 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Summary report for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Gabriele Santini * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Summary implements PHP_CodeSniffer_Report { /** * TRUE if this report needs error messages instead of just totals. * * @var boolean */ public $recordErrors = false; /** * An array of process files and their error data. * * @var boolean */ private $_reportFiles = array(); /** * Generate a partial report for a single processed file. * * Function should return TRUE if it printed or stored data about the file * and FALSE if it ignored the file. Returning TRUE indicates that the file and * its data should be counted in the grand totals. * * @param array $report Prepared report data. * @param PHP_CodeSniffer_File $phpcsFile The file being reported on. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ) { if (PHP_CODESNIFFER_VERBOSITY === 0 && $report['errors'] === 0 && $report['warnings'] === 0 ) { // Nothing to print. return false; } $this->_reportFiles[$report['filename']] = array( 'errors' => $report['errors'], 'warnings' => $report['warnings'], 'strlen' => strlen($report['filename']), ); return true; }//end generateFileReport() /** * Generates a summary of errors and warnings for each file processed. * * @param string $cachedData Any partial report data that was returned from * generateFileReport during the run. * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * @param int $totalFixable Total number of problems that can be fixed. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ) { if (empty($this->_reportFiles) === true) { return; } // Make sure the report width isn't too big. $maxLength = 0; foreach ($this->_reportFiles as $file => $data) { $maxLength = max($maxLength, $data['strlen']); } $width = min($width, ($maxLength + 21)); $width = max($width, 70); echo PHP_EOL."\033[1m".'PHP CODE SNIFFER REPORT SUMMARY'."\033[0m".PHP_EOL; echo str_repeat('-', $width).PHP_EOL; echo "\033[1m".'FILE'.str_repeat(' ', ($width - 20)).'ERRORS WARNINGS'."\033[0m".PHP_EOL; echo str_repeat('-', $width).PHP_EOL; foreach ($this->_reportFiles as $file => $data) { $padding = ($width - 18 - $data['strlen']); if ($padding < 0) { $file = '...'.substr($file, (($padding * -1) + 3)); $padding = 0; } echo $file.str_repeat(' ', $padding).' '; if ($data['errors'] !== 0) { echo "\033[31m".$data['errors']."\033[0m"; echo str_repeat(' ', (8 - strlen((string) $data['errors']))); } else { echo '0 '; } if ($data['warnings'] !== 0) { echo "\033[33m".$data['warnings']."\033[0m"; } else { echo '0'; } echo PHP_EOL; }//end foreach echo str_repeat('-', $width).PHP_EOL; echo "\033[1mA TOTAL OF $totalErrors ERROR"; if ($totalErrors !== 1) { echo 'S'; } echo ' AND '.$totalWarnings.' WARNING'; if ($totalWarnings !== 1) { echo 'S'; } echo ' WERE FOUND IN '.$totalFiles.' FILE'; if ($totalFiles !== 1) { echo 'S'; } echo "\033[0m"; if ($totalFixable > 0) { echo PHP_EOL.str_repeat('-', $width).PHP_EOL; echo "\033[1mPHPCBF CAN FIX $totalFixable OF THESE SNIFF VIOLATIONS AUTOMATICALLY\033[0m"; } echo PHP_EOL.str_repeat('-', $width).PHP_EOL.PHP_EOL; if ($toScreen === true && PHP_CODESNIFFER_INTERACTIVE === false) { PHP_CodeSniffer_Reporting::printRunTime(); } }//end generate() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Svnblame.php0000644000076700000240000000471312647543456022435 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Svnblame report for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Gabriele Santini * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Svnblame extends PHP_CodeSniffer_Reports_VersionControl { /** * The name of the report we want in the output * * @var string */ protected $reportName = 'SVN'; /** * Extract the author from a blame line. * * @param string $line Line to parse. * * @return mixed string or false if impossible to recover. */ protected function getAuthor($line) { $blameParts = array(); preg_match('|\s*([^\s]+)\s+([^\s]+)|', $line, $blameParts); if (isset($blameParts[2]) === false) { return false; } return $blameParts[2]; }//end getAuthor() /** * Gets the blame output. * * @param string $filename File to blame. * * @return array */ protected function getBlameContent($filename) { if (PHP_CODESNIFFER_VERBOSITY > 0) { echo 'Getting SVN blame info for '.basename($filename).'... '; } $command = 'svn blame "'.$filename.'" 2>&1'; $handle = popen($command, 'r'); if ($handle === false) { echo 'ERROR: Could not execute "'.$command.'"'.PHP_EOL.PHP_EOL; exit(2); } $rawContent = stream_get_contents($handle); fclose($handle); if (PHP_CODESNIFFER_VERBOSITY > 0) { echo 'DONE'.PHP_EOL; } $blames = explode("\n", $rawContent); return $blames; }//end getBlameContent() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/VersionControl.php0000644000076700000240000002356112647543456023656 0ustar gsherwoodstaff * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Version control report base class for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Ben Selby * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 1.2.2 * @link http://pear.php.net/package/PHP_CodeSniffer */ abstract class PHP_CodeSniffer_Reports_VersionControl implements PHP_CodeSniffer_Report { /** * The name of the report we want in the output. * * @var string */ protected $reportName = 'VERSION CONTROL'; /** * A cache of author stats collected during the run. * * @var array */ private $_authorCache = array(); /** * A cache of blame stats collected during the run. * * @var array */ private $_praiseCache = array(); /** * A cache of source stats collected during the run. * * @var array */ private $_sourceCache = array(); /** * Generate a partial report for a single processed file. * * Function should return TRUE if it printed or stored data about the file * and FALSE if it ignored the file. Returning TRUE indicates that the file and * its data should be counted in the grand totals. * * @param array $report Prepared report data. * @param PHP_CodeSniffer_File $phpcsFile The file being reported on. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ) { $blames = $this->getBlameContent($report['filename']); foreach ($report['messages'] as $line => $lineErrors) { $author = 'Unknown'; if (isset($blames[($line - 1)]) === true) { $blameAuthor = $this->getAuthor($blames[($line - 1)]); if ($blameAuthor !== false) { $author = $blameAuthor; } } if (isset($this->_authorCache[$author]) === false) { $this->_authorCache[$author] = 0; $this->_praiseCache[$author] = array( 'good' => 0, 'bad' => 0, ); } $this->_praiseCache[$author]['bad']++; foreach ($lineErrors as $column => $colErrors) { foreach ($colErrors as $error) { $this->_authorCache[$author]++; if ($showSources === true) { $source = $error['source']; if (isset($this->_sourceCache[$author][$source]) === false) { $this->_sourceCache[$author][$source] = 1; } else { $this->_sourceCache[$author][$source]++; } } } } unset($blames[($line - 1)]); }//end foreach // No go through and give the authors some credit for // all the lines that do not have errors. foreach ($blames as $line) { $author = $this->getAuthor($line); if ($author === false) { $author = 'Unknown'; } if (isset($this->_authorCache[$author]) === false) { // This author doesn't have any errors. if (PHP_CODESNIFFER_VERBOSITY === 0) { continue; } $this->_authorCache[$author] = 0; $this->_praiseCache[$author] = array( 'good' => 0, 'bad' => 0, ); } $this->_praiseCache[$author]['good']++; }//end foreach return true; }//end generateFileReport() /** * Prints the author of all errors and warnings, as given by "version control blame". * * @param string $cachedData Any partial report data that was returned from * generateFileReport during the run. * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * @param int $totalFixable Total number of problems that can be fixed. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ) { $errorsShown = ($totalErrors + $totalWarnings); if ($errorsShown === 0) { // Nothing to show. return; } // Make sure the report width isn't too big. $maxLength = 0; foreach ($this->_authorCache as $author => $count) { $maxLength = max($maxLength, strlen($author)); if ($showSources === true && isset($this->_sourceCache[$author]) === true) { foreach ($this->_sourceCache[$author] as $source => $count) { if ($source === 'count') { continue; } $maxLength = max($maxLength, (strlen($source) + 9)); } } } $width = min($width, ($maxLength + 30)); $width = max($width, 70); arsort($this->_authorCache); echo PHP_EOL."\033[1m".'PHP CODE SNIFFER '.$this->reportName.' BLAME SUMMARY'."\033[0m".PHP_EOL; echo str_repeat('-', $width).PHP_EOL."\033[1m"; if ($showSources === true) { echo 'AUTHOR SOURCE'.str_repeat(' ', ($width - 43)).'(Author %) (Overall %) COUNT'.PHP_EOL; echo str_repeat('-', $width).PHP_EOL; } else { echo 'AUTHOR'.str_repeat(' ', ($width - 34)).'(Author %) (Overall %) COUNT'.PHP_EOL; echo str_repeat('-', $width).PHP_EOL; } echo "\033[0m"; foreach ($this->_authorCache as $author => $count) { if ($this->_praiseCache[$author]['good'] === 0) { $percent = 0; } else { $total = ($this->_praiseCache[$author]['bad'] + $this->_praiseCache[$author]['good']); $percent = round(($this->_praiseCache[$author]['bad'] / $total * 100), 2); } $overallPercent = '('.round((($count / $errorsShown) * 100), 2).')'; $authorPercent = '('.$percent.')'; $line = str_repeat(' ', (6 - strlen($count))).$count; $line = str_repeat(' ', (12 - strlen($overallPercent))).$overallPercent.$line; $line = str_repeat(' ', (11 - strlen($authorPercent))).$authorPercent.$line; $line = $author.str_repeat(' ', ($width - strlen($author) - strlen($line))).$line; if ($showSources === true) { $line = "\033[1m$line\033[0m"; } echo $line.PHP_EOL; if ($showSources === true && isset($this->_sourceCache[$author]) === true) { $errors = $this->_sourceCache[$author]; asort($errors); $errors = array_reverse($errors); foreach ($errors as $source => $count) { if ($source === 'count') { continue; } $line = str_repeat(' ', (5 - strlen($count))).$count; echo ' '.$source.str_repeat(' ', ($width - 14 - strlen($source))).$line.PHP_EOL; } } }//end foreach echo str_repeat('-', $width).PHP_EOL; echo "\033[1m".'A TOTAL OF '.$errorsShown.' SNIFF VIOLATION'; if ($errorsShown !== 1) { echo 'S'; } echo ' WERE COMMITTED BY '.count($this->_authorCache).' AUTHOR'; if (count($this->_authorCache) !== 1) { echo 'S'; } echo "\033[0m"; if ($totalFixable > 0) { echo PHP_EOL.str_repeat('-', $width).PHP_EOL; echo "\033[1mPHPCBF CAN FIX $totalFixable OF THESE SNIFF VIOLATIONS AUTOMATICALLY\033[0m"; } echo PHP_EOL.str_repeat('-', $width).PHP_EOL.PHP_EOL; if ($toScreen === true && PHP_CODESNIFFER_INTERACTIVE === false) { PHP_CodeSniffer_Reporting::printRunTime(); } }//end generate() /** * Extract the author from a blame line. * * @param string $line Line to parse. * * @return mixed string or false if impossible to recover. */ abstract protected function getAuthor($line); /** * Gets the blame output. * * @param string $filename File to blame. * * @return array */ abstract protected function getBlameContent($filename); }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Reports/Xml.php0000644000076700000240000001110712647543456021421 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Xml report for PHP_CodeSniffer. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Gabriele Santini * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reports_Xml implements PHP_CodeSniffer_Report { /** * Generate a partial report for a single processed file. * * Function should return TRUE if it printed or stored data about the file * and FALSE if it ignored the file. Returning TRUE indicates that the file and * its data should be counted in the grand totals. * * @param array $report Prepared report data. * @param PHP_CodeSniffer_File $phpcsFile The file being reported on. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ) { $out = new XMLWriter; $out->openMemory(); $out->setIndent(true); if ($report['errors'] === 0 && $report['warnings'] === 0) { // Nothing to print. return false; } $out->startElement('file'); $out->writeAttribute('name', $report['filename']); $out->writeAttribute('errors', $report['errors']); $out->writeAttribute('warnings', $report['warnings']); $out->writeAttribute('fixable', $report['fixable']); foreach ($report['messages'] as $line => $lineErrors) { foreach ($lineErrors as $column => $colErrors) { foreach ($colErrors as $error) { $error['type'] = strtolower($error['type']); if (PHP_CODESNIFFER_ENCODING !== 'utf-8') { $error['message'] = iconv(PHP_CODESNIFFER_ENCODING, 'utf-8', $error['message']); } $out->startElement($error['type']); $out->writeAttribute('line', $line); $out->writeAttribute('column', $column); $out->writeAttribute('source', $error['source']); $out->writeAttribute('severity', $error['severity']); $out->writeAttribute('fixable', (int) $error['fixable']); $out->text($error['message']); $out->endElement(); } } }//end foreach $out->endElement(); echo $out->flush(); return true; }//end generateFileReport() /** * Prints all violations for processed files, in a proprietary XML format. * * @param string $cachedData Any partial report data that was returned from * generateFileReport during the run. * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * @param int $totalFixable Total number of problems that can be fixed. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ) { echo ''.PHP_EOL; echo ''.PHP_EOL; echo $cachedData; echo ''.PHP_EOL; }//end generate() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Classes/DuplicateClassNameStandard.xml0000644000076700000240000000105312647543456032201 0ustar gsherwoodstaff Foo { } ]]> Foo { } class Foo { } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Debug/CSSLintStandard.xml0000644000076700000240000000073112647543456027412 0ustar gsherwoodstaff %; } ]]> %; } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Debug/ClosureLinterStandard.xml0000644000076700000240000000075312647543456030731 0ustar gsherwoodstaff ]; ]]> ,]; ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Debug/JSHintStandard.xml0000644000076700000240000000072512647543456027275 0ustar gsherwoodstaff var foo = 5; ]]> foo = 5; ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Commenting/FixmeStandard.xml0000644000076700000240000000102212647543456030247 0ustar gsherwoodstaff Handle strange case if ($test) { $var = 1; } ]]> FIXME: This needs to be fixed! if ($test) { $var = 1; } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Commenting/TodoStandard.xml0000644000076700000240000000101612647543456030107 0ustar gsherwoodstaff Handle strange case if ($test) { $var = 1; } ]]> TODO: This needs to be fixed! if ($test) { $var = 1; } ]]> ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/CodeAnalysis/JumbledIncrementerStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/CodeAnalysis/JumbledIncrementerStandard.xml0000644000076700000240000000124312647543456033240 0ustar gsherwoodstaff $i++) { for ($j = 0; $j < 10; $j++) { } } ]]> $i++) { for ($j = 0; $j < 10; $i++) { } } ]]> ././@LongLink000 151 0003733 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/CodeAnalysis/UnusedFunctionParameterStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/CodeAnalysis/UnusedFunctionParameterStandar0000644000076700000240000000113112647543456033325 0ustar gsherwoodstaff $a + $b + $c; } ]]> $a + $b; } ]]> ././@LongLink000 155 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/ControlStructures/InlineControlStructureStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/ControlStructures/InlineControlStructureSta0000644000076700000240000000101612647543456033516 0ustar gsherwoodstaff { $var = 1; } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/CodeAnalysis/EmptyStatementStandard.xml0000644000076700000240000000104512647543456032445 0ustar gsherwoodstaff // do nothing } ]]> ././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/CodeAnalysis/ForLoopShouldBeWhileLoopStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/CodeAnalysis/ForLoopShouldBeWhileLoopStanda0000644000076700000240000000121612647543456033166 0ustar gsherwoodstaff $i = 0; $i < 10; $i++) { echo "{$i}\n"; } ]]> ;$test;) { $test = doSomething(); } ]]> ././@LongLink000 155 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/CodeAnalysis/ForLoopWithTestFunctionCallStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/CodeAnalysis/ForLoopWithTestFunctionCallSta0000644000076700000240000000135212647543456033231 0ustar gsherwoodstaff $end = count($foo); for ($i = 0; $i < $end; $i++) { echo $foo[$i]."\n"; } ]]> count($foo); $i++) { echo $foo[$i]."\n"; } ]]> ././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/CodeAnalysis/UnconditionalIfStatementStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/CodeAnalysis/UnconditionalIfStatementStanda0000644000076700000240000000162612647543456033314 0ustar gsherwoodstaff $test) { $var = 1; } ]]> true) { $var = 1; } ]]> $test) { $var = 1; } ]]> false) { $var = 1; } ]]> ././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/CodeAnalysis/UnnecessaryFinalModifierStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/CodeAnalysis/UnnecessaryFinalModifierStanda0000644000076700000240000000116712647543456033272 0ustar gsherwoodstaff final function bar() { } } ]]> ././@LongLink000 151 0003733 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/CodeAnalysis/UselessOverridingMethodStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/CodeAnalysis/UselessOverridingMethodStandar0000644000076700000240000000130312647543456033331 0ustar gsherwoodstaff $this->doSomethingElse(); } } ]]> parent::bar(); } } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Files/ByteOrderMarkStandard.xml0000644000076700000240000000040612647543456030660 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Files/EndFileNewlineStandard.xml0000644000076700000240000000024112647543456030773 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Files/EndFileNoNewlineStandard.xml0000644000076700000240000000025012647543456031270 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Files/InlineHTMLStandard.xml0000644000076700000240000000112312647543456030046 0ustar gsherwoodstaff some string here PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Files/LineEndingsStandard.xml0000644000076700000240000000025712647543456030351 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Files/LineLengthStandard.xml0000644000076700000240000000031712647543456030200 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Files/LowercasedFilenameStandard.xml0000644000076700000240000000023112647543456031673 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Files/OneClassPerFileStandard.xml0000644000076700000240000000100212647543456031115 0ustar gsherwoodstaff class Foo { } ]]> class Foo { } class Bar { } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Files/OneInterfacePerFileStandard.xml0000644000076700000240000000103512647543456031756 0ustar gsherwoodstaff interface Foo { } ]]> interface Foo { } interface Bar { } ]]> ././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Formatting/DisallowMultipleStatementsStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Formatting/DisallowMultipleStatementsStanda0000644000076700000240000000101412647543456033427 0ustar gsherwoodstaff ././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Formatting/MultipleStatementAlignmentStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Formatting/MultipleStatementAlignmentStanda0000644000076700000240000000331512647543456033412 0ustar gsherwoodstaff = (1 + 2); $veryLongVarName = 'string'; $var = foo($bar, $baz, $quux); ]]> = (1 + 2); $veryLongVarName = 'string'; $var = foo($bar, $baz, $quux); ]]> += 1; $veryLongVarName = 1; ]]> += 1; $veryLongVarName = 1; ]]> = 1; $veryLongVarName -= 1; ]]> = 1; $veryLongVarName -= 1; ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Formatting/NoSpaceAfterCastStandard.xml0000644000076700000240000000076512647543456032353 0ustar gsherwoodstaff 1; ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Formatting/SpaceAfterCastStandard.xml0000644000076700000240000000076612647543456032057 0ustar gsherwoodstaff 1; ]]> 1; ]]> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Functions/CallTimePassByReferenceStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Functions/CallTimePassByReferenceStandard.x0000644000076700000240000000123112647543456033153 0ustar gsherwoodstaff &$bar) { $bar++; } $baz = 1; foo($baz); ]]> &$baz); ]]> ././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Functions/FunctionCallArgumentSpacingStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Functions/FunctionCallArgumentSpacingStanda0000644000076700000240000000174512647543456033327 0ustar gsherwoodstaff $baz) { } ]]> $baz) { } ]]> = true) { } ]]> =true) { } ]]> ././@LongLink000 154 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Functions/OpeningFunctionBraceBsdAllmanStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Functions/OpeningFunctionBraceBsdAllmanStan0000644000076700000240000000126712647543456033250 0ustar gsherwoodstaff { ... } ]]> { ... } ]]> ././@LongLink000 163 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Functions/OpeningFunctionBraceKernighanRitchieStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Functions/OpeningFunctionBraceKernighanRitc0000644000076700000240000000126512647543456033313 0ustar gsherwoodstaff { ... } ]]> { ... } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Metrics/CyclomaticComplexityStandard.xml0000644000076700000240000000035412647543456032661 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Metrics/NestingLevelStandard.xml0000644000076700000240000000031312647543456031106 0ustar gsherwoodstaff ././@LongLink000 154 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/NamingConventions/CamelCapsFunctionNameStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/NamingConventions/CamelCapsFunctionNameStan0000644000076700000240000000110312647543456033243 0ustar gsherwoodstaff doSomething() { } ]]> do_something() { } ]]> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/NamingConventions/ConstructorNameStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/NamingConventions/ConstructorNameStandard.x0000644000076700000240000000110112647543456033331 0ustar gsherwoodstaff __construct() { } } ]]> Foo() { } } ]]> ././@LongLink000 154 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/NamingConventions/UpperCaseConstantNameStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/NamingConventions/UpperCaseConstantNameStan0000644000076700000240000000115212647543456033312 0ustar gsherwoodstaff FOO_CONSTANT', 'foo'); class FooClass { const FOO_CONSTANT = 'foo'; } ]]> Foo_Constant', 'foo'); class FooClass { const foo_constant = 'foo'; } ]]> ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/PHP/CharacterBeforePHPOpeningTagStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/PHP/CharacterBeforePHPOpeningTagStandard.xm0000644000076700000240000000104112647543456032716 0ustar gsherwoodstaff Beginning content PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/PHP/ClosingPHPTagStandard.xml0000644000076700000240000000102212647543456030130 0ustar gsherwoodstaff echo 'Foo'; ?> ]]> echo 'Foo'; ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/PHP/DeprecatedFunctionsStandard.xml0000644000076700000240000000075712647543456031475 0ustar gsherwoodstaff explode('a', $bar); ]]> split('a', $bar); ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/PHP/DisallowShortOpenTagStandard.xml0000644000076700000240000000041712647543456031611 0ustar gsherwoodstaff to delimit PHP code, not the shorthand. This is the most portable way to include PHP code on differing operating systems and setups. ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/PHP/ForbiddenFunctionsStandard.xml0000644000076700000240000000076212647543456031325 0ustar gsherwoodstaff count($bar); ]]> sizeof($bar); ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/PHP/LowerCaseConstantStandard.xml0000644000076700000240000000114112647543456031126 0ustar gsherwoodstaff true, false and null constants must always be lowercase. ]]> false || $var === null) { $var = true; } ]]> FALSE || $var === NULL) { $var = TRUE; } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/PHP/LowerCaseKeywordStandard.xml0000644000076700000240000000072412647543456030767 0ustar gsherwoodstaff array(); ]]> Array(); ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/PHP/NoSilencedErrorsStandard.xml0000644000076700000240000000104312647543456030751 0ustar gsherwoodstaff isset($foo) && $foo) { echo "Hello\n"; } ]]> @$foo) { echo "Hello\n"; } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/PHP/SAPIUsageStandard.xml0000644000076700000240000000105312647543456027253 0ustar gsherwoodstaff PHP_SAPI === 'cli') { echo "Hello, CLI user."; } ]]> php_sapi_name() === 'cli') { echo "Hello, CLI user."; } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/PHP/UpperCaseConstantStandard.xml0000644000076700000240000000114112647543456031131 0ustar gsherwoodstaff true, false and null constants must always be uppercase. ]]> FALSE || $var === NULL) { $var = TRUE; } ]]> false || $var === null) { $var = true; } ]]> ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Strings/UnnecessaryStringConcatStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/Strings/UnnecessaryStringConcatStandard.xml0000644000076700000240000000101612647543456033351 0ustar gsherwoodstaff ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/VersionControl/SubversionPropertiesStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/VersionControl/SubversionPropertiesStandard0000644000076700000240000000042312647543456033506 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/WhiteSpace/DisallowSpaceIndentStandard.xml0000644000076700000240000000025612647543456033037 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/WhiteSpace/DisallowTabIndentStandard.xml0000644000076700000240000000025412647543456032510 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Docs/WhiteSpace/ScopeIndentStandard.xml0000644000076700000240000000110612647543456031351 0ustar gsherwoodstaff $var = 1; } ]]> $var = 1; } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Arrays/DisallowLongArraySyntaxSniff.php0000644000076700000240000000455112647543456033012 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Bans the use of the PHP long array syntax. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Arrays_DisallowLongArraySyntaxSniff implements PHP_CodeSniffer_Sniff { /** * Registers the tokens that this sniff wants to listen for. * * @return int[] */ public function register() { return array(T_ARRAY); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $phpcsFile->recordMetric($stackPtr, 'Short array syntax used', 'no'); $error = 'Short array syntax must be used to define arrays'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Found'); if ($fix === true) { $tokens = $phpcsFile->getTokens(); $opener = $tokens[$stackPtr]['parenthesis_opener']; $closer = $tokens[$stackPtr]['parenthesis_closer']; $phpcsFile->fixer->beginChangeset(); if ($opener === null) { $phpcsFile->fixer->replaceToken($stackPtr, '[]'); } else { $phpcsFile->fixer->replaceToken($stackPtr, ''); $phpcsFile->fixer->replaceToken($opener, '['); $phpcsFile->fixer->replaceToken($closer, ']'); } $phpcsFile->fixer->endChangeset(); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Arrays/DisallowShortArraySyntaxSniff.php0000644000076700000240000000422312647543456033206 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Bans the use of the PHP short array syntax. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Arrays_DisallowShortArraySyntaxSniff implements PHP_CodeSniffer_Sniff { /** * Registers the tokens that this sniff wants to listen for. * * @return int[] */ public function register() { return array(T_OPEN_SHORT_ARRAY); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $phpcsFile->recordMetric($stackPtr, 'Short array syntax used', 'yes'); $error = 'Short array syntax is not allowed'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Found'); if ($fix === true) { $tokens = $phpcsFile->getTokens(); $opener = $tokens[$stackPtr]['bracket_opener']; $closer = $tokens[$stackPtr]['bracket_closer']; $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->replaceToken($opener, 'array('); $phpcsFile->fixer->replaceToken($closer, ')'); $phpcsFile->fixer->endChangeset(); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Classes/DuplicateClassNameSniff.php0000644000076700000240000001050212647543456032034 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Reports errors if the same class or interface name is used in multiple files. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Classes_DuplicateClassNameSniff implements PHP_CodeSniffer_Sniff { /** * List of classes that have been found during checking. * * @var array */ public $foundClasses = array(); /** * Registers the tokens that this sniff wants to listen for. * * @return int[] */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $namespace = ''; $findTokens = array( T_CLASS, T_INTERFACE, T_NAMESPACE, T_CLOSE_TAG, ); $stackPtr = $phpcsFile->findNext($findTokens, ($stackPtr + 1)); while ($stackPtr !== false) { if ($tokens[$stackPtr]['code'] === T_CLOSE_TAG) { // We can stop here. The sniff will continue from the next open // tag when PHPCS reaches that token, if there is one. return; } // Keep track of what namespace we are in. if ($tokens[$stackPtr]['code'] === T_NAMESPACE) { $nsEnd = $phpcsFile->findNext( array( T_NS_SEPARATOR, T_STRING, T_WHITESPACE, ), ($stackPtr + 1), null, true ); $namespace = trim($phpcsFile->getTokensAsString(($stackPtr + 1), ($nsEnd - $stackPtr - 1))); $stackPtr = $nsEnd; } else { $nameToken = $phpcsFile->findNext(T_STRING, $stackPtr); $name = $tokens[$nameToken]['content']; if ($namespace !== '') { $name = $namespace.'\\'.$name; } $compareName = strtolower($name); if (isset($this->foundClasses[$compareName]) === true) { $type = strtolower($tokens[$stackPtr]['content']); $file = $this->foundClasses[$compareName]['file']; $line = $this->foundClasses[$compareName]['line']; $error = 'Duplicate %s name "%s" found; first defined in %s on line %s'; $data = array( $type, $name, $file, $line, ); $phpcsFile->addWarning($error, $stackPtr, 'Found', $data); } else { $this->foundClasses[$compareName] = array( 'file' => $phpcsFile->getFilename(), 'line' => $tokens[$stackPtr]['line'], ); } }//end if $stackPtr = $phpcsFile->findNext($findTokens, ($stackPtr + 1)); }//end while }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/EmptyStatementSniff.php0000644000076700000240000000553712647543456032313 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * This sniff class detected empty statement. * * This sniff implements the common algorithm for empty statement body detection. * A body is considered as empty if it is completely empty or it only contains * whitespace characters and/or comments. * * * stmt { * // foo * } * stmt (conditions) { * // foo * } * * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @author Greg Sherwood * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_CodeAnalysis_EmptyStatementSniff implements PHP_CodeSniffer_Sniff { /** * Registers the tokens that this sniff wants to listen for. * * @return int[] */ public function register() { return array( T_CATCH, T_DO, T_ELSE, T_ELSEIF, T_FOR, T_FOREACH, T_IF, T_SWITCH, T_TRY, T_WHILE, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $token = $tokens[$stackPtr]; // Skip statements without a body. if (isset($token['scope_opener']) === false) { return; } $next = $phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, ($token['scope_opener'] + 1), ($token['scope_closer'] - 1), true ); if ($next !== false) { return; } // Get token identifier. $name = strtoupper($token['content']); $error = 'Empty %s statement detected'; $phpcsFile->addError($error, $stackPtr, 'Detected'.$name, array($name)); }//end process() }//end class ././@LongLink000 151 0003733 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/ForLoopShouldBeWhileLoopSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/ForLoopShouldBeWhileLoopSnif0000644000076700000240000000545512647543456033224 0ustar gsherwoodstaff * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Detects for-loops that can be simplified to a while-loop. * * This rule is based on the PMD rule catalog. Detects for-loops that can be * simplified as a while-loop. * * * class Foo * { * public function bar($x) * { * for (;true;) true; // No Init or Update part, may as well be: while (true) * } * } * * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_CodeAnalysis_ForLoopShouldBeWhileLoopSniff implements PHP_CodeSniffer_Sniff { /** * Registers the tokens that this sniff wants to listen for. * * @return int[] */ public function register() { return array(T_FOR); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $token = $tokens[$stackPtr]; // Skip invalid statement. if (isset($token['parenthesis_opener']) === false) { return; } $next = ++$token['parenthesis_opener']; $end = --$token['parenthesis_closer']; $parts = array( 0, 0, 0, ); $index = 0; for (; $next <= $end; ++$next) { $code = $tokens[$next]['code']; if ($code === T_SEMICOLON) { ++$index; } else if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === false) { ++$parts[$index]; } } if ($parts[0] === 0 && $parts[2] === 0 && $parts[1] > 0) { $error = 'This FOR loop can be simplified to a WHILE loop'; $phpcsFile->addWarning($error, $stackPtr, 'CanSimplify'); } }//end process() }//end class ././@LongLink000 154 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/ForLoopWithTestFunctionCallSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/ForLoopWithTestFunctionCallS0000644000076700000240000000616312647543456033251 0ustar gsherwoodstaff * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Detects for-loops that use a function call in the test expression. * * This rule is based on the PMD rule catalog. Detects for-loops that use a * function call in the test expression. * * * class Foo * { * public function bar($x) * { * $a = array(1, 2, 3, 4); * for ($i = 0; $i < count($a); $i++) { * $a[$i] *= $i; * } * } * } * * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_CodeAnalysis_ForLoopWithTestFunctionCallSniff implements PHP_CodeSniffer_Sniff { /** * Registers the tokens that this sniff wants to listen for. * * @return int[] */ public function register() { return array(T_FOR); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $token = $tokens[$stackPtr]; // Skip invalid statement. if (isset($token['parenthesis_opener']) === false) { return; } $next = ++$token['parenthesis_opener']; $end = --$token['parenthesis_closer']; $position = 0; for (; $next <= $end; ++$next) { $code = $tokens[$next]['code']; if ($code === T_SEMICOLON) { ++$position; } if ($position < 1) { continue; } else if ($position > 1) { break; } else if ($code !== T_VARIABLE && $code !== T_STRING) { continue; } // Find next non empty token, if it is a open curly brace we have a // function call. $index = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true); if ($tokens[$index]['code'] === T_OPEN_PARENTHESIS) { $error = 'Avoid function calls in a FOR loop test part'; $phpcsFile->addWarning($error, $stackPtr, 'NotAllowed'); break; } }//end for }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/JumbledIncrementerSniff.php0000644000076700000240000001015412647543456033075 0ustar gsherwoodstaff * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Detects incrementer jumbling in for loops. * * This rule is based on the PMD rule catalog. The jumbling incrementer sniff * detects the usage of one and the same incrementer into an outer and an inner * loop. Even it is intended this is confusing code. * * * class Foo * { * public function bar($x) * { * for ($i = 0; $i < 10; $i++) * { * for ($k = 0; $k < 20; $i++) * { * echo 'Hello'; * } * } * } * } * * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_CodeAnalysis_JumbledIncrementerSniff implements PHP_CodeSniffer_Sniff { /** * Registers the tokens that this sniff wants to listen for. * * @return int[] */ public function register() { return array(T_FOR); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $token = $tokens[$stackPtr]; // Skip for-loop without body. if (isset($token['scope_opener']) === false) { return; } // Find incrementors for outer loop. $outer = $this->findIncrementers($tokens, $token); // Skip if empty. if (count($outer) === 0) { return; } // Find nested for loops. $start = ++$token['scope_opener']; $end = --$token['scope_closer']; for (; $start <= $end; ++$start) { if ($tokens[$start]['code'] !== T_FOR) { continue; } $inner = $this->findIncrementers($tokens, $tokens[$start]); $diff = array_intersect($outer, $inner); if (count($diff) !== 0) { $error = 'Loop incrementor (%s) jumbling with inner loop'; $data = array(join(', ', $diff)); $phpcsFile->addWarning($error, $stackPtr, 'Found', $data); } } }//end process() /** * Get all used variables in the incrementer part of a for statement. * * @param array(integer=>array) $tokens Array with all code sniffer tokens. * @param array(string=>mixed) $token Current for loop token * * @return string[] List of all found incrementer variables. */ protected function findIncrementers(array $tokens, array $token) { // Skip invalid statement. if (isset($token['parenthesis_opener']) === false) { return array(); } $start = ++$token['parenthesis_opener']; $end = --$token['parenthesis_closer']; $incrementers = array(); $semicolons = 0; for ($next = $start; $next <= $end; ++$next) { $code = $tokens[$next]['code']; if ($code === T_SEMICOLON) { ++$semicolons; } else if ($semicolons === 2 && $code === T_VARIABLE) { $incrementers[] = $tokens[$next]['content']; } } return $incrementers; }//end findIncrementers() }//end class ././@LongLink000 151 0003733 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/UnconditionalIfStatementSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/UnconditionalIfStatementSnif0000644000076700000240000000547512647543456033347 0ustar gsherwoodstaff * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Detects unconditional if- and elseif-statements. * * This rule is based on the PMD rule catalog. The Unconditional If Statement * sniff detects statement conditions that are only set to one of the constant * values true or false * * * class Foo * { * public function close() * { * if (true) * { * // ... * } * } * } * * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_CodeAnalysis_UnconditionalIfStatementSniff implements PHP_CodeSniffer_Sniff { /** * Registers the tokens that this sniff wants to listen for. * * @return int[] */ public function register() { return array( T_IF, T_ELSEIF, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $token = $tokens[$stackPtr]; // Skip for-loop without body. if (isset($token['parenthesis_opener']) === false) { return; } $next = ++$token['parenthesis_opener']; $end = --$token['parenthesis_closer']; $goodCondition = false; for (; $next <= $end; ++$next) { $code = $tokens[$next]['code']; if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === true) { continue; } else if ($code !== T_TRUE && $code !== T_FALSE) { $goodCondition = true; } } if ($goodCondition === false) { $error = 'Avoid IF statements that are always true or false'; $phpcsFile->addWarning($error, $stackPtr, 'Found'); } }//end process() }//end class ././@LongLink000 151 0003733 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/UnnecessaryFinalModifierSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/UnnecessaryFinalModifierSnif0000644000076700000240000000525612647543456033322 0ustar gsherwoodstaff * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Detects unnecessary final modifiers inside of final classes. * * This rule is based on the PMD rule catalog. The Unnecessary Final Modifier * sniff detects the use of the final modifier inside of a final class which * is unnecessary. * * * final class Foo * { * public final function bar() * { * } * } * * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_CodeAnalysis_UnnecessaryFinalModifierSniff implements PHP_CodeSniffer_Sniff { /** * Registers the tokens that this sniff wants to listen for. * * @return int[] */ public function register() { return array(T_CLASS); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $token = $tokens[$stackPtr]; // Skip for-statements without body. if (isset($token['scope_opener']) === false) { return; } // Fetch previous token. $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); // Skip for non final class. if ($prev === false || $tokens[$prev]['code'] !== T_FINAL) { return; } $next = ++$token['scope_opener']; $end = --$token['scope_closer']; for (; $next <= $end; ++$next) { if ($tokens[$next]['code'] === T_FINAL) { $error = 'Unnecessary FINAL modifier in FINAL class'; $phpcsFile->addWarning($error, $next, 'Found'); } } }//end process() }//end class ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/UnusedFunctionParameterSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/UnusedFunctionParameterSniff0000644000076700000240000001547512647543456033356 0ustar gsherwoodstaff * @author Manuel Pichler * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Checks the for unused function parameters. * * This sniff checks that all function parameters are used in the function body. * One exception is made for empty function bodies or function bodies that only * contain comments. This could be useful for the classes that implement an * interface that defines multiple methods but the implementation only needs some * of them. * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @author Greg Sherwood * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_CodeAnalysis_UnusedFunctionParameterSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_FUNCTION); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $token = $tokens[$stackPtr]; // Skip broken function declarations. if (isset($token['scope_opener']) === false || isset($token['parenthesis_opener']) === false) { return; } $params = array(); foreach ($phpcsFile->getMethodParameters($stackPtr) as $param) { $params[$param['name']] = $stackPtr; } $next = ++$token['scope_opener']; $end = --$token['scope_closer']; $foundContent = false; $validTokens = array( T_HEREDOC => T_HEREDOC, T_NOWDOC => T_NOWDOC, T_END_HEREDOC => T_END_HEREDOC, T_END_NOWDOC => T_END_NOWDOC, T_DOUBLE_QUOTED_STRING => T_DOUBLE_QUOTED_STRING, ); $validTokens += PHP_CodeSniffer_Tokens::$emptyTokens; for (; $next <= $end; ++$next) { $token = $tokens[$next]; $code = $token['code']; // Ignorable tokens. if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === true) { continue; } if ($foundContent === false) { // A throw statement as the first content indicates an interface method. if ($code === T_THROW) { return; } // A return statement as the first content indicates an interface method. if ($code === T_RETURN) { $tmp = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true); if ($tmp === false) { return; } // There is a return. if ($tokens[$tmp]['code'] === T_SEMICOLON) { return; } $tmp = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($tmp + 1), null, true); if ($tmp !== false && $tokens[$tmp]['code'] === T_SEMICOLON) { // There is a return . return; } }//end if }//end if $foundContent = true; if ($code === T_VARIABLE && isset($params[$token['content']]) === true) { unset($params[$token['content']]); } else if ($code === T_DOLLAR) { $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($next + 1), null, true); if ($tokens[$nextToken]['code'] === T_OPEN_CURLY_BRACKET) { $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($nextToken + 1), null, true); if ($tokens[$nextToken]['code'] === T_STRING) { $varContent = '$'.$tokens[$nextToken]['content']; if (isset($params[$varContent]) === true) { unset($params[$varContent]); } } } } else if ($code === T_DOUBLE_QUOTED_STRING || $code === T_START_HEREDOC || $code === T_START_NOWDOC ) { // Tokenize strings that can contain variables. // Make sure the string is re-joined if it occurs over multiple lines. $content = $token['content']; for ($i = ($next + 1); $i <= $end; $i++) { if (isset($validTokens[$tokens[$i]['code']]) === true) { $content .= $tokens[$i]['content']; $next++; } else { break; } } $stringTokens = token_get_all(sprintf('', $content)); foreach ($stringTokens as $stringPtr => $stringToken) { if (is_array($stringToken) === false) { continue; } $varContent = ''; if ($stringToken[0] === T_DOLLAR_OPEN_CURLY_BRACES) { $varContent = '$'.$stringTokens[($stringPtr + 1)][1]; } else if ($stringToken[0] === T_VARIABLE) { $varContent = $stringToken[1]; } if ($varContent !== '' && isset($params[$varContent]) === true) { unset($params[$varContent]); } } }//end if }//end for if ($foundContent === true && count($params) > 0) { foreach ($params as $paramName => $position) { $error = 'The method parameter %s is never used'; $data = array($paramName); $phpcsFile->addWarning($error, $position, 'Found', $data); } } }//end process() }//end class ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/UselessOverridingMethodSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/CodeAnalysis/UselessOverridingMethodSniff0000644000076700000240000001326712647543456033356 0ustar gsherwoodstaff * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Detects unnecessary overridden methods that simply call their parent. * * This rule is based on the PMD rule catalog. The Useless Overriding Method * sniff detects the use of methods that only call their parent classes's method * with the same name and arguments. These methods are not required. * * * class FooBar { * public function __construct($a, $b) { * parent::__construct($a, $b); * } * } * * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_CodeAnalysis_UselessOverridingMethodSniff implements PHP_CodeSniffer_Sniff { /** * Registers the tokens that this sniff wants to listen for. * * @return int[] */ public function register() { return array(T_FUNCTION); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $token = $tokens[$stackPtr]; // Skip function without body. if (isset($token['scope_opener']) === false) { return; } // Get function name. $methodName = $phpcsFile->getDeclarationName($stackPtr); // Get all parameters from method signature. $signature = array(); foreach ($phpcsFile->getMethodParameters($stackPtr) as $param) { $signature[] = $param['name']; } $next = ++$token['scope_opener']; $end = --$token['scope_closer']; for (; $next <= $end; ++$next) { $code = $tokens[$next]['code']; if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === true) { continue; } else if ($code === T_RETURN) { continue; } break; } // Any token except 'parent' indicates correct code. if ($tokens[$next]['code'] !== T_PARENT) { return; } // Find next non empty token index, should be double colon. $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true); // Skip for invalid code. if ($next === false || $tokens[$next]['code'] !== T_DOUBLE_COLON) { return; } // Find next non empty token index, should be the function name. $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true); // Skip for invalid code or other method. if ($next === false || $tokens[$next]['content'] !== $methodName) { return; } // Find next non empty token index, should be the open parenthesis. $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true); // Skip for invalid code. if ($next === false || $tokens[$next]['code'] !== T_OPEN_PARENTHESIS) { return; } $validParameterTypes = array( T_VARIABLE, T_LNUMBER, T_CONSTANT_ENCAPSED_STRING, ); $parameters = array(''); $parenthesisCount = 1; $count = count($tokens); for (++$next; $next < $count; ++$next) { $code = $tokens[$next]['code']; if ($code === T_OPEN_PARENTHESIS) { ++$parenthesisCount; } else if ($code === T_CLOSE_PARENTHESIS) { --$parenthesisCount; } else if ($parenthesisCount === 1 && $code === T_COMMA) { $parameters[] = ''; } else if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === false) { $parameters[(count($parameters) - 1)] .= $tokens[$next]['content']; } if ($parenthesisCount === 0) { break; } }//end for $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true); if ($next === false || $tokens[$next]['code'] !== T_SEMICOLON) { return; } // Check rest of the scope. for (++$next; $next <= $end; ++$next) { $code = $tokens[$next]['code']; // Skip for any other content. if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === false) { return; } } $parameters = array_map('trim', $parameters); $parameters = array_filter($parameters); if (count($parameters) === count($signature) && $parameters === $signature) { $phpcsFile->addWarning('Possible useless method overriding detected', $stackPtr, 'Found'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Commenting/DocCommentSniff.php0000644000076700000240000003365512647543456031104 0ustar gsherwoodstaff * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Ensures doc blocks follow basic formatting. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Commenting_DocCommentSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_DOC_COMMENT_OPEN_TAG); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $commentStart = $stackPtr; $commentEnd = $tokens[$stackPtr]['comment_closer']; $empty = array( T_DOC_COMMENT_WHITESPACE, T_DOC_COMMENT_STAR, ); $short = $phpcsFile->findNext($empty, ($stackPtr + 1), $commentEnd, true); if ($short === false) { // No content at all. $error = 'Doc comment is empty'; $phpcsFile->addError($error, $stackPtr, 'Empty'); return; } // The first line of the comment should just be the /** code. if ($tokens[$short]['line'] === $tokens[$stackPtr]['line']) { $error = 'The open comment tag must be the only content on the line'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'ContentAfterOpen'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->addNewline($stackPtr); $phpcsFile->fixer->addContentBefore($short, '* '); $phpcsFile->fixer->endChangeset(); } } // The last line of the comment should just be the */ code. $prev = $phpcsFile->findPrevious($empty, ($commentEnd - 1), $stackPtr, true); if ($tokens[$prev]['line'] === $tokens[$commentEnd]['line']) { $error = 'The close comment tag must be the only content on the line'; $fix = $phpcsFile->addFixableError($error, $commentEnd, 'ContentBeforeClose'); if ($fix === true) { $phpcsFile->fixer->addNewlineBefore($commentEnd); } } // Check for additional blank lines at the end of the comment. if ($tokens[$prev]['line'] < ($tokens[$commentEnd]['line'] - 1)) { $error = 'Additional blank lines found at end of doc comment'; $fix = $phpcsFile->addFixableError($error, $commentEnd, 'SpacingAfter'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($prev + 1); $i < $commentEnd; $i++) { if ($tokens[($i + 1)]['line'] === $tokens[$commentEnd]['line']) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } } // Check for a comment description. if ($tokens[$short]['code'] !== T_DOC_COMMENT_STRING) { $error = 'Missing short description in doc comment'; $phpcsFile->addError($error, $stackPtr, 'MissingShort'); return; } // No extra newline before short description. if ($tokens[$short]['line'] !== ($tokens[$stackPtr]['line'] + 1)) { $error = 'Doc comment short description must be on the first line'; $fix = $phpcsFile->addFixableError($error, $short, 'SpacingBeforeShort'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = $stackPtr; $i < $short; $i++) { if ($tokens[$i]['line'] === $tokens[$stackPtr]['line']) { continue; } else if ($tokens[$i]['line'] === $tokens[$short]['line']) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } } // Account for the fact that a short description might cover // multiple lines. $shortContent = $tokens[$short]['content']; $shortEnd = $short; for ($i = ($short + 1); $i < $commentEnd; $i++) { if ($tokens[$i]['code'] === T_DOC_COMMENT_STRING) { if ($tokens[$i]['line'] === ($tokens[$shortEnd]['line'] + 1)) { $shortContent .= $tokens[$i]['content']; $shortEnd = $i; } else { break; } } } if (preg_match('/^\p{Ll}/u', $shortContent) === 1) { $error = 'Doc comment short description must start with a capital letter'; $phpcsFile->addError($error, $short, 'ShortNotCapital'); } $long = $phpcsFile->findNext($empty, ($shortEnd + 1), ($commentEnd - 1), true); if ($long !== false && $tokens[$long]['code'] === T_DOC_COMMENT_STRING) { if ($tokens[$long]['line'] !== ($tokens[$shortEnd]['line'] + 2)) { $error = 'There must be exactly one blank line between descriptions in a doc comment'; $fix = $phpcsFile->addFixableError($error, $long, 'SpacingBetween'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($shortEnd + 1); $i < $long; $i++) { if ($tokens[$i]['line'] === $tokens[$shortEnd]['line']) { continue; } else if ($tokens[$i]['line'] === ($tokens[$long]['line'] - 1)) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } } if (preg_match('/^\p{Ll}/u', $tokens[$long]['content']) === 1) { $error = 'Doc comment long description must start with a capital letter'; $phpcsFile->addError($error, $long, 'LongNotCapital'); } }//end if if (empty($tokens[$commentStart]['comment_tags']) === true) { // No tags in the comment. return; } $firstTag = $tokens[$commentStart]['comment_tags'][0]; $prev = $phpcsFile->findPrevious($empty, ($firstTag - 1), $stackPtr, true); if ($tokens[$firstTag]['line'] !== ($tokens[$prev]['line'] + 2)) { $error = 'There must be exactly one blank line before the tags in a doc comment'; $fix = $phpcsFile->addFixableError($error, $firstTag, 'SpacingBeforeTags'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($prev + 1); $i < $firstTag; $i++) { if ($tokens[$i]['line'] === $tokens[$firstTag]['line']) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $indent = str_repeat(' ', $tokens[$stackPtr]['column']); $phpcsFile->fixer->addContent($prev, $phpcsFile->eolChar.$indent.'*'.$phpcsFile->eolChar); $phpcsFile->fixer->endChangeset(); } } // Break out the tags into groups and check alignment within each. // A tag group is one where there are no blank lines between tags. // The param tag group is special as it requires all @param tags to be inside. $tagGroups = array(); $groupid = 0; $paramGroupid = null; foreach ($tokens[$commentStart]['comment_tags'] as $pos => $tag) { if ($pos > 0) { $prev = $phpcsFile->findPrevious( T_DOC_COMMENT_STRING, ($tag - 1), $tokens[$commentStart]['comment_tags'][($pos - 1)] ); if ($prev === false) { $prev = $tokens[$commentStart]['comment_tags'][($pos - 1)]; } if ($tokens[$prev]['line'] !== ($tokens[$tag]['line'] - 1)) { $groupid++; } } if ($tokens[$tag]['content'] === '@param') { if (($paramGroupid === null && empty($tagGroups[$groupid]) === false) || ($paramGroupid !== null && $paramGroupid !== $groupid) ) { $error = 'Parameter tags must be grouped together in a doc comment'; $phpcsFile->addError($error, $tag, 'ParamGroup'); } if ($paramGroupid === null) { $paramGroupid = $groupid; } } else if ($groupid === $paramGroupid) { $error = 'Tag cannot be grouped with parameter tags in a doc comment'; $phpcsFile->addError($error, $tag, 'NonParamGroup'); }//end if $tagGroups[$groupid][] = $tag; }//end foreach foreach ($tagGroups as $group) { $maxLength = 0; $paddings = array(); foreach ($group as $pos => $tag) { $tagLength = strlen($tokens[$tag]['content']); if ($tagLength > $maxLength) { $maxLength = $tagLength; } // Check for a value. No value means no padding needed. $string = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $tag, $commentEnd); if ($string !== false && $tokens[$string]['line'] === $tokens[$tag]['line']) { $paddings[$tag] = strlen($tokens[($tag + 1)]['content']); } } // Check that there was single blank line after the tag block // but account for a multi-line tag comments. $lastTag = $group[$pos]; $next = $phpcsFile->findNext(T_DOC_COMMENT_TAG, ($lastTag + 3), $commentEnd); if ($next !== false) { $prev = $phpcsFile->findPrevious(array(T_DOC_COMMENT_TAG, T_DOC_COMMENT_STRING), ($next - 1), $commentStart); if ($tokens[$next]['line'] !== ($tokens[$prev]['line'] + 2)) { $error = 'There must be a single blank line after a tag group'; $fix = $phpcsFile->addFixableError($error, $lastTag, 'SpacingAfterTagGroup'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($prev + 1); $i < $next; $i++) { if ($tokens[$i]['line'] === $tokens[$next]['line']) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $indent = str_repeat(' ', $tokens[$stackPtr]['column']); $phpcsFile->fixer->addContent($prev, $phpcsFile->eolChar.$indent.'*'.$phpcsFile->eolChar); $phpcsFile->fixer->endChangeset(); } } }//end if // Now check paddings. foreach ($paddings as $tag => $padding) { $required = ($maxLength - strlen($tokens[$tag]['content']) + 1); if ($padding !== $required) { $error = 'Tag value indented incorrectly; expected %s spaces but found %s'; $data = array( $required, $padding, ); $fix = $phpcsFile->addFixableError($error, ($tag + 1), 'TagValueIndent', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($tag + 1), str_repeat(' ', $required)); } } } }//end foreach // If there is a param group, it needs to be first. if ($paramGroupid !== null && $paramGroupid !== 0) { $error = 'Parameter tags must be defined first in a doc comment'; $phpcsFile->addError($error, $tagGroups[$paramGroupid][0], 'ParamNotFirst'); } $foundTags = array(); foreach ($tokens[$stackPtr]['comment_tags'] as $pos => $tag) { $tagName = $tokens[$tag]['content']; if (isset($foundTags[$tagName]) === true) { $lastTag = $tokens[$stackPtr]['comment_tags'][($pos - 1)]; if ($tokens[$lastTag]['content'] !== $tagName) { $error = 'Tags must be grouped together in a doc comment'; $phpcsFile->addError($error, $tag, 'TagsNotGrouped'); } continue; } $foundTags[$tagName] = true; } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Commenting/FixmeSniff.php0000644000076700000240000000540612647543456030115 0ustar gsherwoodstaff * @author Sam Graham * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Commenting_FixmeSniff. * * Warns about FIXME comments. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Sam Graham * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Commenting_FixmeSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return PHP_CodeSniffer_Tokens::$commentTokens; }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $content = $tokens[$stackPtr]['content']; $matches = array(); preg_match('/(?:\A|[^\p{L}]+)fixme([^\p{L}]+(.*)|\Z)/ui', $content, $matches); if (empty($matches) === false) { // Clear whitespace and some common characters not required at // the end of a fixme message to make the error more informative. $type = 'CommentFound'; $fixmeMessage = trim($matches[1]); $fixmeMessage = trim($fixmeMessage, '-:[](). '); $error = 'Comment refers to a FIXME task'; $data = array($fixmeMessage); if ($fixmeMessage !== '') { $type = 'TaskFound'; $error .= ' "%s"'; } $phpcsFile->addError($error, $stackPtr, $type, $data); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Commenting/TodoSniff.php0000644000076700000240000000521012647543456027743 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Commenting_TodoSniff. * * Warns about TODO comments. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Commenting_TodoSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return PHP_CodeSniffer_Tokens::$commentTokens; }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $content = $tokens[$stackPtr]['content']; $matches = array(); preg_match('/(?:\A|[^\p{L}]+)todo([^\p{L}]+(.*)|\Z)/ui', $content, $matches); if (empty($matches) === false) { // Clear whitespace and some common characters not required at // the end of a to-do message to make the warning more informative. $type = 'CommentFound'; $todoMessage = trim($matches[1]); $todoMessage = trim($todoMessage, '-:[](). '); $error = 'Comment refers to a TODO task'; $data = array($todoMessage); if ($todoMessage !== '') { $type = 'TaskFound'; $error .= ' "%s"'; } $phpcsFile->addWarning($error, $stackPtr, $type, $data); } }//end process() }//end class ././@LongLink000 154 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/ControlStructures/InlineControlStructureSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/ControlStructures/InlineControlStructureS0000644000076700000240000002114612647543456033537 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_ControlStructures_InlineControlStructureSniff. * * Verifies that inline control statements are not present. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_ControlStructures_InlineControlStructureSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * If true, an error will be thrown; otherwise a warning. * * @var bool */ public $error = true; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_IF, T_ELSE, T_ELSEIF, T_FOREACH, T_WHILE, T_DO, T_SWITCH, T_FOR, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['scope_opener']) === true) { $phpcsFile->recordMetric($stackPtr, 'Control structure defined inline', 'no'); return; } // Ignore the ELSE in ELSE IF. We'll process the IF part later. if ($tokens[$stackPtr]['code'] === T_ELSE) { $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$next]['code'] === T_IF) { return; } } if ($tokens[$stackPtr]['code'] === T_WHILE) { // This could be from a DO WHILE, which doesn't have an opening brace. $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if ($tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) { $brace = $tokens[$lastContent]; if (isset($brace['scope_condition']) === true) { $condition = $tokens[$brace['scope_condition']]; if ($condition['code'] === T_DO) { return; } } } // In Javascript DO WHILE loops without curly braces are legal. This // is only valid if a single statement is present between the DO and // the WHILE. We can detect this by checking only a single semicolon // is present between them. if ($phpcsFile->tokenizerType === 'JS') { $lastDo = $phpcsFile->findPrevious(T_DO, ($stackPtr - 1)); $lastSemicolon = $phpcsFile->findPrevious(T_SEMICOLON, ($stackPtr - 1)); if ($lastDo !== false && $lastSemicolon !== false && $lastDo < $lastSemicolon) { $precedingSemicolon = $phpcsFile->findPrevious(T_SEMICOLON, ($lastSemicolon - 1)); if ($precedingSemicolon === false || $precedingSemicolon < $lastDo) { return; } } } }//end if // This is a control structure without an opening brace, // so it is an inline statement. if ($this->error === true) { $fix = $phpcsFile->addFixableError('Inline control structures are not allowed', $stackPtr, 'NotAllowed'); } else { $fix = $phpcsFile->addFixableWarning('Inline control structures are discouraged', $stackPtr, 'Discouraged'); } $phpcsFile->recordMetric($stackPtr, 'Control structure defined inline', 'yes'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); if (isset($tokens[$stackPtr]['parenthesis_closer']) === true) { $closer = $tokens[$stackPtr]['parenthesis_closer']; } else { $closer = $stackPtr; } if ($tokens[($closer + 1)]['code'] === T_WHITESPACE || $tokens[($closer + 1)]['code'] === T_SEMICOLON ) { $phpcsFile->fixer->addContent($closer, ' {'); } else { $phpcsFile->fixer->addContent($closer, ' { '); } $lastNonEmpty = $closer; for ($end = ($closer + 1); $end < $phpcsFile->numTokens; $end++) { if ($tokens[$end]['code'] === T_SEMICOLON) { break; } if ($tokens[$end]['code'] === T_CLOSE_TAG) { $end = $lastNonEmpty; break; } if (isset($tokens[$end]['scope_opener']) === true) { $type = $tokens[$end]['code']; $end = $tokens[$end]['scope_closer']; if ($type === T_DO || $type === T_IF || $type === T_ELSEIF) { $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($end + 1), null, true); if ($next === false) { break; } $nextType = $tokens[$next]['code']; // Let additional conditions loop and find their ending. if (($type === T_IF || $type === T_ELSEIF) && ($nextType === T_ELSEIF || $nextType === T_ELSE) ) { continue; } // Account for DO... WHILE conditions. if ($type === T_DO && $nextType === T_WHILE) { $end = $phpcsFile->findNext(T_SEMICOLON, ($next + 1)); } }//end if break; }//end if if ($tokens[$end]['code'] !== T_WHITESPACE) { $lastNonEmpty = $end; } }//end for $next = $phpcsFile->findNext(T_WHITESPACE, ($closer + 1), ($end + 1), true); // Account for a comment on the end of the line. for ($endLine = $end; $endLine < $phpcsFile->numTokens; $endLine++) { if (isset($tokens[($endLine + 1)]) === false || $tokens[$endLine]['line'] !== $tokens[($endLine + 1)]['line'] ) { break; } } if ($tokens[$endLine]['code'] !== T_COMMENT) { $endLine = $end; } if ($next !== $end) { if ($endLine !== $end) { $phpcsFile->fixer->addContent($endLine, '}'); } else { if ($tokens[$end]['code'] !== T_SEMICOLON && $tokens[$end]['code'] !== T_CLOSE_CURLY_BRACKET ) { $phpcsFile->fixer->addContent($end, ';'); } $phpcsFile->fixer->addContent($end, ' }'); } } else { if ($endLine !== $end) { $phpcsFile->fixer->replaceToken($end, ''); $phpcsFile->fixer->addNewlineBefore($endLine); $phpcsFile->fixer->addContent($endLine, '}'); } else { $phpcsFile->fixer->replaceToken($end, '}'); } }//end if $phpcsFile->fixer->endChangeset(); }//end if }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Debug/ClosureLinterSniff.php0000644000076700000240000000667012647543456030571 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Debug_ClosureLinterSniff. * * Runs gjslint on the file. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Debug_ClosureLinterSniff implements PHP_CodeSniffer_Sniff { /** * A list of error codes that should show errors. * * All other error codes will show warnings. * * @var int */ public $errorCodes = array(); /** * A list of error codes to ignore. * * @var int */ public $ignoreCodes = array(); /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('JS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void * @throws PHP_CodeSniffer_Exception If jslint.js could not be run */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $fileName = $phpcsFile->getFilename(); $lintPath = PHP_CodeSniffer::getConfigData('gjslint_path'); if ($lintPath === null) { return; } $cmd = "$lintPath --nosummary --notime --unix_mode \"$fileName\""; $msg = exec($cmd, $output, $retval); if (is_array($output) === false) { return; } foreach ($output as $finding) { $matches = array(); $numMatches = preg_match('/^(.*):([0-9]+):\(.*?([0-9]+)\)(.*)$/', $finding, $matches); if ($numMatches === 0) { continue; } // Skip error codes we are ignoring. $code = $matches[3]; if (in_array($code, $this->ignoreCodes) === true) { continue; } $line = (int) $matches[2]; $error = trim($matches[4]); $message = 'gjslint says: (%s) %s'; $data = array( $code, $error, ); if (in_array($code, $this->errorCodes) === true) { $phpcsFile->addErrorOnLine($message, $line, 'ExternalToolError', $data); } else { $phpcsFile->addWarningOnLine($message, $line, 'ExternalTool', $data); } }//end foreach // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Debug/CSSLintSniff.php0000644000076700000240000000545012647543456027251 0ustar gsherwoodstaff * @copyright 2013-2014 Roman Levishchenko * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Debug_CSSLintSniff. * * Runs csslint on the file. * * @category PHP * @package PHP_CodeSniffer * @author Roman Levishchenko * @copyright 2013-2014 Roman Levishchenko * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Debug_CSSLintSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $fileName = $phpcsFile->getFilename(); $csslintPath = PHP_CodeSniffer::getConfigData('csslint_path'); if ($csslintPath === null) { return; } $cmd = $csslintPath.' '.escapeshellarg($fileName); exec($cmd, $output, $retval); if (is_array($output) === false) { return; } $count = count($output); for ($i = 0; $i < $count; $i++) { $matches = array(); $numMatches = preg_match( '/(error|warning) at line (\d+)/', $output[$i], $matches ); if ($numMatches === 0) { continue; } $line = (int) $matches[2]; $message = 'csslint says: '.$output[($i + 1)]; // First line is message with error line and error code. // Second is error message. // Third is wrong line in file. // Fourth is empty line. $i += 4; $phpcsFile->addWarningOnLine($message, $line, 'ExternalTool'); }//end for // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Debug/JSHintSniff.php0000644000076700000240000000542312647543456027131 0ustar gsherwoodstaff * @author Alexander Wei§ * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Debug_JSHintSniff. * * Runs jshint.js on the file. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Alexander Wei§ * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Debug_JSHintSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('JS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void * @throws PHP_CodeSniffer_Exception If jshint.js could not be run */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $fileName = $phpcsFile->getFilename(); $rhinoPath = PHP_CodeSniffer::getConfigData('rhino_path'); $jshintPath = PHP_CodeSniffer::getConfigData('jshint_path'); if ($rhinoPath === null || $jshintPath === null) { return; } $cmd = "$rhinoPath \"$jshintPath\" \"$fileName\""; $msg = exec($cmd, $output, $retval); if (is_array($output) === true) { foreach ($output as $finding) { $matches = array(); $numMatches = preg_match('/^(.+)\(.+:([0-9]+).*:[0-9]+\)$/', $finding, $matches); if ($numMatches === 0) { continue; } $line = (int) $matches[2]; $message = 'jshint says: '.trim($matches[1]); $phpcsFile->addWarningOnLine($message, $line, 'ExternalTool'); } } // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Files/ByteOrderMarkSniff.php0000644000076700000240000000565312647543456030525 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Files_ByteOrderMarkSniff. * * A simple sniff for detecting BOMs that may corrupt application work. * * @category PHP * @package PHP_CodeSniffer * @author Piotr Karas * @author Greg Sherwood * @copyright 2010-2014 mediaSELF Sp. z o.o. * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer * @see http://en.wikipedia.org/wiki/Byte_order_mark */ class Generic_Sniffs_Files_ByteOrderMarkSniff implements PHP_CodeSniffer_Sniff { /** * List of supported BOM definitions. * * Use encoding names as keys and hex BOM representations as values. * * @var array */ public $bomDefinitions = array( 'UTF-8' => 'efbbbf', 'UTF-16 (BE)' => 'feff', 'UTF-16 (LE)' => 'fffe', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_INLINE_HTML); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { // The BOM will be the very first token in the file. if ($stackPtr !== 0) { return; } $tokens = $phpcsFile->getTokens(); foreach ($this->bomDefinitions as $bomName => $expectedBomHex) { $bomByteLength = (strlen($expectedBomHex) / 2); $htmlBomHex = bin2hex(substr($tokens[$stackPtr]['content'], 0, $bomByteLength)); if ($htmlBomHex === $expectedBomHex) { $errorData = array($bomName); $error = 'File contains %s byte order mark, which may corrupt your application'; $phpcsFile->addError($error, $stackPtr, 'Found', $errorData); $phpcsFile->recordMetric($stackPtr, 'Using byte order mark', 'yes'); return; } } $phpcsFile->recordMetric($stackPtr, 'Using byte order mark', 'no'); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Files/EndFileNewlineSniff.php0000644000076700000240000000535612647543456030643 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Files_EndFileNewlineSniff. * * Ensures the file ends with a newline character. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Files_EndFileNewlineSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', 'CSS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return int */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { // Skip to the end of the file. $tokens = $phpcsFile->getTokens(); $stackPtr = ($phpcsFile->numTokens - 1); if ($phpcsFile->tokenizerType !== 'PHP') { $stackPtr--; } $eolCharLen = strlen($phpcsFile->eolChar); $lastChars = substr($tokens[$stackPtr]['content'], ($eolCharLen * -1)); if ($lastChars !== $phpcsFile->eolChar) { $phpcsFile->recordMetric($stackPtr, 'Newline at EOF', 'no'); $error = 'File must end with a newline character'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NotFound'); if ($fix === true) { $phpcsFile->fixer->addNewline($stackPtr); } } else { $phpcsFile->recordMetric($stackPtr, 'Newline at EOF', 'yes'); } // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Files/EndFileNoNewlineSniff.php0000644000076700000240000000530312647543456031130 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Files_EndFileNoNewlineSniff. * * Ensures the file does not end with a newline character. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Files_EndFileNoNewlineSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', 'CSS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return int */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { // Skip to the end of the file. $tokens = $phpcsFile->getTokens(); $stackPtr = ($phpcsFile->numTokens - 1); if ($phpcsFile->tokenizerType !== 'PHP') { $stackPtr--; } $eolCharLen = strlen($phpcsFile->eolChar); $lastChars = substr($tokens[$stackPtr]['content'], ($eolCharLen * -1)); if ($lastChars === $phpcsFile->eolChar) { $error = 'File must not end with a newline character'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Found'); if ($fix === true) { $newContent = substr($tokens[$stackPtr]['content'], 0, ($eolCharLen * -1)); $phpcsFile->fixer->replaceToken($stackPtr, $newContent); } } // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Files/InlineHTMLSniff.php0000644000076700000240000000364612647543456027716 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Files_InlineHTMLSniff. * * Ensures the whole file is PHP only, with no whitespace or inline HTML anywhere * in the file. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Files_InlineHTMLSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_INLINE_HTML); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { // Ignore shebang lines. $tokens = $phpcsFile->getTokens(); if (substr($tokens[$stackPtr]['content'], 0, 2) === '#!') { return; } $error = 'PHP files must only contain PHP code'; $phpcsFile->addError($error, $stackPtr, 'Found'); return $phpcsFile->numTokens; }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Files/LineEndingsSniff.php0000644000076700000240000001052212647543456030201 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Files_LineEndingsSniff. * * Checks that end of line characters are correct. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Files_LineEndingsSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', 'CSS', ); /** * The valid EOL character. * * @var string */ public $eolChar = '\n'; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return int */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $found = $phpcsFile->eolChar; $found = str_replace("\n", '\n', $found); $found = str_replace("\r", '\r', $found); $phpcsFile->recordMetric($stackPtr, 'EOL char', $found); if ($found === $this->eolChar) { // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); } // Check for single line files without an EOL. This is a very special // case and the EOL char is set to \n when this happens. if ($found === '\n') { $tokens = $phpcsFile->getTokens(); $lastToken = ($phpcsFile->numTokens - 1); if ($tokens[$lastToken]['line'] === 1 && $tokens[$lastToken]['content'] !== "\n" ) { return; } } $error = 'End of line character is invalid; expected "%s" but found "%s"'; $expected = $this->eolChar; $expected = str_replace("\n", '\n', $expected); $expected = str_replace("\r", '\r', $expected); $data = array( $expected, $found, ); // Errors are always reported on line 1, no matter where the first PHP tag is. $fix = $phpcsFile->addFixableError($error, 0, 'InvalidEOLChar', $data); if ($fix === true) { $tokens = $phpcsFile->getTokens(); switch ($this->eolChar) { case '\n': $eolChar = "\n"; break; case '\r': $eolChar = "\r"; break; case '\r\n': $eolChar = "\r\n"; break; default: $eolChar = $this->eolChar; break; } for ($i = 0; $i < $phpcsFile->numTokens; $i++) { if (isset($tokens[($i + 1)]) === false || $tokens[($i + 1)]['line'] > $tokens[$i]['line'] ) { // Token is the last on a line. $newContent = rtrim($tokens[$i]['content'], "\r\n"); $newContent .= $eolChar; $phpcsFile->fixer->replaceToken($i, $newContent); } } }//end if // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Files/LineLengthSniff.php0000644000076700000240000001115312647543456030034 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Files_LineLengthSniff. * * Checks all lines in the file, and throws warnings if they are over 80 * characters in length and errors if they are over 100. Both these * figures can be changed by extending this sniff in your own standard. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Files_LineLengthSniff implements PHP_CodeSniffer_Sniff { /** * The limit that the length of a line should not exceed. * * @var int */ public $lineLimit = 80; /** * The limit that the length of a line must not exceed. * * Set to zero (0) to disable. * * @var int */ public $absoluteLineLimit = 100; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return int */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); for ($i = 1; $i < $phpcsFile->numTokens; $i++) { if ($tokens[$i]['column'] === 1) { $this->checkLineLength($phpcsFile, $tokens, $i); } } $this->checkLineLength($phpcsFile, $tokens, $i); // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() /** * Checks if a line is too long. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param array $tokens The token stack. * @param int $stackPtr The first token on the next line. * * @return null|false */ protected function checkLineLength(PHP_CodeSniffer_File $phpcsFile, $tokens, $stackPtr) { // The passed token is the first on the line. $stackPtr--; if ($tokens[$stackPtr]['column'] === 1 && $tokens[$stackPtr]['length'] === 0 ) { // Blank line. return; } if ($tokens[$stackPtr]['column'] !== 1 && $tokens[$stackPtr]['content'] === $phpcsFile->eolChar ) { $stackPtr--; } $lineLength = ($tokens[$stackPtr]['column'] + $tokens[$stackPtr]['length'] - 1); // Record metrics for common line length groupings. if ($lineLength <= 80) { $phpcsFile->recordMetric($stackPtr, 'Line length', '80 or less'); } else if ($lineLength <= 120) { $phpcsFile->recordMetric($stackPtr, 'Line length', '81-120'); } else if ($lineLength <= 150) { $phpcsFile->recordMetric($stackPtr, 'Line length', '121-150'); } else { $phpcsFile->recordMetric($stackPtr, 'Line length', '151 or more'); } if ($this->absoluteLineLimit > 0 && $lineLength > $this->absoluteLineLimit ) { $data = array( $this->absoluteLineLimit, $lineLength, ); $error = 'Line exceeds maximum limit of %s characters; contains %s characters'; $phpcsFile->addError($error, $stackPtr, 'MaxExceeded', $data); } else if ($lineLength > $this->lineLimit) { $data = array( $this->lineLimit, $lineLength, ); $warning = 'Line exceeds %s characters; contains %s characters'; $phpcsFile->addWarning($warning, $stackPtr, 'TooLong', $data); } }//end checkLineLength() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Files/LowercasedFilenameSniff.php0000644000076700000240000000442112647543456031534 0ustar gsherwoodstaff * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Checks that all file names are lowercased. * * @category PHP * @package PHP_CodeSniffer * @author Andy Grunwald * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Files_LowercasedFilenameSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return int */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $filename = $phpcsFile->getFilename(); if ($filename === 'STDIN') { return; } $filename = basename($filename); $lowercaseFilename = strtolower($filename); if ($filename !== $lowercaseFilename) { $data = array( $filename, $lowercaseFilename, ); $error = 'Filename "%s" doesn\'t match the expected filename "%s"'; $phpcsFile->addError($error, $stackPtr, 'NotFound', $data); $phpcsFile->recordMetric($stackPtr, 'Lowercase filename', 'no'); } else { $phpcsFile->recordMetric($stackPtr, 'Lowercase filename', 'yes'); } // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Files/OneClassPerFileSniff.php0000644000076700000240000000334412647543456030764 0ustar gsherwoodstaff * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Checks that only one class is declared per file. * * @category PHP * @package PHP_CodeSniffer * @author Andy Grunwald * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Files_OneClassPerFileSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_CLASS); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $nextClass = $phpcsFile->findNext($this->register(), ($stackPtr + 1)); if ($nextClass !== false) { $error = 'Only one class is allowed in a file'; $phpcsFile->addError($error, $nextClass, 'MultipleFound'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Files/OneInterfacePerFileSniff.php0000644000076700000240000000340412647543456031614 0ustar gsherwoodstaff * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Checks that only one interface is declared per file. * * @category PHP * @package PHP_CodeSniffer * @author Andy Grunwald * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Files_OneInterfacePerFileSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_INTERFACE); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $nextInterface = $phpcsFile->findNext($this->register(), ($stackPtr + 1)); if ($nextInterface !== false) { $error = 'Only one interface is allowed in a file'; $phpcsFile->addError($error, $nextInterface, 'MultipleFound'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Files/OneTraitPerFileSniff.php0000644000076700000240000000336412647543456031004 0ustar gsherwoodstaff * @copyright 2010-2014 Alexander Obuhovich * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Checks that only one trait is declared per file. * * @category PHP * @package PHP_CodeSniffer * @author Alexander Obuhovich * @copyright 2010-2014 Alexander Obuhovich * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Files_OneTraitPerFileSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_TRAIT); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $nextClass = $phpcsFile->findNext($this->register(), ($stackPtr + 1)); if ($nextClass !== false) { $error = 'Only one trait is allowed in a file'; $phpcsFile->addError($error, $nextClass, 'MultipleFound'); } }//end process() }//end class ././@LongLink000 151 0003733 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Formatting/DisallowMultipleStatementsSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Formatting/DisallowMultipleStatementsSnif0000644000076700000240000000645012647543456033465 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Formatting_DisallowMultipleStatementsSniff. * * Ensures each statement is on a line by itself. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Formatting_DisallowMultipleStatementsSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_SEMICOLON); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $prev = $phpcsFile->findPrevious(array(T_SEMICOLON, T_OPEN_TAG), ($stackPtr - 1)); if ($prev === false || $tokens[$prev]['code'] === T_OPEN_TAG) { $phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'no'); return; } // Ignore multiple statements in a FOR condition. if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) { foreach ($tokens[$stackPtr]['nested_parenthesis'] as $bracket) { if (isset($tokens[$bracket]['parenthesis_owner']) === false) { // Probably a closure sitting inside a function call. continue; } $owner = $tokens[$bracket]['parenthesis_owner']; if ($tokens[$owner]['code'] === T_FOR) { return; } } } if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) { $phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'yes'); $error = 'Each PHP statement must be on a line by itself'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SameLine'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->addNewline($prev); if ($tokens[($prev + 1)]['code'] === T_WHITESPACE) { $phpcsFile->fixer->replaceToken(($prev + 1), ''); } $phpcsFile->fixer->endChangeset(); } } else { $phpcsFile->recordMetric($stackPtr, 'Multiple statements on same line', 'no'); } }//end process() }//end class ././@LongLink000 151 0003733 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Formatting/MultipleStatementAlignmentSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Formatting/MultipleStatementAlignmentSnif0000644000076700000240000002746112647543456033447 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Formatting_MultipleStatementAlignmentSniff. * * Checks alignment of assignments. If there are multiple adjacent assignments, * it will check that the equals signs of each assignment are aligned. It will * display a warning to advise that the signs should be aligned. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Formatting_MultipleStatementAlignmentSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * If true, an error will be thrown; otherwise a warning. * * @var bool */ public $error = false; /** * The maximum amount of padding before the alignment is ignored. * * If the amount of padding required to align this assignment with the * surrounding assignments exceeds this number, the assignment will be * ignored and no errors or warnings will be thrown. * * @var int */ public $maxPadding = 1000; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { $tokens = PHP_CodeSniffer_Tokens::$assignmentTokens; unset($tokens[T_DOUBLE_ARROW]); return $tokens; }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return int */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Ignore assignments used in a condition, like an IF or FOR. if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) { foreach ($tokens[$stackPtr]['nested_parenthesis'] as $start => $end) { if (isset($tokens[$start]['parenthesis_owner']) === true) { return; } } } $lastAssign = $this->checkAlignment($phpcsFile, $stackPtr); return ($lastAssign + 1); }//end process() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return int */ public function checkAlignment(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $assignments = array(); $prevAssign = null; $lastLine = $tokens[$stackPtr]['line']; $maxPadding = null; $stopped = null; $lastCode = $stackPtr; $lastSemi = null; $find = PHP_CodeSniffer_Tokens::$assignmentTokens; unset($find[T_DOUBLE_ARROW]); for ($assign = $stackPtr; $assign < $phpcsFile->numTokens; $assign++) { if (isset($find[$tokens[$assign]['code']]) === false) { // A blank line indicates that the assignment block has ended. if (isset(PHP_CodeSniffer_tokens::$emptyTokens[$tokens[$assign]['code']]) === false) { if (($tokens[$assign]['line'] - $tokens[$lastCode]['line']) > 1) { break; } $lastCode = $assign; if ($tokens[$assign]['code'] === T_SEMICOLON) { if ($tokens[$assign]['conditions'] === $tokens[$stackPtr]['conditions']) { if ($lastSemi !== null && $prevAssign !== null && $lastSemi > $prevAssign) { // This statement did not have an assignment operator in it. break; } else { $lastSemi = $assign; } } else { // Statement is in a different context, so the block is over. break; } } }//end if continue; } else if ($assign !== $stackPtr && $tokens[$assign]['line'] === $lastLine) { // Skip multiple assignments on the same line. We only need to // try and align the first assignment. continue; }//end if if ($assign !== $stackPtr) { // Has to be nested inside the same conditions as the first assignment. if ($tokens[$assign]['conditions'] !== $tokens[$stackPtr]['conditions']) { break; } // Make sure it is not assigned inside a condition (eg. IF, FOR). if (isset($tokens[$assign]['nested_parenthesis']) === true) { foreach ($tokens[$assign]['nested_parenthesis'] as $start => $end) { if (isset($tokens[$start]['parenthesis_owner']) === true) { break(2); } } } }//end if $var = $phpcsFile->findPrevious( PHP_CodeSniffer_Tokens::$emptyTokens, ($assign - 1), null, true ); // Make sure we wouldn't break our max padding length if we // aligned with this statement, or they wouldn't break the max // padding length if they aligned with us. $varEnd = $tokens[($var + 1)]['column']; $assignLen = $tokens[$assign]['length']; if ($assign !== $stackPtr) { if (($varEnd + 1) > $assignments[$prevAssign]['assign_col']) { $padding = 1; $assignColumn = ($varEnd + 1); } else { $padding = ($assignments[$prevAssign]['assign_col'] - $varEnd + $assignments[$prevAssign]['assign_len'] - $assignLen); if ($padding === 0) { $padding = 1; } if ($padding > $this->maxPadding) { $stopped = $assign; break; } $assignColumn = ($varEnd + $padding); }//end if if (($assignColumn + $assignLen) > ($assignments[$maxPadding]['assign_col'] + $assignments[$maxPadding]['assign_len'])) { $newPadding = ($varEnd - $assignments[$maxPadding]['var_end'] + $assignLen - $assignments[$maxPadding]['assign_len'] + 1); if ($newPadding > $this->maxPadding) { $stopped = $assign; break; } else { // New alignment settings for previous assignments. foreach ($assignments as $i => $data) { if ($i === $assign) { break; } $newPadding = ($varEnd - $data['var_end'] + $assignLen - $data['assign_len'] + 1); $assignments[$i]['expected'] = $newPadding; $assignments[$i]['assign_col'] = ($data['var_end'] + $newPadding); } $padding = 1; $assignColumn = ($varEnd + 1); } } else if ($padding > $assignments[$maxPadding]['expected']) { $maxPadding = $assign; }//end if } else { $padding = 1; $assignColumn = ($varEnd + 1); $maxPadding = $assign; }//end if $found = 0; if ($tokens[($var + 1)]['code'] === T_WHITESPACE) { $found = $tokens[($var + 1)]['length']; if ($found === 0) { // This means a newline was found. $found = 1; } } $assignments[$assign] = array( 'var_end' => $varEnd, 'assign_len' => $assignLen, 'assign_col' => $assignColumn, 'expected' => $padding, 'found' => $found, ); $lastLine = $tokens[$assign]['line']; $prevAssign = $assign; }//end for if (empty($assignments) === true) { return $stackPtr; } $errorGenerated = false; foreach ($assignments as $assignment => $data) { if ($data['found'] === $data['expected']) { continue; } $expectedText = $data['expected'].' space'; if ($data['expected'] !== 1) { $expectedText .= 's'; } if ($data['found'] === null) { $foundText = 'a new line'; } else { $foundText = $data['found'].' space'; if ($data['found'] !== 1) { $foundText .= 's'; } } if (count($assignments) === 1) { $type = 'Incorrect'; $error = 'Equals sign not aligned correctly; expected %s but found %s'; } else { $type = 'NotSame'; $error = 'Equals sign not aligned with surrounding assignments; expected %s but found %s'; } $errorData = array( $expectedText, $foundText, ); if ($this->error === true) { $fix = $phpcsFile->addFixableError($error, $assignment, $type, $errorData); } else { $fix = $phpcsFile->addFixableWarning($error, $assignment, $type.'Warning', $errorData); } $errorGenerated = true; if ($fix === true && $data['found'] !== null) { $newContent = str_repeat(' ', $data['expected']); if ($data['found'] === 0) { $phpcsFile->fixer->addContentBefore($assignment, $newContent); } else { $phpcsFile->fixer->replaceToken(($assignment - 1), $newContent); } } }//end foreach if ($errorGenerated === true) { $phpcsFile->recordMetric($stackPtr, 'Adjacent assignments aligned', 'no'); } else { $phpcsFile->recordMetric($stackPtr, 'Adjacent assignments aligned', 'yes'); } if ($stopped !== null) { return $this->checkAlignment($phpcsFile, $stopped); } else { return $assignment; } }//end checkAlignment() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Formatting/NoSpaceAfterCastSniff.php0000644000076700000240000000411012647543456032173 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Formatting_NoSpaceAfterCastSniff. * * Ensures there is no space after cast tokens. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Formatting_NoSpaceAfterCastSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return PHP_CodeSniffer_Tokens::$castTokens; }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE) { return; } $error = 'A cast statement must not be followed by a space'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceFound'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ''); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Formatting/SpaceAfterCastSniff.php0000644000076700000240000000516512647543456031711 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Formatting_SpaceAfterCastSniff. * * Ensures there is a single space after cast tokens. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Formatting_SpaceAfterCastSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return PHP_CodeSniffer_Tokens::$castTokens; }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE) { $error = 'A cast statement must be followed by a single space'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpace'); if ($fix === true) { $phpcsFile->fixer->addContent($stackPtr, ' '); } $phpcsFile->recordMetric($stackPtr, 'Spacing after cast statement', 0); return; } $phpcsFile->recordMetric($stackPtr, 'Spacing after cast statement', $tokens[($stackPtr + 1)]['length']); if ($tokens[($stackPtr + 1)]['length'] !== 1) { $error = 'A cast statement must be followed by a single space'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'TooMuchSpace'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' '); } } }//end process() }//end class ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Functions/CallTimePassByReferenceSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Functions/CallTimePassByReferenceSniff.ph0000644000076700000240000001226012647543456033164 0ustar gsherwoodstaff * @copyright 2009-2014 Florian Grandel * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Functions_CallTimePassByReferenceSniff. * * Ensures that variables are not passed by reference when calling a function. * * @category PHP * @package PHP_CodeSniffer * @author Florian Grandel * @copyright 2009-2014 Florian Grandel * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Functions_CallTimePassByReferenceSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_STRING, T_VARIABLE, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $findTokens = array_merge( PHP_CodeSniffer_Tokens::$emptyTokens, array(T_BITWISE_AND) ); $prev = $phpcsFile->findPrevious($findTokens, ($stackPtr - 1), null, true); // Skip tokens that are the names of functions or classes // within their definitions. For example: function myFunction... // "myFunction" is T_STRING but we should skip because it is not a // function or method *call*. // Also skip if the return value is being assigned to a variable. $prevCode = $tokens[$prev]['code']; if ($prevCode === T_FUNCTION || $prevCode === T_CLASS || isset(PHP_CodeSniffer_Tokens::$assignmentTokens[$prevCode]) === true ) { return; } // If the next non-whitespace token after the function or method call // is not an opening parenthesis then it cant really be a *call*. $functionName = $stackPtr; $openBracket = $phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, ($functionName + 1), null, true ); if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) { return; } if (isset($tokens[$openBracket]['parenthesis_closer']) === false) { return; } $closeBracket = $tokens[$openBracket]['parenthesis_closer']; $nextSeparator = $openBracket; while (($nextSeparator = $phpcsFile->findNext(T_VARIABLE, ($nextSeparator + 1), $closeBracket)) !== false) { if (isset($tokens[$nextSeparator]['nested_parenthesis']) === false) { continue; } // Make sure the variable belongs directly to this function call // and is not inside a nested function call or array. $brackets = $tokens[$nextSeparator]['nested_parenthesis']; $lastBracket = array_pop($brackets); if ($lastBracket !== $closeBracket) { continue; } // Checking this: $value = my_function(...[*]$arg...). $tokenBefore = $phpcsFile->findPrevious( PHP_CodeSniffer_Tokens::$emptyTokens, ($nextSeparator - 1), null, true ); if ($tokens[$tokenBefore]['code'] === T_BITWISE_AND) { // Checking this: $value = my_function(...[*]&$arg...). $tokenBefore = $phpcsFile->findPrevious( PHP_CodeSniffer_Tokens::$emptyTokens, ($tokenBefore - 1), null, true ); // We have to exclude all uses of T_BITWISE_AND that are not // references. We use a blacklist approach as we prefer false // positives to not identifying a pass-by-reference call at all. $tokenCode = $tokens[$tokenBefore]['code']; if ($tokenCode === T_VARIABLE || $tokenCode === T_CLOSE_PARENTHESIS || $tokenCode === T_LNUMBER || isset(PHP_CodeSniffer_Tokens::$assignmentTokens[$tokenCode]) === true ) { continue; } // T_BITWISE_AND represents a pass-by-reference. $error = 'Call-time pass-by-reference calls are prohibited'; $phpcsFile->addError($error, $tokenBefore, 'NotAllowed'); }//end if }//end while }//end process() }//end class ././@LongLink000 151 0003733 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Functions/FunctionCallArgumentSpacingSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Functions/FunctionCallArgumentSpacingSnif0000644000076700000240000001655612647543456033362 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Functions_FunctionCallArgumentSpacingSniff. * * Checks that calls to methods and functions are spaced correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Functions_FunctionCallArgumentSpacingSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_STRING); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Skip tokens that are the names of functions or classes // within their definitions. For example: // function myFunction... // "myFunction" is T_STRING but we should skip because it is not a // function or method *call*. $functionName = $stackPtr; $ignoreTokens = PHP_CodeSniffer_Tokens::$emptyTokens; $ignoreTokens[] = T_BITWISE_AND; $functionKeyword = $phpcsFile->findPrevious($ignoreTokens, ($stackPtr - 1), null, true); if ($tokens[$functionKeyword]['code'] === T_FUNCTION || $tokens[$functionKeyword]['code'] === T_CLASS) { return; } // If the next non-whitespace token after the function or method call // is not an opening parenthesis then it cant really be a *call*. $openBracket = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($functionName + 1), null, true); if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) { return; } if (isset($tokens[$openBracket]['parenthesis_closer']) === false) { return; } $closeBracket = $tokens[$openBracket]['parenthesis_closer']; $nextSeparator = $openBracket; $find = array( T_COMMA, T_VARIABLE, T_CLOSURE, T_OPEN_SHORT_ARRAY, ); while (($nextSeparator = $phpcsFile->findNext($find, ($nextSeparator + 1), $closeBracket)) !== false) { if ($tokens[$nextSeparator]['code'] === T_CLOSURE) { // Skip closures. $nextSeparator = $tokens[$nextSeparator]['scope_closer']; continue; } else if ($tokens[$nextSeparator]['code'] === T_OPEN_SHORT_ARRAY) { // Skips arrays using short notation. $nextSeparator = $tokens[$nextSeparator]['bracket_closer']; continue; } // Make sure the comma or variable belongs directly to this function call, // and is not inside a nested function call or array. $brackets = $tokens[$nextSeparator]['nested_parenthesis']; $lastBracket = array_pop($brackets); if ($lastBracket !== $closeBracket) { continue; } if ($tokens[$nextSeparator]['code'] === T_COMMA) { if ($tokens[($nextSeparator - 1)]['code'] === T_WHITESPACE) { if (isset(PHP_CodeSniffer_Tokens::$heredocTokens[$tokens[($nextSeparator - 2)]['code']]) === false) { $error = 'Space found before comma in function call'; $fix = $phpcsFile->addFixableError($error, $nextSeparator, 'SpaceBeforeComma'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($nextSeparator - 1), ''); } } } if ($tokens[($nextSeparator + 1)]['code'] !== T_WHITESPACE) { $error = 'No space found after comma in function call'; $fix = $phpcsFile->addFixableError($error, $nextSeparator, 'NoSpaceAfterComma'); if ($fix === true) { $phpcsFile->fixer->addContent($nextSeparator, ' '); } } else { // If there is a newline in the space, then they must be formatting // each argument on a newline, which is valid, so ignore it. $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($nextSeparator + 1), null, true); if ($tokens[$next]['line'] === $tokens[$nextSeparator]['line']) { $space = strlen($tokens[($nextSeparator + 1)]['content']); if ($space > 1) { $error = 'Expected 1 space after comma in function call; %s found'; $data = array($space); $fix = $phpcsFile->addFixableError($error, $nextSeparator, 'TooMuchSpaceAfterComma', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($nextSeparator + 1), ' '); } } } }//end if } else { // Token is a variable. $nextToken = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($nextSeparator + 1), $closeBracket, true); if ($nextToken !== false) { if ($tokens[$nextToken]['code'] === T_EQUAL) { if (($tokens[($nextToken - 1)]['code']) !== T_WHITESPACE) { $error = 'Expected 1 space before = sign of default value'; $fix = $phpcsFile->addFixableError($error, $nextToken, 'NoSpaceBeforeEquals'); if ($fix === true) { $phpcsFile->fixer->addContentBefore($nextToken, ' '); } } if ($tokens[($nextToken + 1)]['code'] !== T_WHITESPACE) { $error = 'Expected 1 space after = sign of default value'; $fix = $phpcsFile->addFixableError($error, $nextToken, 'NoSpaceAfterEquals'); if ($fix === true) { $phpcsFile->fixer->addContent($nextToken, ' '); } } } } }//end if }//end while }//end process() }//end class ././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Functions/OpeningFunctionBraceBsdAllmanSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Functions/OpeningFunctionBraceBsdAllmanSn0000644000076700000240000001536212647543456033264 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff. * * Checks that the opening brace of a function is on the line after the * function declaration. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff implements PHP_CodeSniffer_Sniff { /** * Should this sniff check function braces? * * @var bool */ public $checkFunctions = true; /** * Should this sniff check closure braces? * * @var bool */ public $checkClosures = false; /** * Registers the tokens that this sniff wants to listen for. * * @return void */ public function register() { return array( T_FUNCTION, T_CLOSURE, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['scope_opener']) === false) { return; } if (($tokens[$stackPtr]['code'] === T_FUNCTION && (bool) $this->checkFunctions === false) || ($tokens[$stackPtr]['code'] === T_CLOSURE && (bool) $this->checkClosures === false) ) { return; } $openingBrace = $tokens[$stackPtr]['scope_opener']; $closeBracket = $tokens[$stackPtr]['parenthesis_closer']; if ($tokens[$stackPtr]['code'] === T_CLOSURE) { $use = $phpcsFile->findNext(T_USE, ($closeBracket + 1), $tokens[$stackPtr]['scope_opener']); if ($use !== false) { $openBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($use + 1)); $closeBracket = $tokens[$openBracket]['parenthesis_closer']; } } $functionLine = $tokens[$closeBracket]['line']; $braceLine = $tokens[$openingBrace]['line']; $lineDifference = ($braceLine - $functionLine); if ($lineDifference === 0) { $error = 'Opening brace should be on a new line'; $fix = $phpcsFile->addFixableError($error, $openingBrace, 'BraceOnSameLine'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $indent = $phpcsFile->findFirstOnLine(array(), $openingBrace); if ($tokens[$indent]['code'] === T_WHITESPACE) { $phpcsFile->fixer->addContentBefore($openingBrace, $tokens[$indent]['content']); } $phpcsFile->fixer->addNewlineBefore($openingBrace); $phpcsFile->fixer->endChangeset(); } $phpcsFile->recordMetric($stackPtr, 'Function opening brace placement', 'same line'); } else if ($lineDifference > 1) { $error = 'Opening brace should be on the line after the declaration; found %s blank line(s)'; $data = array(($lineDifference - 1)); $fix = $phpcsFile->addFixableError($error, $openingBrace, 'BraceSpacing', $data); if ($fix === true) { for ($i = ($tokens[$stackPtr]['parenthesis_closer'] + 1); $i < $openingBrace; $i++) { if ($tokens[$i]['line'] === $braceLine) { $phpcsFile->fixer->addNewLineBefore($i); break; } $phpcsFile->fixer->replaceToken($i, ''); } } }//end if $next = $phpcsFile->findNext(T_WHITESPACE, ($openingBrace + 1), null, true); if ($tokens[$next]['line'] === $tokens[$openingBrace]['line']) { if ($next === $tokens[$stackPtr]['scope_closer']) { // Ignore empty functions. return; } $error = 'Opening brace must be the last content on the line'; $fix = $phpcsFile->addFixableError($error, $openingBrace, 'ContentAfterBrace'); if ($fix === true) { $phpcsFile->fixer->addNewline($openingBrace); } } // Only continue checking if the opening brace looks good. if ($lineDifference !== 1) { return; } // We need to actually find the first piece of content on this line, // as if this is a method with tokens before it (public, static etc) // or an if with an else before it, then we need to start the scope // checking from there, rather than the current token. $lineStart = $phpcsFile->findFirstOnLine(T_WHITESPACE, $stackPtr, true); // The opening brace is on the correct line, now it needs to be // checked to be correctly indented. $startColumn = $tokens[$lineStart]['column']; $braceIndent = $tokens[$openingBrace]['column']; if ($braceIndent !== $startColumn) { $expected = ($startColumn - 1); $found = ($braceIndent - 1); $error = 'Opening brace indented incorrectly; expected %s spaces, found %s'; $data = array( $expected, $found, ); $fix = $phpcsFile->addFixableError($error, $openingBrace, 'BraceIndent', $data); if ($fix === true) { $indent = str_repeat(' ', $expected); if ($found === 0) { $phpcsFile->fixer->addContentBefore($openingBrace, $indent); } else { $phpcsFile->fixer->replaceToken(($openingBrace - 1), $indent); } } }//end if $phpcsFile->recordMetric($stackPtr, 'Function opening brace placement', 'new line'); }//end process() }//end class ././@LongLink000 162 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Functions/OpeningFunctionBraceKernighanRitchieSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Functions/OpeningFunctionBraceKernighanRi0000644000076700000240000001254712647543456033331 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff. * * Checks that the opening brace of a function is on the same line * as the function declaration. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff implements PHP_CodeSniffer_Sniff { /** * Should this sniff check function braces? * * @var bool */ public $checkFunctions = true; /** * Should this sniff check closure braces? * * @var bool */ public $checkClosures = false; /** * Registers the tokens that this sniff wants to listen for. * * @return void */ public function register() { return array( T_FUNCTION, T_CLOSURE, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['scope_opener']) === false) { return; } if (($tokens[$stackPtr]['code'] === T_FUNCTION && (bool) $this->checkFunctions === false) || ($tokens[$stackPtr]['code'] === T_CLOSURE && (bool) $this->checkClosures === false) ) { return; } $openingBrace = $tokens[$stackPtr]['scope_opener']; $closeBracket = $tokens[$stackPtr]['parenthesis_closer']; if ($tokens[$stackPtr]['code'] === T_CLOSURE) { $use = $phpcsFile->findNext(T_USE, ($closeBracket + 1), $tokens[$stackPtr]['scope_opener']); if ($use !== false) { $openBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($use + 1)); $closeBracket = $tokens[$openBracket]['parenthesis_closer']; } } $functionLine = $tokens[$closeBracket]['line']; $braceLine = $tokens[$openingBrace]['line']; $lineDifference = ($braceLine - $functionLine); if ($lineDifference > 0) { $phpcsFile->recordMetric($stackPtr, 'Function opening brace placement', 'new line'); $error = 'Opening brace should be on the same line as the declaration'; $fix = $phpcsFile->addFixableError($error, $openingBrace, 'BraceOnNewLine'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->addContent($closeBracket, ' {'); $phpcsFile->fixer->replaceToken($openingBrace, ''); $phpcsFile->fixer->endChangeset(); } } $phpcsFile->recordMetric($stackPtr, 'Function opening brace placement', 'same line'); $next = $phpcsFile->findNext(T_WHITESPACE, ($openingBrace + 1), null, true); if ($tokens[$next]['line'] === $tokens[$openingBrace]['line']) { if ($next === $tokens[$stackPtr]['scope_closer']) { // Ignore empty functions. return; } $error = 'Opening brace must be the last content on the line'; $fix = $phpcsFile->addFixableError($error, $openingBrace, 'ContentAfterBrace'); if ($fix === true) { $phpcsFile->fixer->addNewline($openingBrace); } } // Only continue checking if the opening brace looks good. if ($lineDifference > 0) { return; } if ($tokens[($closeBracket + 1)]['code'] !== T_WHITESPACE) { $length = 0; } else if ($tokens[($closeBracket + 1)]['content'] === "\t") { $length = '\t'; } else { $length = strlen($tokens[($closeBracket + 1)]['content']); } if ($length !== 1) { $error = 'Expected 1 space after closing parenthesis; found %s'; $data = array($length); $fix = $phpcsFile->addFixableError($error, $closeBracket, 'SpaceAfterBracket', $data); if ($fix === true) { if ($length === 0 || $length === '\t') { $phpcsFile->fixer->addContent($closeBracket, ' '); } else { $phpcsFile->fixer->replaceToken(($closeBracket + 1), ' '); } } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Metrics/CyclomaticComplexitySniff.php0000644000076700000240000000750012647543456032515 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Checks the cyclomatic complexity (McCabe) for functions. * * The cyclomatic complexity (also called McCabe code metrics) * indicates the complexity within a function by counting * the different paths the function includes. * * @category PHP * @package PHP_CodeSniffer * @author Johann-Peter Hartmann * @author Greg Sherwood * @copyright 2007-2014 Mayflower GmbH * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Metrics_CyclomaticComplexitySniff implements PHP_CodeSniffer_Sniff { /** * A complexity higher than this value will throw a warning. * * @var int */ public $complexity = 10; /** * A complexity higer than this value will throw an error. * * @var int */ public $absoluteComplexity = 20; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_FUNCTION); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $this->currentFile = $phpcsFile; $tokens = $phpcsFile->getTokens(); // Ignore abstract methods. if (isset($tokens[$stackPtr]['scope_opener']) === false) { return; } // Detect start and end of this function definition. $start = $tokens[$stackPtr]['scope_opener']; $end = $tokens[$stackPtr]['scope_closer']; // Predicate nodes for PHP. $find = array( T_CASE => true, T_DEFAULT => true, T_CATCH => true, T_IF => true, T_FOR => true, T_FOREACH => true, T_WHILE => true, T_DO => true, T_ELSEIF => true, ); $complexity = 1; // Iterate from start to end and count predicate nodes. for ($i = ($start + 1); $i < $end; $i++) { if (isset($find[$tokens[$i]['code']]) === true) { $complexity++; } } if ($complexity > $this->absoluteComplexity) { $error = 'Function\'s cyclomatic complexity (%s) exceeds allowed maximum of %s'; $data = array( $complexity, $this->absoluteComplexity, ); $phpcsFile->addError($error, $stackPtr, 'MaxExceeded', $data); } else if ($complexity > $this->complexity) { $warning = 'Function\'s cyclomatic complexity (%s) exceeds %s; consider refactoring the function'; $data = array( $complexity, $this->complexity, ); $phpcsFile->addWarning($warning, $stackPtr, 'TooHigh', $data); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Metrics/NestingLevelSniff.php0000644000076700000240000000653612647543456030757 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Checks the nesting level for methods. * * @category PHP * @package PHP_CodeSniffer * @author Johann-Peter Hartmann * @author Greg Sherwood * @copyright 2007-2014 Mayflower GmbH * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Metrics_NestingLevelSniff implements PHP_CodeSniffer_Sniff { /** * A nesting level than this value will throw a warning. * * @var int */ public $nestingLevel = 5; /** * A nesting level than this value will throw an error. * * @var int */ public $absoluteNestingLevel = 10; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_FUNCTION); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Ignore abstract methods. if (isset($tokens[$stackPtr]['scope_opener']) === false) { return; } // Detect start and end of this function definition. $start = $tokens[$stackPtr]['scope_opener']; $end = $tokens[$stackPtr]['scope_closer']; $nestingLevel = 0; // Find the maximum nesting level of any token in the function. for ($i = ($start + 1); $i < $end; $i++) { $level = $tokens[$i]['level']; if ($nestingLevel < $level) { $nestingLevel = $level; } } // We subtract the nesting level of the function itself. $nestingLevel = ($nestingLevel - $tokens[$stackPtr]['level'] - 1); if ($nestingLevel > $this->absoluteNestingLevel) { $error = 'Function\'s nesting level (%s) exceeds allowed maximum of %s'; $data = array( $nestingLevel, $this->absoluteNestingLevel, ); $phpcsFile->addError($error, $stackPtr, 'MaxExceeded', $data); } else if ($nestingLevel > $this->nestingLevel) { $warning = 'Function\'s nesting level (%s) exceeds %s; consider refactoring the function'; $data = array( $nestingLevel, $this->nestingLevel, ); $phpcsFile->addWarning($warning, $stackPtr, 'TooHigh', $data); } }//end process() }//end class ././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/NamingConventions/CamelCapsFunctionNameSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/NamingConventions/CamelCapsFunctionNameSn0000644000076700000240000002044212647543456033265 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found'); } /** * Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff. * * Ensures method names are correct depending on whether they are public * or private, and that functions are named correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff { /** * A list of all PHP magic methods. * * @var array */ protected $magicMethods = array( 'construct' => true, 'destruct' => true, 'call' => true, 'callstatic' => true, 'get' => true, 'set' => true, 'isset' => true, 'unset' => true, 'sleep' => true, 'wakeup' => true, 'tostring' => true, 'set_state' => true, 'clone' => true, 'invoke' => true, 'debuginfo' => true, ); /** * A list of all PHP non-magic methods starting with a double underscore. * * These come from PHP modules such as SOAPClient. * * @var array */ protected $methodsDoubleUnderscore = array( 'soapcall' => true, 'getlastrequest' => true, 'getlastresponse' => true, 'getlastrequestheaders' => true, 'getlastresponseheaders' => true, 'getfunctions' => true, 'gettypes' => true, 'dorequest' => true, 'setcookie' => true, 'setlocation' => true, 'setsoapheaders' => true, ); /** * A list of all PHP magic functions. * * @var array */ protected $magicFunctions = array('autoload' => true); /** * If TRUE, the string must not have two capital letters next to each other. * * @var bool */ public $strict = true; /** * Constructs a Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff. */ public function __construct() { parent::__construct(array(T_CLASS, T_INTERFACE, T_TRAIT), array(T_FUNCTION), true); }//end __construct() /** * Processes the tokens within the scope. * * @param PHP_CodeSniffer_File $phpcsFile The file being processed. * @param int $stackPtr The position where this token was * found. * @param int $currScope The position of the current scope. * * @return void */ protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope) { $methodName = $phpcsFile->getDeclarationName($stackPtr); if ($methodName === null) { // Ignore closures. return; } $className = $phpcsFile->getDeclarationName($currScope); $errorData = array($className.'::'.$methodName); // Is this a magic method. i.e., is prefixed with "__" ? if (preg_match('|^__|', $methodName) !== 0) { $magicPart = strtolower(substr($methodName, 2)); if (isset($this->magicMethods[$magicPart]) === false && isset($this->methodsDoubleUnderscore[$magicPart]) === false ) { $error = 'Method name "%s" is invalid; only PHP magic methods should be prefixed with a double underscore'; $phpcsFile->addError($error, $stackPtr, 'MethodDoubleUnderscore', $errorData); } return; } // PHP4 constructors are allowed to break our rules. if ($methodName === $className) { return; } // PHP4 destructors are allowed to break our rules. if ($methodName === '_'.$className) { return; } // Ignore first underscore in methods prefixed with "_". $methodName = ltrim($methodName, '_'); $methodProps = $phpcsFile->getMethodProperties($stackPtr); if (PHP_CodeSniffer::isCamelCaps($methodName, false, true, $this->strict) === false) { if ($methodProps['scope_specified'] === true) { $error = '%s method name "%s" is not in camel caps format'; $data = array( ucfirst($methodProps['scope']), $errorData[0], ); $phpcsFile->addError($error, $stackPtr, 'ScopeNotCamelCaps', $data); } else { $error = 'Method name "%s" is not in camel caps format'; $phpcsFile->addError($error, $stackPtr, 'NotCamelCaps', $errorData); } $phpcsFile->recordMetric($stackPtr, 'CamelCase method name', 'no'); return; } else { $phpcsFile->recordMetric($stackPtr, 'CamelCase method name', 'yes'); } }//end processTokenWithinScope() /** * Processes the tokens outside the scope. * * @param PHP_CodeSniffer_File $phpcsFile The file being processed. * @param int $stackPtr The position where this token was * found. * * @return void */ protected function processTokenOutsideScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $functionName = $phpcsFile->getDeclarationName($stackPtr); if ($functionName === null) { // Ignore closures. return; } $errorData = array($functionName); // Is this a magic function. i.e., it is prefixed with "__". if (preg_match('|^__|', $functionName) !== 0) { $magicPart = strtolower(substr($functionName, 2)); if (isset($this->magicFunctions[$magicPart]) === false) { $error = 'Function name "%s" is invalid; only PHP magic methods should be prefixed with a double underscore'; $phpcsFile->addError($error, $stackPtr, 'FunctionDoubleUnderscore', $errorData); } return; } // Ignore first underscore in functions prefixed with "_". $functionName = ltrim($functionName, '_'); if (PHP_CodeSniffer::isCamelCaps($functionName, false, true, $this->strict) === false) { $error = 'Function name "%s" is not in camel caps format'; $phpcsFile->addError($error, $stackPtr, 'NotCamelCaps', $errorData); $phpcsFile->recordMetric($stackPtr, 'CamelCase function name', 'no'); } else { $phpcsFile->recordMetric($stackPtr, 'CamelCase method name', 'yes'); } }//end processTokenOutsideScope() }//end class ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/NamingConventions/ConstructorNameSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/NamingConventions/ConstructorNameSniff.ph0000644000076700000240000001166412647543456033355 0ustar gsherwoodstaff * @author Leif Wickland * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) { $error = 'Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found'; throw new PHP_CodeSniffer_Exception($error); } /** * Generic_Sniffs_NamingConventions_ConstructorNameSniff. * * Favor PHP 5 constructor syntax, which uses "function __construct()". * Avoid PHP 4 constructor syntax, which uses "function ClassName()". * * @category PHP * @package PHP_CodeSniffer * @author Leif Wickland * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_NamingConventions_ConstructorNameSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff { /** * The name of the class we are currently checking. * * @var string */ private $_currentClass = ''; /** * A list of functions in the current class. * * @var string[] */ private $_functionList = array(); /** * Constructs the test with the tokens it wishes to listen for. */ public function __construct() { parent::__construct(array(T_CLASS, T_INTERFACE), array(T_FUNCTION), true); }//end __construct() /** * Processes this test when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The current file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param int $currScope A pointer to the start of the scope. * * @return void */ protected function processTokenWithinScope( PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope ) { $className = $phpcsFile->getDeclarationName($currScope); if ($className !== $this->_currentClass) { $this->loadFunctionNamesInScope($phpcsFile, $currScope); $this->_currentClass = $className; } $methodName = $phpcsFile->getDeclarationName($stackPtr); if (strcasecmp($methodName, $className) === 0) { if (in_array('__construct', $this->_functionList) === false) { $error = 'PHP4 style constructors are not allowed; use "__construct()" instead'; $phpcsFile->addError($error, $stackPtr, 'OldStyle'); } } else if (strcasecmp($methodName, '__construct') !== 0) { // Not a constructor. return; } $tokens = $phpcsFile->getTokens(); $parentClassName = $phpcsFile->findExtendedClassName($currScope); if ($parentClassName === false) { return; } // Stop if the constructor doesn't have a body, like when it is abstract. if (isset($tokens[$stackPtr]['scope_closer']) === false) { return; } $endFunctionIndex = $tokens[$stackPtr]['scope_closer']; $startIndex = $stackPtr; while (($doubleColonIndex = $phpcsFile->findNext(T_DOUBLE_COLON, $startIndex, $endFunctionIndex)) !== false) { if ($tokens[($doubleColonIndex + 1)]['code'] === T_STRING && $tokens[($doubleColonIndex + 1)]['content'] === $parentClassName ) { $error = 'PHP4 style calls to parent constructors are not allowed; use "parent::__construct()" instead'; $phpcsFile->addError($error, ($doubleColonIndex + 1), 'OldStyleCall'); } $startIndex = ($doubleColonIndex + 1); } }//end processTokenWithinScope() /** * Extracts all the function names found in the given scope. * * @param PHP_CodeSniffer_File $phpcsFile The current file being scanned. * @param int $currScope A pointer to the start of the scope. * * @return void */ protected function loadFunctionNamesInScope(PHP_CodeSniffer_File $phpcsFile, $currScope) { $this->_functionList = array(); $tokens = $phpcsFile->getTokens(); for ($i = ($tokens[$currScope]['scope_opener'] + 1); $i < $tokens[$currScope]['scope_closer']; $i++) { if ($tokens[$i]['code'] !== T_FUNCTION) { continue; } $next = $phpcsFile->findNext(T_STRING, $i); $this->_functionList[] = trim($tokens[$next]['content']); } }//end loadFunctionNamesInScope() }//end class ././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/NamingConventions/UpperCaseConstantNameSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/NamingConventions/UpperCaseConstantNameSn0000644000076700000240000001345612647543456033337 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_NamingConventions_UpperCaseConstantNameSniff. * * Ensures that constant names are all uppercase. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_NamingConventions_UpperCaseConstantNameSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_STRING); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $constName = $tokens[$stackPtr]['content']; // If this token is in a heredoc, ignore it. if ($phpcsFile->hasCondition($stackPtr, T_START_HEREDOC) === true) { return; } // Special case for PHP 5.5 class name resolution. if (strtolower($constName) === 'class' && $tokens[($stackPtr - 1)]['code'] === T_DOUBLE_COLON ) { return; } // Special case for PHPUnit. if ($constName === 'PHPUnit_MAIN_METHOD') { return; } // If the next non-whitespace token after this token // is not an opening parenthesis then it is not a function call. for ($openBracket = ($stackPtr + 1); $openBracket < $phpcsFile->numTokens; $openBracket++) { if ($tokens[$openBracket]['code'] !== T_WHITESPACE) { break; } } if ($openBracket === $phpcsFile->numTokens) { return; } if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) { $functionKeyword = $phpcsFile->findPrevious( array( T_WHITESPACE, T_COMMA, T_COMMENT, T_STRING, T_NS_SEPARATOR, ), ($stackPtr - 1), null, true ); if ($tokens[$functionKeyword]['code'] !== T_CONST) { return; } // This is a class constant. if (strtoupper($constName) !== $constName) { if (strtolower($constName) === $constName) { $phpcsFile->recordMetric($stackPtr, 'Constant name case', 'lower'); } else { $phpcsFile->recordMetric($stackPtr, 'Constant name case', 'mixed'); } $error = 'Class constants must be uppercase; expected %s but found %s'; $data = array( strtoupper($constName), $constName, ); $phpcsFile->addError($error, $stackPtr, 'ClassConstantNotUpperCase', $data); } else { $phpcsFile->recordMetric($stackPtr, 'Constant name case', 'upper'); } return; }//end if if (strtolower($constName) !== 'define') { return; } /* This may be a "define" function call. */ // Make sure this is not a method call. $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if ($tokens[$prev]['code'] === T_OBJECT_OPERATOR || $tokens[$prev]['code'] === T_DOUBLE_COLON ) { return; } // The next non-whitespace token must be the constant name. $constPtr = $phpcsFile->findNext(T_WHITESPACE, ($openBracket + 1), null, true); if ($tokens[$constPtr]['code'] !== T_CONSTANT_ENCAPSED_STRING) { return; } $constName = $tokens[$constPtr]['content']; // Check for constants like self::CONSTANT. $prefix = ''; $splitPos = strpos($constName, '::'); if ($splitPos !== false) { $prefix = substr($constName, 0, ($splitPos + 2)); $constName = substr($constName, ($splitPos + 2)); } if (strtoupper($constName) !== $constName) { if (strtolower($constName) === $constName) { $phpcsFile->recordMetric($stackPtr, 'Constant name case', 'lower'); } else { $phpcsFile->recordMetric($stackPtr, 'Constant name case', 'mixed'); } $error = 'Constants must be uppercase; expected %s but found %s'; $data = array( $prefix.strtoupper($constName), $prefix.$constName, ); $phpcsFile->addError($error, $stackPtr, 'ConstantNotUpperCase', $data); } else { $phpcsFile->recordMetric($stackPtr, 'Constant name case', 'upper'); } }//end process() }//end class ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/PHP/CharacterBeforePHPOpeningTagSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/PHP/CharacterBeforePHPOpeningTagSniff.php0000644000076700000240000000415212647543456032734 0ustar gsherwoodstaff * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Checks that the opening PHP tag is the first content in a file. * * @category PHP * @package PHP_CodeSniffer * @author Andy Grunwald * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_PHP_CharacterBeforePHPOpeningTagSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $expected = 0; if ($stackPtr > 0) { // Allow a shebang line. $tokens = $phpcsFile->getTokens(); if (substr($tokens[0]['content'], 0, 2) === '#!') { $expected = 1; } } if ($stackPtr !== $expected) { $error = 'The opening PHP tag must be the first content in the file'; $phpcsFile->addError($error, $stackPtr, 'Found'); } // Skip the rest of the file so we don't pick up additional // open tags, typically embedded in HTML. return $phpcsFile->numTokens; }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/PHP/ClosingPHPTagSniff.php0000644000076700000240000000334712647543456030000 0ustar gsherwoodstaff * @copyright 2010-2014 Stefano Kowalke * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Checks that open PHP tags are paired with closing tags. * * @category PHP * @package PHP_CodeSniffer * @author Stefano Kowalke * @copyright 2010-2014 Stefano Kowalke * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_PHP_ClosingPHPTagSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $closeTag = $phpcsFile->findNext(T_CLOSE_TAG, $stackPtr); if ($closeTag === false) { $error = 'The PHP open tag does not have a corresponding PHP close tag'; $phpcsFile->addError($error, $stackPtr, 'NotFound'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/PHP/DeprecatedFunctionsSniff.php0000644000076700000240000000564512647543456031332 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_PHP_DeprecatedFunctionsSniff. * * Discourages the use of deprecated functions that are kept in PHP for * compatibility with older versions. * * @category PHP * @package PHP_CodeSniffer * @author Sebastian Bergmann * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_PHP_DeprecatedFunctionsSniff extends Generic_Sniffs_PHP_ForbiddenFunctionsSniff { /** * A list of forbidden functions with their alternatives. * * The value is NULL if no alternative exists. IE, the * function should just not be used. * * @var array(string => string|null) */ public $forbiddenFunctions = array(); /** * Constructor. * * Uses the Reflection API to get a list of deprecated functions. */ public function __construct() { $functions = get_defined_functions(); foreach ($functions['internal'] as $functionName) { $function = new ReflectionFunction($functionName); if (method_exists($function, 'isDeprecated') === false) { break; } if ($function->isDeprecated() === true) { $this->forbiddenFunctions[$functionName] = null; } } }//end __construct() /** * Generates the error or warning for this sniff. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the forbidden function * in the token array. * @param string $function The name of the forbidden function. * @param string $pattern The pattern used for the match. * * @return void */ protected function addError($phpcsFile, $stackPtr, $function, $pattern=null) { $data = array($function); $error = 'Function %s() has been deprecated'; $type = 'Deprecated'; if ($this->error === true) { $phpcsFile->addError($error, $stackPtr, $type, $data); } else { $phpcsFile->addWarning($error, $stackPtr, $type, $data); } }//end addError() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/PHP/DisallowShortOpenTagSniff.php0000644000076700000240000000546712647543456031457 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_PHP_DisallowShortOpenTagSniff. * * Makes sure that shorthand PHP open tags are not used. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_PHP_DisallowShortOpenTagSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_OPEN_TAG, T_OPEN_TAG_WITH_ECHO, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $openTag = $tokens[$stackPtr]; if ($openTag['content'] === 'addError($error, $stackPtr, 'Found', $data); $phpcsFile->recordMetric($stackPtr, 'PHP short open tag used', 'yes'); } else { $phpcsFile->recordMetric($stackPtr, 'PHP short open tag used', 'no'); } if ($openTag['code'] === T_OPEN_TAG_WITH_ECHO) { $nextVar = $tokens[$phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true)]; $error = 'Short PHP opening tag used with echo; expected "addError($error, $stackPtr, 'EchoFound', $data); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/PHP/ForbiddenFunctionsSniff.php0000644000076700000240000001666012647543456031165 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_PHP_ForbiddenFunctionsSniff. * * Discourages the use of alias functions that are kept in PHP for compatibility * with older versions. Can be used to forbid the use of any function. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_PHP_ForbiddenFunctionsSniff implements PHP_CodeSniffer_Sniff { /** * A list of forbidden functions with their alternatives. * * The value is NULL if no alternative exists. IE, the * function should just not be used. * * @var array(string => string|null) */ public $forbiddenFunctions = array( 'sizeof' => 'count', 'delete' => 'unset', ); /** * A cache of forbidden function names, for faster lookups. * * @var array(string) */ protected $forbiddenFunctionNames = array(); /** * If true, forbidden functions will be considered regular expressions. * * @var bool */ protected $patternMatch = false; /** * If true, an error will be thrown; otherwise a warning. * * @var bool */ public $error = true; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { // Everyone has had a chance to figure out what forbidden functions // they want to check for, so now we can cache out the list. $this->forbiddenFunctionNames = array_keys($this->forbiddenFunctions); if ($this->patternMatch === true) { foreach ($this->forbiddenFunctionNames as $i => $name) { $this->forbiddenFunctionNames[$i] = '/'.$name.'/i'; } return array(T_STRING); } // If we are not pattern matching, we need to work out what // tokens to listen for. $string = 'forbiddenFunctionNames as $name) { $string .= $name.'();'; } $register = array(); $tokens = token_get_all($string); array_shift($tokens); foreach ($tokens as $token) { if (is_array($token) === true) { $register[] = $token[0]; } } return array_unique($register); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $ignore = array( T_DOUBLE_COLON => true, T_OBJECT_OPERATOR => true, T_FUNCTION => true, T_CONST => true, T_PUBLIC => true, T_PRIVATE => true, T_PROTECTED => true, T_AS => true, T_NEW => true, T_INSTEADOF => true, T_NS_SEPARATOR => true, T_IMPLEMENTS => true, ); $prevToken = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); // If function call is directly preceded by a NS_SEPARATOR it points to the // global namespace, so we should still catch it. if ($tokens[$prevToken]['code'] === T_NS_SEPARATOR) { $prevToken = $phpcsFile->findPrevious(T_WHITESPACE, ($prevToken - 1), null, true); if ($tokens[$prevToken]['code'] === T_STRING) { // Not in the global namespace. return; } } if (isset($ignore[$tokens[$prevToken]['code']]) === true) { // Not a call to a PHP function. return; } $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if (isset($ignore[$tokens[$nextToken]['code']]) === true) { // Not a call to a PHP function. return; } if ($tokens[$stackPtr]['code'] === T_STRING && $tokens[$nextToken]['code'] !== T_OPEN_PARENTHESIS) { // Not a call to a PHP function. return; } $function = strtolower($tokens[$stackPtr]['content']); $pattern = null; if ($this->patternMatch === true) { $count = 0; $pattern = preg_replace( $this->forbiddenFunctionNames, $this->forbiddenFunctionNames, $function, 1, $count ); if ($count === 0) { return; } // Remove the pattern delimiters and modifier. $pattern = substr($pattern, 1, -2); } else { if (in_array($function, $this->forbiddenFunctionNames) === false) { return; } }//end if $this->addError($phpcsFile, $stackPtr, $function, $pattern); }//end process() /** * Generates the error or warning for this sniff. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the forbidden function * in the token array. * @param string $function The name of the forbidden function. * @param string $pattern The pattern used for the match. * * @return void */ protected function addError($phpcsFile, $stackPtr, $function, $pattern=null) { $data = array($function); $error = 'The use of function %s() is '; if ($this->error === true) { $type = 'Found'; $error .= 'forbidden'; } else { $type = 'Discouraged'; $error .= 'discouraged'; } if ($pattern === null) { $pattern = $function; } if ($this->forbiddenFunctions[$pattern] !== null && $this->forbiddenFunctions[$pattern] !== 'null' ) { $type .= 'WithAlternative'; $data[] = $this->forbiddenFunctions[$pattern]; $error .= '; use %s() instead'; } if ($this->error === true) { $phpcsFile->addError($error, $stackPtr, $type, $data); } else { $phpcsFile->addWarning($error, $stackPtr, $type, $data); } }//end addError() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/PHP/LowerCaseConstantSniff.php0000644000076700000240000000565312647543456030776 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_PHP_LowerCaseConstantSniff. * * Checks that all uses of true, false and null are lowercase. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_PHP_LowerCaseConstantSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_TRUE, T_FALSE, T_NULL, ); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $keyword = $tokens[$stackPtr]['content']; $expected = strtolower($keyword); if ($keyword !== $expected) { if ($keyword === strtoupper($keyword)) { $phpcsFile->recordMetric($stackPtr, 'PHP constant case', 'upper'); } else { $phpcsFile->recordMetric($stackPtr, 'PHP constant case', 'mixed'); } $error = 'TRUE, FALSE and NULL must be lowercase; expected "%s" but found "%s"'; $data = array( $expected, $keyword, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Found', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, $expected); } } else { $phpcsFile->recordMetric($stackPtr, 'PHP constant case', 'lower'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/PHP/LowerCaseKeywordSniff.php0000644000076700000240000001025312647543456030621 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_PHP_LowerCaseKeywordSniff. * * Checks that all PHP keywords are lowercase. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_PHP_LowerCaseKeywordSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_HALT_COMPILER, T_ABSTRACT, T_ARRAY, T_ARRAY_HINT, T_AS, T_BREAK, T_CALLABLE, T_CASE, T_CATCH, T_CLASS, T_CLONE, T_CONST, T_CONTINUE, T_DECLARE, T_DEFAULT, T_DO, T_ECHO, T_ELSE, T_ELSEIF, T_EMPTY, T_ENDDECLARE, T_ENDFOR, T_ENDFOREACH, T_ENDIF, T_ENDSWITCH, T_ENDWHILE, T_EVAL, T_EXIT, T_EXTENDS, T_FINAL, T_FINALLY, T_FOR, T_FOREACH, T_FUNCTION, T_GLOBAL, T_GOTO, T_IF, T_IMPLEMENTS, T_INCLUDE, T_INCLUDE_ONCE, T_INSTANCEOF, T_INSTEADOF, T_INTERFACE, T_ISSET, T_LIST, T_LOGICAL_AND, T_LOGICAL_OR, T_LOGICAL_XOR, T_NAMESPACE, T_NEW, T_PRINT, T_PRIVATE, T_PROTECTED, T_PUBLIC, T_REQUIRE, T_REQUIRE_ONCE, T_RETURN, T_STATIC, T_SWITCH, T_THROW, T_TRAIT, T_TRY, T_UNSET, T_USE, T_VAR, T_WHILE, ); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $keyword = $tokens[$stackPtr]['content']; if (strtolower($keyword) !== $keyword) { if ($keyword === strtoupper($keyword)) { $phpcsFile->recordMetric($stackPtr, 'PHP keyword case', 'upper'); } else { $phpcsFile->recordMetric($stackPtr, 'PHP keyword case', 'mixed'); } $error = 'PHP keywords must be lowercase; expected "%s" but found "%s"'; $data = array( strtolower($keyword), $keyword, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Found', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, strtolower($keyword)); } } else { $phpcsFile->recordMetric($stackPtr, 'PHP keyword case', 'lower'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/PHP/NoSilencedErrorsSniff.php0000644000076700000240000000404712647543456030614 0ustar gsherwoodstaff * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_PHP_NoSilencedErrorsSniff. * * Throws an error or warning when any code prefixed with an asperand is encountered. * * * if (@in_array($array, $needle)) * { * doSomething(); * } * * * @category PHP * @package PHP_CodeSniffer * @author Andy Brockhurst * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_PHP_NoSilencedErrorsSniff implements PHP_CodeSniffer_Sniff { /** * If true, an error will be thrown; otherwise a warning. * * @var bool */ public $error = false; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_ASPERAND); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $error = 'Silencing errors is forbidden'; if ($this->error === true) { $error = 'Silencing errors is forbidden'; $phpcsFile->addError($error, $stackPtr, 'Forbidden'); } else { $error = 'Silencing errors is discouraged'; $phpcsFile->addWarning($error, $stackPtr, 'Discouraged'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/PHP/SAPIUsageSniff.php0000644000076700000240000000450012647543456027107 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_PHP_SAPIUsageSniff. * * Ensures the PHP_SAPI constant is used instead of php_sapi_name(). * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_PHP_SAPIUsageSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_STRING); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $ignore = array( T_DOUBLE_COLON => true, T_OBJECT_OPERATOR => true, T_FUNCTION => true, T_CONST => true, ); $prevToken = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if (isset($ignore[$tokens[$prevToken]['code']]) === true) { // Not a call to a PHP function. return; } $function = strtolower($tokens[$stackPtr]['content']); if ($function === 'php_sapi_name') { $error = 'Use the PHP_SAPI constant instead of calling php_sapi_name()'; $phpcsFile->addError($error, $stackPtr, 'FunctionFound'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/PHP/SyntaxSniff.php0000644000076700000240000000442012647543456026655 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_PHP_SyntaxSniff. * * Ensures PHP believes the syntax is clean. * * @category PHP * @package PHP_CodeSniffer * @author Blaine Schmeisser * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_PHP_SyntaxSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $phpPath = PHP_CodeSniffer::getConfigData('php_path'); if ($phpPath === null) { return; } $fileName = $phpcsFile->getFilename(); $cmd = "$phpPath -l \"$fileName\" 2>&1"; $output = shell_exec($cmd); $matches = array(); if (preg_match('/^.*error:(.*) in .* on line ([0-9]+)/', trim($output), $matches) === 1) { $error = trim($matches[1]); $line = (int) $matches[2]; $phpcsFile->addErrorOnLine("PHP syntax error: $error", $line, 'PHPSyntax'); } // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/PHP/UpperCaseConstantSniff.php0000644000076700000240000000525712647543456031001 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_PHP_UpperCaseConstantSniff. * * Checks that all uses of TRUE, FALSE and NULL are uppercase. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_PHP_UpperCaseConstantSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_TRUE, T_FALSE, T_NULL, ); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $keyword = $tokens[$stackPtr]['content']; $expected = strtoupper($keyword); if ($keyword !== $expected) { if ($keyword === strtolower($keyword)) { $phpcsFile->recordMetric($stackPtr, 'PHP constant case', 'lower'); } else { $phpcsFile->recordMetric($stackPtr, 'PHP constant case', 'mixed'); } $error = 'TRUE, FALSE and NULL must be uppercase; expected "%s" but found "%s"'; $data = array( $expected, $keyword, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Found', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, $expected); } } else { $phpcsFile->recordMetric($stackPtr, 'PHP constant case', 'upper'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/Strings/UnnecessaryStringConcatSniff.php0000644000076700000240000001051412647543456033210 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Strings_UnnecessaryStringConcatSniff. * * Checks that two strings are not concatenated together; suggests * using one string instead. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_Strings_UnnecessaryStringConcatSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * If true, an error will be thrown; otherwise a warning. * * @var bool */ public $error = true; /** * If true, strings concatenated over multiple lines are allowed. * * Useful if you break strings over multiple lines to work * within a max line length. * * @var bool */ public $allowMultiline = false; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_STRING_CONCAT, T_PLUS, ); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { // Work out which type of file this is for. $tokens = $phpcsFile->getTokens(); if ($tokens[$stackPtr]['code'] === T_STRING_CONCAT) { if ($phpcsFile->tokenizerType === 'JS') { return; } } else { if ($phpcsFile->tokenizerType === 'PHP') { return; } } $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($prev === false || $next === false) { return; } if (isset(PHP_CodeSniffer_Tokens::$stringTokens[$tokens[$prev]['code']]) === true && isset(PHP_CodeSniffer_Tokens::$stringTokens[$tokens[$next]['code']]) === true ) { if ($tokens[$prev]['content'][0] === $tokens[$next]['content'][0]) { // Before we throw an error for PHP, allow strings to be // combined if they would have < and ? next to each other because // this trick is sometimes required in PHP strings. if ($phpcsFile->tokenizerType === 'PHP') { $prevChar = substr($tokens[$prev]['content'], -2, 1); $nextChar = $tokens[$next]['content'][1]; $combined = $prevChar.$nextChar; if ($combined === '?'.'>' || $combined === '<'.'?') { return; } } if ($this->allowMultiline === true && $tokens[$prev]['line'] !== $tokens[$next]['line'] ) { return; } $error = 'String concat is not required here; use a single string instead'; if ($this->error === true) { $phpcsFile->addError($error, $stackPtr, 'Found'); } else { $phpcsFile->addWarning($error, $stackPtr, 'Found'); } }//end if }//end if }//end process() }//end class ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/VersionControl/SubversionPropertiesSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/VersionControl/SubversionPropertiesSniff.0000644000076700000240000001501412647543456033433 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_VersionControl_SubversionPropertiesSniff. * * Tests that the correct Subversion properties are set. * * @category PHP * @package PHP_CodeSniffer * @author Jack Bates * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_VersionControl_SubversionPropertiesSniff implements PHP_CodeSniffer_Sniff { /** * The Subversion properties that should be set. * * Key of array is the SVN property and the value is the * exact value the property should have or NULL if the * property should just be set but the value is not fixed. * * @var array */ protected $properties = array( 'svn:keywords' => 'Author Id Revision', 'svn:eol-style' => 'native', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Make sure this is the first PHP open tag so we don't process the // same file twice. $prevOpenTag = $phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)); if ($prevOpenTag !== false) { return; } $path = $phpcsFile->getFileName(); $properties = $this->getProperties($path); if ($properties === null) { // Not under version control. return; } $allProperties = ($properties + $this->properties); foreach ($allProperties as $key => $value) { if (isset($properties[$key]) === true && isset($this->properties[$key]) === false ) { $error = 'Unexpected Subversion property "%s" = "%s"'; $data = array( $key, $properties[$key], ); $phpcsFile->addError($error, $stackPtr, 'Unexpected', $data); continue; } if (isset($properties[$key]) === false && isset($this->properties[$key]) === true ) { $error = 'Missing Subversion property "%s" = "%s"'; $data = array( $key, $this->properties[$key], ); $phpcsFile->addError($error, $stackPtr, 'Missing', $data); continue; } if ($properties[$key] !== null && $properties[$key] !== $this->properties[$key] ) { $error = 'Subversion property "%s" = "%s" does not match "%s"'; $data = array( $key, $properties[$key], $this->properties[$key], ); $phpcsFile->addError($error, $stackPtr, 'NoMatch', $data); } }//end foreach }//end process() /** * Returns the Subversion properties which are actually set on a path. * * Returns NULL if the file is not under version control. * * @param string $path The path to return Subversion properties on. * * @return array * @throws PHP_CodeSniffer_Exception If Subversion properties file could * not be opened. */ protected function getProperties($path) { $properties = array(); $paths = array(); $paths[] = dirname($path).'/.svn/props/'.basename($path).'.svn-work'; $paths[] = dirname($path).'/.svn/prop-base/'.basename($path).'.svn-base'; $foundPath = false; foreach ($paths as $path) { if (file_exists($path) === true) { $foundPath = true; $handle = fopen($path, 'r'); if ($handle === false) { $error = 'Error opening file; could not get Subversion properties'; throw new PHP_CodeSniffer_Exception($error); } while (feof($handle) === false) { // Read a key length line. Might be END, though. $buffer = trim(fgets($handle)); // Check for the end of the hash. if ($buffer === 'END') { break; } // Now read that much into a buffer. $key = fread($handle, substr($buffer, 2)); // Suck up extra newline after key data. fgetc($handle); // Read a value length line. $buffer = trim(fgets($handle)); // Now read that much into a buffer. $length = substr($buffer, 2); if ($length === '0') { // Length of value is ZERO characters, so // value is actually empty. $value = ''; } else { $value = fread($handle, $length); } // Suck up extra newline after value data. fgetc($handle); $properties[$key] = $value; }//end while fclose($handle); }//end if }//end foreach if ($foundPath === false) { return null; } return $properties; }//end getProperties() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/WhiteSpace/DisallowSpaceIndentSniff.php0000644000076700000240000001157312647543456032677 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_WhiteSpace_DisallowSpaceIndentSniff. * * Throws errors if spaces are used for indentation. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_WhiteSpace_DisallowSpaceIndentSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', 'CSS', ); /** * The --tab-width CLI value that is being used. * * @var int */ private $_tabWidth = null; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile All the tokens found in the document. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { if ($this->_tabWidth === null) { $cliValues = $phpcsFile->phpcs->cli->getCommandLineValues(); if (isset($cliValues['tabWidth']) === false || $cliValues['tabWidth'] === 0) { // We have no idea how wide tabs are, so assume 4 spaces for fixing. // It shouldn't really matter because indent checks elsewhere in the // standard should fix things up. $this->_tabWidth = 4; } else { $this->_tabWidth = $cliValues['tabWidth']; } } $checkTokens = array( T_WHITESPACE => true, T_DOC_COMMENT_WHITESPACE => true, ); $tokens = $phpcsFile->getTokens(); for ($i = ($stackPtr + 1); $i < $phpcsFile->numTokens; $i++) { if ($tokens[$i]['column'] !== 1 || isset($checkTokens[$tokens[$i]['code']]) === false) { continue; } // If tabs are being converted to spaces, the original content // should be used instead of the converted content. if (isset($tokens[$i]['orig_content']) === true) { $content = $tokens[$i]['orig_content']; } else { $content = $tokens[$i]['content']; } if ($content[0] === ' ') { if ($tokens[$i]['code'] === T_DOC_COMMENT_WHITESPACE && $content === ' ') { // Ignore file/class-level DocBlock. continue; } // Space are considered ok if they are proceeded by tabs and not followed // by tabs, as is the case with standard docblock comments. $phpcsFile->recordMetric($i, 'Line indent', 'spaces'); $error = 'Tabs must be used to indent lines; spaces are not allowed'; $fix = $phpcsFile->addFixableError($error, $i, 'SpacesUsed'); if ($fix === true) { $trimmed = ltrim($content, ' '); $numSpaces = (strlen($content) - strlen($trimmed)); if ($numSpaces < $this->_tabWidth) { $numTabs = 1; $padding = "\t"; } else { $numTabs = floor($numSpaces / $this->_tabWidth); $remaining = ($numSpaces - ($numTabs * $this->_tabWidth)); $padding = str_repeat("\t", $numTabs).$padding = str_repeat(' ', $remaining); } $phpcsFile->fixer->replaceToken($i, $padding.$trimmed); } } else if ($content[0] === "\t") { $phpcsFile->recordMetric($i, 'Line indent', 'tabs'); }//end if }//end for // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/WhiteSpace/DisallowTabIndentSniff.php0000644000076700000240000001214612647543456032347 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_WhiteSpace_DisallowTabIndentSniff. * * Throws errors if tabs are used for indentation. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_WhiteSpace_DisallowTabIndentSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', 'CSS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile All the tokens found in the document. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $error = 'Spaces must be used to indent lines; tabs are not allowed'; $errorCode = 'TabsUsed'; $checkTokens = array( T_WHITESPACE => true, T_DOC_COMMENT_WHITESPACE => true, T_DOC_COMMENT_STRING => true, ); for ($i = ($stackPtr + 1); $i < $phpcsFile->numTokens; $i++) { if (isset($checkTokens[$tokens[$i]['code']]) === false) { continue; } // If tabs are being converted to spaces by PHPCS, the // original content should be checked instead of the converted content. if (isset($tokens[$i]['orig_content']) === true) { $content = $tokens[$i]['orig_content']; } else { $content = $tokens[$i]['content']; } if ($content === '') { continue; } if ($tokens[$i]['code'] === T_DOC_COMMENT_WHITESPACE && $content === ' ') { // Ignore file/class-level DocBlock, especially for recording metrics. continue; } $tabFound = false; if ($tokens[$i]['column'] === 1) { if ($content[0] === "\t") { $phpcsFile->recordMetric($i, 'Line indent', 'tabs'); $tabFound = true; } else if ($content[0] === ' ') { if (strpos($content, "\t") !== false) { $phpcsFile->recordMetric($i, 'Line indent', 'mixed'); $tabFound = true; } else { $phpcsFile->recordMetric($i, 'Line indent', 'spaces'); } } } else { // Look for tabs so we can report and replace, but don't // record any metrics about them because they aren't // line indent tokens. if (strpos($content, "\t") !== false) { $tabFound = true; $error = 'Spaces must be used for alignment; tabs are not allowed'; $errorCode = 'NonIndentTabsUsed'; } }//end if if ($tabFound === false) { continue; } $fix = $phpcsFile->addFixableError($error, $i, $errorCode); if ($fix === true) { if (isset($tokens[$i]['orig_content']) === true) { // Use the replacement that PHPCS has already done. $phpcsFile->fixer->replaceToken($i, $tokens[$i]['content']); } else { // Replace tabs with spaces, using an indent of 4 spaces. // Other sniffs can then correct the indent if they need to. $newContent = str_replace("\t", ' ', $tokens[$i]['content']); $phpcsFile->fixer->replaceToken($i, $newContent); } } }//end for // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Sniffs/WhiteSpace/ScopeIndentSniff.php0000644000076700000240000013663712647543456031227 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Whitespace_ScopeIndentSniff. * * Checks that control structures are structured correctly, and their content * is indented correctly. This sniff will throw errors if tabs are used * for indentation rather than spaces. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Sniffs_WhiteSpace_ScopeIndentSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * The number of spaces code should be indented. * * @var int */ public $indent = 4; /** * Does the indent need to be exactly right? * * If TRUE, indent needs to be exactly $indent spaces. If FALSE, * indent needs to be at least $indent spaces (but can be more). * * @var bool */ public $exact = false; /** * Should tabs be used for indenting? * * If TRUE, fixes will be made using tabs instead of spaces. * The size of each tab is important, so it should be specified * using the --tab-width CLI argument. * * @var bool */ public $tabIndent = false; /** * The --tab-width CLI value that is being used. * * @var int */ private $_tabWidth = null; /** * List of tokens not needing to be checked for indentation. * * Useful to allow Sniffs based on this to easily ignore/skip some * tokens from verification. For example, inline HTML sections * or PHP open/close tags can escape from here and have their own * rules elsewhere. * * @var int[] */ public $ignoreIndentationTokens = array(); /** * List of tokens not needing to be checked for indentation. * * This is a cached copy of the public version of this var, which * can be set in a ruleset file, and some core ignored tokens. * * @var int[] */ private $_ignoreIndentationTokens = array(); /** * Any scope openers that should not cause an indent. * * @var int[] */ protected $nonIndentingScopes = array(); /** * Show debug output for this sniff. * * @var bool */ private $_debug = false; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { if (defined('PHP_CODESNIFFER_IN_TESTS') === true) { $this->_debug = false; } return array(T_OPEN_TAG); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile All the tokens found in the document. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $debug = PHP_CodeSniffer::getConfigData('scope_indent_debug'); if ($debug !== null) { $this->_debug = (bool) $debug; } if ($this->_tabWidth === null) { $cliValues = $phpcsFile->phpcs->cli->getCommandLineValues(); if (isset($cliValues['tabWidth']) === false || $cliValues['tabWidth'] === 0) { // We have no idea how wide tabs are, so assume 4 spaces for fixing. // It shouldn't really matter because indent checks elsewhere in the // standard should fix things up. $this->_tabWidth = 4; } else { $this->_tabWidth = $cliValues['tabWidth']; } } $currentIndent = 0; $lastOpenTag = $stackPtr; $lastCloseTag = null; $openScopes = array(); $adjustments = array(); $tokens = $phpcsFile->getTokens(); $first = $phpcsFile->findFirstOnLine(T_INLINE_HTML, $stackPtr); $trimmed = ltrim($tokens[$first]['content']); if ($trimmed === '') { $currentIndent = ($tokens[$stackPtr]['column'] - 1); } else { $currentIndent = (strlen($tokens[$first]['content']) - strlen($trimmed)); } if ($this->_debug === true) { $line = $tokens[$stackPtr]['line']; echo "Start with token $stackPtr on line $line with indent $currentIndent".PHP_EOL; } if (empty($this->_ignoreIndentationTokens) === true) { $this->_ignoreIndentationTokens = array(T_INLINE_HTML => true); foreach ($this->ignoreIndentationTokens as $token) { if (is_int($token) === false) { if (defined($token) === false) { continue; } $token = constant($token); } $this->_ignoreIndentationTokens[$token] = true; } }//end if $this->exact = (bool) $this->exact; $this->tabIndent = (bool) $this->tabIndent; for ($i = ($stackPtr + 1); $i < $phpcsFile->numTokens; $i++) { if ($i === false) { // Something has gone very wrong; maybe a parse error. break; } $checkToken = null; $checkIndent = null; $exact = (bool) $this->exact; if ($exact === true && isset($tokens[$i]['nested_parenthesis']) === true) { // Don't check indents exactly between parenthesis as they // tend to have custom rules, such as with multi-line function calls // and control structure conditions. $exact = false; } // Detect line changes and figure out where the indent is. if ($tokens[$i]['column'] === 1) { $trimmed = ltrim($tokens[$i]['content']); if ($trimmed === '') { if (isset($tokens[($i + 1)]) === true && $tokens[$i]['line'] === $tokens[($i + 1)]['line'] ) { $checkToken = ($i + 1); $tokenIndent = ($tokens[($i + 1)]['column'] - 1); } } else { $checkToken = $i; $tokenIndent = (strlen($tokens[$i]['content']) - strlen($trimmed)); } } // Closing parenthesis should just be indented to at least // the same level as where they were opened (but can be more). if (($checkToken !== null && $tokens[$checkToken]['code'] === T_CLOSE_PARENTHESIS && isset($tokens[$checkToken]['parenthesis_opener']) === true) || ($tokens[$i]['code'] === T_CLOSE_PARENTHESIS && isset($tokens[$i]['parenthesis_opener']) === true && isset($tokens[$i]['parenthesis_owner']) === true && $tokens[$tokens[$i]['parenthesis_owner']]['code'] === T_ARRAY) ) { if ($checkToken !== null) { $parenCloser = $checkToken; } else { $parenCloser = $i; } if ($this->_debug === true) { $line = $tokens[$i]['line']; echo "Closing parenthesis found on line $line".PHP_EOL; } $parenOpener = $tokens[$parenCloser]['parenthesis_opener']; if ($tokens[$parenCloser]['line'] !== $tokens[$parenOpener]['line']) { $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $parenOpener, true); $checkIndent = ($tokens[$first]['column'] - 1); if (isset($adjustments[$first]) === true) { $checkIndent += $adjustments[$first]; } $exact = false; if ($this->_debug === true) { $line = $tokens[$first]['line']; $type = $tokens[$first]['type']; echo "\t* first token on line $line is $type *".PHP_EOL; } if ($first === $tokens[$parenCloser]['parenthesis_opener']) { // This is unlikely to be the start of the statement, so look // back further to find it. $first--; } $prev = $phpcsFile->findStartOfStatement($first); if ($prev !== $first) { // This is not the start of the statement. if ($this->_debug === true) { $line = $tokens[$prev]['line']; $type = $tokens[$prev]['type']; echo "\t* previous is $type on line $line *".PHP_EOL; } $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $prev, true); $prev = $phpcsFile->findStartOfStatement($first); $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $prev, true); if ($this->_debug === true) { $line = $tokens[$first]['line']; $type = $tokens[$first]['type']; echo "\t* amended first token is $type on line $line *".PHP_EOL; } } if (isset($tokens[$first]['scope_closer']) === true && $tokens[$first]['scope_closer'] === $first ) { if ($this->_debug === true) { echo "\t* first token is a scope closer *".PHP_EOL; } if (isset($tokens[$first]['scope_condition']) === true) { $scopeCloser = $first; $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $tokens[$scopeCloser]['scope_condition'], true); $currentIndent = ($tokens[$first]['column'] - 1); if (isset($adjustments[$first]) === true) { $currentIndent += $adjustments[$first]; } // Make sure it is divisible by our expected indent. if ($tokens[$tokens[$scopeCloser]['scope_condition']]['code'] !== T_CLOSURE) { $currentIndent = (int) (ceil($currentIndent / $this->indent) * $this->indent); } if ($this->_debug === true) { echo "\t=> indent set to $currentIndent".PHP_EOL; } }//end if } else { // Don't force current indent to divisible because there could be custom // rules in place between parenthesis, such as with arrays. $currentIndent = ($tokens[$first]['column'] - 1); if (isset($adjustments[$first]) === true) { $currentIndent += $adjustments[$first]; } if ($this->_debug === true) { echo "\t=> checking indent of $checkIndent; main indent set to $currentIndent".PHP_EOL; } }//end if } else if ($this->_debug === true) { echo "\t * ignoring single-line definition *".PHP_EOL; }//end if }//end if // Closing short array bracket should just be indented to at least // the same level as where it was opened (but can be more). if ($tokens[$i]['code'] === T_CLOSE_SHORT_ARRAY || ($checkToken !== null && $tokens[$checkToken]['code'] === T_CLOSE_SHORT_ARRAY) ) { if ($checkToken !== null) { $arrayCloser = $checkToken; } else { $arrayCloser = $i; } if ($this->_debug === true) { $line = $tokens[$arrayCloser]['line']; echo "Closing short array bracket found on line $line".PHP_EOL; } $arrayOpener = $tokens[$arrayCloser]['bracket_opener']; if ($tokens[$arrayCloser]['line'] !== $tokens[$arrayOpener]['line']) { $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $arrayOpener, true); $checkIndent = ($tokens[$first]['column'] - 1); if (isset($adjustments[$first]) === true) { $checkIndent += $adjustments[$first]; } $exact = false; if ($this->_debug === true) { $line = $tokens[$first]['line']; $type = $tokens[$first]['type']; echo "\t* first token on line $line is $type *".PHP_EOL; } if ($first === $tokens[$arrayCloser]['bracket_opener']) { // This is unlikely to be the start of the statement, so look // back further to find it. $first--; } $prev = $phpcsFile->findStartOfStatement($first); if ($prev !== $first) { // This is not the start of the statement. if ($this->_debug === true) { $line = $tokens[$prev]['line']; $type = $tokens[$prev]['type']; echo "\t* previous is $type on line $line *".PHP_EOL; } $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $prev, true); $prev = $phpcsFile->findStartOfStatement($first); $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $prev, true); if ($this->_debug === true) { $line = $tokens[$first]['line']; $type = $tokens[$first]['type']; echo "\t* amended first token is $type on line $line *".PHP_EOL; } } if (isset($tokens[$first]['scope_closer']) === true && $tokens[$first]['scope_closer'] === $first ) { // The first token is a scope closer and would have already // been processed and set the indent level correctly, so // don't adjust it again. if ($this->_debug === true) { echo "\t* first token is a scope closer; ignoring closing short array bracket *".PHP_EOL; } } else { // Don't force current indent to be divisible because there could be custom // rules in place for arrays. $currentIndent = ($tokens[$first]['column'] - 1); if (isset($adjustments[$first]) === true) { $currentIndent += $adjustments[$first]; } if ($this->_debug === true) { echo "\t=> checking indent of $checkIndent; main indent set to $currentIndent".PHP_EOL; } } } else if ($this->_debug === true) { echo "\t * ignoring single-line definition *".PHP_EOL; }//end if }//end if // Adjust lines within scopes while auto-fixing. if ($checkToken !== null && $exact === false && (empty($tokens[$checkToken]['conditions']) === false || (isset($tokens[$checkToken]['scope_opener']) === true && $tokens[$checkToken]['scope_opener'] === $checkToken)) ) { if (empty($tokens[$checkToken]['conditions']) === false) { end($tokens[$checkToken]['conditions']); $condition = key($tokens[$checkToken]['conditions']); } else { $condition = $tokens[$checkToken]['scope_condition']; } $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $condition, true); if (isset($adjustments[$first]) === true && (($adjustments[$first] < 0 && $tokenIndent > $currentIndent) || ($adjustments[$first] > 0 && $tokenIndent < $currentIndent)) ) { $padding = ($tokenIndent + $adjustments[$first]); if ($padding > 0) { if ($this->tabIndent === true) { $numTabs = floor($padding / $this->_tabWidth); $numSpaces = ($padding - ($numTabs * $this->_tabWidth)); $padding = str_repeat("\t", $numTabs).str_repeat(' ', $numSpaces); } else { $padding = str_repeat(' ', $padding); } } else { $padding = ''; } if ($checkToken === $i) { $phpcsFile->fixer->replaceToken($checkToken, $padding.$trimmed); } else { // Easier to just replace the entire indent. $phpcsFile->fixer->replaceToken(($checkToken - 1), $padding); } if ($this->_debug === true) { $length = strlen($padding); $line = $tokens[$checkToken]['line']; $type = $tokens[$checkToken]['type']; echo "Indent adjusted to $length for $type on line $line".PHP_EOL; } $adjustments[$checkToken] = $adjustments[$first]; if ($this->_debug === true) { $line = $tokens[$checkToken]['line']; $type = $tokens[$checkToken]['type']; echo "\t=> Add adjustment of ".$adjustments[$checkToken]." for token $checkToken ($type) on line $line".PHP_EOL; } }//end if }//end if // Scope closers reset the required indent to the same level as the opening condition. if (($checkToken !== null && isset($openScopes[$checkToken]) === true || (isset($tokens[$checkToken]['scope_condition']) === true && isset($tokens[$checkToken]['scope_closer']) === true && $tokens[$checkToken]['scope_closer'] === $checkToken && $tokens[$checkToken]['line'] !== $tokens[$tokens[$checkToken]['scope_opener']]['line'])) || ($checkToken === null && isset($openScopes[$i]) === true || (isset($tokens[$i]['scope_condition']) === true && isset($tokens[$i]['scope_closer']) === true && $tokens[$i]['scope_closer'] === $i && $tokens[$i]['line'] !== $tokens[$tokens[$i]['scope_opener']]['line'])) ) { if ($this->_debug === true) { if ($checkToken === null) { $type = $tokens[$tokens[$i]['scope_condition']]['type']; $line = $tokens[$i]['line']; } else { $type = $tokens[$tokens[$checkToken]['scope_condition']]['type']; $line = $tokens[$checkToken]['line']; } echo "Close scope ($type) on line $line".PHP_EOL; } $scopeCloser = $checkToken; if ($scopeCloser === null) { $scopeCloser = $i; } else { array_pop($openScopes); } if (isset($tokens[$scopeCloser]['scope_condition']) === true) { $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $tokens[$scopeCloser]['scope_condition'], true); $currentIndent = ($tokens[$first]['column'] - 1); if (isset($adjustments[$first]) === true) { $currentIndent += $adjustments[$first]; } // Make sure it is divisible by our expected indent. if ($tokens[$tokens[$scopeCloser]['scope_condition']]['code'] !== T_CLOSURE) { $currentIndent = (int) (ceil($currentIndent / $this->indent) * $this->indent); } if ($this->_debug === true) { echo "\t=> indent set to $currentIndent".PHP_EOL; } // We only check the indent of scope closers if they are // curly braces because other constructs tend to have different rules. if ($tokens[$scopeCloser]['code'] === T_CLOSE_CURLY_BRACKET) { $exact = true; } else { $checkToken = null; } }//end if }//end if // Handle scope for JS object notation. if ($phpcsFile->tokenizerType === 'JS' && (($checkToken !== null && $tokens[$checkToken]['code'] === T_CLOSE_OBJECT && $tokens[$checkToken]['line'] !== $tokens[$tokens[$checkToken]['bracket_opener']]['line']) || ($checkToken === null && $tokens[$i]['code'] === T_CLOSE_OBJECT && $tokens[$i]['line'] !== $tokens[$tokens[$i]['bracket_opener']]['line'])) ) { if ($this->_debug === true) { $line = $tokens[$i]['line']; echo "Close JS object on line $line".PHP_EOL; } $scopeCloser = $checkToken; if ($scopeCloser === null) { $scopeCloser = $i; } else { array_pop($openScopes); } $parens = 0; if (isset($tokens[$scopeCloser]['nested_parenthesis']) === true && empty($tokens[$scopeCloser]['nested_parenthesis']) === false ) { end($tokens[$scopeCloser]['nested_parenthesis']); $parens = key($tokens[$scopeCloser]['nested_parenthesis']); if ($this->_debug === true) { $line = $tokens[$parens]['line']; echo "\t* token has nested parenthesis $parens on line $line *".PHP_EOL; } } $condition = 0; if (isset($tokens[$scopeCloser]['conditions']) === true && empty($tokens[$scopeCloser]['conditions']) === false ) { end($tokens[$scopeCloser]['conditions']); $condition = key($tokens[$scopeCloser]['conditions']); if ($this->_debug === true) { $line = $tokens[$condition]['line']; $type = $tokens[$condition]['type']; echo "\t* token is inside condition $condition ($type) on line $line *".PHP_EOL; } } if ($parens > $condition) { if ($this->_debug === true) { echo "\t* using parenthesis *".PHP_EOL; } $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $parens, true); $condition = 0; } else if ($condition > 0) { if ($this->_debug === true) { echo "\t* using condition *".PHP_EOL; } $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $condition, true); $parens = 0; } else { if ($this->_debug === true) { $line = $tokens[$tokens[$scopeCloser]['bracket_opener']]['line']; echo "\t* token is not in parenthesis or condition; using opener on line $line *".PHP_EOL; } $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $tokens[$scopeCloser]['bracket_opener'], true); }//end if $currentIndent = ($tokens[$first]['column'] - 1); if (isset($adjustments[$first]) === true) { $currentIndent += $adjustments[$first]; } if ($parens > 0 || $condition > 0) { $checkIndent = ($tokens[$first]['column'] - 1); if (isset($adjustments[$first]) === true) { $checkIndent += $adjustments[$first]; } if ($condition > 0) { $checkIndent += $this->indent; $currentIndent += $this->indent; $exact = true; } } else { $checkIndent = $currentIndent; } // Make sure it is divisible by our expected indent. $currentIndent = (int) (ceil($currentIndent / $this->indent) * $this->indent); $checkIndent = (int) (ceil($checkIndent / $this->indent) * $this->indent); if ($this->_debug === true) { echo "\t=> checking indent of $checkIndent; main indent set to $currentIndent".PHP_EOL; } }//end if if ($checkToken !== null && isset(PHP_CodeSniffer_Tokens::$scopeOpeners[$tokens[$checkToken]['code']]) === true && in_array($tokens[$checkToken]['code'], $this->nonIndentingScopes) === false && isset($tokens[$checkToken]['scope_opener']) === true ) { $exact = true; $lastOpener = null; if (empty($openScopes) === false) { end($openScopes); $lastOpener = current($openScopes); } // A scope opener that shares a closer with another token (like multiple // CASEs using the same BREAK) needs to reduce the indent level so its // indent is checked correctly. It will then increase the indent again // (as all openers do) after being checked. if ($lastOpener !== null && isset($tokens[$lastOpener]['scope_closer']) === true && $tokens[$lastOpener]['level'] === $tokens[$checkToken]['level'] && $tokens[$lastOpener]['scope_closer'] === $tokens[$checkToken]['scope_closer'] ) { $currentIndent -= $this->indent; if ($this->_debug === true) { $line = $tokens[$i]['line']; echo "Shared closer found on line $line".PHP_EOL; echo "\t=> indent set to $currentIndent".PHP_EOL; } } if ($tokens[$checkToken]['code'] === T_CLOSURE && $tokenIndent > $currentIndent ) { // The opener is indented more than needed, which is fine. // But just check that it is divisible by our expected indent. $checkIndent = (int) (ceil($tokenIndent / $this->indent) * $this->indent); $exact = false; if ($this->_debug === true) { $line = $tokens[$i]['line']; echo "Closure found on line $line".PHP_EOL; echo "\t=> checking indent of $checkIndent; main indent remains at $currentIndent".PHP_EOL; } } }//end if // Method prefix indentation has to be exact or else if will break // the rest of the function declaration, and potentially future ones. if ($checkToken !== null && isset(PHP_CodeSniffer_Tokens::$methodPrefixes[$tokens[$checkToken]['code']]) === true && $tokens[($checkToken + 1)]['code'] !== T_DOUBLE_COLON ) { $exact = true; } // JS property indentation has to be exact or else if will break // things like function and object indentation. if ($checkToken !== null && $tokens[$checkToken]['code'] === T_PROPERTY) { $exact = true; } // PHP tags needs to be indented to exact column positions // so they don't cause problems with indent checks for the code // within them, but they don't need to line up with the current indent. if ($checkToken !== null && ($tokens[$checkToken]['code'] === T_OPEN_TAG || $tokens[$checkToken]['code'] === T_OPEN_TAG_WITH_ECHO || $tokens[$checkToken]['code'] === T_CLOSE_TAG) ) { $exact = true; $checkIndent = ($tokens[$checkToken]['column'] - 1); $checkIndent = (int) (ceil($checkIndent / $this->indent) * $this->indent); } // Check the line indent. if ($checkIndent === null) { $checkIndent = $currentIndent; } $adjusted = false; if ($checkToken !== null && isset($this->_ignoreIndentationTokens[$tokens[$checkToken]['code']]) === false && (($tokenIndent !== $checkIndent && $exact === true) || ($tokenIndent < $checkIndent && $exact === false)) ) { $type = 'IncorrectExact'; $error = 'Line indented incorrectly; expected '; if ($exact === false) { $error .= 'at least '; $type = 'Incorrect'; } if ($this->tabIndent === true) { $error .= '%s tabs, found %s'; $data = array( floor($checkIndent / $this->_tabWidth), floor($tokenIndent / $this->_tabWidth), ); } else { $error .= '%s spaces, found %s'; $data = array( $checkIndent, $tokenIndent, ); } if ($this->_debug === true) { $line = $tokens[$checkToken]['line']; $message = vsprintf($error, $data); echo "[Line $line] $message".PHP_EOL; } $fix = $phpcsFile->addFixableError($error, $checkToken, $type, $data); if ($fix === true || $this->_debug === true) { $padding = ''; if ($this->tabIndent === true) { $numTabs = floor($checkIndent / $this->_tabWidth); if ($numTabs > 0) { $numSpaces = ($checkIndent - ($numTabs * $this->_tabWidth)); $padding = str_repeat("\t", $numTabs).str_repeat(' ', $numSpaces); } } else if ($checkIndent > 0) { $padding = str_repeat(' ', $checkIndent); } if ($checkToken === $i) { $accepted = $phpcsFile->fixer->replaceToken($checkToken, $padding.$trimmed); } else { // Easier to just replace the entire indent. $accepted = $phpcsFile->fixer->replaceToken(($checkToken - 1), $padding); } if ($accepted === true) { $adjustments[$checkToken] = ($checkIndent - $tokenIndent); if ($this->_debug === true) { $line = $tokens[$checkToken]['line']; $type = $tokens[$checkToken]['type']; echo "\t=> Add adjustment of ".$adjustments[$checkToken]." for token $checkToken ($type) on line $line".PHP_EOL; } } }//end if }//end if if ($checkToken !== null) { $i = $checkToken; } // Completely skip here/now docs as the indent is a part of the // content itself. if ($tokens[$i]['code'] === T_START_HEREDOC || $tokens[$i]['code'] === T_START_NOWDOC ) { $i = $phpcsFile->findNext(array(T_END_HEREDOC, T_END_NOWDOC), ($i + 1)); continue; } // Completely skip multi-line strings as the indent is a part of the // content itself. if ($tokens[$i]['code'] === T_CONSTANT_ENCAPSED_STRING || $tokens[$i]['code'] === T_DOUBLE_QUOTED_STRING ) { $i = $phpcsFile->findNext($tokens[$i]['code'], ($i + 1), null, true); $i--; continue; } // Completely skip doc comments as they tend to have complex // indentation rules. if ($tokens[$i]['code'] === T_DOC_COMMENT_OPEN_TAG) { $i = $tokens[$i]['comment_closer']; continue; } // Open tags reset the indent level. if ($tokens[$i]['code'] === T_OPEN_TAG || $tokens[$i]['code'] === T_OPEN_TAG_WITH_ECHO ) { if ($this->_debug === true) { $line = $tokens[$i]['line']; echo "Open PHP tag found on line $line".PHP_EOL; } if ($checkToken === null) { $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $i, true); $currentIndent = (strlen($tokens[$first]['content']) - strlen(ltrim($tokens[$first]['content']))); } else { $currentIndent = ($tokens[$i]['column'] - 1); } $lastOpenTag = $i; if (isset($adjustments[$i]) === true) { $currentIndent += $adjustments[$i]; } // Make sure it is divisible by our expected indent. $currentIndent = (int) (ceil($currentIndent / $this->indent) * $this->indent); if ($this->_debug === true) { echo "\t=> indent set to $currentIndent".PHP_EOL; } continue; }//end if // Close tags reset the indent level, unless they are closing a tag // opened on the same line. if ($tokens[$i]['code'] === T_CLOSE_TAG) { if ($this->_debug === true) { $line = $tokens[$i]['line']; echo "Close PHP tag found on line $line".PHP_EOL; } if ($tokens[$lastOpenTag]['line'] !== $tokens[$i]['line']) { $currentIndent = ($tokens[$i]['column'] - 1); $lastCloseTag = $i; } else { if ($lastCloseTag === null) { $currentIndent = 0; } else { $currentIndent = ($tokens[$lastCloseTag]['column'] - 1); } } if (isset($adjustments[$i]) === true) { $currentIndent += $adjustments[$i]; } // Make sure it is divisible by our expected indent. $currentIndent = (int) (ceil($currentIndent / $this->indent) * $this->indent); if ($this->_debug === true) { echo "\t=> indent set to $currentIndent".PHP_EOL; } continue; }//end if // Closures set the indent based on their own indent level. if ($tokens[$i]['code'] === T_CLOSURE) { $closer = $tokens[$i]['scope_closer']; if ($tokens[$i]['line'] === $tokens[$closer]['line']) { if ($this->_debug === true) { $line = $tokens[$i]['line']; echo "* ignoring single-line closure on line $line".PHP_EOL; } $i = $closer; continue; } if ($this->_debug === true) { $line = $tokens[$i]['line']; echo "Open closure on line $line".PHP_EOL; } $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $i, true); $currentIndent = (($tokens[$first]['column'] - 1) + $this->indent); if (isset($adjustments[$first]) === true) { $currentIndent += $adjustments[$first]; } // Make sure it is divisible by our expected indent. $currentIndent = (int) (floor($currentIndent / $this->indent) * $this->indent); $i = $tokens[$i]['scope_opener']; if ($this->_debug === true) { echo "\t=> indent set to $currentIndent".PHP_EOL; } continue; }//end if // Scope openers increase the indent level. if (isset($tokens[$i]['scope_condition']) === true && isset($tokens[$i]['scope_opener']) === true && $tokens[$i]['scope_opener'] === $i ) { $closer = $tokens[$i]['scope_closer']; if ($tokens[$i]['line'] === $tokens[$closer]['line']) { if ($this->_debug === true) { $line = $tokens[$i]['line']; $type = $tokens[$i]['type']; echo "* ignoring single-line $type on line $line".PHP_EOL; } $i = $closer; continue; } $condition = $tokens[$tokens[$i]['scope_condition']]['code']; if (isset(PHP_CodeSniffer_Tokens::$scopeOpeners[$condition]) === true && in_array($condition, $this->nonIndentingScopes) === false ) { if ($this->_debug === true) { $line = $tokens[$i]['line']; $type = $tokens[$tokens[$i]['scope_condition']]['type']; echo "Open scope ($type) on line $line".PHP_EOL; } $currentIndent += $this->indent; $openScopes[$tokens[$i]['scope_closer']] = $tokens[$i]['scope_condition']; if ($this->_debug === true) { echo "\t=> indent set to $currentIndent".PHP_EOL; } continue; } }//end if // JS objects set the indent level. if ($phpcsFile->tokenizerType === 'JS' && $tokens[$i]['code'] === T_OBJECT ) { $closer = $tokens[$i]['bracket_closer']; if ($tokens[$i]['line'] === $tokens[$closer]['line']) { if ($this->_debug === true) { $line = $tokens[$i]['line']; echo "* ignoring single-line JS object on line $line".PHP_EOL; } $i = $closer; continue; } if ($this->_debug === true) { $line = $tokens[$i]['line']; echo "Open JS object on line $line".PHP_EOL; } $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $i, true); $currentIndent = (($tokens[$first]['column'] - 1) + $this->indent); if (isset($adjustments[$first]) === true) { $currentIndent += $adjustments[$first]; } // Make sure it is divisible by our expected indent. $currentIndent = (int) (ceil($currentIndent / $this->indent) * $this->indent); if ($this->_debug === true) { echo "\t=> indent set to $currentIndent".PHP_EOL; } continue; }//end if // Closing a closure. if (isset($tokens[$i]['scope_condition']) === true && $tokens[$i]['scope_closer'] === $i && $tokens[$tokens[$i]['scope_condition']]['code'] === T_CLOSURE ) { if ($this->_debug === true) { $line = $tokens[$i]['line']; echo "Close closure on line $line".PHP_EOL; } $prev = false; $object = 0; if ($phpcsFile->tokenizerType === 'JS') { $conditions = $tokens[$i]['conditions']; krsort($conditions, SORT_NUMERIC); foreach ($conditions as $token => $condition) { if ($condition === T_OBJECT) { $object = $token; break; } } if ($this->_debug === true && $object !== 0) { $line = $tokens[$object]['line']; echo "\t* token is inside JS object $object on line $line *".PHP_EOL; } } $parens = 0; if (isset($tokens[$i]['nested_parenthesis']) === true && empty($tokens[$i]['nested_parenthesis']) === false ) { end($tokens[$i]['nested_parenthesis']); $parens = key($tokens[$i]['nested_parenthesis']); if ($this->_debug === true) { $line = $tokens[$parens]['line']; echo "\t* token has nested parenthesis $parens on line $line *".PHP_EOL; } } $condition = 0; if (isset($tokens[$i]['conditions']) === true && empty($tokens[$i]['conditions']) === false ) { end($tokens[$i]['conditions']); $condition = key($tokens[$i]['conditions']); if ($this->_debug === true) { $line = $tokens[$condition]['line']; $type = $tokens[$condition]['type']; echo "\t* token is inside condition $condition ($type) on line $line *".PHP_EOL; } } if ($parens > $object && $parens > $condition) { if ($this->_debug === true) { echo "\t* using parenthesis *".PHP_EOL; } $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($parens - 1), null, true); $object = 0; $condition = 0; } else if ($object > 0 && $object >= $condition) { if ($this->_debug === true) { echo "\t* using object *".PHP_EOL; } $prev = $object; $parens = 0; $condition = 0; } else if ($condition > 0) { if ($this->_debug === true) { echo "\t* using condition *".PHP_EOL; } $prev = $condition; $object = 0; $parens = 0; }//end if if ($prev === false) { $prev = $phpcsFile->findPrevious(array(T_EQUAL, T_RETURN), ($tokens[$i]['scope_condition'] - 1), null, false, null, true); if ($prev === false) { $prev = $i; if ($this->_debug === true) { echo "\t* could not find a previous T_EQUAL or T_RETURN token; will use current token *".PHP_EOL; } } } if ($this->_debug === true) { $line = $tokens[$prev]['line']; $type = $tokens[$prev]['type']; echo "\t* previous token is $type on line $line *".PHP_EOL; } $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $prev, true); if ($this->_debug === true) { $line = $tokens[$first]['line']; $type = $tokens[$first]['type']; echo "\t* first token on line $line is $type *".PHP_EOL; } $prev = $phpcsFile->findStartOfStatement($first); if ($prev !== $first) { // This is not the start of the statement. if ($this->_debug === true) { $line = $tokens[$prev]['line']; $type = $tokens[$prev]['type']; echo "\t* amended previous is $type on line $line *".PHP_EOL; } $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $prev, true); if ($this->_debug === true) { $line = $tokens[$first]['line']; $type = $tokens[$first]['type']; echo "\t* amended first token is $type on line $line *".PHP_EOL; } } $currentIndent = ($tokens[$first]['column'] - 1); if ($object > 0 || $condition > 0) { $currentIndent += $this->indent; } if (isset($tokens[$first]['scope_closer']) === true && $tokens[$first]['scope_closer'] === $first ) { if ($this->_debug === true) { echo "\t* first token is a scope closer *".PHP_EOL; } $currentIndent -= $this->indent; } // Make sure it is divisible by our expected indent. $currentIndent = (int) (ceil($currentIndent / $this->indent) * $this->indent); if ($this->_debug === true) { echo "\t=> indent set to $currentIndent".PHP_EOL; } }//end if }//end for // Don't process the rest of the file. return $phpcsFile->numTokens; }//end process() }//end class ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Arrays/DisallowLongArraySyntaxUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Arrays/DisallowLongArraySyntaxUnitTest.inc0000644000076700000240000000060412647543456033353 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowLongArraySyntax sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Arrays_DisallowLongArraySyntaxUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 4 => 1, 6 => 1, 7 => 1, 12 => 1, 13 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Arrays/DisallowShortArraySyntaxUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Arrays/DisallowShortArraySyntaxUnitTest.in0000644000076700000240000000023612647543456033411 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowShortArraySyntax sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Arrays_DisallowShortArraySyntaxUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 5 => 1, 7 => 1, 8 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Classes/DuplicateClassNameUnitTest.1.inc0000644000076700000240000000021212647543456032536 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Classes/DuplicateClassNameUnitTest.2.inc0000644000076700000240000000006212647543456032542 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Classes/DuplicateClassNameUnitTest.3.inc0000644000076700000240000000016212647543456032544 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Classes/DuplicateClassNameUnitTest.4.inc0000644000076700000240000000007712647543456032552 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Classes/DuplicateClassNameUnitTest.5.inc0000644000076700000240000000014012647543456032542 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Classes/DuplicateClassNameUnitTest.6.inc0000644000076700000240000000016612647543456032553 0ustar gsherwoodstaff

some html here

* @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DuplicateClassName multi-file sniff. * * A multi-file sniff unit test checks a .1.inc and a .2.inc file for expected violations * of a single coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Classes_DuplicateClassNameUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getWarningList($testFile='') { switch ($testFile) { case 'DuplicateClassNameUnitTest.1.inc': return array( 6 => 1, 7 => 1, ); break; case 'DuplicateClassNameUnitTest.2.inc': return array( 2 => 1, 3 => 1, ); break; case 'DuplicateClassNameUnitTest.5.inc': return array( 3 => 1, 7 => 1, ); break; case 'DuplicateClassNameUnitTest.6.inc': return array( 10 => 1, ); break; default: return array(); break; }//end switch }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/EmptyStatementUnitTest.inc0000644000076700000240000000171312647543456032651 0ustar gsherwoodstaffgetTraceAsString(); } } try { throw Exception('Error...'); } catch (Exception $e) {} try { throw Exception('Error...'); } catch (Exception $e) { // TODO: Handle this exception later :-) } if (true) {} elseif (false) {}PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/EmptyStatementUnitTest.php0000644000076700000240000000414612647543456032672 0ustar gsherwoodstaff * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the EmptyStatement sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_CodeAnalysis_EmptyStatementUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 15 => 1, 17 => 1, 19 => 1, 30 => 1, 35 => 1, 41 => 1, 47 => 1, 52 => 1, 55 => 1, 64 => 1, 68 => 1, 72 => 2, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/ForLoopShouldBeWhileLoopUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/ForLoopShouldBeWhileLoopUnitT0000644000076700000240000000035712647543456033236 0ustar gsherwoodstaffvalid();) { $it->next(); } for (;(($it1->valid() && $foo) || (!$it2->value && ($bar || false)));/*Could be ingored*/) { $it1->next(); $it2->next(); }././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/ForLoopShouldBeWhileLoopUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/ForLoopShouldBeWhileLoopUnitT0000644000076700000240000000356012647543456033235 0ustar gsherwoodstaff * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ForLoopShouldBeWhileLoop sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_CodeAnalysis_ForLoopShouldBeWhileLoopUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 6 => 1, 10 => 1, ); }//end getWarningList() }//end class ?>././@LongLink000 156 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/ForLoopWithTestFunctionCallUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/ForLoopWithTestFunctionCallUn0000644000076700000240000000040512647543456033274 0ustar gsherwoodstaffrewind(); $it->valid(); $it->next()) { echo $it->current(); }././@LongLink000 156 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/ForLoopWithTestFunctionCallUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/ForLoopWithTestFunctionCallUn0000644000076700000240000000357112647543456033303 0ustar gsherwoodstaff * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ForLoopWithTestFunctionCall sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_CodeAnalysis_ForLoopWithTestFunctionCallUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 4 => 1, 13 => 1, ); }//end getWarningList() }//end class ?>././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/JumbledIncrementerUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/JumbledIncrementerUnitTest.in0000644000076700000240000000063212647543456033300 0ustar gsherwoodstaff 3; $i++) { } } } for ($i = 0; $i < 20; $i++) { for ($j = 0; $j < 5; $j += 2) { for ($k = 0; $k > 3; $k++) { } } } for ($i = 0; $i < 20; $i++) { for ($j = 0; $j < 5; $j += 2) { for ($k = 0; $k > 3; $j++) { } } }././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/JumbledIncrementerUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/JumbledIncrementerUnitTest.ph0000644000076700000240000000356712647543456033313 0ustar gsherwoodstaff * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the JumbledIncrementer sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_CodeAnalysis_JumbledIncrementerUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 3 => 2, 4 => 1, 20 => 1, ); }//end getWarningList() }//end class ?>././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/UnconditionalIfStatementUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/UnconditionalIfStatementUnitT0000644000076700000240000000016312647543456033352 0ustar gsherwoodstaff * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the UnconditionalIfStatement sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_CodeAnalysis_UnconditionalIfStatementUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 3 => 1, 5 => 1, 7 => 1, ); }//end getWarningList() }//end class ?>././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/UnnecessaryFinalModifierUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/UnnecessaryFinalModifierUnitT0000644000076700000240000000060212647543456033326 0ustar gsherwoodstaff * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the UnnecessaryFinalModifier sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_CodeAnalysis_UnnecessaryFinalModifierUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 11 => 1, 14 => 1, 17 => 1, ); }//end getWarningList() }//end class ?>././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/UnusedFunctionParameterUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/UnusedFunctionParameterUnitTe0000644000076700000240000000202612647543456033357 0ustar gsherwoodstaff $parameter HTML; } print foo( 'PARAMETER' ); print "\n"; function foo($bar) { print "${bar} things\n"; } function bar($x) { return 2 * ${x}; }././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/UnusedFunctionParameterUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/UnusedFunctionParameterUnitTe0000644000076700000240000000355312647543456033365 0ustar gsherwoodstaff * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the UnusedFunctionParameter sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_CodeAnalysis_UnusedFunctionParameterUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 3 => 1, 7 => 1, ); }//end getWarningList() }//end class ?>././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/UselessOverridingMethodUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/CodeAnalysis/UselessOverridingMethodUnitTe0000644000076700000240000000064612647543456033370 0ustar gsherwoodstaff * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the UselessOverridingMethod sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Manuel Pichler * @copyright 2007-2014 Manuel Pichler. All rights reserved. * @license http://www.opensource.org/licenses/bsd-license.php BSD License * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_CodeAnalysis_UselessOverridingMethodUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 4 => 1, 16 => 1, ); }//end getWarningList() }//end class ?>PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Commenting/DocCommentUnitTest.inc0000644000076700000240000000553512647543456031446 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Comment * * @one * @two * @one * * @two something * here * @two foo * @three something * here * @three bar */ /** * @ var Comment */ /** @var Database $mockedDatabase */ /** @var Container $mockedContainer */ /** * 这是一条测试评论. */ /** * I'm a function short-description * @return boolean */ /** * this is a test * @author test * @param boolean $foo blah * @return boolean * @param boolean $bar Blah. */ /** * étude des ... */ PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Commenting/DocCommentUnitTest.js0000644000076700000240000000553612647543456031312 0ustar gsherwoodstaff /** * Short description. * * Long description * over multiple lines. * * @tag1 one * @tag2 two * @tag3 three */ /** * short description * * long description * over multiple lines. * @tag1 one */ /** * * Short description * * * Long description * over multiple lines * * * @tag1 one * */ /* This is not a doc block. */ /** Short description. * * @tag one * @tag2 two * @tagThree three * @tagFour four */ /** * Short description. * * @tag one * * @param * @param * */ /** * Short description. * @param * @param * @tag one */ /** * Short description. * * * @param * * @param * * * @tag one */ /** * Short description. * * @param * * @tag one * @param */ /** * Short description. * * @groupOne one * @groupOne two * * @group2 one * @group2 two * * * @g3 * @g3 two */ /** * Short description * over multiple lines. * * Long descrption. * * @param * * @tag one */ /** * Short description. * * @tag1 one some comment across * multiple lines * @tag1 two some comment across * multiple lines * @tag1 three some comment across * multiple lines */ /** * Returns true if the specified string is in the camel caps format. * * @param boolean $classFormat If true, check to see if the string is in the * class format. Class format strings must start * with a capital letter and contain no * underscores. * @param boolean $strict If true, the string must not have two capital * letters next to each other. If false, a * relaxed camel caps policy is used to allow * for acronyms. * * @return boolean */ /** * Verifies that a @throws tag exists for a function that throws exceptions. * Verifies the number of @throws tags and the number of throw tokens matches. * Verifies the exception type. * * PHP version 5 * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Comment * * @one * @two * @one * * @two something * here * @two foo * @three something * here * @three bar */ /** * @ var Comment */ /** @var Database $mockedDatabase */ /** @var Container $mockedContainer */ /** * 这是一条测试评论. */ /** * I'm a function short-description * @return boolean */ /** * this is a test * @author test * @param boolean $foo blah * @return boolean * @param boolean $bar Blah. */ /** * étude des ... */ PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Commenting/DocCommentUnitTest.php0000644000076700000240000000463112647543456031460 0ustar gsherwoodstaff * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for DocCommentSniff. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Commenting_DocCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array(int => int) */ public function getErrorList() { return array( 14 => 1, 16 => 1, 18 => 1, 23 => 1, 26 => 1, 30 => 1, 32 => 1, 38 => 2, 40 => 1, 41 => 1, 51 => 1, 54 => 1, 58 => 1, 60 => 2, 67 => 1, 69 => 2, 80 => 1, 81 => 2, 88 => 1, 91 => 1, 95 => 1, 156 => 1, 158 => 1, 170 => 3, 171 => 3, 179 => 1, 183 => 1, 184 => 1, 185 => 2, 186 => 1, 187 => 2, 191 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array(int => int) */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Commenting/FixmeUnitTest.inc0000644000076700000240000000065612647543456030465 0ustar gsherwoodstaff * @author Marc McIntyre * @author Sam Graham * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the Fixme sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @author Sam Graham * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Commenting_FixmeUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='FixmeUnitTest.inc') { return array( 3 => 1, 4 => 1, 7 => 1, 10 => 1, 13 => 1, 16 => 1, 18 => 1, 21 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getWarningList($testFile='FixmeUnitTest.inc') { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Commenting/TodoUnitTest.inc0000644000076700000240000000055412647543456030317 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the Todo sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Commenting_TodoUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='TodoUnitTest.inc') { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getWarningList($testFile='TodoUnitTest.inc') { return array( 3 => 1, 4 => 1, 7 => 1, 10 => 1, 13 => 1, 16 => 1, 18 => 1, 21 => 1, ); }//end getWarningList() }//end class ././@LongLink000 156 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/ControlStructures/InlineControlStructureUn0000644000076700000240000000465012647543456033572 0ustar gsherwoodstaff 0; $i--) echo 'hello'; while ($something) echo 'hello'; do { $i--; } while ($something); if(true) $someObject->{$name}; if (true) : $foo = true; endif; while (true) : $foo = true; endwhile; for ($i; $i > 0; $i--) : echo 'hello'; endfor; foreach ($array as $element) : echo 'hello'; endforeach; while (!$this->readLine($tokens, $tag)); while (!$this->readLine($tokens, $tag)); //skip to end of file foreach ($cookies as $cookie) if ($cookie->match($uri, $matchSessionCookies, $now)) $ret[] = $cookie; foreach ($stringParade as $hit) $hitParade[] = $hit + 0; //cast to integer if ($foo) : echo 'true'; elseif ($something) : echo 'foo'; else: echo 'false'; endif; function test() { if ($a) $a.=' '.($b ? 'b' : ($c ? ($d ? 'd' : 'c') : '')); } if ($a) foreach ($b as $c) { if ($d) { $e=$f; $g=$h; } elseif ($i==0) { $j=$k; } } ?>
scenario == 'simple') $widget->renderPager() ?>
error): case Shop_Customer :: ERROR_INVALID_GENDER: ?> Ungültiges Geschlecht! Die eingetragene E-Mail-Adresse ist bereits registriert. allowShopping !== true): if ($this->status != Shop_Cart :: OK): switch ($this->status): case Shop_Cart :: NOT_FOUND: echo 'foo'; endswitch; endif; else: echo 'foo'; endif; // ELSE IF split over multiple lines (not inline) if ($test) { } else if ($test) { } else { } switch($response = \Bar::baz('bat', function ($foo) { return 'bar'; })) { case 1: return 'test'; case 2: return 'other'; } $stuff = [1,2,3]; foreach($stuff as $num) if ($num %2 ) { echo "even"; } else { echo "odd"; } $i = 0; foreach($stuff as $num) do { echo $i; $i++; } while ($i < 5); foreach($stuff as $num) if (true) { echo "true1\n"; } if (true) { echo "true2\n"; } if ($foo) echo 'foo'; elseif ($bar) echo 'bar'; else echo 'baz'; ././@LongLink000 164 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/ControlStructures/InlineControlStructureUn0000644000076700000240000000477112647543456033576 0ustar gsherwoodstaff 0; $i--) { echo 'hello'; } while ($something) { echo 'hello'; } do { $i--; } while ($something); if(true) { $someObject->{$name}; } if (true) : $foo = true; endif; while (true) : $foo = true; endwhile; for ($i; $i > 0; $i--) : echo 'hello'; endfor; foreach ($array as $element) : echo 'hello'; endforeach; while (!$this->readLine($tokens, $tag)) {} while (!$this->readLine($tokens, $tag)) { //skip to end of file } foreach ($cookies as $cookie) { if ($cookie->match($uri, $matchSessionCookies, $now)) { $ret[] = $cookie; } } foreach ($stringParade as $hit) { $hitParade[] = $hit + 0; //cast to integer } if ($foo) : echo 'true'; elseif ($something) : echo 'foo'; else: echo 'false'; endif; function test() { if ($a) { $a.=' '.($b ? 'b' : ($c ? ($d ? 'd' : 'c') : '')); } } if ($a) { foreach ($b as $c) { if ($d) { $e=$f; $g=$h; } elseif ($i==0) { $j=$k; } } } ?>
scenario == 'simple') { $widget->renderPager(); } ?>
error): case Shop_Customer :: ERROR_INVALID_GENDER: ?> Ungültiges Geschlecht! Die eingetragene E-Mail-Adresse ist bereits registriert. allowShopping !== true): if ($this->status != Shop_Cart :: OK): switch ($this->status): case Shop_Cart :: NOT_FOUND: echo 'foo'; endswitch; endif; else: echo 'foo'; endif; // ELSE IF split over multiple lines (not inline) if ($test) { } else if ($test) { } else { } switch($response = \Bar::baz('bat', function ($foo) { return 'bar'; })) { case 1: return 'test'; case 2: return 'other'; } $stuff = [1,2,3]; foreach($stuff as $num) { if ($num %2 ) { echo "even"; } else { echo "odd"; } } $i = 0; foreach($stuff as $num) { do { echo $i; $i++; } while ($i < 5); } foreach($stuff as $num) { if (true) { echo "true1\n"; } } if (true) { echo "true2\n"; } if ($foo) { echo 'foo'; } elseif ($bar) { echo 'bar'; } else { echo 'baz'; } ././@LongLink000 155 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.jsPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/ControlStructures/InlineControlStructureUn0000644000076700000240000000054312647543456033567 0ustar gsherwoodstaff if (something) print 'hello'; if (something) { print 'hello'; } else print 'hi'; if (something) { print 'hello'; } else if (something) print 'hi'; for (i; i > 0; i--) print 'hello'; while (something) print 'hello'; do { i--; } while (something); do i++; while (i < 5); SomeClass.prototype.switch = function() { // do something }; ././@LongLink000 163 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.js.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/ControlStructures/InlineControlStructureUn0000644000076700000240000000057312647543456033572 0ustar gsherwoodstaff if (something) { print 'hello'; } if (something) { print 'hello'; } else { print 'hi'; } if (something) { print 'hello'; } else if (something) { print 'hi'; } for (i; i > 0; i--) { print 'hello'; } while (something) { print 'hello'; } do { i--; } while (something); do { i++; } while (i < 5); SomeClass.prototype.switch = function() { // do something }; ././@LongLink000 156 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/ControlStructures/InlineControlStructureUn0000644000076700000240000000613112647543456033566 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the InlineControlStructure sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_ControlStructures_InlineControlStructureUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='InlineControlStructureUnitTest.inc') { switch ($testFile) { case 'InlineControlStructureUnitTest.inc': return array( 3 => 1, 7 => 1, 11 => 1, 13 => 1, 15 => 1, 17 => 1, 23 => 1, 42 => 1, 43 => 1, 45 => 1, 46 => 1, 49 => 1, 62 => 1, 66 => 1, 78 => 1, 120 => 1, 128 => 1, 134 => 1, 142 => 1, 143 => 1, 144 => 1, ); break; case 'InlineControlStructureUnitTest.js': return array( 3 => 1, 7 => 1, 11 => 1, 13 => 1, 15 => 1, 21 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/ByteOrderMarkUnitTest.inc0000644000076700000240000000003012647543456031053 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/ByteOrderMarkUnitTest.php0000644000076700000240000000342512647543456031104 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ByteOrderMark sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Files_ByteOrderMarkUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 1 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/EndFileNewlineUnitTest.1.css0000644000076700000240000000002612647543456031354 0ustar gsherwoodstaff #login-container {} PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/EndFileNewlineUnitTest.1.js0000644000076700000240000000001612647543456031177 0ustar gsherwoodstaff alert('hi); PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/EndFileNewlineUnitTest.1.inc0000644000076700000240000000002312647543456031332 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the EndFileNewline sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Files_EndFileNewlineUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='') { switch ($testFile) { case 'EndFileNewlineUnitTest.3.inc': case 'EndFileNewlineUnitTest.3.js': case 'EndFileNewlineUnitTest.3.css': return array( 2 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getWarningList($testFile='') { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/EndFileNoNewlineUnitTest.1.css0000644000076700000240000000002612647543456031651 0ustar gsherwoodstaff #login-container {} PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/EndFileNoNewlineUnitTest.1.js0000644000076700000240000000001612647543456031474 0ustar gsherwoodstaff alert('hi); PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/EndFileNoNewlineUnitTest.1.inc0000644000076700000240000000002312647543456031627 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/EndFileNoNewlineUnitTest.3.css0000644000076700000240000000002412647543456031651 0ustar gsherwoodstaff #login-container {}PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/EndFileNoNewlineUnitTest.3.js0000644000076700000240000000001412647543456031474 0ustar gsherwoodstaff alert('hi);PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/EndFileNoNewlineUnitTest.3.inc0000644000076700000240000000002112647543456031627 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/EndFileNoNewlineUnitTest.php0000644000076700000240000000472112647543456031517 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the EndFileNoNewline sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Files_EndFileNoNewlineUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='') { switch ($testFile) { case 'EndFileNoNewlineUnitTest.1.inc': case 'EndFileNoNewlineUnitTest.1.css': case 'EndFileNoNewlineUnitTest.1.js': case 'EndFileNoNewlineUnitTest.2.inc': return array( 3 => 1, ); break; case 'EndFileNoNewlineUnitTest.2.css': case 'EndFileNoNewlineUnitTest.2.js': return array( 2 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getWarningList($testFile='') { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/InlineHTMLUnitTest.1.inc0000644000076700000240000000002312647543456030405 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/InlineHTMLUnitTest.3.inc0000644000076700000240000000005612647543456030415 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/InlineHTMLUnitTest.5.inc0000644000076700000240000000004512647543456030415 0ustar gsherwoodstaff#!/usr/bin/env php * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the InlineHTML sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Files_InlineHTMLUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='') { switch ($testFile) { case 'InlineHTMLUnitTest.3.inc': return array( 4 => 1, ); break; case 'InlineHTMLUnitTest.4.inc': return array( 1 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getWarningList($testFile='') { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/LineEndingsUnitTest.css0000644000076700000240000000006112647543456030563 0ustar gsherwoodstaff#login-container { margin-left: -225px; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/LineEndingsUnitTest.inc0000644000076700000240000000006212647543456030545 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/LineEndingsUnitTest.js0000644000076700000240000000003412647543456030407 0ustar gsherwoodstaffalert('hi'); alert('hi'); PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/LineEndingsUnitTest.php0000644000076700000240000000356312647543456030574 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the LineEndings sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Files_LineEndingsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 1 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/LineLengthUnitTest.inc0000644000076700000240000000310612647543456030401 0ustar gsherwoodstaff Hellob> * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the LineLength sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Files_LineLengthUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 31 => 1, 34 => 1, 45 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 9 => 1, 15 => 1, 21 => 1, 24 => 1, 29 => 1, 37 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/LowercasedFilenameUnitTest.inc0000644000076700000240000000002412647543456032075 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/LowercasedFilenameUnitTest.php0000644000076700000240000000333612647543456032124 0ustar gsherwoodstaff * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the LowercasedFilename sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Andy Grunwald * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Files_LowercasedFilenameUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(1 => 1); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/OneClassPerFileUnitTest.inc0000644000076700000240000000006712647543456031331 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/OneClassPerFileUnitTest.php0000644000076700000240000000342112647543456031344 0ustar gsherwoodstaff * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the OneClassPerFile sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Andy Grunwald * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Files_OneClassPerFileUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 6 => 1, 10 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/OneInterfacePerFileUnitTest.inc0000644000076700000240000000010612647543456032156 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/OneInterfacePerFileUnitTest.php0000644000076700000240000000343512647543456032204 0ustar gsherwoodstaff * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the OneInterfacePerFile sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Andy Grunwald * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Files_OneInterfacePerFileUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 6 => 1, 10 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/OneTraitPerFileUnitTest.inc0000644000076700000240000000017612647543456031350 0ustar gsherwoodstafftrait; echo Something::$trait; echo $trait; PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Files/OneTraitPerFileUnitTest.php0000644000076700000240000000356012647543456031366 0ustar gsherwoodstaff * @copyright 2010-2014 Alexander Obuhovich * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the OneTraitPerFile sniff. * * @category PHP * @package PHP_CodeSniffer * @author Alexander Obuhovich * @copyright 2010-2014 Alexander Obuhovich * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Files_OneTraitPerFileUnitTest extends AbstractSniffUnitTest { /** * Should this test be skipped for some reason. * * @return bool */ protected function shouldSkipTest() { return version_compare(PHP_VERSION, '5.4.0', '<'); }//end shouldSkipTest() /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array(int => int) */ public function getErrorList() { return array( 6 => 1, 10 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array(int => int) */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/DisallowMultipleStatementsUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/DisallowMultipleStatementsUnitT0000644000076700000240000000036412647543456033501 0ustar gsherwoodstaffwizardid = 10; $this->paint(); echo 'x'; ?>
././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/DisallowMultipleStatementsUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/DisallowMultipleStatementsUnitT0000644000076700000240000000375512647543456033510 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowMultipleStatements sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Formatting_DisallowMultipleStatementsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 6 => 1, 7 => 1, 8 => 2, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitT0000644000076700000240000001151612647543456033457 0ustar gsherwoodstafffindPrevious(); $commentEnd = $this->_phpcsFile; $expected .= '...'; // Invalid $this->okButton = new Button(); $content = new MyClass(); $GLOBALS['_PEAR_ERRORSTACK_SINGLETON'] = array(); class MyClass { const MODE_DEBUG = 'debug'; const MODE_DEBUG2 = 'debug'; $array[$test] = 'anything'; $var = 'anything'; const MODE_DEBUG2 = 'debug'; $array[$test] = 'anything'; $var = 'anything'; $array[($test + 1)] = 'anything'; $array[($blah + (10 - $test))] = 'anything'; } function myFunction($var=true) { if ($strict === true) { $length = strlen($string); $lastCharWasCaps = ($classFormat === false) ? false : true; for ($i = 1; $i < $length; $i++) { $isCaps = (strtoupper($string{$i}) === $string{$i}) ? true : false; if ($isCaps === true && $lastCharWasCaps === true) { return false; } $lastCharWasCaps = $isCaps; } } } // Valid for ($i = 0; $i < 10; $i += 2) { $i = ($i - 1); } // Invalid foreach ($files as $file) { $saves[$file] = array(); $contents = stripslashes(file_get_contents($file)); list($assetid, $time, $content) = explode("\n", $contents); $saves[$file]['assetid'] = $assetid; } $i = ($i - 10); $ip = ($i - 10); for ($i = 0; $i < 10; $i += 2) { $i = ($i - 10); } // Valid $variable = 12; $var = a_very(long_line('that', 'contains'), a_bunch('of long', 'parameters'), 'that_need to be aligned with the equal sign'); $var2 = 12; // Valid $variable = 12; $var = 'a very long line of text that contains ' .$someVar .' and some other stuff that is too long to fit on one line'; $var2 = 12; // Invalid $variable = 12; $var = a_very(long_line('that', 'contains'), a_bunch('of long', 'parameters'), 'that_need to be aligned with the equal sign'); $var2 = 12; // Invalid $variable = 12; $var = 'a very long line of text that contains ' .$someVar .' and some other stuff that is too long to fit on one line'; $var2 = 12; // Valid $variable = 12; $var .= 'a very long line of text that contains ' .$someVar .' and some other stuff that is too long to fit on one line'; $var2 = 12; // Valid $variable += 12; $var .= 'a very long line of text that contains ' .$someVar .' and some other stuff that is too long to fit on one line'; $var2 = 12; // Invalid $variable = 12; $var .= 'a very long line of text that contains ' .$someVar .' and some other stuff that is too long to fit on one line'; $var2 = 12; // Valid $error = false; while (list($h, $f) = each($handle)) { $error = true; } // Valid $value = false; function blah ($value = true) { $value = false; if ($value === true) { $value = false; } } if (TRUE) { $args = array('foo' => 'foo'); $res = 'bar'; } // @codingStandardsChangeSetting Generic.Formatting.MultipleStatementAlignment maxPadding 8 $one = 'one'; $varonetwo = 'two'; $varonetwothree = 'three'; $varonetwothreefour = 'four'; $one = 'one'; $varonetwo .= 'two'; $varonetwo = 'two'; $varonetwo .= 'two'; $varonetwothree = 'three'; $varonetwothreefour = 'four'; // @codingStandardsChangeSetting Generic.Formatting.MultipleStatementAlignment maxPadding 1000 $filterQuery = SquizRoadmap::getSearchQueryFilter($searchParams); Channels::addToBasket('itemid', $filterQuery); $query = DAL::getDALQuery('SquizRoadmapItem', 'getItemIds'); $results = DAL::getAssoc($query, 0); $path = BaseSystem::getDataDir('SquizRoadmap').'/items/'; $path .= FileSystem::getHashDir($itemid).'/'.$itemid; $contents .= 'if ('; $conditions = array(); $bar = 'hi'; $foo = $moo = $test; $boo = 'boo'; $foo = $moooo = 'foo'; ././@LongLink000 161 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitTest.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitT0000644000076700000240000001164212647543456033457 0ustar gsherwoodstafffindPrevious(); $commentEnd = $this->_phpcsFile; $expected .= '...'; // Invalid $this->okButton = new Button(); $content = new MyClass(); $GLOBALS['_PEAR_ERRORSTACK_SINGLETON'] = array(); class MyClass { const MODE_DEBUG = 'debug'; const MODE_DEBUG2 = 'debug'; $array[$test] = 'anything'; $var = 'anything'; const MODE_DEBUG2 = 'debug'; $array[$test] = 'anything'; $var = 'anything'; $array[($test + 1)] = 'anything'; $array[($blah + (10 - $test))] = 'anything'; } function myFunction($var=true) { if ($strict === true) { $length = strlen($string); $lastCharWasCaps = ($classFormat === false) ? false : true; for ($i = 1; $i < $length; $i++) { $isCaps = (strtoupper($string{$i}) === $string{$i}) ? true : false; if ($isCaps === true && $lastCharWasCaps === true) { return false; } $lastCharWasCaps = $isCaps; } } } // Valid for ($i = 0; $i < 10; $i += 2) { $i = ($i - 1); } // Invalid foreach ($files as $file) { $saves[$file] = array(); $contents = stripslashes(file_get_contents($file)); list($assetid, $time, $content) = explode("\n", $contents); $saves[$file]['assetid'] = $assetid; } $i = ($i - 10); $ip = ($i - 10); for ($i = 0; $i < 10; $i += 2) { $i = ($i - 10); } // Valid $variable = 12; $var = a_very(long_line('that', 'contains'), a_bunch('of long', 'parameters'), 'that_need to be aligned with the equal sign'); $var2 = 12; // Valid $variable = 12; $var = 'a very long line of text that contains ' .$someVar .' and some other stuff that is too long to fit on one line'; $var2 = 12; // Invalid $variable = 12; $var = a_very(long_line('that', 'contains'), a_bunch('of long', 'parameters'), 'that_need to be aligned with the equal sign'); $var2 = 12; // Invalid $variable = 12; $var = 'a very long line of text that contains ' .$someVar .' and some other stuff that is too long to fit on one line'; $var2 = 12; // Valid $variable = 12; $var .= 'a very long line of text that contains ' .$someVar .' and some other stuff that is too long to fit on one line'; $var2 = 12; // Valid $variable += 12; $var .= 'a very long line of text that contains ' .$someVar .' and some other stuff that is too long to fit on one line'; $var2 = 12; // Invalid $variable = 12; $var .= 'a very long line of text that contains ' .$someVar .' and some other stuff that is too long to fit on one line'; $var2 = 12; // Valid $error = false; while (list($h, $f) = each($handle)) { $error = true; } // Valid $value = false; function blah ($value = true) { $value = false; if ($value === true) { $value = false; } } if (TRUE) { $args = array('foo' => 'foo'); $res = 'bar'; } // @codingStandardsChangeSetting Generic.Formatting.MultipleStatementAlignment maxPadding 8 $one = 'one'; $varonetwo = 'two'; $varonetwothree = 'three'; $varonetwothreefour = 'four'; $one = 'one'; $varonetwo .= 'two'; $varonetwo = 'two'; $varonetwo .= 'two'; $varonetwothree = 'three'; $varonetwothreefour = 'four'; // @codingStandardsChangeSetting Generic.Formatting.MultipleStatementAlignment maxPadding 1000 $filterQuery = SquizRoadmap::getSearchQueryFilter($searchParams); Channels::addToBasket('itemid', $filterQuery); $query = DAL::getDALQuery('SquizRoadmapItem', 'getItemIds'); $results = DAL::getAssoc($query, 0); $path = BaseSystem::getDataDir('SquizRoadmap').'/items/'; $path .= FileSystem::getHashDir($itemid).'/'.$itemid; $contents .= 'if ('; $conditions = array(); $bar = 'hi'; $foo = $moo = $test; $boo = 'boo'; $foo = $moooo = 'foo'; ././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitTest.jsPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitT0000644000076700000240000000322412647543456033454 0ustar gsherwoodstaff // Valid var1 = 'var1'; var10 = 'var1'; var100 = 'var1'; var1000 = 'var1'; // Invalid var1 = 'var1'; var10 = 'var1'; var100 = 'var1'; var1000 = 'var1'; // Valid var1 = 'var1'; var10 = 'var1'; var100 = 'var1'; var1000 = 'var1'; // Invalid var1 = 'var1'; var10 = 'var1'; var100 = 'var1'; var1000 = 'var1'; // Valid var1 += 'var1'; var10 += 'var1'; var100 += 'var1'; var1000 += 'var1'; // Invalid var1 += 'var1'; var10+= 'var1'; var100 += 'var1'; var1000 += 'var1'; // Valid var1 = 'var1'; var10 += 'var1'; var100 = 'var1'; var1000 += 'var1'; // Invalid var1 = 'var1'; var10 += 'var1'; var100 = 'var1'; var1000+= 'var1'; // Valid var1 += 'var1'; var10 += 'var1'; var100 += 'var1'; var1000 += 'var1'; // Invalid var1 += 'var1'; var10 += 'var1'; var100 += 'var1'; var1000 += 'var1'; // Valid var test = 100; // InValid var test = 100; commentStart = phpcsFile.findPrevious(); commentEnd = this._phpcsFile; expected += '...'; // Invalid this.okButton = {}; content = {}; var buttonid = [this.id, '-positionFormats-add'].join(''); var buttonWidget = WidgetStore.get(buttonid); var spinButtonid = [this.id, '-positionFormats-spinButton'].join(''); var spinButtonWidget = WidgetStore.get(spinButtonid); var position = spinButtonWidget.getValue(); var posForamatsList = WidgetStore.get([self.id, '-positionFormats-list'].join('')); dfx.stripTags = function(content, allowedTags) { var match; var re = 'blah'; }; var contents += 'if ('; var conditions = array(); var foo = {}; foo.blah = 'blah'; var script = document.createElement('script'); script.onload = function() { clearTimeout(t); }; ././@LongLink000 160 0003733 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitTest.js.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitT0000644000076700000240000000325412647543456033457 0ustar gsherwoodstaff // Valid var1 = 'var1'; var10 = 'var1'; var100 = 'var1'; var1000 = 'var1'; // Invalid var1 = 'var1'; var10 = 'var1'; var100 = 'var1'; var1000 = 'var1'; // Valid var1 = 'var1'; var10 = 'var1'; var100 = 'var1'; var1000 = 'var1'; // Invalid var1 = 'var1'; var10 = 'var1'; var100 = 'var1'; var1000 = 'var1'; // Valid var1 += 'var1'; var10 += 'var1'; var100 += 'var1'; var1000 += 'var1'; // Invalid var1 += 'var1'; var10 += 'var1'; var100 += 'var1'; var1000 += 'var1'; // Valid var1 = 'var1'; var10 += 'var1'; var100 = 'var1'; var1000 += 'var1'; // Invalid var1 = 'var1'; var10 += 'var1'; var100 = 'var1'; var1000 += 'var1'; // Valid var1 += 'var1'; var10 += 'var1'; var100 += 'var1'; var1000 += 'var1'; // Invalid var1 += 'var1'; var10 += 'var1'; var100 += 'var1'; var1000 += 'var1'; // Valid var test = 100; // InValid var test = 100; commentStart = phpcsFile.findPrevious(); commentEnd = this._phpcsFile; expected += '...'; // Invalid this.okButton = {}; content = {}; var buttonid = [this.id, '-positionFormats-add'].join(''); var buttonWidget = WidgetStore.get(buttonid); var spinButtonid = [this.id, '-positionFormats-spinButton'].join(''); var spinButtonWidget = WidgetStore.get(spinButtonid); var position = spinButtonWidget.getValue(); var posForamatsList = WidgetStore.get([self.id, '-positionFormats-list'].join('')); dfx.stripTags = function(content, allowedTags) { var match; var re = 'blah'; }; var contents += 'if ('; var conditions = array(); var foo = {}; foo.blah = 'blah'; var script = document.createElement('script'); script.onload = function() { clearTimeout(t); }; ././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitT0000644000076700000240000001000212647543456033444 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the MultipleStatementAlignment sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Formatting_MultipleStatementAlignmentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getWarningList($testFile='MultipleStatementAlignmentUnitTest.inc') { switch ($testFile) { case 'MultipleStatementAlignmentUnitTest.inc': return array( 11 => 1, 12 => 1, 23 => 1, 24 => 1, 26 => 1, 27 => 1, 37 => 1, 38 => 1, 48 => 1, 50 => 1, 51 => 1, 61 => 1, 62 => 1, 64 => 1, 65 => 1, 71 => 1, 78 => 1, 79 => 1, 86 => 1, 92 => 1, 93 => 1, 94 => 1, 95 => 1, 123 => 1, 124 => 1, 126 => 1, 129 => 1, 154 => 1, 161 => 1, 178 => 1, 179 => 1, 182 => 1, 206 => 1, 207 => 1, ); break; case 'MultipleStatementAlignmentUnitTest.js': return array( 11 => 1, 12 => 1, 23 => 1, 24 => 1, 26 => 1, 27 => 1, 37 => 1, 38 => 1, 48 => 1, 50 => 1, 51 => 1, 61 => 1, 62 => 1, 64 => 1, 65 => 1, 71 => 1, 78 => 1, 79 => 1, 81 => 1, 82 => 1, 83 => 1, 85 => 1, 86 => 1, 100 => 1, ); break; default: return array(); break; } }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/NoSpaceAfterCastUnitTest.inc0000644000076700000240000000136412647543456032551 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/NoSpaceAfterCastUnitTest.php0000644000076700000240000000462512647543456032572 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the NoSpaceAfterCast sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Formatting_NoSpaceAfterCastUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 5 => 1, 7 => 1, 9 => 1, 11 => 1, 13 => 1, 15 => 1, 17 => 1, 19 => 1, 21 => 1, 23 => 1, 25 => 1, 27 => 1, 29 => 1, 31 => 1, 33 => 1, 35 => 1, 37 => 1, 39 => 1, 41 => 1, 43 => 1, 45 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/SpaceAfterCastUnitTest.inc0000644000076700000240000000136412647543456032254 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Formatting/SpaceAfterCastUnitTest.php0000644000076700000240000000461712647543456032276 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the SpaceAfterCast sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Formatting_SpaceAfterCastUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 4 => 1, 5 => 1, 8 => 1, 9 => 1, 12 => 1, 13 => 1, 16 => 1, 17 => 1, 20 => 1, 21 => 1, 24 => 1, 25 => 1, 28 => 1, 29 => 1, 32 => 1, 33 => 1, 36 => 1, 37 => 1, 40 => 1, 41 => 1, 44 => 1, 45 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Functions/CallTimePassByReferenceUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Functions/CallTimePassByReferenceUnitTest.0000644000076700000240000000063112647543456033217 0ustar gsherwoodstaffmyfunc(&$myvar); $this->myfunc($myvar); myclass::myfunc(&$myvar); myclass::myfunc($myvar); while(testfunc($var1, &$var2, $var3, &$var4) === false) { } sprintf("0%o", 0777 & $p); $foo(&$myvar); if (is_array($foo = &$this->bar())) { } ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Functions/CallTimePassByReferenceUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Functions/CallTimePassByReferenceUnitTest.0000644000076700000240000000400012647543456033211 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the CallTimePassByReference sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Functions_CallTimePassByReferenceUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 9 => 1, 12 => 1, 15 => 1, 18 => 2, 23 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Functions/FunctionCallArgumentSpacingUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Functions/FunctionCallArgumentSpacingUnitT0000644000076700000240000000355112647543456033367 0ustar gsherwoodstaffgetArray($one, $two,$three),$this->arrayMap); $this->error($obj->getCode(),$obj->getMessage(),$obj->getFile(),$obj->getLine()); make_foo($string /*the string*/ , true /*test*/); make_foo($string/*the string*/ , /*test*/ true); make_foo($string /*the string*/, /*test*/ true); class MyClass { function myFunction() { blah($foo, "{{$config['host']}}", "{$config}", "hi there{}{}{{{}{}{}}"); } } // Function definition, not function call, so should be ignored function &myFunction($arg1=1,$arg2=2) { } return array_udiff( $foo, $bar, function($a, $b) { $foo='bar'; return $foo; } ); var_dump(<<getArray($one, $two, $three), $this->arrayMap); $this->error($obj->getCode(), $obj->getMessage(), $obj->getFile(), $obj->getLine()); make_foo($string /*the string*/, true /*test*/); make_foo($string/*the string*/, /*test*/ true); make_foo($string /*the string*/, /*test*/ true); class MyClass { function myFunction() { blah($foo, "{{$config['host']}}", "{$config}", "hi there{}{}{{{}{}{}}"); } } // Function definition, not function call, so should be ignored function &myFunction($arg1=1,$arg2=2) { } return array_udiff( $foo, $bar, function($a, $b) { $foo='bar'; return $foo; } ); var_dump(<< * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the FunctionCallArgumentSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Functions_FunctionCallArgumentSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 5 => 1, 6 => 1, 7 => 2, 8 => 1, 11 => 2, 12 => 2, 13 => 3, 42 => 3, 43 => 3, 45 => 1, 46 => 2, 79 => 1, 82 => 1, 93 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ././@LongLink000 155 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Functions/OpeningFunctionBraceBsdAllmanUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Functions/OpeningFunctionBraceBsdAllmanUni0000644000076700000240000000571512647543456033312 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the OpeningFunctionBraceBsdAllman sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Functions_OpeningFunctionBraceBsdAllmanUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 4 => 1, 13 => 1, 19 => 1, 24 => 1, 30 => 1, 40 => 1, 44 => 1, 50 => 1, 55 => 1, 67 => 1, 78 => 1, 85 => 1, 91 => 1, 98 => 1, 110 => 1, 115 => 1, 122 => 1, 128 => 1, 155 => 1, 158 => 1, 164 => 1, 168 => 1, 172 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ././@LongLink000 164 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Functions/OpeningFunctionBraceKernighanRitchieUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Functions/OpeningFunctionBraceKernighanRit0000644000076700000240000000450012647543456033355 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the OpeningFunctionBraceKernighanRitchie sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Functions_OpeningFunctionBraceKernighanRitchieUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 9 => 1, 13 => 1, 17 => 1, 29 => 1, 33 => 1, 37 => 1, 53 => 1, 58 => 1, 63 => 1, 77 => 1, 82 => 1, 87 => 1, 104 => 1, 119 => 1, 123 => 1, 127 => 1, 132 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Metrics/CyclomaticComplexityUnitTest.inc0000644000076700000240000000542412647543456033066 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Metrics/CyclomaticComplexityUnitTest.php0000644000076700000240000000372412647543456033105 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the CyclomaticComplexity sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Metrics_CyclomaticComplexityUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 116 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 45 => 1, 72 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Metrics/NestingLevelUnitTest.inc0000644000076700000240000000461512647543456031321 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Metrics/NestingLevelUnitTest.php0000644000076700000240000000367312647543456031342 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the NestingLevel sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Metrics_NestingLevelUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 73 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 27 => 1, 46 => 1, ); }//end getWarningList() }//end class ?> ././@LongLink000 155 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/NamingConventions/CamelCapsFunctionNameUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/NamingConventions/CamelCapsFunctionNameUni0000644000076700000240000000471612647543456033320 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the CamelCapsFunctionName sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_NamingConventions_CamelCapsFunctionNameUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { $errors = array( 10 => 1, 11 => 1, 12 => 1, 13 => 1, 16 => 1, 17 => 1, 20 => 1, 21 => 1, 24 => 1, 25 => 1, 30 => 1, 31 => 1, 50 => 1, 52 => 1, 53 => 1, 57 => 1, 58 => 1, 59 => 1, 60 => 1, 61 => 1, 62 => 1, 63 => 1, 64 => 1, 65 => 1, 66 => 1, 67 => 1, 68 => 1, 69 => 1, 71 => 1, 72 => 1, 73 => 1, 74 => 1, 118 => 1, ); return $errors; }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/NamingConventions/ConstructorNameUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/NamingConventions/ConstructorNameUnitTest.0000644000076700000240000000133012647543456033376 0ustar gsherwoodstaff ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/NamingConventions/ConstructorNameUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/NamingConventions/ConstructorNameUnitTest.0000644000076700000240000000353212647543456033404 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ConstructorName sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_NamingConventions_ConstructorNameUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 6 => 1, 11 => 1, 47 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 155 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/NamingConventions/UpperCaseConstantNameUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/NamingConventions/UpperCaseConstantNameUni0000644000076700000240000000537612647543456033366 0ustar gsherwoodstaffdefine('bar'); $foo->getBar()->define('foo'); // This is allowed as it is required for PHPUnit. if (PHPUnit_MAIN_METHOD == 'PHP_Shell_AllTests::main') { PHP_Shell_AllTests::main(); } class ConstTest { const TESTER = '1'; public function __construct() { echo constant('self::TESTER'); echo constant('self::tester'); } } class A { public static function constant($x) {} } A::constant('anything-not-in-uppercase'); // goto goto gotolabel; gototarget1: function ConstTest() { gototarget2: } switch($foo) { case $bar: gototarget3: } $a = 2 * ${x} - ${minus}; class Object implements IObject { use TProperties; use TReflected { TReflected::reflect insteadof TProperties; } use ListenerAggregateTrait, PreLoadUserTrait, PreLoadCompanyTrait { PreloadUserTrait::PreLoadUser as loadUser; PreloadCompanyTrait::PreLoadCompany as loadCompany; } } class MyClass { use Something { delete as protected blah; } } class Foo { public function bar() { return Bar::class; } } ?> ././@LongLink000 155 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/NamingConventions/UpperCaseConstantNameUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/NamingConventions/UpperCaseConstantNameUni0000644000076700000240000000371312647543456033357 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ValidConstantName sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_NamingConventions_UpperCaseConstantNameUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 8 => 1, 10 => 1, 15 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/CharacterBeforePHPOpeningTagUnitTest.1.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/CharacterBeforePHPOpeningTagUnitTest.10000644000076700000240000000006212647543456032665 0ustar gsherwoodstaffFoo ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/CharacterBeforePHPOpeningTagUnitTest.2.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/CharacterBeforePHPOpeningTagUnitTest.20000644000076700000240000000004512647543456032667 0ustar gsherwoodstaff#!/usr/bin/env php * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the CharacterBeforePHPOpeningTag sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Andy Grunwald * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_PHP_CharacterBeforePHPOpeningTagUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='') { switch ($testFile) { case 'CharacterBeforePHPOpeningTagUnitTest.1.inc': return array( 2 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/ClosingPHPTagUnitTest.inc0000644000076700000240000000013712647543456030340 0ustar gsherwoodstaff Bold text Italic text * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ClosingPHPTag sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Andy Grunwald * @copyright 2010-2014 Andy Grunwald * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_PHP_ClosingPHPTagUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 9 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/DisallowShortOpenTagUnitTest.inc0000644000076700000240000000012212647543456032004 0ustar gsherwoodstaff
Some content here.
PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/DisallowShortOpenTagUnitTest.php0000644000076700000240000000457412647543456032041 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowShortOpenTag sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_PHP_DisallowShortOpenTagUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { $option = (boolean) ini_get('short_open_tag'); if ($option === true || defined('HHVM_VERSION') === true) { return array( 4 => 1, 5 => 1, ); } else if (version_compare(PHP_VERSION, '5.4.0RC1') >= 0) { // Shorthand echo is always available from PHP 5.4.0 but needed the // short_open_tag ini var to be set for versions before this. return array( 4 => 1, ); } return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/ForbiddenFunctionsUnitTest.inc0000644000076700000240000000200112647543456031513 0ustar gsherwoodstaffsizeof($array); $size = $class->count($array); $class->delete($filepath); $class->unset($filepath); function delete() {} function unset() {} function sizeof() {} function count() {} trait DelProvider { public function delete() { //irrelevant } } class LeftSideTest { use DelProvider { delete as protected unsetter; } } class RightSideTest { use DelProvider { delete as delete; } } class RightSideVisTest { use DelProvider { delete as protected delete; delete insteadof delete; } } namespace Something\sizeof; $var = new Sizeof(); class SizeOf implements Something {} function mymodule_form_callback(SizeOf $sizeof) { } ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/ForbiddenFunctionsUnitTest.php0000644000076700000240000000373612647543456031551 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ForbiddenFunctions sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_PHP_ForbiddenFunctionsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { $errors = array( 2 => 1, 4 => 1, 6 => 1, ); return $errors; }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/LowerCaseConstantUnitTest.inc0000644000076700000240000000233412647543456031335 0ustar gsherwoodstaffNULL = 7; use Zend\Log\Writer\NULL as NullWriter; new \Zend\Log\Writer\NULL(); namespace False; class True extends Null implements False {} use True\Something; use Something\True; class MyClass { public function myFunction() { $var = array('foo' => new True()); } } $x = $f?FALSE:true; $x = $f? FALSE:true; class MyClass { // Spice things up a little. const TRUE = false; } var_dump(MyClass::TRUE); function tRUE() {} $input->getFilterChain()->attachByName('Null', ['type' => Null::TYPE_STRING]); PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/LowerCaseConstantUnitTest.inc.fixed0000644000076700000240000000233412647543456032433 0ustar gsherwoodstaffNULL = 7; use Zend\Log\Writer\NULL as NullWriter; new \Zend\Log\Writer\NULL(); namespace False; class True extends Null implements False {} use True\Something; use Something\True; class MyClass { public function myFunction() { $var = array('foo' => new True()); } } $x = $f?false:true; $x = $f? false:true; class MyClass { // Spice things up a little. const TRUE = false; } var_dump(MyClass::TRUE); function tRUE() {} $input->getFilterChain()->attachByName('Null', ['type' => Null::TYPE_STRING]); PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/LowerCaseConstantUnitTest.js0000644000076700000240000000045412647543456031201 0ustar gsherwoodstaffif (variable === true) { } if (variable === TRUE) { } if (variable === True) { } variable = True; if (variable === false) { } if (variable === FALSE) { } if (variable === False) { } variable = false; if (variable === null) { } if (variable === NULL) { } if (variable === Null) { } variable = NULL; PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/LowerCaseConstantUnitTest.js.fixed0000644000076700000240000000045412647543456032277 0ustar gsherwoodstaffif (variable === true) { } if (variable === true) { } if (variable === true) { } variable = true; if (variable === false) { } if (variable === false) { } if (variable === false) { } variable = false; if (variable === null) { } if (variable === null) { } if (variable === null) { } variable = null; PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/LowerCaseConstantUnitTest.php0000644000076700000240000000556712647543456031366 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the LowerCaseConstant sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_PHP_LowerCaseConstantUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='LowerCaseConstantUnitTest.inc') { switch ($testFile) { case 'LowerCaseConstantUnitTest.inc': return array( 7 => 1, 10 => 1, 15 => 1, 16 => 1, 23 => 1, 26 => 1, 31 => 1, 32 => 1, 39 => 1, 42 => 1, 47 => 1, 48 => 1, 70 => 1, 71 => 1, ); break; case 'LowerCaseConstantUnitTest.js': return array( 2 => 1, 3 => 1, 4 => 1, 7 => 1, 8 => 1, 12 => 1, 13 => 1, 14 => 1, ); break; default: return array(); break; } }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/LowerCaseKeywordUnitTest.inc0000644000076700000240000000105112647543456031163 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/LowerCaseKeywordUnitTest.inc.fixed0000644000076700000240000000105112647543456032261 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/LowerCaseKeywordUnitTest.php0000644000076700000240000000366312647543456031214 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the LowerCaseKeyword sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_PHP_LowerCaseKeywordUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 10 => 3, 11 => 4, 12 => 1, 13 => 3, 14 => 7, 15 => 1, 16 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/NoSilencedErrorsUnitTest.inc0000644000076700000240000000012512647543456031153 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/NoSilencedErrorsUnitTest.php0000644000076700000240000000343412647543456031177 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the NoSilencedErrors sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_PHP_NoSilencedErrorsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 5 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/SAPIUsageUnitTest.inc0000644000076700000240000000015512647543456027457 0ustar gsherwoodstaffphp_sapi_name() === true) {} PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/SAPIUsageUnitTest.php0000644000076700000240000000340712647543456027500 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the SAPIUsage sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_PHP_SAPIUsageUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/SyntaxUnitTest.inc0000644000076700000240000000002112647543456027214 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the Syntax sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Blaine Schmeisser * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_PHP_SyntaxUnitTest extends AbstractSniffUnitTest { /** * Should this test be skipped for some reason. * * @return void */ protected function shouldSkipTest() { $phpPath = PHP_CodeSniffer::getConfigData('php_path'); return (is_null($phpPath)); }//end shouldSkipTest() /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/UpperCaseConstantUnitTest.inc0000644000076700000240000000221212647543456031333 0ustar gsherwoodstaffnull = 7; use Zend\Log\Writer\Null as NullWriter; new \Zend\Log\Writer\Null() namespace False; class True extends Null implements False {} use True\Something; use Something\True; class MyClass { public function myFunction() { $var = array('foo' => new True()); } } $x = $f?false:TRUE; $x = $f? false:TRUE; class MyClass { // Spice things up a little. const true = FALSE; } var_dump(MyClass::true); function true() {}PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/UpperCaseConstantUnitTest.inc.fixed0000644000076700000240000000221212647543456032431 0ustar gsherwoodstaffnull = 7; use Zend\Log\Writer\Null as NullWriter; new \Zend\Log\Writer\Null() namespace False; class True extends Null implements False {} use True\Something; use Something\True; class MyClass { public function myFunction() { $var = array('foo' => new True()); } } $x = $f?FALSE:TRUE; $x = $f? FALSE:TRUE; class MyClass { // Spice things up a little. const true = FALSE; } var_dump(MyClass::true); function true() {}PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/PHP/UpperCaseConstantUnitTest.php0000644000076700000240000000431112647543456031353 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the UpperCaseConstant sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_PHP_UpperCaseConstantUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 7 => 1, 10 => 1, 15 => 1, 16 => 1, 23 => 1, 26 => 1, 31 => 1, 32 => 1, 39 => 1, 42 => 1, 47 => 1, 48 => 1, 70 => 1, 71 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Strings/UnnecessaryStringConcatUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Strings/UnnecessaryStringConcatUnitTest.in0000644000076700000240000000073412647543456033416 0ustar gsherwoodstaff'; $code = '<'.'?php '; $string = 'This is a really long string. ' . 'It is being used for errors. ' . 'The message is not translated.'; ?> ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Strings/UnnecessaryStringConcatUnitTest.jsPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Strings/UnnecessaryStringConcatUnitTest.js0000644000076700000240000000063712647543456033426 0ustar gsherwoodstaffvar x = 'My ' + 'string'; var x = 'My ' + 1234; var x = 'My ' + y + ' test'; this.errors['test'] = x; this.errors['test' + 10] = x; this.errors['test' + y] = x; this.errors['test' + 'blah'] = x; this.errors[y] = x; this.errors[y + z] = x; this.errors[y + z + 'My' + 'String'] = x; var long = 'This is a really long string. ' + 'It is being used for errors. ' + 'The message is not translated.'; ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Strings/UnnecessaryStringConcatUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/Strings/UnnecessaryStringConcatUnitTest.ph0000644000076700000240000000500012647543456033406 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the UnnecessaryStringConcat sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_Strings_UnnecessaryStringConcatUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='UnnecessaryStringConcatUnitTest.inc') { switch ($testFile) { case 'UnnecessaryStringConcatUnitTest.inc': return array( 2 => 1, 6 => 1, 9 => 1, 12 => 1, 19 => 1, 20 => 1, ); break; case 'UnnecessaryStringConcatUnitTest.js': return array( 1 => 1, 8 => 1, 11 => 1, 14 => 1, 15 => 1, ); break; default: return array(); break; } }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowSpaceIndentUnitTest.cssPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowSpaceIndentUnitTest.css0000644000076700000240000000007512647543456033257 0ustar gsherwoodstaff#login-container { margin-left: -225px; width: 450px; } ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowSpaceIndentUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowSpaceIndentUnitTest.inc0000644000076700000240000000165712647543456033247 0ustar gsherwoodstaff"; return "<$name$xmlns$type_str $atts xsi:nil=\"true\"/>"; // [space][space][space][tab]return "<$name$xmlns$type_str $atts xsi:nil=\"true\"/>"; return "<$name$xmlns$type_str $atts xsi:nil=\"true\"/>"; // Doc comments are indent with tabs and one space //[tab]/** //[tab][space]* /** * CVS revision for HTTP headers. * * @var string * @access private */ /** * */ $str = 'hello there'; /** * This PHP DocBlock should be fine, even though there is a single space at the beginning. * * @var int $x */ $x = 1; PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowSpaceIndentUnitTest.js0000644000076700000240000000011012647543456033071 0ustar gsherwoodstaffvar x = { abc: 1, zyz: 2, abc: 5, mno: { abc: 4 }, abc: 5 } ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowSpaceIndentUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowSpaceIndentUnitTest.php0000644000076700000240000000511312647543456033254 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowSpaceIndent sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_WhiteSpace_DisallowSpaceIndentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='DisallowSpaceIndentUnitTest.inc') { switch ($testFile) { case 'DisallowSpaceIndentUnitTest.inc': return array( 5 => 1, 9 => 1, 15 => 1, 18 => 1, 19 => 1, 24 => 1, 30 => 1, 35 => 1, ); break; case 'DisallowSpaceIndentUnitTest.js': return array( 3 => 1, ); break; case 'DisallowSpaceIndentUnitTest.css': return array( 2 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowTabIndentUnitTest.css0000644000076700000240000000007612647543456032733 0ustar gsherwoodstaff#login-container { margin-left: -225px; width: 450px; } ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowTabIndentUnitTest.css.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowTabIndentUnitTest.css.f0000644000076700000240000000010412647543456033147 0ustar gsherwoodstaff#login-container { margin-left: -225px; width: 450px; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowTabIndentUnitTest.inc0000644000076700000240000000070712647543456032715 0ustar gsherwoodstaff 'Czech republic', 'România' => 'Romania', 'Magyarország' => 'Hungary', ); $var = "$hello $there"; ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowTabIndentUnitTest.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowTabIndentUnitTest.inc.f0000644000076700000240000000076712647543456033147 0ustar gsherwoodstaff 'Czech republic', 'România' => 'Romania', 'Magyarország' => 'Hungary', ); $var = "$hello $there"; PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowTabIndentUnitTest.js0000644000076700000240000000011212647543456032546 0ustar gsherwoodstaffvar x = { abc: 1, zyz: 2, abc: 5, mno: { abc: 4 }, abc: 5 } ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowTabIndentUnitTest.js.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowTabIndentUnitTest.js.fi0000644000076700000240000000011712647543456033150 0ustar gsherwoodstaffvar x = { abc: 1, zyz: 2, abc: 5, mno: { abc: 4 }, abc: 5 } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/DisallowTabIndentUnitTest.php0000644000076700000240000000621312647543456032731 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowTabIndent sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_WhiteSpace_DisallowTabIndentUnitTest extends AbstractSniffUnitTest { /** * Get a list of CLI values to set befor the file is tested. * * @param string $testFile The name of the file being tested. * * @return array */ public function getCliValues($testFile) { return array('--tab-width=4', '--encoding=utf-8'); }//end getCliValues() /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='DisallowTabIndentUnitTest.inc') { switch ($testFile) { case 'DisallowTabIndentUnitTest.inc': return array( 5 => 2, 9 => 1, 15 => 1, 20 => 2, 21 => 1, 22 => 2, 23 => 1, 24 => 2, 31 => 1, 32 => 2, 33 => 2, ); break; case 'DisallowTabIndentUnitTest.js': return array( 3 => 1, 5 => 1, 6 => 1, ); break; case 'DisallowTabIndentUnitTest.css': return array( 1 => 1, 2 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/ScopeIndentUnitTest.1.inc0000644000076700000240000004212112647543456031714 0ustar gsherwoodstaff@codingStandardsChangeSetting Generic.WhiteSpace.ScopeIndent tabIndent false hello(); } function hello() { echo 'hello'; }//end hello() function hello2() { if (TRUE) { echo 'hello'; // no error here as its more than 4 spaces. } else { echo 'bye'; } while (TRUE) { echo 'hello'; } do { echo 'hello'; } while (TRUE); } function hello3() { switch ($hello) { case 'hello': break; } } } ?>


validate()) {
    $safe = $form->getSubmitValues();
}
?>
open(); // error here } public function open() { // Some inline stuff that shouldn't error if (TRUE) echo 'hello'; foreach ($tokens as $token) echo $token; } /** * This is a comment 1. * This is a comment 2. * This is a comment 3. * This is a comment 4. */ public function close() { // All ok. if (TRUE) { if (TRUE) { } else if (FALSE) { foreach ($tokens as $token) { switch ($token) { case '1': case '2': if (true) { if (false) { if (false) { if (false) { echo 'hello'; } } } } break; case '5': break; } do { while (true) { foreach ($tokens as $token) { for ($i = 0; $i < $token; $i++) { echo 'hello'; } } } } while (true); } } } } /* This is another c style comment 1. This is another c style comment 2. This is another c style comment 3. This is another c style comment 4. This is another c style comment 5. */ /* This is a T_COMMENT * * * */ /** This is a T_DOC_COMMENT */ /* This T_COMMENT has a newline in it. */ public function read() { echo 'hello'; // no errors below. $array = array( 'this', 'that' => array( 'hello', 'hello again' => array( 'hello', ), ), ); } } abstract class Test3 { public function parse() { foreach ($t as $ndx => $token) { if (is_array($token)) { echo 'here'; } else { $ts[] = array("token" => $token, "value" => ''); $last = count($ts) - 1; switch ($token) { case '(': if ($last >= 3 && $ts[0]['token'] != T_CLASS && $ts[$last - 2]['token'] == T_OBJECT_OPERATOR && $ts[$last - 3]['token'] == T_VARIABLE ) { if (true) { echo 'hello'; } } array_push($braces, $token); break; } } } } } public function test() { $o = << doSomething( function () { echo 123; } ); } } some_function( function() { $a = 403; if ($a === 404) { $a = 403; } } ); some_function( function() { $a = 403; if ($a === 404) { $a = 403; } } ); $myFunction = function() { $a = 403; if ($a === 404) { $a = 403; } } class Whatever { protected $_protectedArray = array( 'normalString' => 'That email address is already in use!', 'offendingString' => <<<'STRING' Each line of this string is always said to be at column 0, no matter how many spaces are placed at the beginning of each line and the ending STRING on the next line is reported as having to be indented. STRING ); } class MyClass { public static function myFunction() { if (empty($keywords) === FALSE) { $keywords = 'foo'; $existing = 'foo'; } return $keywords; }//end myFunction() }//end class $var = call_user_func( $new_var = function () use (&$a) { if ($a > 0) { return $a++; } else { return $a--; } } ); class AnonymousFn { public function getAnonFn() { return array( 'functions' => Array( 'function1' => function ($a, $b, $c) { $a = $b + $c; $b = $c / 2; return Array($a, $b, $c); }, ), ); } } ?>
"") { $test = true; } else { $test = true; } } ?>

some text

function ($a) { if ($a === true) { echo 'hi'; } } ]; $list = [ 'fn' => function ($a) { if ($a === true) { echo 'hi'; } } ]; if ($foo) { foreach ($bar as $baz) { if ($baz) { ?>
1) { echo '1'; } ?>
1) { echo '1'; } ?>
1) { echo '1'; } ?>
<?= CHtml::encode($this->pageTitle); ?> expects($this->at(2)) ->with($this->callback( function ($subject) { } ) ); /** @var Database $mockedDatabase */ /** @var Container $mockedContainer */ echo $string->append('foo') ->appaend('bar') ->appaend('baz') ->outputUsing( function () { } ); echo PHP_EOL; switch ($arg) { case 1: break; case 2: if ($arg2 == 'foo') { } case 3: default: echo 'default'; } if ($tokens[$stackPtr]['content']{0} === '#') { } else if ($tokens[$stackPtr]['content']{0} === '/' && $tokens[$stackPtr]['content']{1} === '/' ) { } $var = call_user_func( function() { if ($foo) { $new_var = function() { if ($a > 0) { return $a++; } else { return $a--; } } } } ); a( function() { $a = function() { $b = false; }; true } ); $var = [ [ '1' => function () { return true; }, ], [ '1' => function () { return true; }, '2' => true, ] ]; if ($foo) { ?>

self::_replaceKeywords($failingComment, $result), 'screenshot' => Test::getScreenshotPath( $projectid, $result['class_name'], ), ); } $this->mockedDatabase ->with( $this->callback( function () { return; } ) ); $this->subject->recordLogin(); function a() { if (true) { static::$a[$b] = static::where($c) ->where($c) ->where( function ($d) { $d->whereNull(); $d->orWhere(); } ) ->first(); if (static::$a[$b] === null) { static::$a[$b] = new static( array( 'a' => $a->id, 'a' => $a->id, ) ); } } return static::$a[$b]; } $foo->load( array( 'bar' => function ($baz) { $baz->call(); } ) ); hello(); $foo = array_unique( array_map( function ($entry) { return $entry * 2; }, array() ) ); bar($foo); class PHP_CodeSniffer_Tokenizers_JS { public $scopeOpeners = array( T_CASE => array( 'end' => array( T_BREAK => T_BREAK, T_RETURN => T_RETURN, ), 'strict' => true, ), ); } echo $string-> append('foo')-> appaend('bar')-> appaend('baz')-> outputUsing( function () { } ); $str = 'the items I want to show are: ' . implode( ', ', array('a', 'b', 'c') ); echo $str; $str = 'foo' . '1' . '2'; echo $str; bar([ 'foo' => foo(function () { return 'foo'; }) ]); $domains = array_unique( array_map( function ($url) { $urlObject = new \Purl\Url($url); return $urlObject->registerableDomain; }, $sites ) ); return $domains; if ($a == 5) : echo "a equals 5"; echo "..."; elseif ($a == 6) : echo "a equals 6"; echo "!!!"; else : echo "a is neither 5 nor 6"; endif; if ($foo): if ($bar) $foo = 1; elseif ($baz) $foo = 2; endif; $this ->method(array( 'foo' => 'bar', ), 'arg', array( 'foo' => 'bar', )); class Foo { use Bar { myMethod as renamedMethod; } } class Foo { use Bar { myMethod as renamedMethod; } } foo(); array( 'key1' => function ($bar) { return $bar; }, 'key2' => function ($foo) { return $foo; }, ); ?> 1, ]; $c = 2; class foo { public function get() { $foo = ['b' => 'c', 'd' => [ ['e' => 'f'] ]]; echo '42'; $foo = array('b' => 'c', 'd' => array( array('e' => 'f') )); echo '42'; } } switch ($foo) { case 1: return array(); case 2: return ''; case 3: return $function(); case 4: return $functionCall($param[0]); case 5: return array() + array(); // Array Merge case 6: // String connect return $functionReturningString('') . $functionReturningString(array()); case 7: return functionCall( $withMultiLineParam[0], array(), $functionReturningString( $withMultiLineParam[1] ) ); case 8: return $param[0][0]; } class Test { public $foo ,$bar ,$baz = [ ] ; public function wtfindent() { } } switch ($x) { case 1: return [1]; default: return [2]; } switch ($foo) { case self::FOO: return $this->bar($gfoo, function ($id) { return FOO::bar($id); }, $values); case self::BAR: $values = $this->bar($foo, $values); break; } $var = array( 'long description' => array(0, 'something'), 'another long description' => array(1, "something else") ); $services = array( 'service 1' => Mockery::mock('class 1') ->shouldReceive('setFilter')->once() ->shouldReceive('getNbResults')->atLeast()->once() ->shouldReceive('getSlice')->once()->andReturn(array()) ->getMock(), 'service 2' => Mockery::mock('class 2') ->shouldReceive('__invoke')->once() ->getMock() ); function foo() { $foo = array( ); if ($foo) { echo 'foo'; } return false; } /* $a = array( */ ); echo "" ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/ScopeIndentUnitTest.1.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/ScopeIndentUnitTest.1.inc.fixed0000644000076700000240000004217212647543456033020 0ustar gsherwoodstaff@codingStandardsChangeSetting Generic.WhiteSpace.ScopeIndent tabIndent false hello(); } function hello() { echo 'hello'; }//end hello() function hello2() { if (TRUE) { echo 'hello'; // no error here as its more than 4 spaces. } else { echo 'bye'; } while (TRUE) { echo 'hello'; } do { echo 'hello'; } while (TRUE); } function hello3() { switch ($hello) { case 'hello': break; } } } ?>


validate()) {
    $safe = $form->getSubmitValues();
}
?>
open(); // error here } public function open() { // Some inline stuff that shouldn't error if (TRUE) echo 'hello'; foreach ($tokens as $token) echo $token; } /** * This is a comment 1. * This is a comment 2. * This is a comment 3. * This is a comment 4. */ public function close() { // All ok. if (TRUE) { if (TRUE) { } else if (FALSE) { foreach ($tokens as $token) { switch ($token) { case '1': case '2': if (true) { if (false) { if (false) { if (false) { echo 'hello'; } } } } break; case '5': break; } do { while (true) { foreach ($tokens as $token) { for ($i = 0; $i < $token; $i++) { echo 'hello'; } } } } while (true); } } } } /* This is another c style comment 1. This is another c style comment 2. This is another c style comment 3. This is another c style comment 4. This is another c style comment 5. */ /* This is a T_COMMENT * * * */ /** This is a T_DOC_COMMENT */ /* This T_COMMENT has a newline in it. */ public function read() { echo 'hello'; // no errors below. $array = array( 'this', 'that' => array( 'hello', 'hello again' => array( 'hello', ), ), ); } } abstract class Test3 { public function parse() { foreach ($t as $ndx => $token) { if (is_array($token)) { echo 'here'; } else { $ts[] = array("token" => $token, "value" => ''); $last = count($ts) - 1; switch ($token) { case '(': if ($last >= 3 && $ts[0]['token'] != T_CLASS && $ts[$last - 2]['token'] == T_OBJECT_OPERATOR && $ts[$last - 3]['token'] == T_VARIABLE ) { if (true) { echo 'hello'; } } array_push($braces, $token); break; } } } } } public function test() { $o = << doSomething( function () { echo 123; } ); } } some_function( function() { $a = 403; if ($a === 404) { $a = 403; } } ); some_function( function() { $a = 403; if ($a === 404) { $a = 403; } } ); $myFunction = function() { $a = 403; if ($a === 404) { $a = 403; } } class Whatever { protected $_protectedArray = array( 'normalString' => 'That email address is already in use!', 'offendingString' => <<<'STRING' Each line of this string is always said to be at column 0, no matter how many spaces are placed at the beginning of each line and the ending STRING on the next line is reported as having to be indented. STRING ); } class MyClass { public static function myFunction() { if (empty($keywords) === FALSE) { $keywords = 'foo'; $existing = 'foo'; } return $keywords; }//end myFunction() }//end class $var = call_user_func( $new_var = function () use (&$a) { if ($a > 0) { return $a++; } else { return $a--; } } ); class AnonymousFn { public function getAnonFn() { return array( 'functions' => Array( 'function1' => function ($a, $b, $c) { $a = $b + $c; $b = $c / 2; return Array($a, $b, $c); }, ), ); } } ?>
"") { $test = true; } else { $test = true; } } ?>

some text

function ($a) { if ($a === true) { echo 'hi'; } } ]; $list = [ 'fn' => function ($a) { if ($a === true) { echo 'hi'; } } ]; if ($foo) { foreach ($bar as $baz) { if ($baz) { ?>
1) { echo '1'; } ?>
1) { echo '1'; } ?>
1) { echo '1'; } ?>
<?= CHtml::encode($this->pageTitle); ?> expects($this->at(2)) ->with($this->callback( function ($subject) { } ) ); /** @var Database $mockedDatabase */ /** @var Container $mockedContainer */ echo $string->append('foo') ->appaend('bar') ->appaend('baz') ->outputUsing( function () { } ); echo PHP_EOL; switch ($arg) { case 1: break; case 2: if ($arg2 == 'foo') { } case 3: default: echo 'default'; } if ($tokens[$stackPtr]['content']{0} === '#') { } else if ($tokens[$stackPtr]['content']{0} === '/' && $tokens[$stackPtr]['content']{1} === '/' ) { } $var = call_user_func( function() { if ($foo) { $new_var = function() { if ($a > 0) { return $a++; } else { return $a--; } } } } ); a( function() { $a = function() { $b = false; }; true } ); $var = [ [ '1' => function () { return true; }, ], [ '1' => function () { return true; }, '2' => true, ] ]; if ($foo) { ?>

self::_replaceKeywords($failingComment, $result), 'screenshot' => Test::getScreenshotPath( $projectid, $result['class_name'], ), ); } $this->mockedDatabase ->with( $this->callback( function () { return; } ) ); $this->subject->recordLogin(); function a() { if (true) { static::$a[$b] = static::where($c) ->where($c) ->where( function ($d) { $d->whereNull(); $d->orWhere(); } ) ->first(); if (static::$a[$b] === null) { static::$a[$b] = new static( array( 'a' => $a->id, 'a' => $a->id, ) ); } } return static::$a[$b]; } $foo->load( array( 'bar' => function ($baz) { $baz->call(); } ) ); hello(); $foo = array_unique( array_map( function ($entry) { return $entry * 2; }, array() ) ); bar($foo); class PHP_CodeSniffer_Tokenizers_JS { public $scopeOpeners = array( T_CASE => array( 'end' => array( T_BREAK => T_BREAK, T_RETURN => T_RETURN, ), 'strict' => true, ), ); } echo $string-> append('foo')-> appaend('bar')-> appaend('baz')-> outputUsing( function () { } ); $str = 'the items I want to show are: ' . implode( ', ', array('a', 'b', 'c') ); echo $str; $str = 'foo' . '1' . '2'; echo $str; bar([ 'foo' => foo(function () { return 'foo'; }) ]); $domains = array_unique( array_map( function ($url) { $urlObject = new \Purl\Url($url); return $urlObject->registerableDomain; }, $sites ) ); return $domains; if ($a == 5) : echo "a equals 5"; echo "..."; elseif ($a == 6) : echo "a equals 6"; echo "!!!"; else : echo "a is neither 5 nor 6"; endif; if ($foo): if ($bar) $foo = 1; elseif ($baz) $foo = 2; endif; $this ->method(array( 'foo' => 'bar', ), 'arg', array( 'foo' => 'bar', )); class Foo { use Bar { myMethod as renamedMethod; } } class Foo { use Bar { myMethod as renamedMethod; } } foo(); array( 'key1' => function ($bar) { return $bar; }, 'key2' => function ($foo) { return $foo; }, ); ?> 1, ]; $c = 2; class foo { public function get() { $foo = ['b' => 'c', 'd' => [ ['e' => 'f'] ]]; echo '42'; $foo = array('b' => 'c', 'd' => array( array('e' => 'f') )); echo '42'; } } switch ($foo) { case 1: return array(); case 2: return ''; case 3: return $function(); case 4: return $functionCall($param[0]); case 5: return array() + array(); // Array Merge case 6: // String connect return $functionReturningString('') . $functionReturningString(array()); case 7: return functionCall( $withMultiLineParam[0], array(), $functionReturningString( $withMultiLineParam[1] ) ); case 8: return $param[0][0]; } class Test { public $foo ,$bar ,$baz = [ ] ; public function wtfindent() { } } switch ($x) { case 1: return [1]; default: return [2]; } switch ($foo) { case self::FOO: return $this->bar($gfoo, function ($id) { return FOO::bar($id); }, $values); case self::BAR: $values = $this->bar($foo, $values); break; } $var = array( 'long description' => array(0, 'something'), 'another long description' => array(1, "something else") ); $services = array( 'service 1' => Mockery::mock('class 1') ->shouldReceive('setFilter')->once() ->shouldReceive('getNbResults')->atLeast()->once() ->shouldReceive('getSlice')->once()->andReturn(array()) ->getMock(), 'service 2' => Mockery::mock('class 2') ->shouldReceive('__invoke')->once() ->getMock() ); function foo() { $foo = array( ); if ($foo) { echo 'foo'; } return false; } /* $a = array( */ ); echo "" PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/ScopeIndentUnitTest.1.js0000644000076700000240000000645512647543456031571 0ustar gsherwoodstaff@codingStandardsChangeSetting Generic.WhiteSpace.ScopeIndent tabIndent false var script = document.createElement('script'); script.onload = function() { clearTimeout(t); script456.onload = null; script.onreadystatechange = null; callback.call(this); }; this.callbacks[type] = { namespaces: {}, others: [] }; blah = function() { print something; } test(blah, function() { print something; }); var test = [{x: 10}]; var test = [{ x: 10, y: { b14h: 12, 'b14h': 12 }, z: 23 }]; Viper.prototype = { _removeEvents: function(elem) { if (!elem) { elem = this.element; } ViperUtil.removeEvent(elem, '.' + this.getEventNamespace()); } }; this.init = function(data) { if (_pageListWdgt) { GUI.getWidget('changedPagesList').addItemClickedCallback( function(itemid, target) { draftChangeTypeClicked( itemid, target, { reviewData: _reviewData, pageid: itemid } ); } ); }//end if }; a( function() { var _a = function() { b = false; }; true } ); (function() { a = function() { a(function() { if (true) { a = true; } }); a( function() { if (true) { if (true) { a = true; } } } ); a( function() { if (true) { a = true; } } ); }; })(); a.prototype = { a: function() { var currentSize = null; ViperUtil.addEvent( header, 'safedblclick', function() {}, ); if (topContent) { ViperUtil.addClass(topContent, 'Viper-popup-top'); main.appendChild(topContent); } ViperUtil.addClass(midContent, 'Viper-popup-content'); main.appendChild(midContent); } }; a.prototype = { a: function() { ViperUtil.addClass(midContent, 'Viper-popup-content'); main.appendChild(midContent); var mouseUpAction = function() {}; var preventMouseUp = false; var self = this; if (clickAction) { } } }; a.prototype = { a: function() { var a = function() { var a = 'foo'; }; if (true) { } }, b: function() { ViperUtil.addEvent( function() { if (fullScreen !== true) { currentSize = { }; showfullScreen(); } } ); }, c: function() { this.a( { a: function() { form.onsubmit = function() { return false; }; var a = true; } } ); } }; a.prototype = { init: function() {}, _b: function() { } }; for (var i = 0; i < 10; i++) { var foo = {foo:{'a':'b', 'c':'d'}}; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/ScopeIndentUnitTest.1.js.fixed0000644000076700000240000000652612647543456032666 0ustar gsherwoodstaff@codingStandardsChangeSetting Generic.WhiteSpace.ScopeIndent tabIndent false var script = document.createElement('script'); script.onload = function() { clearTimeout(t); script456.onload = null; script.onreadystatechange = null; callback.call(this); }; this.callbacks[type] = { namespaces: {}, others: [] }; blah = function() { print something; } test(blah, function() { print something; }); var test = [{x: 10}]; var test = [{ x: 10, y: { b14h: 12, 'b14h': 12 }, z: 23 }]; Viper.prototype = { _removeEvents: function(elem) { if (!elem) { elem = this.element; } ViperUtil.removeEvent(elem, '.' + this.getEventNamespace()); } }; this.init = function(data) { if (_pageListWdgt) { GUI.getWidget('changedPagesList').addItemClickedCallback( function(itemid, target) { draftChangeTypeClicked( itemid, target, { reviewData: _reviewData, pageid: itemid } ); } ); }//end if }; a( function() { var _a = function() { b = false; }; true } ); (function() { a = function() { a(function() { if (true) { a = true; } }); a( function() { if (true) { if (true) { a = true; } } } ); a( function() { if (true) { a = true; } } ); }; })(); a.prototype = { a: function() { var currentSize = null; ViperUtil.addEvent( header, 'safedblclick', function() {}, ); if (topContent) { ViperUtil.addClass(topContent, 'Viper-popup-top'); main.appendChild(topContent); } ViperUtil.addClass(midContent, 'Viper-popup-content'); main.appendChild(midContent); } }; a.prototype = { a: function() { ViperUtil.addClass(midContent, 'Viper-popup-content'); main.appendChild(midContent); var mouseUpAction = function() {}; var preventMouseUp = false; var self = this; if (clickAction) { } } }; a.prototype = { a: function() { var a = function() { var a = 'foo'; }; if (true) { } }, b: function() { ViperUtil.addEvent( function() { if (fullScreen !== true) { currentSize = { }; showfullScreen(); } } ); }, c: function() { this.a( { a: function() { form.onsubmit = function() { return false; }; var a = true; } } ); } }; a.prototype = { init: function() {}, _b: function() { } }; for (var i = 0; i < 10; i++) { var foo = {foo:{'a':'b', 'c':'d'}}; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/ScopeIndentUnitTest.2.inc0000644000076700000240000003105712647543456031723 0ustar gsherwoodstaff@codingStandardsChangeSetting Generic.WhiteSpace.ScopeIndent tabIndent true hello(); } function hello() { echo 'hello'; }//end hello() function hello2() { if (TRUE) { echo 'hello'; // no error here as its more than 4 spaces. } else { echo 'bye'; } while (TRUE) { echo 'hello'; } do { echo 'hello'; } while (TRUE); } function hello3() { switch ($hello) { case 'hello': break; } } } ?>


validate()) {
	$safe = $form->getSubmitValues();
}
?>
open(); // error here } public function open() { // Some inline stuff that shouldn't error if (TRUE) echo 'hello'; foreach ($tokens as $token) echo $token; } /** * This is a comment 1. * This is a comment 2. * This is a comment 3. * This is a comment 4. */ public function close() { // All ok. if (TRUE) { if (TRUE) { } else if (FALSE) { foreach ($tokens as $token) { switch ($token) { case '1': case '2': if (true) { if (false) { if (false) { if (false) { echo 'hello'; } } } } break; case '5': break; } do { while (true) { foreach ($tokens as $token) { for ($i = 0; $i < $token; $i++) { echo 'hello'; } } } } while (true); } } } } /* This is another c style comment 1. This is another c style comment 2. This is another c style comment 3. This is another c style comment 4. This is another c style comment 5. */ /* This is a T_COMMENT * * * */ /** This is a T_DOC_COMMENT */ /* This T_COMMENT has a newline in it. */ public function read() { echo 'hello'; // no errors below. $array = array( 'this', 'that' => array( 'hello', 'hello again' => array( 'hello', ), ), ); } } abstract class Test3 { public function parse() { foreach ($t as $ndx => $token) { if (is_array($token)) { echo 'here'; } else { $ts[] = array("token" => $token, "value" => ''); $last = count($ts) - 1; switch ($token) { case '(': if ($last >= 3 && $ts[0]['token'] != T_CLASS && $ts[$last - 2]['token'] == T_OBJECT_OPERATOR && $ts[$last - 3]['token'] == T_VARIABLE ) { if (true) { echo 'hello'; } } array_push($braces, $token); break; } } } } } public function test() { $o = << doSomething( function () { echo 123; } ); } } some_function( function() { $a = 403; if ($a === 404) { $a = 403; } } ); some_function( function() { $a = 403; if ($a === 404) { $a = 403; } } ); $myFunction = function() { $a = 403; if ($a === 404) { $a = 403; } } class Whatever { protected $_protectedArray = array( 'normalString' => 'That email address is already in use!', 'offendingString' => <<<'STRING' Each line of this string is always said to be at column 0, no matter how many spaces are placed at the beginning of each line and the ending STRING on the next line is reported as having to be indented. STRING ); } class MyClass { public static function myFunction() { if (empty($keywords) === FALSE) { $keywords = 'foo'; $existing = 'foo'; } return $keywords; }//end myFunction() }//end class $var = call_user_func( $new_var = function () use (&$a) { if ($a > 0) { return $a++; } else { return $a--; } } ); class AnonymousFn { public function getAnonFn() { return array( 'functions' => Array( 'function1' => function ($a, $b, $c) { $a = $b + $c; $b = $c / 2; return Array($a, $b, $c); }, ), ); } } ?>
"") { $test = true; } else { $test = true; } } ?>

some text

function ($a) { if ($a === true) { echo 'hi'; } } ]; $list = [ 'fn' => function ($a) { if ($a === true) { echo 'hi'; } } ]; if ($foo) { foreach ($bar as $baz) { if ($baz) { ?>
1) { echo '1'; } ?>
1) { echo '1'; } ?>
1) { echo '1'; } ?>
<?= CHtml::encode($this->pageTitle); ?> expects($this->at(2)) ->with($this->callback( function ($subject) { } ) ); /** @var Database $mockedDatabase */ /** @var Container $mockedContainer */ echo $string->append('foo') ->appaend('bar') ->appaend('baz') ->outputUsing( function () { } ); echo PHP_EOL; switch ($arg) { case 1: break; case 2: if ($arg2 == 'foo') { } case 3: default: echo 'default'; } if ($tokens[$stackPtr]['content']{0} === '#') { } else if ($tokens[$stackPtr]['content']{0} === '/' && $tokens[$stackPtr]['content']{1} === '/' ) { } $var = call_user_func( function() { if ($foo) { $new_var = function() { if ($a > 0) { return $a++; } else { return $a--; } } } } ); a( function() { $a = function() { $b = false; }; true } ); $var = [ [ '1' => function () { return true; }, ], [ '1' => function () { return true; }, '2' => true, ] ]; if ($foo) { ?>

self::_replaceKeywords($failingComment, $result), 'screenshot' => Test::getScreenshotPath( $projectid, $result['class_name'], ), ); } $this->mockedDatabase ->with( $this->callback( function () { return; } ) ); $this->subject->recordLogin(); function a() { if (true) { static::$a[$b] = static::where($c) ->where($c) ->where( function ($d) { $d->whereNull(); $d->orWhere(); } ) ->first(); if (static::$a[$b] === null) { static::$a[$b] = new static( array( 'a' => $a->id, 'a' => $a->id, ) ); } } return static::$a[$b]; } $foo->load( array( 'bar' => function ($baz) { $baz->call(); } ) ); hello(); $foo = array_unique( array_map( function ($entry) { return $entry * 2; }, array() ) ); bar($foo); class PHP_CodeSniffer_Tokenizers_JS { public $scopeOpeners = array( T_CASE => array( 'end' => array( T_BREAK => T_BREAK, T_RETURN => T_RETURN, ), 'strict' => true, ), ); } echo $string-> append('foo')-> appaend('bar')-> appaend('baz')-> outputUsing( function () { } ); $str = 'the items I want to show are: ' . implode( ', ', array('a', 'b', 'c') ); echo $str; $str = 'foo' . '1' . '2'; echo $str; bar([ 'foo' => foo(function () { return 'foo'; }) ]); $domains = array_unique( array_map( function ($url) { $urlObject = new \Purl\Url($url); return $urlObject->registerableDomain; }, $sites ) ); return $domains; if ($a == 5) : echo "a equals 5"; echo "..."; elseif ($a == 6) : echo "a equals 6"; echo "!!!"; else : echo "a is neither 5 nor 6"; endif; if ($foo): if ($bar) $foo = 1; elseif ($baz) $foo = 2; endif; $this ->method(array( 'foo' => 'bar', ), 'arg', array( 'foo' => 'bar', )); class Foo { use Bar { myMethod as renamedMethod; } } class Foo { use Bar { myMethod as renamedMethod; } } foo(); array( 'key1' => function ($bar) { return $bar; }, 'key2' => function ($foo) { return $foo; }, ); ?> 1, ]; $c = 2; class foo { public function get() { $foo = ['b' => 'c', 'd' => [ ['e' => 'f'] ]]; echo '42'; $foo = array('b' => 'c', 'd' => array( array('e' => 'f') )); echo '42'; } } switch ($foo) { case 1: return array(); case 2: return ''; case 3: return $function(); case 4: return $functionCall($param[0]); case 5: return array() + array(); // Array Merge case 6: // String connect return $functionReturningString('') . $functionReturningString(array()); case 7: return functionCall( $withMultiLineParam[0], array(), $functionReturningString( $withMultiLineParam[1] ) ); case 8: return $param[0][0]; } class Test { public $foo ,$bar ,$baz = [ ] ; public function wtfindent() { } } switch ($x) { case 1: return [1]; default: return [2]; } switch ($foo) { case self::FOO: return $this->bar($gfoo, function ($id) { return FOO::bar($id); }, $values); case self::BAR: $values = $this->bar($foo, $values); break; } $var = array( 'long description' => array(0, 'something'), 'another long description' => array(1, "something else") ); $services = array( 'service 1' => Mockery::mock('class 1') ->shouldReceive('setFilter')->once() ->shouldReceive('getNbResults')->atLeast()->once() ->shouldReceive('getSlice')->once()->andReturn(array()) ->getMock(), 'service 2' => Mockery::mock('class 2') ->shouldReceive('__invoke')->once() ->getMock() ); function foo() { $foo = array( ); if ($foo) { echo 'foo'; } return false; } /* $a = array( */ ); echo "" ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/ScopeIndentUnitTest.2.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/ScopeIndentUnitTest.2.inc.fixed0000644000076700000240000003100612647543456033013 0ustar gsherwoodstaff@codingStandardsChangeSetting Generic.WhiteSpace.ScopeIndent tabIndent true hello(); } function hello() { echo 'hello'; }//end hello() function hello2() { if (TRUE) { echo 'hello'; // no error here as its more than 4 spaces. } else { echo 'bye'; } while (TRUE) { echo 'hello'; } do { echo 'hello'; } while (TRUE); } function hello3() { switch ($hello) { case 'hello': break; } } } ?>


validate()) {
	$safe = $form->getSubmitValues();
}
?>
open(); // error here } public function open() { // Some inline stuff that shouldn't error if (TRUE) echo 'hello'; foreach ($tokens as $token) echo $token; } /** * This is a comment 1. * This is a comment 2. * This is a comment 3. * This is a comment 4. */ public function close() { // All ok. if (TRUE) { if (TRUE) { } else if (FALSE) { foreach ($tokens as $token) { switch ($token) { case '1': case '2': if (true) { if (false) { if (false) { if (false) { echo 'hello'; } } } } break; case '5': break; } do { while (true) { foreach ($tokens as $token) { for ($i = 0; $i < $token; $i++) { echo 'hello'; } } } } while (true); } } } } /* This is another c style comment 1. This is another c style comment 2. This is another c style comment 3. This is another c style comment 4. This is another c style comment 5. */ /* This is a T_COMMENT * * * */ /** This is a T_DOC_COMMENT */ /* This T_COMMENT has a newline in it. */ public function read() { echo 'hello'; // no errors below. $array = array( 'this', 'that' => array( 'hello', 'hello again' => array( 'hello', ), ), ); } } abstract class Test3 { public function parse() { foreach ($t as $ndx => $token) { if (is_array($token)) { echo 'here'; } else { $ts[] = array("token" => $token, "value" => ''); $last = count($ts) - 1; switch ($token) { case '(': if ($last >= 3 && $ts[0]['token'] != T_CLASS && $ts[$last - 2]['token'] == T_OBJECT_OPERATOR && $ts[$last - 3]['token'] == T_VARIABLE ) { if (true) { echo 'hello'; } } array_push($braces, $token); break; } } } } } public function test() { $o = << doSomething( function () { echo 123; } ); } } some_function( function() { $a = 403; if ($a === 404) { $a = 403; } } ); some_function( function() { $a = 403; if ($a === 404) { $a = 403; } } ); $myFunction = function() { $a = 403; if ($a === 404) { $a = 403; } } class Whatever { protected $_protectedArray = array( 'normalString' => 'That email address is already in use!', 'offendingString' => <<<'STRING' Each line of this string is always said to be at column 0, no matter how many spaces are placed at the beginning of each line and the ending STRING on the next line is reported as having to be indented. STRING ); } class MyClass { public static function myFunction() { if (empty($keywords) === FALSE) { $keywords = 'foo'; $existing = 'foo'; } return $keywords; }//end myFunction() }//end class $var = call_user_func( $new_var = function () use (&$a) { if ($a > 0) { return $a++; } else { return $a--; } } ); class AnonymousFn { public function getAnonFn() { return array( 'functions' => Array( 'function1' => function ($a, $b, $c) { $a = $b + $c; $b = $c / 2; return Array($a, $b, $c); }, ), ); } } ?>
"") { $test = true; } else { $test = true; } } ?>

some text

function ($a) { if ($a === true) { echo 'hi'; } } ]; $list = [ 'fn' => function ($a) { if ($a === true) { echo 'hi'; } } ]; if ($foo) { foreach ($bar as $baz) { if ($baz) { ?>
1) { echo '1'; } ?>
1) { echo '1'; } ?>
1) { echo '1'; } ?>
<?= CHtml::encode($this->pageTitle); ?> expects($this->at(2)) ->with($this->callback( function ($subject) { } ) ); /** @var Database $mockedDatabase */ /** @var Container $mockedContainer */ echo $string->append('foo') ->appaend('bar') ->appaend('baz') ->outputUsing( function () { } ); echo PHP_EOL; switch ($arg) { case 1: break; case 2: if ($arg2 == 'foo') { } case 3: default: echo 'default'; } if ($tokens[$stackPtr]['content']{0} === '#') { } else if ($tokens[$stackPtr]['content']{0} === '/' && $tokens[$stackPtr]['content']{1} === '/' ) { } $var = call_user_func( function() { if ($foo) { $new_var = function() { if ($a > 0) { return $a++; } else { return $a--; } } } } ); a( function() { $a = function() { $b = false; }; true } ); $var = [ [ '1' => function () { return true; }, ], [ '1' => function () { return true; }, '2' => true, ] ]; if ($foo) { ?>

self::_replaceKeywords($failingComment, $result), 'screenshot' => Test::getScreenshotPath( $projectid, $result['class_name'], ), ); } $this->mockedDatabase ->with( $this->callback( function () { return; } ) ); $this->subject->recordLogin(); function a() { if (true) { static::$a[$b] = static::where($c) ->where($c) ->where( function ($d) { $d->whereNull(); $d->orWhere(); } ) ->first(); if (static::$a[$b] === null) { static::$a[$b] = new static( array( 'a' => $a->id, 'a' => $a->id, ) ); } } return static::$a[$b]; } $foo->load( array( 'bar' => function ($baz) { $baz->call(); } ) ); hello(); $foo = array_unique( array_map( function ($entry) { return $entry * 2; }, array() ) ); bar($foo); class PHP_CodeSniffer_Tokenizers_JS { public $scopeOpeners = array( T_CASE => array( 'end' => array( T_BREAK => T_BREAK, T_RETURN => T_RETURN, ), 'strict' => true, ), ); } echo $string-> append('foo')-> appaend('bar')-> appaend('baz')-> outputUsing( function () { } ); $str = 'the items I want to show are: ' . implode( ', ', array('a', 'b', 'c') ); echo $str; $str = 'foo' . '1' . '2'; echo $str; bar([ 'foo' => foo(function () { return 'foo'; }) ]); $domains = array_unique( array_map( function ($url) { $urlObject = new \Purl\Url($url); return $urlObject->registerableDomain; }, $sites ) ); return $domains; if ($a == 5) : echo "a equals 5"; echo "..."; elseif ($a == 6) : echo "a equals 6"; echo "!!!"; else : echo "a is neither 5 nor 6"; endif; if ($foo): if ($bar) $foo = 1; elseif ($baz) $foo = 2; endif; $this ->method(array( 'foo' => 'bar', ), 'arg', array( 'foo' => 'bar', )); class Foo { use Bar { myMethod as renamedMethod; } } class Foo { use Bar { myMethod as renamedMethod; } } foo(); array( 'key1' => function ($bar) { return $bar; }, 'key2' => function ($foo) { return $foo; }, ); ?> 1, ]; $c = 2; class foo { public function get() { $foo = ['b' => 'c', 'd' => [ ['e' => 'f'] ]]; echo '42'; $foo = array('b' => 'c', 'd' => array( array('e' => 'f') )); echo '42'; } } switch ($foo) { case 1: return array(); case 2: return ''; case 3: return $function(); case 4: return $functionCall($param[0]); case 5: return array() + array(); // Array Merge case 6: // String connect return $functionReturningString('') . $functionReturningString(array()); case 7: return functionCall( $withMultiLineParam[0], array(), $functionReturningString( $withMultiLineParam[1] ) ); case 8: return $param[0][0]; } class Test { public $foo ,$bar ,$baz = [ ] ; public function wtfindent() { } } switch ($x) { case 1: return [1]; default: return [2]; } switch ($foo) { case self::FOO: return $this->bar($gfoo, function ($id) { return FOO::bar($id); }, $values); case self::BAR: $values = $this->bar($foo, $values); break; } $var = array( 'long description' => array(0, 'something'), 'another long description' => array(1, "something else") ); $services = array( 'service 1' => Mockery::mock('class 1') ->shouldReceive('setFilter')->once() ->shouldReceive('getNbResults')->atLeast()->once() ->shouldReceive('getSlice')->once()->andReturn(array()) ->getMock(), 'service 2' => Mockery::mock('class 2') ->shouldReceive('__invoke')->once() ->getMock() ); function foo() { $foo = array( ); if ($foo) { echo 'foo'; } return false; } /* $a = array( */ ); echo "" PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/Tests/WhiteSpace/ScopeIndentUnitTest.3.inc0000644000076700000240000000054312647543456031720 0ustar gsherwoodstaff@codingStandardsChangeSetting Generic.WhiteSpace.ScopeIndent tabIndent false @codingStandardsChangeSetting Generic.WhiteSpace.ScopeIndent exact true * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ScopeIndent sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Generic_Tests_WhiteSpace_ScopeIndentUnitTest extends AbstractSniffUnitTest { /** * Get a list of CLI values to set befor the file is tested. * * @param string $testFile The name of the file being tested. * * @return array */ public function getCliValues($testFile) { // Tab width setting is only needed for the tabbed file. if ($testFile === 'ScopeIndentUnitTest.2.inc') { return array('--tab-width=4'); } return array(); }//end getCliValues() /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='ScopeIndentUnitTest.inc') { if ($testFile === 'ScopeIndentUnitTest.1.js') { return array( 6 => 1, 14 => 1, 21 => 1, 30 => 1, 31 => 1, 33 => 1, 34 => 1, 39 => 1, 42 => 1, 47 => 1, 59 => 1, 60 => 1, 75 => 1, 120 => 1, 121 => 1, 122 => 1, 141 => 1, 155 => 1, 168 => 1, 184 => 1, ); } if ($testFile === 'ScopeIndentUnitTest.3.inc') { return array( 6 => 1, 7 => 1, 10 => 1, ); } return array( 7 => 1, 10 => 1, 13 => 1, 17 => 1, 20 => 1, 24 => 1, 25 => 1, 27 => 1, 28 => 1, 29 => 1, 30 => 1, 58 => 1, 123 => 1, 224 => 1, 225 => 1, 279 => 1, 280 => 1, 281 => 1, 284 => 1, 336 => 1, 349 => 1, 380 => 1, 386 => 1, 388 => 1, 390 => 1, 391 => 1, 397 => 1, 419 => 1, 420 => 1, 465 => 1, 472 => 1, 473 => 1, 496 => 1, 524 => 1, 544 => 1, 545 => 1, 639 => 1, 660 => 1, 662 => 1, 802 => 1, 803 => 1, 823 => 1, 858 => 1, 860 => 1, 862 => 1, 863 => 1, 879 => 1, 987 => 1, 999 => 1, 1000 => 1, 1002 => 1, 1004 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Generic/ruleset.xml0000644000076700000240000000025612647543456024221 0ustar gsherwoodstaff A collection of generic sniffs. This standard is not designed to be used to check code. PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/Channels/DisallowSelfActionsSniff.php0000644000076700000240000001155612647543456032606 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Ensures that self and static are not used to call public methods in action classes. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_Channels_DisallowSelfActionsSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_CLASS); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // We are not interested in abstract classes. $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if ($prev !== false && $tokens[$prev]['code'] === T_ABSTRACT) { return; } // We are only interested in Action classes. $classNameToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); $className = $tokens[$classNameToken]['content']; if (substr($className, -7) !== 'Actions') { return; } $foundFunctions = array(); $foundCalls = array(); // Find all static method calls in the form self::method() in the class. $classEnd = $tokens[$stackPtr]['scope_closer']; for ($i = ($classNameToken + 1); $i < $classEnd; $i++) { if ($tokens[$i]['code'] !== T_DOUBLE_COLON) { if ($tokens[$i]['code'] === T_FUNCTION) { // Cache the function information. $funcName = $phpcsFile->findNext(T_STRING, ($i + 1)); $funcScope = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$scopeModifiers, ($i - 1)); $foundFunctions[$tokens[$funcName]['content']] = strtolower($tokens[$funcScope]['content']); } continue; } $prevToken = $phpcsFile->findPrevious(T_WHITESPACE, ($i - 1), null, true); if ($tokens[$prevToken]['content'] !== 'self' && $tokens[$prevToken]['content'] !== 'static' ) { continue; } $funcNameToken = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), null, true); if ($tokens[$funcNameToken]['code'] === T_VARIABLE) { // We are only interested in function calls. continue; } $funcName = $tokens[$funcNameToken]['content']; // We've found the function, now we need to find it and see if it is // public, private or protected. If it starts with an underscore we // can assume it is private. if ($funcName{0} === '_') { continue; } $foundCalls[$i] = array( 'name' => $funcName, 'type' => strtolower($tokens[$prevToken]['content']), ); }//end for $errorClassName = substr($className, 0, -7); foreach ($foundCalls as $token => $funcData) { if (isset($foundFunctions[$funcData['name']]) === false) { // Function was not in this class, might have come from the parent. // Either way, we can't really check this. continue; } else if ($foundFunctions[$funcData['name']] === 'public') { $type = $funcData['type']; $error = "Static calls to public methods in Action classes must not use the $type keyword; use %s::%s() instead"; $data = array( $errorClassName, $funcName, ); $phpcsFile->addError($error, $token, 'Found'.ucfirst($funcData['type']), $data); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/Channels/IncludeOwnSystemSniff.php0000644000076700000240000000650612647543456032150 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Ensures that a system does not include itself. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_Channels_IncludeOwnSystemSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_DOUBLE_COLON); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $fileName = $phpcsFile->getFilename(); $matches = array(); if (preg_match('|/systems/(.*)/([^/]+)?actions.inc$|i', $fileName, $matches) === 0) { // Not an actions file. return; } $ownClass = $matches[2]; $tokens = $phpcsFile->getTokens(); $typeName = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($stackPtr + 2), null, false, true); $typeName = trim($tokens[$typeName]['content'], " '"); switch (strtolower($tokens[($stackPtr + 1)]['content'])) { case 'includesystem' : $included = strtolower($typeName); break; case 'includeasset' : $included = strtolower($typeName).'assettype'; break; case 'includewidget' : $included = strtolower($typeName).'widgettype'; break; default: return; } if ($included === strtolower($ownClass)) { $error = "You do not need to include \"%s\" from within the system's own actions file"; $data = array($ownClass); $phpcsFile->addError($error, $stackPtr, 'NotRequired', $data); } }//end process() /** * Determines the included class name from given token. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param array $tokens The array of file tokens. * @param int $stackPtr The position in the tokens array of the * potentially included class. * * @return string */ protected function getIncludedClassFromToken( PHP_CodeSniffer_File $phpcsFile, array $tokens, $stackPtr ) { return false; }//end getIncludedClassFromToken() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/Channels/IncludeSystemSniff.php0000644000076700000240000003357012647543456031465 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) { $error = 'Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found'; throw new PHP_CodeSniffer_Exception($error); } /** * Ensures that systems, asset types and libs are included before they are used. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_Channels_IncludeSystemSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff { /** * A list of classes that don't need to be included. * * @var array(string) */ private $_ignore = array( 'self' => true, 'static' => true, 'parent' => true, 'channels' => true, 'basesystem' => true, 'dal' => true, 'init' => true, 'pdo' => true, 'util' => true, 'ziparchive' => true, 'phpunit_framework_assert' => true, 'abstractmysourceunittest' => true, 'abstractdatacleanunittest' => true, 'exception' => true, 'abstractwidgetwidgettype' => true, 'domdocument' => true, ); /** * Constructs a Squiz_Sniffs_Scope_MethodScopeSniff. */ public function __construct() { parent::__construct(array(T_FUNCTION), array(T_DOUBLE_COLON, T_EXTENDS), true); }//end __construct() /** * Processes the function tokens within the class. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param integer $stackPtr The position where the token was found. * @param integer $currScope The current scope opener token. * * @return void */ protected function processTokenWithinScope( PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope ) { $tokens = $phpcsFile->getTokens(); // Determine the name of the class that the static function // is being called on. $classNameToken = $phpcsFile->findPrevious( T_WHITESPACE, ($stackPtr - 1), null, true ); // Don't process class names represented by variables as this can be // an inexact science. if ($tokens[$classNameToken]['code'] === T_VARIABLE) { return; } $className = $tokens[$classNameToken]['content']; if (isset($this->_ignore[strtolower($className)]) === true) { return; } $includedClasses = array(); $fileName = strtolower($phpcsFile->getFilename()); $matches = array(); if (preg_match('|/systems/(.*)/([^/]+)?actions.inc$|', $fileName, $matches) !== 0) { // This is an actions file, which means we don't // have to include the system in which it exists. $includedClasses[$matches[2]] = true; // Or a system it implements. $class = $phpcsFile->getCondition($stackPtr, T_CLASS); $implements = $phpcsFile->findNext(T_IMPLEMENTS, $class, ($class + 10)); if ($implements !== false) { $implementsClass = $phpcsFile->findNext(T_STRING, $implements); $implementsClassName = strtolower($tokens[$implementsClass]['content']); if (substr($implementsClassName, -7) === 'actions') { $includedClasses[substr($implementsClassName, 0, -7)] = true; } } } // Go searching for includeSystem and includeAsset calls within this // function, or the inclusion of .inc files, which // would be library files. for ($i = ($currScope + 1); $i < $stackPtr; $i++) { $name = $this->getIncludedClassFromToken($phpcsFile, $tokens, $i); if ($name !== false) { $includedClasses[$name] = true; // Special case for Widgets cause they are, well, special. } else if (strtolower($tokens[$i]['content']) === 'includewidget') { $typeName = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($i + 1)); $typeName = trim($tokens[$typeName]['content'], " '"); $includedClasses[strtolower($typeName).'widgettype'] = true; } } // Now go searching for includeSystem, includeAsset or require/include // calls outside our scope. If we are in a class, look outside the // class. If we are not, look outside the function. $condPtr = $currScope; if ($phpcsFile->hasCondition($stackPtr, T_CLASS) === true) { foreach ($tokens[$stackPtr]['conditions'] as $condPtr => $condType) { if ($condType === T_CLASS) { break; } } } for ($i = 0; $i < $condPtr; $i++) { // Skip other scopes. if (isset($tokens[$i]['scope_closer']) === true) { $i = $tokens[$i]['scope_closer']; continue; } $name = $this->getIncludedClassFromToken($phpcsFile, $tokens, $i); if ($name !== false) { $includedClasses[$name] = true; } } // If we are in a testing class, we might have also included // some systems and classes in our setUp() method. $setupFunction = null; if ($phpcsFile->hasCondition($stackPtr, T_CLASS) === true) { foreach ($tokens[$stackPtr]['conditions'] as $condPtr => $condType) { if ($condType === T_CLASS) { // Is this is a testing class? $name = $phpcsFile->findNext(T_STRING, $condPtr); $name = $tokens[$name]['content']; if (substr($name, -8) === 'UnitTest') { // Look for a method called setUp(). $end = $tokens[$condPtr]['scope_closer']; $function = $phpcsFile->findNext(T_FUNCTION, ($condPtr + 1), $end); while ($function !== false) { $name = $phpcsFile->findNext(T_STRING, $function); if ($tokens[$name]['content'] === 'setUp') { $setupFunction = $function; break; } $function = $phpcsFile->findNext(T_FUNCTION, ($function + 1), $end); } } } }//end foreach }//end if if ($setupFunction !== null) { $start = ($tokens[$setupFunction]['scope_opener'] + 1); $end = $tokens[$setupFunction]['scope_closer']; for ($i = $start; $i < $end; $i++) { $name = $this->getIncludedClassFromToken($phpcsFile, $tokens, $i); if ($name !== false) { $includedClasses[$name] = true; } } }//end if if (isset($includedClasses[strtolower($className)]) === false) { $error = 'Static method called on non-included class or system "%s"; include system with Channels::includeSystem() or include class with require_once'; $data = array($className); $phpcsFile->addError($error, $stackPtr, 'NotIncludedCall', $data); } }//end processTokenWithinScope() /** * Processes a token within the scope that this test is listening to. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * this token was found. * * @return void */ protected function processTokenOutsideScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[$stackPtr]['code'] === T_EXTENDS) { // Find the class name. $classNameToken = $phpcsFile->findNext(T_STRING, ($stackPtr + 1)); $className = $tokens[$classNameToken]['content']; } else { // Determine the name of the class that the static function // is being called on. But don't process class names represented by // variables as this can be an inexact science. $classNameToken = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if ($tokens[$classNameToken]['code'] === T_VARIABLE) { return; } $className = $tokens[$classNameToken]['content']; } // Some systems are always available. if (isset($this->_ignore[strtolower($className)]) === true) { return; } $includedClasses = array(); $fileName = strtolower($phpcsFile->getFilename()); $matches = array(); if (preg_match('|/systems/([^/]+)/([^/]+)?actions.inc$|', $fileName, $matches) !== 0) { // This is an actions file, which means we don't // have to include the system in which it exists // We know the system from the path. $includedClasses[$matches[1]] = true; } // Go searching for includeSystem, includeAsset or require/include // calls outside our scope. for ($i = 0; $i < $stackPtr; $i++) { // Skip classes and functions as will we never get // into their scopes when including this file, although // we have a chance of getting into IF's, WHILE's etc. if (($tokens[$i]['code'] === T_CLASS || $tokens[$i]['code'] === T_INTERFACE || $tokens[$i]['code'] === T_FUNCTION) && isset($tokens[$i]['scope_closer']) === true ) { $i = $tokens[$i]['scope_closer']; continue; } $name = $this->getIncludedClassFromToken($phpcsFile, $tokens, $i); if ($name !== false) { $includedClasses[$name] = true; // Special case for Widgets cause they are, well, special. } else if (strtolower($tokens[$i]['content']) === 'includewidget') { $typeName = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($i + 1)); $typeName = trim($tokens[$typeName]['content'], " '"); $includedClasses[strtolower($typeName).'widgettype'] = true; } }//end for if (isset($includedClasses[strtolower($className)]) === false) { if ($tokens[$stackPtr]['code'] === T_EXTENDS) { $error = 'Class extends non-included class or system "%s"; include system with Channels::includeSystem() or include class with require_once'; $data = array($className); $phpcsFile->addError($error, $stackPtr, 'NotIncludedExtends', $data); } else { $error = 'Static method called on non-included class or system "%s"; include system with Channels::includeSystem() or include class with require_once'; $data = array($className); $phpcsFile->addError($error, $stackPtr, 'NotIncludedCall', $data); } } }//end processTokenOutsideScope() /** * Determines the included class name from given token. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param array $tokens The array of file tokens. * @param int $stackPtr The position in the tokens array of the * potentially included class. * * @return string */ protected function getIncludedClassFromToken( PHP_CodeSniffer_File $phpcsFile, array $tokens, $stackPtr ) { if (strtolower($tokens[$stackPtr]['content']) === 'includesystem') { $systemName = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($stackPtr + 1)); $systemName = trim($tokens[$systemName]['content'], " '"); return strtolower($systemName); } else if (strtolower($tokens[$stackPtr]['content']) === 'includeasset') { $typeName = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($stackPtr + 1)); $typeName = trim($tokens[$typeName]['content'], " '"); return strtolower($typeName).'assettype'; } else if (isset(PHP_CodeSniffer_Tokens::$includeTokens[$tokens[$stackPtr]['code']]) === true) { $filePath = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, ($stackPtr + 1)); $filePath = $tokens[$filePath]['content']; $filePath = trim($filePath, " '"); $filePath = basename($filePath, '.inc'); return strtolower($filePath); } return false; }//end getIncludedClassFromToken() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/Channels/UnusedSystemSniff.php0000644000076700000240000001276712647543456031352 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Ensures that systems and asset types are used if they are included. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_Channels_UnusedSystemSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_DOUBLE_COLON); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Check if this is a call to includeSystem, includeAsset or includeWidget. $methodName = strtolower($tokens[($stackPtr + 1)]['content']); if ($methodName === 'includesystem' || $methodName === 'includeasset' || $methodName === 'includewidget' ) { $systemName = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 3), null, true); if ($systemName === false || $tokens[$systemName]['code'] !== T_CONSTANT_ENCAPSED_STRING) { // Must be using a variable instead of a specific system name. // We can't accurately check that. return; } $systemName = trim($tokens[$systemName]['content'], " '"); } else { return; } if ($methodName === 'includeasset') { $systemName .= 'assettype'; } else if ($methodName === 'includewidget') { $systemName .= 'widgettype'; } $systemName = strtolower($systemName); // Now check if this system is used anywhere in this scope. $level = $tokens[$stackPtr]['level']; for ($i = ($stackPtr + 1); $i < $phpcsFile->numTokens; $i++) { if ($tokens[$i]['level'] < $level) { // We have gone out of scope. // If the original include was inside an IF statement that // is checking if the system exists, check the outer scope // as well. if ($tokens[$stackPtr]['level'] === $level) { // We are still in the base level, so this is the first // time we have got here. $conditions = array_keys($tokens[$stackPtr]['conditions']); if (empty($conditions) === false) { $cond = array_pop($conditions); if ($tokens[$cond]['code'] === T_IF) { $i = $tokens[$cond]['scope_closer']; $level--; continue; } } } break; }//end if if ($tokens[$i]['code'] !== T_DOUBLE_COLON && $tokens[$i]['code'] !== T_EXTENDS && $tokens[$i]['code'] !== T_IMPLEMENTS ) { continue; } switch ($tokens[$i]['code']) { case T_DOUBLE_COLON: $usedName = strtolower($tokens[($i - 1)]['content']); if ($usedName === $systemName) { // The included system was used, so it is fine. return; } break; case T_EXTENDS: $classNameToken = $phpcsFile->findNext(T_STRING, ($i + 1)); $className = strtolower($tokens[$classNameToken]['content']); if ($className === $systemName) { // The included system was used, so it is fine. return; } break; case T_IMPLEMENTS: $endImplements = $phpcsFile->findNext(array(T_EXTENDS, T_OPEN_CURLY_BRACKET), ($i + 1)); for ($x = ($i + 1); $x < $endImplements; $x++) { if ($tokens[$x]['code'] === T_STRING) { $className = strtolower($tokens[$x]['content']); if ($className === $systemName) { // The included system was used, so it is fine. return; } } } break; }//end switch }//end for // If we get to here, the system was not use. $error = 'Included system "%s" is never used'; $data = array($systemName); $phpcsFile->addError($error, $stackPtr, 'Found', $data); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/Commenting/FunctionCommentSniff.php0000644000076700000240000000776312647543456032357 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('Squiz_Sniffs_Commenting_FunctionCommentSniff', true) === false) { $error = 'Class Squiz_Sniffs_Commenting_FunctionCommentSniff not found'; throw new PHP_CodeSniffer_Exception($error); } /** * Parses and verifies the doc comments for functions. * * Same as the Squiz standard, but adds support for API tags. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_Commenting_FunctionCommentSniff extends Squiz_Sniffs_Commenting_FunctionCommentSniff { /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { parent::process($phpcsFile, $stackPtr); $tokens = $phpcsFile->getTokens(); $find = PHP_CodeSniffer_Tokens::$methodPrefixes; $find[] = T_WHITESPACE; $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true); if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG) { return; } $commentStart = $tokens[$commentEnd]['comment_opener']; $hasApiTag = false; foreach ($tokens[$commentStart]['comment_tags'] as $tag) { if ($tokens[$tag]['content'] === '@api') { if ($hasApiTag === true) { // We've come across an API tag already, which means // we were not the first tag in the API list. $error = 'The @api tag must come first in the @api tag list in a function comment'; $phpcsFile->addError($error, $tag, 'ApiNotFirst'); } $hasApiTag = true; // There needs to be a blank line before the @api tag. $prev = $phpcsFile->findPrevious(array(T_DOC_COMMENT_STRING, T_DOC_COMMENT_TAG), ($tag - 1)); if ($tokens[$prev]['line'] !== ($tokens[$tag]['line'] - 2)) { $error = 'There must be one blank line before the @api tag in a function comment'; $phpcsFile->addError($error, $tag, 'ApiSpacing'); } } else if (substr($tokens[$tag]['content'], 0, 5) === '@api-') { $hasApiTag = true; $prev = $phpcsFile->findPrevious(array(T_DOC_COMMENT_STRING, T_DOC_COMMENT_TAG), ($tag - 1)); if ($tokens[$prev]['line'] !== ($tokens[$tag]['line'] - 1)) { $error = 'There must be no blank line before the @%s tag in a function comment'; $data = array($tokens[$tag]['content']); $phpcsFile->addError($error, $tag, 'ApiTagSpacing', $data); } }//end if }//end foreach if ($hasApiTag === true && substr($tokens[$tag]['content'], 0, 4) !== '@api') { // API tags must be the last tags in a function comment. $error = 'The @api tags must be the last tags in a function comment'; $phpcsFile->addError($error, $commentEnd, 'ApiNotLast'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/CSS/BrowserSpecificStylesSniff.php0000644000076700000240000000573712647543456032073 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * MySource_Sniffs_CSS_BrowserSpecificStylesSniff. * * Ensure that browser-specific styles are not used. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_CSS_BrowserSpecificStylesSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * A list of specific stylesheet suffixes we allow. * * These stylesheets contain browser specific styles * so this sniff ignore them files in the form: * *_moz.css and *_ie7.css etc. * * @var array */ protected $specificStylesheets = array( 'moz' => true, 'ie' => true, 'ie7' => true, 'ie8' => true, 'webkit' => true, ); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_STYLE); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { // Ignore files with browser-specific suffixes. $filename = $phpcsFile->getFilename(); $breakChar = strrpos($filename, '_'); if ($breakChar !== false && substr($filename, -4) === '.css') { $specific = substr($filename, ($breakChar + 1), -4); if (isset($this->specificStylesheets[$specific]) === true) { return; } } $tokens = $phpcsFile->getTokens(); $content = $tokens[$stackPtr]['content']; if ($content{0} === '-') { $error = 'Browser-specific styles are not allowed'; $phpcsFile->addError($error, $stackPtr, 'ForbiddenStyle'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/Debug/DebugCodeSniff.php0000644000076700000240000000377612647543456030016 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Warns about the use of debug code. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_Debug_DebugCodeSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_DOUBLE_COLON); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $className = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if (strtolower($tokens[$className]['content']) === 'debug') { $method = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); $error = 'Call to debug function Debug::%s() must be removed'; $data = array($tokens[$method]['content']); $phpcsFile->addError($error, $stackPtr, 'Found', $data); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/Debug/FirebugConsoleSniff.php0000644000076700000240000000417212647543456031072 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Ensures that console is not used for function or var names. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_Debug_FirebugConsoleSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('JS'); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_STRING, T_PROPERTY, T_LABEL, T_OBJECT, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (strtolower($tokens[$stackPtr]['content']) === 'console') { $error = 'Variables, functions and labels must not be named "console"; name may conflict with Firebug internal variable'; $phpcsFile->addError($error, $stackPtr, 'ConflictFound'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/Objects/AssignThisSniff.php0000644000076700000240000000547212647543456030607 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Ensures this is not assigned to any other var but self. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_Objects_AssignThisSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('JS'); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_THIS); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Ignore this.something and other uses of "this" that are not // direct assignments. $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$next]['code'] !== T_SEMICOLON) { if ($tokens[$next]['line'] === $tokens[$stackPtr]['line']) { return; } } // Something must be assigned to "this". $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if ($tokens[$prev]['code'] !== T_EQUAL) { return; } // A variable needs to be assigned to "this". $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($prev - 1), null, true); if ($tokens[$prev]['code'] !== T_STRING) { return; } // We can only assign "this" to a var called "self". if ($tokens[$prev]['content'] !== 'self' && $tokens[$prev]['content'] !== '_self') { $error = 'Keyword "this" can only be assigned to a variable called "self" or "_self"'; $phpcsFile->addError($error, $prev, 'NotSelf'); } }//end process() }//end class ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/Objects/CreateWidgetTypeCallbackSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/Objects/CreateWidgetTypeCallbackSniff.ph0000644000076700000240000002106012647543456033170 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Ensures the create() method of widget types properly uses callbacks. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_Objects_CreateWidgetTypeCallbackSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('JS'); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OBJECT); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $className = $phpcsFile->findPrevious(T_STRING, ($stackPtr - 1)); if (substr(strtolower($tokens[$className]['content']), -10) !== 'widgettype') { return; } // Search for a create method. $create = $phpcsFile->findNext(T_PROPERTY, $stackPtr, $tokens[$stackPtr]['bracket_closer'], null, 'create'); if ($create === false) { return; } $function = $phpcsFile->findNext(array(T_WHITESPACE, T_COLON), ($create + 1), null, true); if ($tokens[$function]['code'] !== T_FUNCTION && $tokens[$function]['code'] !== T_CLOSURE ) { return; } $start = ($tokens[$function]['scope_opener'] + 1); $end = ($tokens[$function]['scope_closer'] - 1); // Check that the first argument is called "callback". $arg = $phpcsFile->findNext(T_WHITESPACE, ($tokens[$function]['parenthesis_opener'] + 1), null, true); if ($tokens[$arg]['content'] !== 'callback') { $error = 'The first argument of the create() method of a widget type must be called "callback"'; $phpcsFile->addError($error, $arg, 'FirstArgNotCallback'); } /* Look for return statements within the function. They cannot return anything and must be preceded by the callback.call() line. The callback itself must contain "self" or "this" as the first argument and there needs to be a call to the callback function somewhere in the create method. All calls to the callback function must be followed by a return statement or the end of the method. */ $foundCallback = false; $passedCallback = false; $nestedFunction = null; for ($i = $start; $i <= $end; $i++) { // Keep track of nested functions. if ($nestedFunction !== null) { if ($i === $nestedFunction) { $nestedFunction = null; continue; } } else if (($tokens[$i]['code'] === T_FUNCTION || $tokens[$i]['code'] === T_CLOSURE) && isset($tokens[$i]['scope_closer']) === true ) { $nestedFunction = $tokens[$i]['scope_closer']; continue; } if ($nestedFunction === null && $tokens[$i]['code'] === T_RETURN) { // Make sure return statements are not returning anything. if ($tokens[($i + 1)]['code'] !== T_SEMICOLON) { $error = 'The create() method of a widget type must not return a value'; $phpcsFile->addError($error, $i, 'ReturnValue'); } continue; } else if ($tokens[$i]['code'] !== T_STRING || $tokens[$i]['content'] !== 'callback' ) { continue; } // If this is the form "callback.call(" then it is a call // to the callback function. if ($tokens[($i + 1)]['code'] !== T_OBJECT_OPERATOR || $tokens[($i + 2)]['content'] !== 'call' || $tokens[($i + 3)]['code'] !== T_OPEN_PARENTHESIS ) { // One last chance; this might be the callback function // being passed to another function, like this // "this.init(something, callback, something)". if (isset($tokens[$i]['nested_parenthesis']) === false) { continue; } // Just make sure those brackets dont belong to anyone, // like an IF or FOR statement. foreach ($tokens[$i]['nested_parenthesis'] as $bracket) { if (isset($tokens[$bracket]['parenthesis_owner']) === true) { continue(2); } } // Note that we use this endBracket down further when checking // for a RETURN statement. $endBracket = end($tokens[$i]['nested_parenthesis']); $bracket = key($tokens[$i]['nested_parenthesis']); $prev = $phpcsFile->findPrevious( PHP_CodeSniffer_Tokens::$emptyTokens, ($bracket - 1), null, true ); if ($tokens[$prev]['code'] !== T_STRING) { // This is not a function passing the callback. continue; } $passedCallback = true; }//end if $foundCallback = true; if ($passedCallback === false) { // The first argument must be "this" or "self". $arg = $phpcsFile->findNext(T_WHITESPACE, ($i + 4), null, true); if ($tokens[$arg]['content'] !== 'this' && $tokens[$arg]['content'] !== 'self' ) { $error = 'The first argument passed to the callback function must be "this" or "self"'; $phpcsFile->addError($error, $arg, 'FirstArgNotSelf'); } } // Now it must be followed by a return statement or the end of the function. if ($passedCallback === false) { $endBracket = $tokens[($i + 3)]['parenthesis_closer']; } for ($next = $endBracket; $next <= $end; $next++) { // Skip whitespace so we find the next content after the call. if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$next]['code']]) === true) { continue; } // Skip closing braces like END IF because it is not executable code. if ($tokens[$next]['code'] === T_CLOSE_CURLY_BRACKET) { continue; } // We don't care about anything on the current line, like a // semicolon. It doesn't matter if there are other statements on the // line because another sniff will check for those. if ($tokens[$next]['line'] === $tokens[$endBracket]['line']) { continue; } break; } if ($next !== $tokens[$function]['scope_closer'] && $tokens[$next]['code'] !== T_RETURN ) { $error = 'The call to the callback function must be followed by a return statement if it is not the last statement in the create() method'; $phpcsFile->addError($error, $i, 'NoReturn'); } }//end for if ($foundCallback === false) { $error = 'The create() method of a widget type must call the callback function'; $phpcsFile->addError($error, $create, 'CallbackNotCalled'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/Objects/DisallowNewWidgetSniff.php0000644000076700000240000000420712647543456032122 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Ensures that widgets are not manually created. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_Objects_DisallowNewWidgetSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_NEW); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $className = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$className]['code'] !== T_STRING) { return; } if (substr(strtolower($tokens[$className]['content']), -10) === 'widgettype') { $widgetType = substr($tokens[$className]['content'], 0, -10); $error = 'Manual creation of widget objects is banned; use Widget::getWidget(\'%s\'); instead'; $data = array($widgetType); $phpcsFile->addError($error, $stackPtr, 'Found', $data); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/PHP/AjaxNullComparisonSniff.php0000644000076700000240000000726212647543456031341 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Ensures that values submitted via JS are not compared to NULL. * * With jQuery 1.8, the behaviour of ajax requests changed so that null values are * submitted as null= instead of null=null. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_PHP_AjaxNullComparisonSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_FUNCTION); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Make sure it is an API function. We know this by the doc comment. $commentEnd = $phpcsFile->findPrevious(T_DOC_COMMENT_CLOSE_TAG, $stackPtr); $commentStart = $phpcsFile->findPrevious(T_DOC_COMMENT_OPEN_TAG, ($commentEnd - 1)); $comment = $phpcsFile->getTokensAsString($commentStart, ($commentEnd - $commentStart)); if (strpos($comment, '* @api') === false) { return; } // Find all the vars passed in as we are only interested in comparisons // to NULL for these specific variables. $foundVars = array(); $open = $tokens[$stackPtr]['parenthesis_opener']; $close = $tokens[$stackPtr]['parenthesis_closer']; for ($i = ($open + 1); $i < $close; $i++) { if ($tokens[$i]['code'] === T_VARIABLE) { $foundVars[$tokens[$i]['content']] = true; } } if (empty($foundVars) === true) { return; } $start = $tokens[$stackPtr]['scope_opener']; $end = $tokens[$stackPtr]['scope_closer']; for ($i = ($start + 1); $i < $end; $i++) { if ($tokens[$i]['code'] !== T_VARIABLE || isset($foundVars[$tokens[$i]['content']]) === false ) { continue; } $operator = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), null, true); if ($tokens[$operator]['code'] !== T_IS_IDENTICAL && $tokens[$operator]['code'] !== T_IS_NOT_IDENTICAL ) { continue; } $nullValue = $phpcsFile->findNext(T_WHITESPACE, ($operator + 1), null, true); if ($tokens[$nullValue]['code'] !== T_NULL) { continue; } $error = 'Values submitted via Ajax requests should not be compared directly to NULL; use empty() instead'; $phpcsFile->addWarning($error, $nullValue, 'Found'); }//end for }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/PHP/EvalObjectFactorySniff.php0000644000076700000240000001035112647543456031127 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Ensures that eval() is not used to create objects. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_PHP_EvalObjectFactorySniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_EVAL); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); /* We need to find all strings that will be in the eval to determine if the "new" keyword is being used. */ $openBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($stackPtr + 1)); $closeBracket = $tokens[$openBracket]['parenthesis_closer']; $strings = array(); $vars = array(); for ($i = ($openBracket + 1); $i < $closeBracket; $i++) { if (isset(PHP_CodeSniffer_Tokens::$stringTokens[$tokens[$i]['code']]) === true) { $strings[$i] = $tokens[$i]['content']; } else if ($tokens[$i]['code'] === T_VARIABLE) { $vars[$i] = $tokens[$i]['content']; } } /* We now have some variables that we need to expand into the strings that were assigned to them, if any. */ foreach ($vars as $varPtr => $varName) { while (($prev = $phpcsFile->findPrevious(T_VARIABLE, ($varPtr - 1))) !== false) { // Make sure this is an assignment of the variable. That means // it will be the first thing on the line. $prevContent = $phpcsFile->findPrevious(T_WHITESPACE, ($prev - 1), null, true); if ($tokens[$prevContent]['line'] === $tokens[$prev]['line']) { $varPtr = $prevContent; continue; } if ($tokens[$prev]['content'] !== $varName) { // This variable has a different name. $varPtr = $prevContent; continue; } // We found one. break; }//end while if ($prev !== false) { // Find all strings on the line. $lineEnd = $phpcsFile->findNext(T_SEMICOLON, ($prev + 1)); for ($i = ($prev + 1); $i < $lineEnd; $i++) { if (isset(PHP_CodeSniffer_Tokens::$stringTokens[$tokens[$i]['code']]) === true) { $strings[$i] = $tokens[$i]['content']; } } } }//end foreach foreach ($strings as $string) { // If the string has "new" in it, it is not allowed. // We don't bother checking if the word "new" is echo'd // because that is unlikely to happen. We assume the use // of "new" is for object instantiation. if (strstr($string, ' new ') !== false) { $error = 'Do not use eval() to create objects dynamically; use reflection instead'; $phpcsFile->addWarning($error, $stackPtr, 'Found'); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/PHP/GetRequestDataSniff.php0000644000076700000240000000766512647543456030461 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Ensures that getRequestData() is used to access super globals. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_PHP_GetRequestDataSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_VARIABLE); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $varName = $tokens[$stackPtr]['content']; if ($varName !== '$_REQUEST' && $varName !== '$_GET' && $varName !== '$_POST' && $varName !== '$_FILES' ) { return; } // The only place these super globals can be accessed directly is // in the getRequestData() method of the Security class. $inClass = false; foreach ($tokens[$stackPtr]['conditions'] as $i => $type) { if ($tokens[$i]['code'] === T_CLASS) { $className = $phpcsFile->findNext(T_STRING, $i); $className = $tokens[$className]['content']; if (strtolower($className) === 'security') { $inClass = true; } else { // We don't have nested classes. break; } } else if ($inClass === true && $tokens[$i]['code'] === T_FUNCTION) { $funcName = $phpcsFile->findNext(T_STRING, $i); $funcName = $tokens[$funcName]['content']; if (strtolower($funcName) === 'getrequestdata') { // This is valid. return; } else { // We don't have nested functions. break; } }//end if }//end foreach // If we get to here, the super global was used incorrectly. // First find out how it is being used. $globalName = strtolower(substr($varName, 2)); $usedVar = ''; $openBracket = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$openBracket]['code'] === T_OPEN_SQUARE_BRACKET) { $closeBracket = $tokens[$openBracket]['bracket_closer']; $usedVar = $phpcsFile->getTokensAsString(($openBracket + 1), ($closeBracket - $openBracket - 1)); } $type = 'SuperglobalAccessed'; $error = 'The %s super global must not be accessed directly; use Security::getRequestData('; $data = array($varName); if ($usedVar !== '') { $type .= 'WithVar'; $error .= '%s, \'%s\''; $data[] = $usedVar; $data[] = $globalName; } $error .= ') instead'; $phpcsFile->addError($error, $stackPtr, $type, $data); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/PHP/ReturnFunctionValueSniff.php0000644000076700000240000000450112647543456031543 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Warns when function values are returned directly. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_PHP_ReturnFunctionValueSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_RETURN); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $functionName = $phpcsFile->findNext(T_STRING, ($stackPtr + 1), null, false, null, true); while ($functionName !== false) { // Check if this is really a function. $bracket = $phpcsFile->findNext(T_WHITESPACE, ($functionName + 1), null, true); if ($tokens[$bracket]['code'] !== T_OPEN_PARENTHESIS) { // Not a function call. $functionName = $phpcsFile->findNext(T_STRING, ($functionName + 1), null, false, null, true); continue; } $error = 'The result of a function call should be assigned to a variable before being returned'; $phpcsFile->addWarning($error, $stackPtr, 'NotAssigned'); break; } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Sniffs/Strings/JoinStringsSniff.php0000644000076700000240000000530212647543456031034 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Ensures that strings are not joined using array.join(). * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Sniffs_Strings_JoinStringsSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('JS'); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_STRING); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param integer $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[$stackPtr]['content'] !== 'join') { return; } $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); if ($tokens[$prev]['code'] !== T_OBJECT_OPERATOR) { return; } $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($prev - 1), null, true); if ($tokens[$prev]['code'] === T_CLOSE_SQUARE_BRACKET) { $opener = $tokens[$prev]['bracket_opener']; if ($tokens[($opener - 1)]['code'] !== T_STRING) { // This means the array is declared inline, like x = [a,b,c].join() // and not elsewhere, like x = y[a].join() // The first is not allowed while the second is. $error = 'Joining strings using inline arrays is not allowed; use the + operator instead'; $phpcsFile->addError($error, $stackPtr, 'ArrayNotAllowed'); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Channels/DisallowSelfActionsUnitTest.inc0000644000076700000240000000160012647543456033141 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Channels/DisallowSelfActionsUnitTest.php0000644000076700000240000000363112647543456033165 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowSelfActionsUnitTest sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Tests_Channels_DisallowSelfActionsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 12 => 1, 13 => 1, 28 => 1, 29 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Channels/IncludeSystemUnitTest.inc0000644000076700000240000000556512647543456032036 0ustar gsherwoodstafffetch(PDO::FETCH_NUM) BaseSystem::getDataDir(); Util::getArrayIndex(array(), ''); Channels::includeSystem('Widget'); Widget::includeWidget('AbstractContainer'); class MyWidget extends AbstractContainerWidgetType {} class MyOtherWidget extends BookWidgetType {} $zip = new ZipArchive(); $res = $zip->open($path, ZipArchive::CREATE); class AssetListingUnitTest extends AbstractMySourceUnitTest { function setUp() { parent::setUp(); Channels::includeSystem('MySystem2'); include_once 'Libs/FileSystem.inc'; } function two() { $siteid = MySystem2::getCurrentSiteId(); $parserFiles = FileSystem::listDirectory(); } function three() { $siteid = MySystem3::getCurrentSiteId(); $parserFiles = FileSystem::listDirectory(); } } if (Channels::systemExists('Log') === TRUE) { Channels::includeSystem('Log'); } else { return; } Log::addProjectLog('metadata.field.update', $msg); function two() { Widget::includeWidget('CacheAdminScreen'); $barChart = CacheAdminScreenWidgetType::constructBarchart($data); } $adjustDialog->setOrientation(AbstractWidgetWidgetType::CENTER); $className = 'SquizPerspective'.ucfirst($property['type']).'PropertyType'; Channels::includeSystem($className); $className::setValue($assetid, $propertyid, $perspectives, $value, (array) $property['settings']); ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Channels/IncludeSystemUnitTest.php0000644000076700000240000000404612647543456032045 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the IncludeSystem sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Tests_Channels_IncludeSystemUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 9 => 1, 14 => 1, 24 => 1, 27 => 1, 28 => 1, 31 => 1, 36 => 1, 41 => 1, 61 => 1, 70 => 1, 89 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Channels/UnusedSystemUnitTest.inc0000644000076700000240000000304212647543456031702 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Channels/UnusedSystemUnitTest.php0000644000076700000240000000364612647543456031732 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the UnusedSystem sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Tests_Channels_UnusedSystemUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 5 => 1, 8 => 1, 24 => 1, 34 => 1, 54 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Commenting/FunctionCommentUnitTest.inc0000644000076700000240000000245412647543456032715 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Commenting/FunctionCommentUnitTest.php0000644000076700000240000000334212647543456032730 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for FunctionCommentSniff. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Tests_Commenting_FunctionCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 28 => 1, 36 => 1, 37 => 2, 49 => 1, 58 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/CSS/BrowserSpecificStylesUnitTest.css0000644000076700000240000000043112647543456032442 0ustar gsherwoodstaff.SettingsTabPaneWidgetType-tab-mid { background: transparent url(tab_inact_mid.png) repeat-x; line-height: -25px; cursor: pointer; -moz-user-select: none; } .AssetLineageWidgetType-item { float: left; list-style: none; height: 22px; cursor: pointer; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/CSS/BrowserSpecificStylesUnitTest.php0000644000076700000240000000345412647543456032451 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the BrowserSpecificStyles sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Tests_CSS_BrowserSpecificStylesUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 5 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Debug/DebugCodeUnitTest.inc0000644000076700000240000000006712647543456030352 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Debug/DebugCodeUnitTest.php0000644000076700000240000000346412647543456030374 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DebugCode sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Tests_Debug_DebugCodeUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 3 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Debug/FirebugConsoleUnitTest.js0000644000076700000240000000017312647543456031300 0ustar gsherwoodstaffconsole.info(); console.warn(); console.test(); con.sole(); var console = { console: 'string'; }; function console() {}PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Debug/FirebugConsoleUnitTest.php0000644000076700000240000000416112647543456031454 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the FirebugConsole sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Tests_Debug_FirebugConsoleUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='FirebugConsoleUnitTest.js') { if ($testFile !== 'FirebugConsoleUnitTest.js') { return array(); } return array( 1 => 1, 2 => 1, 3 => 1, 5 => 1, 6 => 1, 8 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Objects/AssignThisUnitTest.js0000644000076700000240000000044512647543456031013 0ustar gsherwoodstaffvar self = this; buttonWidget.addClickEvent(function() { self.addDynamicSouce(); }); var x = self; var y = this; var test = ''; if (true) { test = this } var itemid = this.items[i].getAttribute('itemid'); for (var x = this; y < 10; y++) { var x = this + 1; } var _self = this;PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Objects/AssignThisUnitTest.php0000644000076700000240000000403212647543456031162 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the AssignThis sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Tests_Objects_AssignThisUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='AssignThisUnitTest.js') { if ($testFile !== 'AssignThisUnitTest.js') { return array(); } return array( 7 => 1, 11 => 1, 16 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Objects/CreateWidgetTypeCallbackUnitTest.jsPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Objects/CreateWidgetTypeCallbackUnitTest.0000644000076700000240000000573012647543456033232 0ustar gsherwoodstaffSampleWidgetType.prototype = { create: function(callback) { if (x === 1) { return; } if (y === 1) { callback.call(this); // A comment here to explain the return is okay. return; } if (a === 1) { // Cant return value even after calling callback. callback.call(this); return something; } if (a === 1) { // Need to pass self or this to callback function. callback.call(a); } callback.call(self); var self = this; this.createChildren(null, function() { callback.call(self, div); }); // Never good to return a vaue. return something; callback.call(self); } }; AnotherSampleWidgetType.prototype = { create: function(input) { return; } getSomething: function(input) { return 1; } }; NoCreateWidgetType.prototype = { getSomething: function(input) { return; } }; SomeRandom.prototype = { create: function(input) { return; } }; SampleWidgetType.prototype = { create: function(callback) { if (a === 1) { // This is ok because it is the last statement, // even though it is conditional. callback.call(self); } } }; SampleWidgetType.prototype = { create: function(callback) { var something = callback; } }; SampleWidgetType.prototype = { create: function(callback) { // Also valid because we are passing the callback to // someone else to call. if (y === 1) { this.something(callback); return; } this.init(callback); } }; SampleWidgetType.prototype = { create: function(callback) { // Also valid because we are passing the callback to // someone else to call. if (y === 1) { this.something(callback); } this.init(callback); } }; SampleWidgetType.prototype = { create: function(callback) { if (a === 1) { // This is ok because it is the last statement, // even though it is conditional. this.something(callback); } } }; SampleWidgetType.prototype = { create: function(callback) { if (dfx.isFn(callback) === true) { callback.call(this, cont); return; } } }; SampleWidgetType.prototype = { create: function(callback) { dfx.foreach(items, function(item) { return true; }); if (dfx.isFn(callback) === true) { callback.call(this); } } }; SampleWidgetType.prototype = { create: function(callback) { var self = this; this.createChildren(null, function() { callback.call(self, div); return; }); } };././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Objects/CreateWidgetTypeCallbackUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Objects/CreateWidgetTypeCallbackUnitTest.0000644000076700000240000000417312647543456033232 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the CreateWidgetTypeCallback sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Tests_Objects_CreateWidgetTypeCallbackUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='CreateWidgetTypeCallbackUnitTest.js') { return array( 18 => 1, 23 => 2, 26 => 1, 30 => 1, 34 => 1, 43 => 2, 91 => 1, 123 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Objects/DisallowNewWidgetUnitTest.inc0000644000076700000240000000023712647543456032467 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Objects/DisallowNewWidgetUnitTest.php0000644000076700000240000000346612647543456032514 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowNewWidget sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Tests_Objects_DisallowNewWidgetUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 4 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/PHP/AjaxNullComparisonUnitTest.inc0000644000076700000240000001346712647543456031713 0ustar gsherwoodstaffgetMessage()); }//end try if ($something === NULL) { if ($bar !== NULL) { } } return $issueid; }//end addIssue() /** * Adds a new issue. * * Returns the new issue id. * * @param string $title Title of the new issue. * @param string $description The description of the issue. * @param string $reporter Asset id of the reporter. * @param integer $projectid Id of the project that the issue belongs to. * @param array $tags Array of tags. * @param string $status The status of the issue. * @param string $assignedTo The asset id of the user that the issue is * assigned to. * @param string $reportedDate If set then this date will be used instead of the * current date and time. * @param integer $reportedMilestone Reported milestone. * * @return integer * @throws ChannelException If there is an error. * */ public static function addIssue( $title, $description, $reporter=NULL, $projectid=NULL, array $tags=array(), $status=NULL, $assignedTo=NULL, $reportedDate=NULL, $reportedMilestone=NULL ) { // Get current projectid if not specified. if ($projectid === NULL) { Channels::includeSystem('Project'); $projectid = Project::getCurrentProjectId(); Channels::modifyBasket('project', $projectid); } }//end addIssue() ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/PHP/AjaxNullComparisonUnitTest.php0000644000076700000240000000367112647543456031725 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the AjaxNullComparison sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Tests_PHP_AjaxNullComparisonUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 37 => 1, 49 => 1, 60 => 1, 73 => 1, 88 => 1, 118 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/PHP/EvalObjectFactoryUnitTest.inc0000644000076700000240000000061212647543456031474 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/PHP/EvalObjectFactoryUnitTest.php0000644000076700000240000000354512647543456031522 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the EvalObjectFactory sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Tests_PHP_EvalObjectFactoryUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 4 => 1, 12 => 1, 21 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/PHP/GetRequestDataUnitTest.inc0000644000076700000240000000111012647543456031002 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/PHP/GetRequestDataUnitTest.php0000644000076700000240000000370012647543456031027 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the GetRequestData sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Tests_PHP_GetRequestDataUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 5 => 1, 8 => 1, 21 => 1, 26 => 1, 27 => 1, 28 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/PHP/ReturnFunctionValueUnitTest.inc0000644000076700000240000000025412647543456032112 0ustar gsherwoodstaffmyFunction(); return $obj->variable; return MyClass::VARIABLE; return $variable; return ($var + 1); ?>PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/PHP/ReturnFunctionValueUnitTest.php0000644000076700000240000000355012647543456032132 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ReturnFunctionValue sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Tests_PHP_ReturnFunctionValueUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 2 => 1, 3 => 1, 4 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Strings/JoinStringsUnitTest.js0000644000076700000240000000073212647543456031247 0ustar gsherwoodstaffone = (1 + 2); two = (one + 2); two = (one + one); three = ('1' + 2); four = ['1', two].join(); four = ['1', two].join(''); four = ['1', [one, two].join(',')].join(' '); four = ['1', [one, two].join()].join(' '); four = ['1', [one, two].join()].join(); five = 'string' + ['1', [one, two].join()].join() + 'string'; six = myArray.join(' '); six = [arrayOne, arrayTwo].join(); // This is fine because the array is not created inline. var x = 'x' + test[x].join('p') + 't';PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/Tests/Strings/JoinStringsUnitTest.php0000644000076700000240000000420312647543456031417 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the JoinStrings sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer_MySource * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class MySource_Tests_Strings_JoinStringsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='JoinStringsUnitTest.js') { if ($testFile !== 'JoinStringsUnitTest.js') { return array(); } return array( 6 => 1, 7 => 1, 8 => 2, 9 => 2, 10 => 2, 12 => 2, 15 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/MySource/ruleset.xml0000644000076700000240000000127112647543456024411 0ustar gsherwoodstaff The MySource coding standard builds on the Squiz coding standard. Currently used for MySource Mini development. */Tests/* */Oven/* */data/* */jquery.js */jquery.*.js */viper/* DALConf.inc PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/Classes/ClassDeclarationStandard.xml0000644000076700000240000000101112647543456031060 0ustar gsherwoodstaff { } ]]> { } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/Commenting/ClassCommentStandard.xml0000644000076700000240000000627512647543456030761 0ustar gsherwoodstaff /** * The Foo class. */ class Foo { } ]]> /** * The Foo class. */ class Foo { } ]]> /** * The Foo class. */ class Foo { } ]]> /** * The Foo class. */ class Foo { } ]]> The Foo class. */ class Foo { } ]]> The Foo class. */ class Foo { } ]]> * A helper for the Bar class. * * @see Bar */ class Foo { } ]]> * * A helper for the Bar class. * * * @see Bar */ class Foo { } ]]> * @see Bar */ class Foo { } ]]> * * @see Bar */ class Foo { } ]]> Release: 1.0 */ class Foo { } ]]> 1.0 */ class Foo { } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/Commenting/FileCommentStandard.xml0000644000076700000240000001470612647543456030571 0ustar gsherwoodstaff /** * Short description here. * * PHP version 5 * * @category Foo * @package Foo_Helpers * @author Marty McFly * @copyright 2013-2014 Foo Inc. * @license MIT License * @link http://example.com */ ]]> ]]> Short description here. * * PHP version 5 * * @category Foo * @package Foo_Helpers * @author Marty McFly * @copyright 2013-2014 Foo Inc. * @license MIT License * @link http://example.com */ ]]> * Short description here. * * PHP version 5 * * @category Foo * @package Foo_Helpers * @author Marty McFly * @copyright 2013-2014 Foo Inc. * @license MIT License * @link http://example.com */ ]]> * PHP version 5 * * @category Foo * @package Foo_Helpers * @author Marty McFly * @copyright 2013-2014 Foo Inc. * @license MIT License * @link http://example.com */ ]]> * * PHP version 5 * * * @category Foo * @package Foo_Helpers * @author Marty McFly * @copyright 2013-2014 Foo Inc. * @license MIT License * @link http://example.com */ ]]> * @category Foo * @package Foo_Helpers * @author Marty McFly * @copyright 2013-2014 Foo Inc. * @license MIT License * @link http://example.com */ ]]> * * @category Foo * @package Foo_Helpers * @author Marty McFly * @copyright 2013-2014 Foo Inc. * @license MIT License * @link http://example.com */ ]]> @category Foo * @package Foo_Helpers * @author Marty McFly * @copyright 2013-2014 Foo Inc. * @license MIT License * @link http://example.com */ ]]> @category Foo * @package Foo_Helpers * @author Marty McFly * @copyright 2013-2014 Foo Inc. * @license MIT License * @link http://example.com */ ]]> @category Foo * @category Bar * @package Foo_Helpers * @author Marty McFly * @copyright 2013-2014 Foo Inc. * @license MIT License * @link http://example.com */ ]]> PHP version 5 * * @category Foo * @package Foo_Helpers * @author Marty McFly * @copyright 2013-2014 Foo Inc. * @license MIT License * @link http://example.com */ ]]> @package Foo_Helpers * @category Foo * @author Marty McFly * @copyright 2013-2014 Foo Inc. * @license MIT License * @link http://example.com */ ]]> * @copyright 2013-2014 Foo Inc. * @license MIT License * @link http://example.com */ ]]> * @copyright 2013-2014 Foo Inc. * @license MIT License * @link http://example.com */ ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/Commenting/FunctionCommentStandard.xml0000644000076700000240000001102712647543456031470 0ustar gsherwoodstaff /** * Short description here. * * @return void */ function foo() { } ]]> Short description here. * * @return void */ function foo() { } ]]> * Short description here. * * @return void */ function foo() { } ]]> * Long description here. * * @return void */ function foo() { } ]]> * * Long description here. * * * @return void */ function foo() { } ]]> * @return void */ function foo() { } ]]> * * @return void */ function foo() { } ]]> FooException */ function foo() { } ]]> @throws */ function foo() { } ]]> @return void */ function foo() { } ]]> $foo Foo parameter * @param string $bar Bar parameter * @return void */ function foo($foo, $bar) { } ]]> $qux Bar parameter * @return void */ function foo($foo, $bar) { } ]]> $foo Foo parameter * @param string $bar Bar parameter * @return void */ function foo($foo, $bar) { } ]]> $bar Bar parameter * @param string $foo Foo parameter * @return void */ function foo($foo, $bar) { } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/Commenting/InlineCommentStandard.xml0000644000076700000240000000066412647543456031126 0ustar gsherwoodstaff // A comment. ]]> # A comment. ]]> ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/ControlStructures/ControlSignatureStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/ControlStructures/ControlSignatureStandard.xml0000644000076700000240000000171612647543456033312 0ustar gsherwoodstaff ($foo) { } ]]> ($foo){ } ]]> { } ]]> { } ]]> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/ControlStructures/MultiLineConditionStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/ControlStructures/MultiLineConditionStandard.x0000644000076700000240000000243012647543456033222 0ustar gsherwoodstaff && $bar ) { } ]]> && $bar ) { } ]]> && $bar ) { } ]]> && $bar ) { } ]]> ) { } ]]> ) { } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/Files/IncludingFileStandard.xml0000644000076700000240000000206612647543456030041 0ustar gsherwoodstaff require_once. Anywhere you are conditionally including a class file (for example, factory methods), use include_once. Either of these will ensure that class files are included only once. They share the same file list, so you don't need to worry about mixing them - a file included with require_once will not be included again by include_once. ]]> include_once and require_once are statements, not functions. Parentheses should not surround the subject filename. ]]> ('PHP/CodeSniffer.php'); ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/Files/LineLengthStandard.xml0000644000076700000240000000031712647543456027353 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/Formatting/MultiLineAssignmentStandard.xml0000644000076700000240000000157612647543456032335 0ustar gsherwoodstaff = $bar; ]]> = $bar; ]]> = $bar; ]]> = $bar; ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/Functions/FunctionCallSignatureStandard.xml0000644000076700000240000000123512647543456032473 0ustar gsherwoodstaff ( $bar, $baz, $quux ) ; ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/Functions/FunctionDeclarationStandard.xml0000644000076700000240000000260512647543456032165 0ustar gsherwoodstaff () use ($bar) { }; ]]> ()use($bar){ }; ]]> $bar, $baz ) { }; ]]> $bar, $baz) { }; ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/Functions/ValidDefaultValueStandard.xml0000644000076700000240000000117312647543456031572 0ustar gsherwoodstaff $persistent = false) { ... } ]]> $persistent = false, $dsn) { ... } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/NamingConventions/ValidClassNameStandard.xml0000644000076700000240000000126112647543456032544 0ustar gsherwoodstaff ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/NamingConventions/ValidFunctionNameStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/NamingConventions/ValidFunctionNameStandard.xm0000644000076700000240000000144612647543456033115 0ustar gsherwoodstaff ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/NamingConventions/ValidVariableNameStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/NamingConventions/ValidVariableNameStandard.xm0000644000076700000240000000141312647543456033047 0ustar gsherwoodstaff publicVar; protected $protectedVar; private $_privateVar; } ]]> _publicVar; protected $_protectedVar; private $privateVar; } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/WhiteSpace/ScopeClosingBraceStandard.xml0000644000076700000240000000110112647543456031631 0ustar gsherwoodstaff } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/WhiteSpace/ScopeIndentStandard.xml0000644000076700000240000000125212647543456030526 0ustar gsherwoodstaff if ($test) { $var = 1; } } ]]> if ($test) { $var = 1; } } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Docs/WhiteSpace/ObjectOperatorIndentStandard.xml0000644000076700000240000000174312647543456032404 0ustar gsherwoodstaff ->bar() ->baz(); ]]> -> bar()-> baz(); ]]> ->bar() ->baz(); ]]> ->bar() ->baz(); ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/Classes/ClassDeclarationSniff.php0000644000076700000240000001355412647543456030733 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Class Declaration Test. * * Checks the declaration of the class is correct. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_Classes_ClassDeclarationSniff implements PHP_CodeSniffer_Sniff { /** * The number of spaces code should be indented. * * @var int */ public $indent = 4; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_CLASS, T_INTERFACE, T_TRAIT, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param integer $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $errorData = array(strtolower($tokens[$stackPtr]['content'])); if (isset($tokens[$stackPtr]['scope_opener']) === false) { $error = 'Possible parse error: %s missing opening or closing brace'; $phpcsFile->addWarning($error, $stackPtr, 'MissingBrace', $errorData); return; } $curlyBrace = $tokens[$stackPtr]['scope_opener']; $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($curlyBrace - 1), $stackPtr, true); $classLine = $tokens[$lastContent]['line']; $braceLine = $tokens[$curlyBrace]['line']; if ($braceLine === $classLine) { $phpcsFile->recordMetric($stackPtr, 'Class opening brace placement', 'same line'); $error = 'Opening brace of a %s must be on the line after the definition'; $fix = $phpcsFile->addFixableError($error, $curlyBrace, 'OpenBraceNewLine', $errorData); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); if ($tokens[($curlyBrace - 1)]['code'] === T_WHITESPACE) { $phpcsFile->fixer->replaceToken(($curlyBrace - 1), ''); } $phpcsFile->fixer->addNewlineBefore($curlyBrace); $phpcsFile->fixer->endChangeset(); } return; } else { $phpcsFile->recordMetric($stackPtr, 'Class opening brace placement', 'new line'); if ($braceLine > ($classLine + 1)) { $error = 'Opening brace of a %s must be on the line following the %s declaration; found %s line(s)'; $data = array( $tokens[$stackPtr]['content'], $tokens[$stackPtr]['content'], ($braceLine - $classLine - 1), ); $fix = $phpcsFile->addFixableError($error, $curlyBrace, 'OpenBraceWrongLine', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($curlyBrace - 1); $i > $lastContent; $i--) { if ($tokens[$i]['line'] === ($tokens[$curlyBrace]['line'] + 1)) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } return; }//end if }//end if if ($tokens[($curlyBrace + 1)]['content'] !== $phpcsFile->eolChar) { $error = 'Opening %s brace must be on a line by itself'; $fix = $phpcsFile->addFixableError($error, $curlyBrace, 'OpenBraceNotAlone', $errorData); if ($fix === true) { $phpcsFile->fixer->addNewline($curlyBrace); } } if ($tokens[($curlyBrace - 1)]['code'] === T_WHITESPACE) { $prevContent = $tokens[($curlyBrace - 1)]['content']; if ($prevContent === $phpcsFile->eolChar) { $spaces = 0; } else { $blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar)); $spaces = strlen($blankSpace); } $expected = ($tokens[$stackPtr]['level'] * $this->indent); if ($spaces !== $expected) { $error = 'Expected %s spaces before opening brace; %s found'; $data = array( $expected, $spaces, ); $fix = $phpcsFile->addFixableError($error, $curlyBrace, 'SpaceBeforeBrace', $data); if ($fix === true) { $indent = str_repeat(' ', $expected); if ($spaces === 0) { $phpcsFile->fixer->addContentBefore($curlyBrace, $indent); } else { $phpcsFile->fixer->replaceToken(($curlyBrace - 1), $indent); } } } }//end if }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/Commenting/ClassCommentSniff.php0000644000076700000240000001125512647543456030607 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Parses and verifies the doc comments for classes. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_Commenting_ClassCommentSniff extends PEAR_Sniffs_Commenting_FileCommentSniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_CLASS, T_INTERFACE, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $this->currentFile = $phpcsFile; $tokens = $phpcsFile->getTokens(); $type = strtolower($tokens[$stackPtr]['content']); $errorData = array($type); $find = PHP_CodeSniffer_Tokens::$methodPrefixes; $find[] = T_WHITESPACE; $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true); if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG && $tokens[$commentEnd]['code'] !== T_COMMENT ) { $phpcsFile->addError('Missing class doc comment', $stackPtr, 'Missing'); $phpcsFile->recordMetric($stackPtr, 'Class has doc comment', 'no'); return; } else { $phpcsFile->recordMetric($stackPtr, 'Class has doc comment', 'yes'); } // Try and determine if this is a file comment instead of a class comment. // We assume that if this is the first comment after the open PHP tag, then // it is most likely a file comment instead of a class comment. if ($tokens[$commentEnd]['code'] === T_DOC_COMMENT_CLOSE_TAG) { $start = ($tokens[$commentEnd]['comment_opener'] - 1); } else { $start = $phpcsFile->findPrevious(T_COMMENT, ($commentEnd - 1), null, true); } $prev = $phpcsFile->findPrevious(T_WHITESPACE, $start, null, true); if ($tokens[$prev]['code'] === T_OPEN_TAG) { $prevOpen = $phpcsFile->findPrevious(T_OPEN_TAG, ($prev - 1)); if ($prevOpen === false) { // This is a comment directly after the first open tag, // so probably a file comment. $phpcsFile->addError('Missing class doc comment', $stackPtr, 'Missing'); return; } } if ($tokens[$commentEnd]['code'] === T_COMMENT) { $phpcsFile->addError('You must use "/**" style comments for a class comment', $stackPtr, 'WrongStyle'); return; } // Check each tag. $this->processTags($phpcsFile, $stackPtr, $tokens[$commentEnd]['comment_opener']); }//end process() /** * Process the version tag. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param array $tags The tokens for these tags. * * @return void */ protected function processVersion(PHP_CodeSniffer_File $phpcsFile, array $tags) { $tokens = $phpcsFile->getTokens(); foreach ($tags as $tag) { if ($tokens[($tag + 2)]['code'] !== T_DOC_COMMENT_STRING) { // No content. continue; } $content = $tokens[($tag + 2)]['content']; if ((strstr($content, 'Release:') === false)) { $error = 'Invalid version "%s" in doc comment; consider "Release: " instead'; $data = array($content); $phpcsFile->addWarning($error, $tag, 'InvalidVersion', $data); } } }//end processVersion() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/Commenting/FileCommentSniff.php0000644000076700000240000005061512647543456030424 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Parses and verifies the doc comments for files. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_Commenting_FileCommentSniff implements PHP_CodeSniffer_Sniff { /** * Tags in correct order and related info. * * @var array */ protected $tags = array( '@category' => array( 'required' => true, 'allow_multiple' => false, ), '@package' => array( 'required' => true, 'allow_multiple' => false, ), '@subpackage' => array( 'required' => false, 'allow_multiple' => false, ), '@author' => array( 'required' => true, 'allow_multiple' => true, ), '@copyright' => array( 'required' => false, 'allow_multiple' => true, ), '@license' => array( 'required' => true, 'allow_multiple' => false, ), '@version' => array( 'required' => false, 'allow_multiple' => false, ), '@link' => array( 'required' => true, 'allow_multiple' => true, ), '@see' => array( 'required' => false, 'allow_multiple' => true, ), '@since' => array( 'required' => false, 'allow_multiple' => false, ), '@deprecated' => array( 'required' => false, 'allow_multiple' => false, ), ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return int */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Find the next non whitespace token. $commentStart = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); // Allow declare() statements at the top of the file. if ($tokens[$commentStart]['code'] === T_DECLARE) { $semicolon = $phpcsFile->findNext(T_SEMICOLON, ($commentStart + 1)); $commentStart = $phpcsFile->findNext(T_WHITESPACE, ($semicolon + 1), null, true); } // Ignore vim header. if ($tokens[$commentStart]['code'] === T_COMMENT) { if (strstr($tokens[$commentStart]['content'], 'vim:') !== false) { $commentStart = $phpcsFile->findNext( T_WHITESPACE, ($commentStart + 1), null, true ); } } $errorToken = ($stackPtr + 1); if (isset($tokens[$errorToken]) === false) { $errorToken--; } if ($tokens[$commentStart]['code'] === T_CLOSE_TAG) { // We are only interested if this is the first open tag. return ($phpcsFile->numTokens + 1); } else if ($tokens[$commentStart]['code'] === T_COMMENT) { $error = 'You must use "/**" style comments for a file comment'; $phpcsFile->addError($error, $errorToken, 'WrongStyle'); $phpcsFile->recordMetric($stackPtr, 'File has doc comment', 'yes'); return ($phpcsFile->numTokens + 1); } else if ($commentStart === false || $tokens[$commentStart]['code'] !== T_DOC_COMMENT_OPEN_TAG ) { $phpcsFile->addError('Missing file doc comment', $errorToken, 'Missing'); $phpcsFile->recordMetric($stackPtr, 'File has doc comment', 'no'); return ($phpcsFile->numTokens + 1); } else { $phpcsFile->recordMetric($stackPtr, 'File has doc comment', 'yes'); } // Check the PHP Version, which should be in some text before the first tag. $commentEnd = $tokens[$commentStart]['comment_closer']; $found = false; for ($i = ($commentStart + 1); $i < $commentEnd; $i++) { if ($tokens[$i]['code'] === T_DOC_COMMENT_TAG) { break; } else if ($tokens[$i]['code'] === T_DOC_COMMENT_STRING && strstr(strtolower($tokens[$i]['content']), 'php version') !== false ) { $found = true; break; } } if ($found === false) { $error = 'PHP version not specified'; $phpcsFile->addWarning($error, $commentEnd, 'MissingVersion'); } // Check each tag. $this->processTags($phpcsFile, $stackPtr, $commentStart); // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() /** * Processes each required or optional tag. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param int $commentStart Position in the stack where the comment started. * * @return void */ protected function processTags(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart) { $tokens = $phpcsFile->getTokens(); if (get_class($this) === 'PEAR_Sniffs_Commenting_FileCommentSniff') { $docBlock = 'file'; } else { $docBlock = 'class'; } $commentEnd = $tokens[$commentStart]['comment_closer']; $foundTags = array(); $tagTokens = array(); foreach ($tokens[$commentStart]['comment_tags'] as $tag) { $name = $tokens[$tag]['content']; if (isset($this->tags[$name]) === false) { continue; } if ($this->tags[$name]['allow_multiple'] === false && isset($tagTokens[$name]) === true) { $error = 'Only one %s tag is allowed in a %s comment'; $data = array( $name, $docBlock, ); $phpcsFile->addError($error, $tag, 'Duplicate'.ucfirst(substr($name, 1)).'Tag', $data); } $foundTags[] = $name; $tagTokens[$name][] = $tag; $string = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $tag, $commentEnd); if ($string === false || $tokens[$string]['line'] !== $tokens[$tag]['line']) { $error = 'Content missing for %s tag in %s comment'; $data = array( $name, $docBlock, ); $phpcsFile->addError($error, $tag, 'Empty'.ucfirst(substr($name, 1)).'Tag', $data); continue; } }//end foreach // Check if the tags are in the correct position. $pos = 0; foreach ($this->tags as $tag => $tagData) { if (isset($tagTokens[$tag]) === false) { if ($tagData['required'] === true) { $error = 'Missing %s tag in %s comment'; $data = array( $tag, $docBlock, ); $phpcsFile->addError($error, $commentEnd, 'Missing'.ucfirst(substr($tag, 1)).'Tag', $data); } continue; } else { $method = 'process'.substr($tag, 1); if (method_exists($this, $method) === true) { // Process each tag if a method is defined. call_user_func(array($this, $method), $phpcsFile, $tagTokens[$tag]); } } if (isset($foundTags[$pos]) === false) { break; } if ($foundTags[$pos] !== $tag) { $error = 'The tag in position %s should be the %s tag'; $data = array( ($pos + 1), $tag, ); $phpcsFile->addError($error, $tokens[$commentStart]['comment_tags'][$pos], ucfirst(substr($tag, 1)).'TagOrder', $data); } // Account for multiple tags. $pos++; while (isset($foundTags[$pos]) === true && $foundTags[$pos] === $tag) { $pos++; } }//end foreach }//end processTags() /** * Process the category tag. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param array $tags The tokens for these tags. * * @return void */ protected function processCategory(PHP_CodeSniffer_File $phpcsFile, array $tags) { $tokens = $phpcsFile->getTokens(); foreach ($tags as $tag) { if ($tokens[($tag + 2)]['code'] !== T_DOC_COMMENT_STRING) { // No content. continue; } $content = $tokens[($tag + 2)]['content']; if (PHP_CodeSniffer::isUnderscoreName($content) !== true) { $newContent = str_replace(' ', '_', $content); $nameBits = explode('_', $newContent); $firstBit = array_shift($nameBits); $newName = ucfirst($firstBit).'_'; foreach ($nameBits as $bit) { if ($bit !== '') { $newName .= ucfirst($bit).'_'; } } $error = 'Category name "%s" is not valid; consider "%s" instead'; $validName = trim($newName, '_'); $data = array( $content, $validName, ); $phpcsFile->addError($error, $tag, 'InvalidCategory', $data); } }//end foreach }//end processCategory() /** * Process the package tag. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param array $tags The tokens for these tags. * * @return void */ protected function processPackage(PHP_CodeSniffer_File $phpcsFile, array $tags) { $tokens = $phpcsFile->getTokens(); foreach ($tags as $tag) { if ($tokens[($tag + 2)]['code'] !== T_DOC_COMMENT_STRING) { // No content. continue; } $content = $tokens[($tag + 2)]['content']; if (PHP_CodeSniffer::isUnderscoreName($content) === true) { continue; } $newContent = str_replace(' ', '_', $content); $newContent = trim($newContent, '_'); $newContent = preg_replace('/[^A-Za-z_]/', '', $newContent); if ($newContent === '') { $error = 'Package name "%s" is not valid'; $data = array($content); $phpcsFile->addError($error, $tag, 'InvalidPackageValue', $data); } else { $nameBits = explode('_', $newContent); $firstBit = array_shift($nameBits); $newName = strtoupper($firstBit{0}).substr($firstBit, 1).'_'; foreach ($nameBits as $bit) { if ($bit !== '') { $newName .= strtoupper($bit{0}).substr($bit, 1).'_'; } } $error = 'Package name "%s" is not valid; consider "%s" instead'; $validName = trim($newName, '_'); $data = array( $content, $validName, ); $phpcsFile->addError($error, $tag, 'InvalidPackage', $data); }//end if }//end foreach }//end processPackage() /** * Process the subpackage tag. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param array $tags The tokens for these tags. * * @return void */ protected function processSubpackage(PHP_CodeSniffer_File $phpcsFile, array $tags) { $tokens = $phpcsFile->getTokens(); foreach ($tags as $tag) { if ($tokens[($tag + 2)]['code'] !== T_DOC_COMMENT_STRING) { // No content. continue; } $content = $tokens[($tag + 2)]['content']; if (PHP_CodeSniffer::isUnderscoreName($content) === true) { continue; } $newContent = str_replace(' ', '_', $content); $nameBits = explode('_', $newContent); $firstBit = array_shift($nameBits); $newName = strtoupper($firstBit{0}).substr($firstBit, 1).'_'; foreach ($nameBits as $bit) { if ($bit !== '') { $newName .= strtoupper($bit{0}).substr($bit, 1).'_'; } } $error = 'Subpackage name "%s" is not valid; consider "%s" instead'; $validName = trim($newName, '_'); $data = array( $content, $validName, ); $phpcsFile->addError($error, $tag, 'InvalidSubpackage', $data); }//end foreach }//end processSubpackage() /** * Process the author tag(s) that this header comment has. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param array $tags The tokens for these tags. * * @return void */ protected function processAuthor(PHP_CodeSniffer_File $phpcsFile, array $tags) { $tokens = $phpcsFile->getTokens(); foreach ($tags as $tag) { if ($tokens[($tag + 2)]['code'] !== T_DOC_COMMENT_STRING) { // No content. continue; } $content = $tokens[($tag + 2)]['content']; $local = '\da-zA-Z-_+'; // Dot character cannot be the first or last character in the local-part. $localMiddle = $local.'.\w'; if (preg_match('/^([^<]*)\s+<(['.$local.'](['.$localMiddle.']*['.$local.'])*@[\da-zA-Z][-.\w]*[\da-zA-Z]\.[a-zA-Z]{2,7})>$/', $content) === 0) { $error = 'Content of the @author tag must be in the form "Display Name "'; $phpcsFile->addError($error, $tag, 'InvalidAuthors'); } } }//end processAuthor() /** * Process the copyright tags. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param array $tags The tokens for these tags. * * @return void */ protected function processCopyright(PHP_CodeSniffer_File $phpcsFile, array $tags) { $tokens = $phpcsFile->getTokens(); foreach ($tags as $tag) { if ($tokens[($tag + 2)]['code'] !== T_DOC_COMMENT_STRING) { // No content. continue; } $content = $tokens[($tag + 2)]['content']; $matches = array(); if (preg_match('/^([0-9]{4})((.{1})([0-9]{4}))? (.+)$/', $content, $matches) !== 0) { // Check earliest-latest year order. if ($matches[3] !== '') { if ($matches[3] !== '-') { $error = 'A hyphen must be used between the earliest and latest year'; $phpcsFile->addError($error, $tag, 'CopyrightHyphen'); } if ($matches[4] !== '' && $matches[4] < $matches[1]) { $error = "Invalid year span \"$matches[1]$matches[3]$matches[4]\" found; consider \"$matches[4]-$matches[1]\" instead"; $phpcsFile->addWarning($error, $tag, 'InvalidCopyright'); } } } else { $error = '@copyright tag must contain a year and the name of the copyright holder'; $phpcsFile->addError($error, $tag, 'IncompleteCopyright'); } }//end foreach }//end processCopyright() /** * Process the license tag. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param array $tags The tokens for these tags. * * @return void */ protected function processLicense(PHP_CodeSniffer_File $phpcsFile, array $tags) { $tokens = $phpcsFile->getTokens(); foreach ($tags as $tag) { if ($tokens[($tag + 2)]['code'] !== T_DOC_COMMENT_STRING) { // No content. continue; } $content = $tokens[($tag + 2)]['content']; $matches = array(); preg_match('/^([^\s]+)\s+(.*)/', $content, $matches); if (count($matches) !== 3) { $error = '@license tag must contain a URL and a license name'; $phpcsFile->addError($error, $tag, 'IncompleteLicense'); } } }//end processLicense() /** * Process the version tag. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param array $tags The tokens for these tags. * * @return void */ protected function processVersion(PHP_CodeSniffer_File $phpcsFile, array $tags) { $tokens = $phpcsFile->getTokens(); foreach ($tags as $tag) { if ($tokens[($tag + 2)]['code'] !== T_DOC_COMMENT_STRING) { // No content. continue; } $content = $tokens[($tag + 2)]['content']; if (strstr($content, 'CVS:') === false && strstr($content, 'SVN:') === false && strstr($content, 'GIT:') === false && strstr($content, 'HG:') === false ) { $error = 'Invalid version "%s" in file comment; consider "CVS: " or "SVN: " or "GIT: " or "HG: " instead'; $data = array($content); $phpcsFile->addWarning($error, $tag, 'InvalidVersion', $data); } } }//end processVersion() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/Commenting/FunctionCommentSniff.php0000644000076700000240000003571312647543456031334 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Parses and verifies the doc comments for functions. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_Commenting_FunctionCommentSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_FUNCTION); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $find = PHP_CodeSniffer_Tokens::$methodPrefixes; $find[] = T_WHITESPACE; $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true); if ($tokens[$commentEnd]['code'] === T_COMMENT) { // Inline comments might just be closing comments for // control structures or functions instead of function comments // using the wrong comment type. If there is other code on the line, // assume they relate to that code. $prev = $phpcsFile->findPrevious($find, ($commentEnd - 1), null, true); if ($prev !== false && $tokens[$prev]['line'] === $tokens[$commentEnd]['line']) { $commentEnd = $prev; } } if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG && $tokens[$commentEnd]['code'] !== T_COMMENT ) { $phpcsFile->addError('Missing function doc comment', $stackPtr, 'Missing'); $phpcsFile->recordMetric($stackPtr, 'Function has doc comment', 'no'); return; } else { $phpcsFile->recordMetric($stackPtr, 'Function has doc comment', 'yes'); } if ($tokens[$commentEnd]['code'] === T_COMMENT) { $phpcsFile->addError('You must use "/**" style comments for a function comment', $stackPtr, 'WrongStyle'); return; } if ($tokens[$commentEnd]['line'] !== ($tokens[$stackPtr]['line'] - 1)) { $error = 'There must be no blank lines after the function comment'; $phpcsFile->addError($error, $commentEnd, 'SpacingAfter'); } $commentStart = $tokens[$commentEnd]['comment_opener']; foreach ($tokens[$commentStart]['comment_tags'] as $tag) { if ($tokens[$tag]['content'] === '@see') { // Make sure the tag isn't empty. $string = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $tag, $commentEnd); if ($string === false || $tokens[$string]['line'] !== $tokens[$tag]['line']) { $error = 'Content missing for @see tag in function comment'; $phpcsFile->addError($error, $tag, 'EmptySees'); } } } $this->processReturn($phpcsFile, $stackPtr, $commentStart); $this->processThrows($phpcsFile, $stackPtr, $commentStart); $this->processParams($phpcsFile, $stackPtr, $commentStart); }//end process() /** * Process the return comment of this function comment. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param int $commentStart The position in the stack where the comment started. * * @return void */ protected function processReturn(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart) { $tokens = $phpcsFile->getTokens(); // Skip constructor and destructor. $methodName = $phpcsFile->getDeclarationName($stackPtr); $isSpecialMethod = ($methodName === '__construct' || $methodName === '__destruct'); $return = null; foreach ($tokens[$commentStart]['comment_tags'] as $tag) { if ($tokens[$tag]['content'] === '@return') { if ($return !== null) { $error = 'Only 1 @return tag is allowed in a function comment'; $phpcsFile->addError($error, $tag, 'DuplicateReturn'); return; } $return = $tag; } } if ($isSpecialMethod === true) { return; } if ($return !== null) { $content = $tokens[($return + 2)]['content']; if (empty($content) === true || $tokens[($return + 2)]['code'] !== T_DOC_COMMENT_STRING) { $error = 'Return type missing for @return tag in function comment'; $phpcsFile->addError($error, $return, 'MissingReturnType'); } } else { $error = 'Missing @return tag in function comment'; $phpcsFile->addError($error, $tokens[$commentStart]['comment_closer'], 'MissingReturn'); }//end if }//end processReturn() /** * Process any throw tags that this function comment has. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param int $commentStart The position in the stack where the comment started. * * @return void */ protected function processThrows(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart) { $tokens = $phpcsFile->getTokens(); $throws = array(); foreach ($tokens[$commentStart]['comment_tags'] as $tag) { if ($tokens[$tag]['content'] !== '@throws') { continue; } $exception = null; $comment = null; if ($tokens[($tag + 2)]['code'] === T_DOC_COMMENT_STRING) { $matches = array(); preg_match('/([^\s]+)(?:\s+(.*))?/', $tokens[($tag + 2)]['content'], $matches); $exception = $matches[1]; if (isset($matches[2]) === true) { $comment = $matches[2]; } } if ($exception === null) { $error = 'Exception type missing for @throws tag in function comment'; $phpcsFile->addError($error, $tag, 'InvalidThrows'); } }//end foreach }//end processThrows() /** * Process the function parameter comments. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param int $commentStart The position in the stack where the comment started. * * @return void */ protected function processParams(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart) { $tokens = $phpcsFile->getTokens(); $params = array(); $maxType = 0; $maxVar = 0; foreach ($tokens[$commentStart]['comment_tags'] as $pos => $tag) { if ($tokens[$tag]['content'] !== '@param') { continue; } $type = ''; $typeSpace = 0; $var = ''; $varSpace = 0; $comment = ''; if ($tokens[($tag + 2)]['code'] === T_DOC_COMMENT_STRING) { $matches = array(); preg_match('/([^$&.]+)(?:((?:\.\.\.)?(?:\$|&)[^\s]+)(?:(\s+)(.*))?)?/', $tokens[($tag + 2)]['content'], $matches); $typeLen = strlen($matches[1]); $type = trim($matches[1]); $typeSpace = ($typeLen - strlen($type)); $typeLen = strlen($type); if ($typeLen > $maxType) { $maxType = $typeLen; } if (isset($matches[2]) === true) { $var = $matches[2]; $varLen = strlen($var); if ($varLen > $maxVar) { $maxVar = $varLen; } if (isset($matches[4]) === true) { $varSpace = strlen($matches[3]); $comment = $matches[4]; // Any strings until the next tag belong to this comment. if (isset($tokens[$commentStart]['comment_tags'][($pos + 1)]) === true) { $end = $tokens[$commentStart]['comment_tags'][($pos + 1)]; } else { $end = $tokens[$commentStart]['comment_closer']; } for ($i = ($tag + 3); $i < $end; $i++) { if ($tokens[$i]['code'] === T_DOC_COMMENT_STRING) { $comment .= ' '.$tokens[$i]['content']; } } } else { $error = 'Missing parameter comment'; $phpcsFile->addError($error, $tag, 'MissingParamComment'); } } else { $error = 'Missing parameter name'; $phpcsFile->addError($error, $tag, 'MissingParamName'); }//end if } else { $error = 'Missing parameter type'; $phpcsFile->addError($error, $tag, 'MissingParamType'); }//end if $params[] = array( 'tag' => $tag, 'type' => $type, 'var' => $var, 'comment' => $comment, 'type_space' => $typeSpace, 'var_space' => $varSpace, ); }//end foreach $realParams = $phpcsFile->getMethodParameters($stackPtr); $foundParams = array(); // We want to use ... for all variable length arguments, so added // this prefix to the variable name so comparisons are easier. foreach ($realParams as $pos => $param) { if ($param['variable_length'] === true) { $realParams[$pos]['name'] = '...'.$realParams[$pos]['name']; } } foreach ($params as $pos => $param) { if ($param['var'] === '') { continue; } $foundParams[] = $param['var']; // Check number of spaces after the type. $spaces = ($maxType - strlen($param['type']) + 1); if ($param['type_space'] !== $spaces) { $error = 'Expected %s spaces after parameter type; %s found'; $data = array( $spaces, $param['type_space'], ); $fix = $phpcsFile->addFixableError($error, $param['tag'], 'SpacingAfterParamType', $data); if ($fix === true) { $content = $param['type']; $content .= str_repeat(' ', $spaces); $content .= $param['var']; $content .= str_repeat(' ', $param['var_space']); $content .= $param['comment']; $phpcsFile->fixer->replaceToken(($param['tag'] + 2), $content); } } // Make sure the param name is correct. if (isset($realParams[$pos]) === true) { $realName = $realParams[$pos]['name']; if ($realName !== $param['var']) { $code = 'ParamNameNoMatch'; $data = array( $param['var'], $realName, ); $error = 'Doc comment for parameter %s does not match '; if (strtolower($param['var']) === strtolower($realName)) { $error .= 'case of '; $code = 'ParamNameNoCaseMatch'; } $error .= 'actual variable name %s'; $phpcsFile->addError($error, $param['tag'], $code, $data); } } else if (substr($param['var'], -4) !== ',...') { // We must have an extra parameter comment. $error = 'Superfluous parameter comment'; $phpcsFile->addError($error, $param['tag'], 'ExtraParamComment'); }//end if if ($param['comment'] === '') { continue; } // Check number of spaces after the var name. $spaces = ($maxVar - strlen($param['var']) + 1); if ($param['var_space'] !== $spaces) { $error = 'Expected %s spaces after parameter name; %s found'; $data = array( $spaces, $param['var_space'], ); $fix = $phpcsFile->addFixableError($error, $param['tag'], 'SpacingAfterParamName', $data); if ($fix === true) { $content = $param['type']; $content .= str_repeat(' ', $param['type_space']); $content .= $param['var']; $content .= str_repeat(' ', $spaces); $content .= $param['comment']; $phpcsFile->fixer->replaceToken(($param['tag'] + 2), $content); } } }//end foreach $realNames = array(); foreach ($realParams as $realParam) { $realNames[] = $realParam['name']; } // Report missing comments. $diff = array_diff($realNames, $foundParams); foreach ($diff as $neededParam) { $error = 'Doc comment for parameter "%s" missing'; $data = array($neededParam); $phpcsFile->addError($error, $commentStart, 'MissingParamTag', $data); } }//end processParams() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/Commenting/InlineCommentSniff.php0000644000076700000240000000536112647543456030761 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PHP_CodeSniffer_Sniffs_PEAR_Commenting_InlineCommentSniff. * * Checks that no perl-style comments are used. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_Commenting_InlineCommentSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_COMMENT); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[$stackPtr]['content']{0} === '#') { $phpcsFile->recordMetric($stackPtr, 'Inline comment style', '# ...'); $error = 'Perl-style comments are not allowed. Use "// Comment."'; $error .= ' or "/* comment */" instead.'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'WrongStyle'); if ($fix === true) { $newComment = ltrim($tokens[$stackPtr]['content'], '# '); $newComment = '// '.$newComment; $phpcsFile->fixer->replaceToken($stackPtr, $newComment); } } else if ($tokens[$stackPtr]['content']{0} === '/' && $tokens[$stackPtr]['content']{1} === '/' ) { $phpcsFile->recordMetric($stackPtr, 'Inline comment style', '// ...'); } else if ($tokens[$stackPtr]['content']{0} === '/' && $tokens[$stackPtr]['content']{1} === '*' ) { $phpcsFile->recordMetric($stackPtr, 'Inline comment style', '/* ... */'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/ControlStructures/ControlSignatureSniff.php0000644000076700000240000000365112647543456033146 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractPatternSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractPatternSniff not found'); } /** * Verifies that control statements conform to their coding standards. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_ControlStructures_ControlSignatureSniff extends PHP_CodeSniffer_Standards_AbstractPatternSniff { /** * If true, comments will be ignored if they are found in the code. * * @var boolean */ public $ignoreComments = true; /** * Returns the patterns that this test wishes to verify. * * @return string[] */ protected function getPatterns() { return array( 'do {EOL...} while (...);EOL', 'while (...) {EOL', 'for (...) {EOL', 'if (...) {EOL', 'foreach (...) {EOL', '} else if (...) {EOL', '} elseif (...) {EOL', '} else {EOL', 'do {EOL', ); }//end getPatterns() }//end class ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/ControlStructures/MultiLineConditionSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/ControlStructures/MultiLineConditionSniff.ph0000644000076700000240000002567712647543456033251 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PEAR_Sniffs_ControlStructures_MultiLineConditionSniff. * * Ensure multi-line IF conditions are defined correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_ControlStructures_MultiLineConditionSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * The number of spaces code should be indented. * * @var int */ public $indent = 4; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_IF, T_ELSEIF, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['parenthesis_opener']) === false) { return; } $openBracket = $tokens[$stackPtr]['parenthesis_opener']; $closeBracket = $tokens[$stackPtr]['parenthesis_closer']; $spaceAfterOpen = 0; if ($tokens[($openBracket + 1)]['code'] === T_WHITESPACE) { if (strpos($tokens[($openBracket + 1)]['content'], $phpcsFile->eolChar) !== false) { $spaceAfterOpen = 'newline'; } else { $spaceAfterOpen = strlen($tokens[($openBracket + 1)]['content']); } } if ($spaceAfterOpen !== 0) { $error = 'First condition of a multi-line IF statement must directly follow the opening parenthesis'; $fix = $phpcsFile->addFixableError($error, ($openBracket + 1), 'SpacingAfterOpenBrace'); if ($fix === true) { if ($spaceAfterOpen === 'newline') { $phpcsFile->fixer->replaceToken(($openBracket + 1), ''); } else { $phpcsFile->fixer->replaceToken(($openBracket + 1), ''); } } } // We need to work out how far indented the if statement // itself is, so we can work out how far to indent conditions. $statementIndent = 0; for ($i = ($stackPtr - 1); $i >= 0; $i--) { if ($tokens[$i]['line'] !== $tokens[$stackPtr]['line']) { $i++; break; } } if ($i >= 0 && $tokens[$i]['code'] === T_WHITESPACE) { $statementIndent = strlen($tokens[$i]['content']); } // Each line between the parenthesis should be indented 4 spaces // and start with an operator, unless the line is inside a // function call, in which case it is ignored. $lastLine = $tokens[$openBracket]['line']; for ($i = ($openBracket + 1); $i < $closeBracket; $i++) { if ($tokens[$i]['line'] !== $lastLine) { if ($tokens[$i]['line'] === $tokens[$closeBracket]['line']) { $next = $phpcsFile->findNext(T_WHITESPACE, $i, null, true); if ($next !== $closeBracket) { // Closing bracket is on the same line as a condition. $error = 'Closing parenthesis of a multi-line IF statement must be on a new line'; $fix = $phpcsFile->addFixableError($error, $closeBracket, 'CloseBracketNewLine'); if ($fix === true) { // Account for a comment at the end of the line. $next = $phpcsFile->findNext(T_WHITESPACE, ($closeBracket + 1), null, true); if ($tokens[$next]['code'] !== T_COMMENT) { $phpcsFile->fixer->addNewlineBefore($closeBracket); } else { $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($next + 1), null, true); $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->replaceToken($closeBracket, ''); $phpcsFile->fixer->addContentBefore($next, ')'); $phpcsFile->fixer->endChangeset(); } } $expectedIndent = ($statementIndent + $this->indent); } else { // Closing brace needs to be indented to the same level // as the statement. $expectedIndent = $statementIndent; }//end if } else { $expectedIndent = ($statementIndent + $this->indent); }//end if if ($tokens[$i]['code'] === T_COMMENT) { $lastLine = $tokens[$i]['line']; continue; } // We changed lines, so this should be a whitespace indent token. if ($tokens[$i]['code'] !== T_WHITESPACE) { $foundIndent = 0; } else { $foundIndent = strlen($tokens[$i]['content']); } if ($expectedIndent !== $foundIndent) { $error = 'Multi-line IF statement not indented correctly; expected %s spaces but found %s'; $data = array( $expectedIndent, $foundIndent, ); $fix = $phpcsFile->addFixableError($error, $i, 'Alignment', $data); if ($fix === true) { $spaces = str_repeat(' ', $expectedIndent); if ($foundIndent === 0) { $phpcsFile->fixer->addContentBefore($i, $spaces); } else { $phpcsFile->fixer->replaceToken($i, $spaces); } } } if ($tokens[$i]['line'] !== $tokens[$closeBracket]['line']) { $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, $i, null, true); if (isset(PHP_CodeSniffer_Tokens::$booleanOperators[$tokens[$next]['code']]) === false) { $error = 'Each line in a multi-line IF statement must begin with a boolean operator'; $fix = $phpcsFile->addFixableError($error, $i, 'StartWithBoolean'); if ($fix === true) { $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($i - 1), $openBracket, true); if (isset(PHP_CodeSniffer_Tokens::$booleanOperators[$tokens[$prev]['code']]) === true) { $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->replaceToken($prev, ''); $phpcsFile->fixer->addContentBefore($next, $tokens[$prev]['content'].' '); $phpcsFile->fixer->endChangeset(); } else { for ($x = ($prev + 1); $x < $next; $x++) { $phpcsFile->fixer->replaceToken($x, ''); } } } } }//end if $lastLine = $tokens[$i]['line']; }//end if if ($tokens[$i]['code'] === T_STRING) { $next = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), null, true); if ($tokens[$next]['code'] === T_OPEN_PARENTHESIS) { // This is a function call, so skip to the end as they // have their own indentation rules. $i = $tokens[$next]['parenthesis_closer']; $lastLine = $tokens[$i]['line']; continue; } } }//end for // From here on, we are checking the spacing of the opening and closing // braces. If this IF statement does not use braces, we end here. if (isset($tokens[$stackPtr]['scope_opener']) === false) { return; } // The opening brace needs to be one space away from the closing parenthesis. $openBrace = $tokens[$stackPtr]['scope_opener']; $next = $phpcsFile->findNext(T_WHITESPACE, ($closeBracket + 1), $openBrace, true); if ($next !== false) { // Probably comments in between tokens, so don't check. return; } if ($tokens[$openBrace]['line'] > $tokens[$closeBracket]['line']) { $length = -1; } else if ($openBrace === ($closeBracket + 1)) { $length = 0; } else if ($openBrace === ($closeBracket + 2) && $tokens[($closeBracket + 1)]['code'] === T_WHITESPACE ) { $length = strlen($tokens[($closeBracket + 1)]['content']); } else { // Confused, so don't check. $length = 1; } if ($length === 1) { return; } $data = array($length); $code = 'SpaceBeforeOpenBrace'; $error = 'There must be a single space between the closing parenthesis and the opening brace of a multi-line IF statement; found '; if ($length === -1) { $error .= 'newline'; $code = 'NewlineBeforeOpenBrace'; } else { $error .= '%s spaces'; } $fix = $phpcsFile->addFixableError($error, ($closeBracket + 1), $code, $data); if ($fix === true) { if ($length === 0) { $phpcsFile->fixer->addContent($closeBracket, ' '); } else { $phpcsFile->fixer->replaceToken(($closeBracket + 1), ' '); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/Files/IncludingFileSniff.php0000644000076700000240000001356412647543456027702 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PEAR_Sniffs_Files_IncludingFileSniff. * * Checks that the include_once is used in conditional situations, and * require_once is used elsewhere. Also checks that brackets do not surround * the file being included. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_Files_IncludingFileSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_INCLUDE_ONCE, T_REQUIRE_ONCE, T_REQUIRE, T_INCLUDE, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $nextToken = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true); if ($tokens[$nextToken]['code'] === T_OPEN_PARENTHESIS) { $error = '"%s" is a statement not a function; no parentheses are required'; $data = array($tokens[$stackPtr]['content']); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'BracketsNotRequired', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->replaceToken($tokens[$nextToken]['parenthesis_closer'], ''); if ($tokens[($nextToken - 1)]['code'] !== T_WHITESPACE) { $phpcsFile->fixer->replaceToken($nextToken, ' '); } else { $phpcsFile->fixer->replaceToken($nextToken, ''); } $phpcsFile->fixer->endChangeset(); } } if (count($tokens[$stackPtr]['conditions']) !== 0) { $inCondition = true; } else { $inCondition = false; } // Check to see if this including statement is within the parenthesis // of a condition. If that's the case then we need to process it as being // within a condition, as they are checking the return value. if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) { foreach ($tokens[$stackPtr]['nested_parenthesis'] as $left => $right) { if (isset($tokens[$left]['parenthesis_owner']) === true) { $inCondition = true; } } } // Check to see if they are assigning the return value of this // including call. If they are then they are probably checking it, so // it's conditional. $previous = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); if (isset(PHP_CodeSniffer_Tokens::$assignmentTokens[$tokens[$previous]['code']]) === true) { // The have assigned the return value to it, so its conditional. $inCondition = true; } $tokenCode = $tokens[$stackPtr]['code']; if ($inCondition === true) { // We are inside a conditional statement. We need an include_once. if ($tokenCode === T_REQUIRE_ONCE) { $error = 'File is being conditionally included; '; $error .= 'use "include_once" instead'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'UseIncludeOnce'); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, 'include_once'); } } else if ($tokenCode === T_REQUIRE) { $error = 'File is being conditionally included; '; $error .= 'use "include" instead'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'UseInclude'); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, 'include'); } } } else { // We are unconditionally including, we need a require_once. if ($tokenCode === T_INCLUDE_ONCE) { $error = 'File is being unconditionally included; '; $error .= 'use "require_once" instead'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'UseRequireOnce'); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, 'require_once'); } } else if ($tokenCode === T_INCLUDE) { $error = 'File is being unconditionally included; '; $error .= 'use "require" instead'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'UseRequire'); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, 'require'); } } }//end if }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/Formatting/MultiLineAssignmentSniff.php0000644000076700000240000000715712647543456032172 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PEAR_Sniffs_Formatting_MultiLineAssignmentSniff. * * If an assignment goes over two lines, ensure the equal sign is indented. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_Formatting_MultiLineAssignmentSniff implements PHP_CodeSniffer_Sniff { /** * The number of spaces code should be indented. * * @var int */ public $indent = 4; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_EQUAL); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Equal sign can't be the last thing on the line. $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($next === false) { // Bad assignment. return; } if ($tokens[$next]['line'] !== $tokens[$stackPtr]['line']) { $error = 'Multi-line assignments must have the equal sign on the second line'; $phpcsFile->addError($error, $stackPtr, 'EqualSignLine'); return; } // Make sure it is the first thing on the line, otherwise we ignore it. $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), false, true); if ($prev === false) { // Bad assignment. return; } if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) { return; } // Find the required indent based on the ident of the previous line. $assignmentIndent = 0; $prevLine = $tokens[$prev]['line']; for ($i = ($prev - 1); $i >= 0; $i--) { if ($tokens[$i]['line'] !== $prevLine) { $i++; break; } } if ($tokens[$i]['code'] === T_WHITESPACE) { $assignmentIndent = strlen($tokens[$i]['content']); } // Find the actual indent. $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1)); $expectedIndent = ($assignmentIndent + $this->indent); $foundIndent = strlen($tokens[$prev]['content']); if ($foundIndent !== $expectedIndent) { $error = 'Multi-line assignment not indented correctly; expected %s spaces but found %s'; $data = array( $expectedIndent, $foundIndent, ); $phpcsFile->addError($error, $stackPtr, 'Indent', $data); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/Functions/FunctionCallSignatureSniff.php0000644000076700000240000005076112647543456032337 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PEAR_Sniffs_Functions_FunctionCallSignatureSniff. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_Functions_FunctionCallSignatureSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * The number of spaces code should be indented. * * @var int */ public $indent = 4; /** * If TRUE, multiple arguments can be defined per line in a multi-line call. * * @var bool */ public $allowMultipleArguments = true; /** * How many spaces should follow the opening bracket. * * @var int */ public $requiredSpacesAfterOpen = 0; /** * How many spaces should precede the closing bracket. * * @var int */ public $requiredSpacesBeforeClose = 0; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return PHP_CodeSniffer_Tokens::$functionNameTokens; }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $this->requiredSpacesAfterOpen = (int) $this->requiredSpacesAfterOpen; $this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose; $tokens = $phpcsFile->getTokens(); // Find the next non-empty token. $openBracket = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true); if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) { // Not a function call. return; } if (isset($tokens[$openBracket]['parenthesis_closer']) === false) { // Not a function call. return; } // Find the previous non-empty token. $search = PHP_CodeSniffer_Tokens::$emptyTokens; $search[] = T_BITWISE_AND; $previous = $phpcsFile->findPrevious($search, ($stackPtr - 1), null, true); if ($tokens[$previous]['code'] === T_FUNCTION) { // It's a function definition, not a function call. return; } $closeBracket = $tokens[$openBracket]['parenthesis_closer']; if (($stackPtr + 1) !== $openBracket) { // Checking this: $value = my_function[*](...). $error = 'Space before opening parenthesis of function call prohibited'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeOpenBracket'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($stackPtr + 1); $i < $openBracket; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } // Modify the bracket as well to ensure a conflict if the bracket // has been changed in some way by another sniff. $phpcsFile->fixer->replaceToken($openBracket, '('); $phpcsFile->fixer->endChangeset(); } } $next = $phpcsFile->findNext(T_WHITESPACE, ($closeBracket + 1), null, true); if ($tokens[$next]['code'] === T_SEMICOLON) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[($closeBracket + 1)]['code']]) === true) { $error = 'Space after closing parenthesis of function call prohibited'; $fix = $phpcsFile->addFixableError($error, $closeBracket, 'SpaceAfterCloseBracket'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($closeBracket + 1); $i < $next; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } // Modify the bracket as well to ensure a conflict if the bracket // has been changed in some way by another sniff. $phpcsFile->fixer->replaceToken($closeBracket, ')'); $phpcsFile->fixer->endChangeset(); } } } // Check if this is a single line or multi-line function call. if ($this->isMultiLineCall($phpcsFile, $stackPtr, $openBracket, $tokens) === true) { $this->processMultiLineCall($phpcsFile, $stackPtr, $openBracket, $tokens); } else { $this->processSingleLineCall($phpcsFile, $stackPtr, $openBracket, $tokens); } }//end process() /** * Processes single-line calls. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param int $openBracket The position of the opening bracket * in the stack passed in $tokens. * @param array $tokens The stack of tokens that make up * the file. * * @return void */ public function isMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens) { $closeBracket = $tokens[$openBracket]['parenthesis_closer']; if ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']) { return true; } return false; }//end isMultiLineCall() /** * Processes single-line calls. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param int $openBracket The position of the opening bracket * in the stack passed in $tokens. * @param array $tokens The stack of tokens that make up * the file. * * @return void */ public function processSingleLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens) { $closer = $tokens[$openBracket]['parenthesis_closer']; if ($openBracket === ($closer - 1)) { return; } if ($this->requiredSpacesAfterOpen === 0 && $tokens[($openBracket + 1)]['code'] === T_WHITESPACE) { // Checking this: $value = my_function([*]...). $error = 'Space after opening parenthesis of function call prohibited'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpenBracket'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($openBracket + 1), ''); } } else if ($this->requiredSpacesAfterOpen > 0) { $spaceAfterOpen = 0; if ($tokens[($openBracket + 1)]['code'] === T_WHITESPACE) { $spaceAfterOpen = strlen($tokens[($openBracket + 1)]['content']); } if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) { $error = 'Expected %s spaces after opening bracket; %s found'; $data = array( $this->requiredSpacesAfterOpen, $spaceAfterOpen, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpenBracket', $data); if ($fix === true) { $padding = str_repeat(' ', $this->requiredSpacesAfterOpen); if ($spaceAfterOpen === 0) { $phpcsFile->fixer->addContent($openBracket, $padding); } else { $phpcsFile->fixer->replaceToken(($openBracket + 1), $padding); } } } }//end if // Checking this: $value = my_function(...[*]). $spaceBeforeClose = 0; $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($closer - 1), $openBracket, true); if ($tokens[$prev]['code'] === T_END_HEREDOC || $tokens[$prev]['code'] === T_END_NOWDOC) { // Need a newline after these tokens, so ignore this rule. return; } if ($tokens[$prev]['line'] !== $tokens[$closer]['line']) { $spaceBeforeClose = 'newline'; } else if ($tokens[($closer - 1)]['code'] === T_WHITESPACE) { $spaceBeforeClose = strlen($tokens[($closer - 1)]['content']); } if ($spaceBeforeClose !== $this->requiredSpacesBeforeClose) { $error = 'Expected %s spaces before closing bracket; %s found'; $data = array( $this->requiredSpacesBeforeClose, $spaceBeforeClose, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeCloseBracket', $data); if ($fix === true) { $padding = str_repeat(' ', $this->requiredSpacesBeforeClose); if ($spaceBeforeClose === 0) { $phpcsFile->fixer->addContentBefore($closer, $padding); } else { $phpcsFile->fixer->replaceToken(($closer - 1), $padding); } } } }//end processSingleLineCall() /** * Processes multi-line calls. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param int $openBracket The position of the opening bracket * in the stack passed in $tokens. * @param array $tokens The stack of tokens that make up * the file. * * @return void */ public function processMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens) { // We need to work out how far indented the function // call itself is, so we can work out how far to // indent the arguments. $start = $phpcsFile->findStartOfStatement($stackPtr); foreach (array('stackPtr', 'start') as $checkToken) { $x = $$checkToken; for ($i = ($x - 1); $i >= 0; $i--) { if ($tokens[$i]['line'] !== $tokens[$x]['line']) { $i++; break; } } if ($i <= 0) { $functionIndent = 0; } else if ($tokens[$i]['code'] === T_WHITESPACE) { $functionIndent = strlen($tokens[$i]['content']); } else if ($tokens[$i]['code'] === T_CONSTANT_ENCAPSED_STRING) { $functionIndent = 0; } else { $trimmed = ltrim($tokens[$i]['content']); if ($trimmed === '') { if ($tokens[$i]['code'] === T_INLINE_HTML) { $functionIndent = strlen($tokens[$i]['content']); } else { $functionIndent = ($tokens[$i]['column'] - 1); } } else { $functionIndent = (strlen($tokens[$i]['content']) - strlen($trimmed)); } } $varName = $checkToken.'Indent'; $$varName = $functionIndent; }//end foreach $functionIndent = max($startIndent, $stackPtrIndent); $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($openBracket + 1), null, true); if ($tokens[$next]['line'] === $tokens[$openBracket]['line']) { $error = 'Opening parenthesis of a multi-line function call must be the last content on the line'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'ContentAfterOpenBracket'); if ($fix === true) { $phpcsFile->fixer->addContent( $openBracket, $phpcsFile->eolChar.str_repeat(' ', ($functionIndent + $this->indent)) ); } } $closeBracket = $tokens[$openBracket]['parenthesis_closer']; $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($closeBracket - 1), null, true); if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) { $error = 'Closing parenthesis of a multi-line function call must be on a line by itself'; $fix = $phpcsFile->addFixableError($error, $closeBracket, 'CloseBracketLine'); if ($fix === true) { $phpcsFile->fixer->addContentBefore( $closeBracket, $phpcsFile->eolChar.str_repeat(' ', ($functionIndent + $this->indent)) ); } } // Each line between the parenthesis should be indented n spaces. $lastLine = $tokens[$openBracket]['line']; $argStart = null; $argEnd = null; $inArg = false; for ($i = ($openBracket + 1); $i < $closeBracket; $i++) { if ($i > $argStart && $i < $argEnd) { $inArg = true; } else { $inArg = false; } if ($tokens[$i]['line'] !== $lastLine) { $lastLine = $tokens[$i]['line']; // Ignore heredoc indentation. if (isset(PHP_CodeSniffer_Tokens::$heredocTokens[$tokens[$i]['code']]) === true) { continue; } // Ignore multi-line string indentation. if (isset(PHP_CodeSniffer_Tokens::$stringTokens[$tokens[$i]['code']]) === true && $tokens[$i]['code'] === $tokens[($i - 1)]['code'] ) { continue; } // Ignore inline HTML. if ($tokens[$i]['code'] === T_INLINE_HTML) { continue; } // We changed lines, so this should be a whitespace indent token, but first make // sure it isn't a blank line because we don't need to check indent unless there // is actually some code to indent. if ($tokens[$i]['code'] === T_WHITESPACE) { $nextCode = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), ($closeBracket + 1), true); if ($tokens[$nextCode]['line'] !== $lastLine) { if ($inArg === false) { $error = 'Empty lines are not allowed in multi-line function calls'; $fix = $phpcsFile->addFixableError($error, $i, 'EmptyLine'); if ($fix === true) { $phpcsFile->fixer->replaceToken($i, ''); } } continue; } } else { $nextCode = $i; } if ($tokens[$nextCode]['line'] === $tokens[$closeBracket]['line']) { // Closing brace needs to be indented to the same level // as the function call. $inArg = false; $expectedIndent = $functionIndent; } else { $expectedIndent = ($functionIndent + $this->indent); } if ($tokens[$i]['code'] !== T_WHITESPACE && $tokens[$i]['code'] !== T_DOC_COMMENT_WHITESPACE ) { // Just check if it is a multi-line block comment. If so, we can // calculate the indent from the whitespace before the content. if ($tokens[$i]['code'] === T_COMMENT && $tokens[($i - 1)]['code'] === T_COMMENT ) { $trimmed = ltrim($tokens[$i]['content']); $foundIndent = (strlen($tokens[$i]['content']) - strlen($trimmed)); } else { $foundIndent = 0; } } else { $foundIndent = strlen($tokens[$i]['content']); } if ($foundIndent < $expectedIndent || ($inArg === false && $expectedIndent !== $foundIndent) ) { $error = 'Multi-line function call not indented correctly; expected %s spaces but found %s'; $data = array( $expectedIndent, $foundIndent, ); $fix = $phpcsFile->addFixableError($error, $i, 'Indent', $data); if ($fix === true) { $padding = str_repeat(' ', $expectedIndent); if ($foundIndent === 0) { $phpcsFile->fixer->addContentBefore($i, $padding); } else { if ($tokens[$i]['code'] === T_COMMENT) { $comment = $padding.ltrim($tokens[$i]['content']); $phpcsFile->fixer->replaceToken($i, $comment); } else { $phpcsFile->fixer->replaceToken($i, $padding); } } } }//end if if ($inArg === false) { $argStart = $nextCode; $argEnd = $phpcsFile->findEndOfStatement($nextCode); } }//end if // If we are within an argument we should be ignoring commas // as these are not signaling the end of an argument. if ($inArg === false && $tokens[$i]['code'] === T_COMMA) { $next = $phpcsFile->findNext(array(T_WHITESPACE, T_COMMENT), ($i + 1), $closeBracket, true); if ($next === false) { continue; } if ($this->allowMultipleArguments === false) { // Comma has to be the last token on the line. if ($tokens[$i]['line'] === $tokens[$next]['line']) { $error = 'Only one argument is allowed per line in a multi-line function call'; $fix = $phpcsFile->addFixableError($error, $next, 'MultipleArguments'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($x = ($next - 1); $x > $i; $x--) { if ($tokens[$x]['code'] !== T_WHITESPACE) { break; } $phpcsFile->fixer->replaceToken($x, ''); } $phpcsFile->fixer->addContentBefore( $next, $phpcsFile->eolChar.str_repeat(' ', ($functionIndent + $this->indent)) ); $phpcsFile->fixer->endChangeset(); } } }//end if $argStart = $next; $argEnd = $phpcsFile->findEndOfStatement($next); }//end if }//end for }//end processMultiLineCall() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/Functions/FunctionDeclarationSniff.php0000644000076700000240000004072412647543456032025 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PEAR_Sniffs_Functions_FunctionDeclarationSniff. * * Ensure single and multi-line function declarations are defined correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_Functions_FunctionDeclarationSniff implements PHP_CodeSniffer_Sniff { /** * The number of spaces code should be indented. * * @var int */ public $indent = 4; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_FUNCTION, T_CLOSURE, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['parenthesis_opener']) === false || isset($tokens[$stackPtr]['parenthesis_closer']) === false || $tokens[$stackPtr]['parenthesis_opener'] === null || $tokens[$stackPtr]['parenthesis_closer'] === null ) { return; } $openBracket = $tokens[$stackPtr]['parenthesis_opener']; $closeBracket = $tokens[$stackPtr]['parenthesis_closer']; // Must be one space after the FUNCTION keyword. if ($tokens[($stackPtr + 1)]['content'] === $phpcsFile->eolChar) { $spaces = 'newline'; } else if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) { $spaces = strlen($tokens[($stackPtr + 1)]['content']); } else { $spaces = 0; } if ($spaces !== 1) { $error = 'Expected 1 space after FUNCTION keyword; %s found'; $data = array($spaces); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterFunction', $data); if ($fix === true) { if ($spaces === 0) { $phpcsFile->fixer->addContent($stackPtr, ' '); } else { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' '); } } } // Must be one space before the opening parenthesis. For closures, this is // enforced by the first check because there is no content between the keywords // and the opening parenthesis. if ($tokens[$stackPtr]['code'] === T_FUNCTION) { if ($tokens[($openBracket - 1)]['content'] === $phpcsFile->eolChar) { $spaces = 'newline'; } else if ($tokens[($openBracket - 1)]['code'] === T_WHITESPACE) { $spaces = strlen($tokens[($openBracket - 1)]['content']); } else { $spaces = 0; } if ($spaces !== 0) { $error = 'Expected 0 spaces before opening parenthesis; %s found'; $data = array($spaces); $fix = $phpcsFile->addFixableError($error, $openBracket, 'SpaceBeforeOpenParen', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($openBracket - 1), ''); } } }//end if // Must be one space before and after USE keyword for closures. if ($tokens[$stackPtr]['code'] === T_CLOSURE) { $use = $phpcsFile->findNext(T_USE, ($closeBracket + 1), $tokens[$stackPtr]['scope_opener']); if ($use !== false) { if ($tokens[($use + 1)]['code'] !== T_WHITESPACE) { $length = 0; } else if ($tokens[($use + 1)]['content'] === "\t") { $length = '\t'; } else { $length = strlen($tokens[($use + 1)]['content']); } if ($length !== 1) { $error = 'Expected 1 space after USE keyword; found %s'; $data = array($length); $fix = $phpcsFile->addFixableError($error, $use, 'SpaceAfterUse', $data); if ($fix === true) { if ($length === 0) { $phpcsFile->fixer->addContent($use, ' '); } else { $phpcsFile->fixer->replaceToken(($use + 1), ' '); } } } if ($tokens[($use - 1)]['code'] !== T_WHITESPACE) { $length = 0; } else if ($tokens[($use - 1)]['content'] === "\t") { $length = '\t'; } else { $length = strlen($tokens[($use - 1)]['content']); } if ($length !== 1) { $error = 'Expected 1 space before USE keyword; found %s'; $data = array($length); $fix = $phpcsFile->addFixableError($error, $use, 'SpaceBeforeUse', $data); if ($fix === true) { if ($length === 0) { $phpcsFile->fixer->addContentBefore($use, ' '); } else { $phpcsFile->fixer->replaceToken(($use - 1), ' '); } } } }//end if }//end if // Check if this is a single line or multi-line declaration. $singleLine = true; if ($tokens[$openBracket]['line'] === $tokens[$closeBracket]['line']) { // Closures may use the USE keyword and so be multi-line in this way. if ($tokens[$stackPtr]['code'] === T_CLOSURE) { if ($use !== false) { // If the opening and closing parenthesis of the use statement // are also on the same line, this is a single line declaration. $open = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($use + 1)); $close = $tokens[$open]['parenthesis_closer']; if ($tokens[$open]['line'] !== $tokens[$close]['line']) { $singleLine = false; } } } } else { $singleLine = false; } if ($singleLine === true) { $this->processSingleLineDeclaration($phpcsFile, $stackPtr, $tokens); } else { $this->processMultiLineDeclaration($phpcsFile, $stackPtr, $tokens); } }//end process() /** * Processes single-line declarations. * * Just uses the Generic BSD-Allman brace sniff. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param array $tokens The stack of tokens that make up * the file. * * @return void */ public function processSingleLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens) { if ($tokens[$stackPtr]['code'] === T_CLOSURE) { if (class_exists('Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff not found'); } $sniff = new Generic_Sniffs_Functions_OpeningFunctionBraceKernighanRitchieSniff(); } else { if (class_exists('Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff not found'); } $sniff = new Generic_Sniffs_Functions_OpeningFunctionBraceBsdAllmanSniff(); } $sniff->checkClosures = true; $sniff->process($phpcsFile, $stackPtr); }//end processSingleLineDeclaration() /** * Processes multi-line declarations. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param array $tokens The stack of tokens that make up * the file. * * @return void */ public function processMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens) { // We need to work out how far indented the function // declaration itself is, so we can work out how far to // indent parameters. $functionIndent = 0; for ($i = ($stackPtr - 1); $i >= 0; $i--) { if ($tokens[$i]['line'] !== $tokens[$stackPtr]['line']) { $i++; break; } } if ($tokens[$i]['code'] === T_WHITESPACE) { $functionIndent = strlen($tokens[$i]['content']); } // The closing parenthesis must be on a new line, even // when checking abstract function definitions. $closeBracket = $tokens[$stackPtr]['parenthesis_closer']; $prev = $phpcsFile->findPrevious( T_WHITESPACE, ($closeBracket - 1), null, true ); if ($tokens[$closeBracket]['line'] !== $tokens[$tokens[$closeBracket]['parenthesis_opener']]['line']) { if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) { $error = 'The closing parenthesis of a multi-line function declaration must be on a new line'; $fix = $phpcsFile->addFixableError($error, $closeBracket, 'CloseBracketLine'); if ($fix === true) { $phpcsFile->fixer->addNewlineBefore($closeBracket); } } } // If this is a closure and is using a USE statement, the closing // parenthesis we need to look at from now on is the closing parenthesis // of the USE statement. if ($tokens[$stackPtr]['code'] === T_CLOSURE) { $use = $phpcsFile->findNext(T_USE, ($closeBracket + 1), $tokens[$stackPtr]['scope_opener']); if ($use !== false) { $open = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($use + 1)); $closeBracket = $tokens[$open]['parenthesis_closer']; $prev = $phpcsFile->findPrevious( T_WHITESPACE, ($closeBracket - 1), null, true ); if ($tokens[$closeBracket]['line'] !== $tokens[$tokens[$closeBracket]['parenthesis_opener']]['line']) { if ($tokens[$prev]['line'] === $tokens[$closeBracket]['line']) { $error = 'The closing parenthesis of a multi-line use declaration must be on a new line'; $fix = $phpcsFile->addFixableError($error, $closeBracket, 'UseCloseBracketLine'); if ($fix === true) { $phpcsFile->fixer->addNewlineBefore($closeBracket); } } } }//end if }//end if // Each line between the parenthesis should be indented 4 spaces. $openBracket = $tokens[$stackPtr]['parenthesis_opener']; $lastLine = $tokens[$openBracket]['line']; for ($i = ($openBracket + 1); $i < $closeBracket; $i++) { if ($tokens[$i]['line'] !== $lastLine) { if ($i === $tokens[$stackPtr]['parenthesis_closer'] || ($tokens[$i]['code'] === T_WHITESPACE && (($i + 1) === $closeBracket || ($i + 1) === $tokens[$stackPtr]['parenthesis_closer'])) ) { // Closing braces need to be indented to the same level // as the function. $expectedIndent = $functionIndent; } else { $expectedIndent = ($functionIndent + $this->indent); } // We changed lines, so this should be a whitespace indent token. if ($tokens[$i]['code'] !== T_WHITESPACE) { $foundIndent = 0; } else { $foundIndent = strlen($tokens[$i]['content']); } if ($expectedIndent !== $foundIndent) { $error = 'Multi-line function declaration not indented correctly; expected %s spaces but found %s'; $data = array( $expectedIndent, $foundIndent, ); $fix = $phpcsFile->addFixableError($error, $i, 'Indent', $data); if ($fix === true) { $spaces = str_repeat(' ', $expectedIndent); if ($foundIndent === 0) { $phpcsFile->fixer->addContentBefore($i, $spaces); } else { $phpcsFile->fixer->replaceToken($i, $spaces); } } } $lastLine = $tokens[$i]['line']; }//end if if ($tokens[$i]['code'] === T_ARRAY || $tokens[$i]['code'] === T_OPEN_SHORT_ARRAY) { // Skip arrays as they have their own indentation rules. if ($tokens[$i]['code'] === T_OPEN_SHORT_ARRAY) { $i = $tokens[$i]['bracket_closer']; } else { $i = $tokens[$i]['parenthesis_closer']; } $lastLine = $tokens[$i]['line']; continue; } }//end for if (isset($tokens[$stackPtr]['scope_opener']) === false) { return; } // The opening brace needs to be one space away from the closing parenthesis. $opener = $tokens[$stackPtr]['scope_opener']; if ($tokens[$opener]['line'] !== $tokens[$closeBracket]['line']) { $error = 'The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line'; $fix = $phpcsFile->addFixableError($error, $opener, 'NewlineBeforeOpenBrace'); if ($fix === true) { $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($opener - 1), $closeBracket, true); $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->addContent($prev, ' {'); $phpcsFile->fixer->replaceToken($opener, ''); $phpcsFile->fixer->endChangeset(); } } else { $prev = $tokens[($opener - 1)]; if ($prev['code'] !== T_WHITESPACE) { $length = 0; } else { $length = strlen($prev['content']); } if ($length !== 1) { $error = 'There must be a single space between the closing parenthesis and the opening brace of a multi-line function declaration; found %s spaces'; $fix = $phpcsFile->addFixableError($error, ($opener - 1), 'SpaceBeforeOpenBrace', array($length)); if ($fix === true) { if ($length === 0) { $phpcsFile->fixer->addContentBefore($opener, ' '); } else { $phpcsFile->fixer->replaceToken(($opener - 1), ' '); } } return; }//end if }//end if }//end processMultiLineDeclaration() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/Functions/ValidDefaultValueSniff.php0000644000076700000240000000670512647543456031434 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PEAR_Sniffs_Functions_ValidDefaultValueSniff. * * A Sniff to ensure that parameters defined for a function that have a default * value come at the end of the function signature. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_Functions_ValidDefaultValueSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_FUNCTION); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $argStart = $tokens[$stackPtr]['parenthesis_opener']; $argEnd = $tokens[$stackPtr]['parenthesis_closer']; // Flag for when we have found a default in our arg list. // If there is a value without a default after this, it is an error. $defaultFound = false; $nextArg = $argStart; while (($nextArg = $phpcsFile->findNext(T_VARIABLE, ($nextArg + 1), $argEnd)) !== false) { if ($tokens[($nextArg - 1)]['code'] === T_ELLIPSIS) { continue; } $argHasDefault = self::_argHasDefault($phpcsFile, $nextArg); if ($argHasDefault === false && $defaultFound === true) { $error = 'Arguments with default values must be at the end of the argument list'; $phpcsFile->addError($error, $nextArg, 'NotAtEnd'); return; } if ($argHasDefault === true) { $defaultFound = true; } } }//end process() /** * Returns true if the passed argument has a default value. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $argPtr The position of the argument * in the stack. * * @return bool */ private static function _argHasDefault(PHP_CodeSniffer_File $phpcsFile, $argPtr) { $tokens = $phpcsFile->getTokens(); $nextToken = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($argPtr + 1), null, true); if ($tokens[$nextToken]['code'] !== T_EQUAL) { return false; } return true; }//end _argHasDefault() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/NamingConventions/ValidClassNameSniff.php0000644000076700000240000000730112647543456032401 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PEAR_Sniffs_NamingConventions_ValidClassNameSniff. * * Ensures class and interface names start with a capital letter * and use _ separators. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_NamingConventions_ValidClassNameSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_CLASS, T_INTERFACE, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The current file being processed. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $className = $phpcsFile->findNext(T_STRING, $stackPtr); $name = trim($tokens[$className]['content']); $errorData = array(ucfirst($tokens[$stackPtr]['content'])); // Make sure the first letter is a capital. if (preg_match('|^[A-Z]|', $name) === 0) { $error = '%s name must begin with a capital letter'; $phpcsFile->addError($error, $stackPtr, 'StartWithCapital', $errorData); } // Check that each new word starts with a capital as well, but don't // check the first word, as it is checked above. $validName = true; $nameBits = explode('_', $name); $firstBit = array_shift($nameBits); foreach ($nameBits as $bit) { if ($bit === '' || $bit{0} !== strtoupper($bit{0})) { $validName = false; break; } } if ($validName === false) { // Strip underscores because they cause the suggested name // to be incorrect. $nameBits = explode('_', trim($name, '_')); $firstBit = array_shift($nameBits); if ($firstBit === '') { $error = '%s name is not valid'; $phpcsFile->addError($error, $stackPtr, 'Invalid', $errorData); } else { $newName = strtoupper($firstBit{0}).substr($firstBit, 1).'_'; foreach ($nameBits as $bit) { if ($bit !== '') { $newName .= strtoupper($bit{0}).substr($bit, 1).'_'; } } $newName = rtrim($newName, '_'); $error = '%s name is not valid; consider %s instead'; $data = $errorData; $data[] = $newName; $phpcsFile->addError($error, $stackPtr, 'Invalid', $data); } }//end if }//end process() }//end class ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/NamingConventions/ValidFunctionNameSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/NamingConventions/ValidFunctionNameSniff.php0000644000076700000240000002612512647543456033126 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found'); } /** * PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff. * * Ensures method names are correct depending on whether they are public * or private, and that functions are named correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff { /** * A list of all PHP magic methods. * * @var array */ protected $magicMethods = array( 'construct' => true, 'destruct' => true, 'call' => true, 'callstatic' => true, 'get' => true, 'set' => true, 'isset' => true, 'unset' => true, 'sleep' => true, 'wakeup' => true, 'tostring' => true, 'set_state' => true, 'clone' => true, 'invoke' => true, 'debuginfo' => true, ); /** * A list of all PHP magic functions. * * @var array */ protected $magicFunctions = array('autoload' => true); /** * Constructs a PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff. */ public function __construct() { parent::__construct(array(T_CLASS, T_INTERFACE, T_TRAIT), array(T_FUNCTION), true); }//end __construct() /** * Processes the tokens within the scope. * * @param PHP_CodeSniffer_File $phpcsFile The file being processed. * @param int $stackPtr The position where this token was * found. * @param int $currScope The position of the current scope. * * @return void */ protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope) { $methodName = $phpcsFile->getDeclarationName($stackPtr); if ($methodName === null) { // Ignore closures. return; } $className = $phpcsFile->getDeclarationName($currScope); $errorData = array($className.'::'.$methodName); // Is this a magic method. i.e., is prefixed with "__" ? if (preg_match('|^__|', $methodName) !== 0) { $magicPart = strtolower(substr($methodName, 2)); if (isset($this->magicMethods[$magicPart]) === false) { $error = 'Method name "%s" is invalid; only PHP magic methods should be prefixed with a double underscore'; $phpcsFile->addError($error, $stackPtr, 'MethodDoubleUnderscore', $errorData); } return; } // PHP4 constructors are allowed to break our rules. if ($methodName === $className) { return; } // PHP4 destructors are allowed to break our rules. if ($methodName === '_'.$className) { return; } $methodProps = $phpcsFile->getMethodProperties($stackPtr); $scope = $methodProps['scope']; $scopeSpecified = $methodProps['scope_specified']; if ($methodProps['scope'] === 'private') { $isPublic = false; } else { $isPublic = true; } // If it's a private method, it must have an underscore on the front. if ($isPublic === false) { if ($methodName{0} !== '_') { $error = 'Private method name "%s" must be prefixed with an underscore'; $phpcsFile->addError($error, $stackPtr, 'PrivateNoUnderscore', $errorData); $phpcsFile->recordMetric($stackPtr, 'Private method prefixed with underscore', 'no'); return; } else { $phpcsFile->recordMetric($stackPtr, 'Private method prefixed with underscore', 'yes'); } } // If it's not a private method, it must not have an underscore on the front. if ($isPublic === true && $scopeSpecified === true && $methodName{0} === '_') { $error = '%s method name "%s" must not be prefixed with an underscore'; $data = array( ucfirst($scope), $errorData[0], ); $phpcsFile->addError($error, $stackPtr, 'PublicUnderscore', $data); return; } // If the scope was specified on the method, then the method must be // camel caps and an underscore should be checked for. If it wasn't // specified, treat it like a public method and remove the underscore // prefix if there is one because we cant determine if it is private or // public. $testMethodName = $methodName; if ($scopeSpecified === false && $methodName{0} === '_') { $testMethodName = substr($methodName, 1); } if (PHP_CodeSniffer::isCamelCaps($testMethodName, false, $isPublic, false) === false) { if ($scopeSpecified === true) { $error = '%s method name "%s" is not in camel caps format'; $data = array( ucfirst($scope), $errorData[0], ); $phpcsFile->addError($error, $stackPtr, 'ScopeNotCamelCaps', $data); } else { $error = 'Method name "%s" is not in camel caps format'; $phpcsFile->addError($error, $stackPtr, 'NotCamelCaps', $errorData); } return; } }//end processTokenWithinScope() /** * Processes the tokens outside the scope. * * @param PHP_CodeSniffer_File $phpcsFile The file being processed. * @param int $stackPtr The position where this token was * found. * * @return void */ protected function processTokenOutsideScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $functionName = $phpcsFile->getDeclarationName($stackPtr); if ($functionName === null) { // Ignore closures. return; } if (ltrim($functionName, '_') === '') { // Ignore special functions. return; } $errorData = array($functionName); // Is this a magic function. i.e., it is prefixed with "__". if (preg_match('|^__|', $functionName) !== 0) { $magicPart = strtolower(substr($functionName, 2)); if (isset($this->magicFunctions[$magicPart]) === false) { $error = 'Function name "%s" is invalid; only PHP magic methods should be prefixed with a double underscore'; $phpcsFile->addError($error, $stackPtr, 'FunctionDoubleUnderscore', $errorData); } return; } // Function names can be in two parts; the package name and // the function name. $packagePart = ''; $camelCapsPart = ''; $underscorePos = strrpos($functionName, '_'); if ($underscorePos === false) { $camelCapsPart = $functionName; } else { $packagePart = substr($functionName, 0, $underscorePos); $camelCapsPart = substr($functionName, ($underscorePos + 1)); // We don't care about _'s on the front. $packagePart = ltrim($packagePart, '_'); } // If it has a package part, make sure the first letter is a capital. if ($packagePart !== '') { if ($functionName{0} === '_') { $error = 'Function name "%s" is invalid; only private methods should be prefixed with an underscore'; $phpcsFile->addError($error, $stackPtr, 'FunctionUnderscore', $errorData); return; } if ($functionName{0} !== strtoupper($functionName{0})) { $error = 'Function name "%s" is prefixed with a package name but does not begin with a capital letter'; $phpcsFile->addError($error, $stackPtr, 'FunctionNoCapital', $errorData); return; } } // If it doesn't have a camel caps part, it's not valid. if (trim($camelCapsPart) === '') { $error = 'Function name "%s" is not valid; name appears incomplete'; $phpcsFile->addError($error, $stackPtr, 'FunctionInvalid', $errorData); return; } $validName = true; $newPackagePart = $packagePart; $newCamelCapsPart = $camelCapsPart; // Every function must have a camel caps part, so check that first. if (PHP_CodeSniffer::isCamelCaps($camelCapsPart, false, true, false) === false) { $validName = false; $newCamelCapsPart = strtolower($camelCapsPart{0}).substr($camelCapsPart, 1); } if ($packagePart !== '') { // Check that each new word starts with a capital. $nameBits = explode('_', $packagePart); foreach ($nameBits as $bit) { if ($bit{0} !== strtoupper($bit{0})) { $newPackagePart = ''; foreach ($nameBits as $bit) { $newPackagePart .= strtoupper($bit{0}).substr($bit, 1).'_'; } $validName = false; break; } } } if ($validName === false) { $newName = rtrim($newPackagePart, '_').'_'.$newCamelCapsPart; if ($newPackagePart === '') { $newName = $newCamelCapsPart; } else { $newName = rtrim($newPackagePart, '_').'_'.$newCamelCapsPart; } $error = 'Function name "%s" is invalid; consider "%s" instead'; $data = $errorData; $data[] = $newName; $phpcsFile->addError($error, $stackPtr, 'FunctionNameInvalid', $data); } }//end processTokenOutsideScope() }//end class ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/NamingConventions/ValidVariableNameSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/NamingConventions/ValidVariableNameSniff.php0000644000076700000240000000757312647543456033074 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractVariableSniff', true) === false) { $error = 'Class PHP_CodeSniffer_Standards_AbstractVariableSniff not found'; throw new PHP_CodeSniffer_Exception($error); } /** * PEAR_Sniffs_NamingConventions_ValidVariableNameSniff. * * Checks the naming of member variables. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_NamingConventions_ValidVariableNameSniff extends PHP_CodeSniffer_Standards_AbstractVariableSniff { /** * Processes class member variables. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ protected function processMemberVar(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $memberProps = $phpcsFile->getMemberProperties($stackPtr); if (empty($memberProps) === true) { return; } $memberName = ltrim($tokens[$stackPtr]['content'], '$'); $scope = $memberProps['scope']; $scopeSpecified = $memberProps['scope_specified']; if ($memberProps['scope'] === 'private') { $isPublic = false; } else { $isPublic = true; } // If it's a private member, it must have an underscore on the front. if ($isPublic === false && $memberName{0} !== '_') { $error = 'Private member variable "%s" must be prefixed with an underscore'; $data = array($memberName); $phpcsFile->addError($error, $stackPtr, 'PrivateNoUnderscore', $data); return; } // If it's not a private member, it must not have an underscore on the front. if ($isPublic === true && $scopeSpecified === true && $memberName{0} === '_') { $error = '%s member variable "%s" must not be prefixed with an underscore'; $data = array( ucfirst($scope), $memberName, ); $phpcsFile->addError($error, $stackPtr, 'PublicUnderscore', $data); return; } }//end processMemberVar() /** * Processes normal variables. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the token was found. * * @return void */ protected function processVariable(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { /* We don't care about normal variables. */ }//end processVariable() /** * Processes variables in double quoted strings. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the token was found. * * @return void */ protected function processVariableInString(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { /* We don't care about normal variables. */ }//end processVariableInString() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/WhiteSpace/ObjectOperatorIndentSniff.php0000644000076700000240000001517312647543456032242 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PEAR_Sniffs_WhiteSpace_ObjectOperatorIndentSniff. * * Checks that object operators are indented 4 spaces if they are the first * thing on a line. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_WhiteSpace_ObjectOperatorIndentSniff implements PHP_CodeSniffer_Sniff { /** * The number of spaces code should be indented. * * @var int */ public $indent = 4; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OBJECT_OPERATOR); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile All the tokens found in the document. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Make sure this is the first object operator in a chain of them. $varToken = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if ($varToken === false || $tokens[$varToken]['code'] !== T_VARIABLE) { return; } // Make sure this is a chained call. $next = $phpcsFile->findNext( T_OBJECT_OPERATOR, ($stackPtr + 1), null, false, null, true ); if ($next === false) { // Not a chained call. return; } // Determine correct indent. for ($i = ($varToken - 1); $i >= 0; $i--) { if ($tokens[$i]['line'] !== $tokens[$varToken]['line']) { $i++; break; } } $requiredIndent = 0; if ($i >= 0 && $tokens[$i]['code'] === T_WHITESPACE) { $requiredIndent = strlen($tokens[$i]['content']); } $requiredIndent += $this->indent; // Determine the scope of the original object operator. $origBrackets = null; if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) { $origBrackets = $tokens[$stackPtr]['nested_parenthesis']; } $origConditions = null; if (isset($tokens[$stackPtr]['conditions']) === true) { $origConditions = $tokens[$stackPtr]['conditions']; } // Check indentation of each object operator in the chain. // If the first object operator is on a different line than // the variable, make sure we check its indentation too. if ($tokens[$stackPtr]['line'] > $tokens[$varToken]['line']) { $next = $stackPtr; } while ($next !== false) { // Make sure it is in the same scope, otherwise don't check indent. $brackets = null; if (isset($tokens[$next]['nested_parenthesis']) === true) { $brackets = $tokens[$next]['nested_parenthesis']; } $conditions = null; if (isset($tokens[$next]['conditions']) === true) { $conditions = $tokens[$next]['conditions']; } if ($origBrackets === $brackets && $origConditions === $conditions) { // Make sure it starts a line, otherwise dont check indent. $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($next - 1), $stackPtr, true); $indent = $tokens[($next - 1)]; if ($tokens[$prev]['line'] !== $tokens[$next]['line'] && $indent['code'] === T_WHITESPACE ) { if ($indent['line'] === $tokens[$next]['line']) { $foundIndent = strlen($indent['content']); } else { $foundIndent = 0; } if ($foundIndent !== $requiredIndent) { $error = 'Object operator not indented correctly; expected %s spaces but found %s'; $data = array( $requiredIndent, $foundIndent, ); $fix = $phpcsFile->addFixableError($error, $next, 'Incorrect', $data); if ($fix === true) { $spaces = str_repeat(' ', $requiredIndent); if ($foundIndent === 0) { $phpcsFile->fixer->addContentBefore($next, $spaces); } else { $phpcsFile->fixer->replaceToken(($next - 1), $spaces); } } } }//end if // It cant be the last thing on the line either. $content = $phpcsFile->findNext(T_WHITESPACE, ($next + 1), null, true); if ($tokens[$content]['line'] !== $tokens[$next]['line']) { $error = 'Object operator must be at the start of the line, not the end'; $fix = $phpcsFile->addFixableError($error, $next, 'StartOfLine'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($x = ($next + 1); $x < $content; $x++) { $phpcsFile->fixer->replaceToken($x, ''); } $phpcsFile->fixer->addNewlineBefore($next); $phpcsFile->fixer->endChangeset(); } } }//end if $next = $phpcsFile->findNext( T_OBJECT_OPERATOR, ($next + 1), null, false, null, true ); }//end while }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/WhiteSpace/ScopeClosingBraceSniff.php0000644000076700000240000001537512647543456031507 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PEAR_Sniffs_Whitespace_ScopeClosingBraceSniff. * * Checks that the closing braces of scopes are aligned correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_WhiteSpace_ScopeClosingBraceSniff implements PHP_CodeSniffer_Sniff { /** * The number of spaces code should be indented. * * @var int */ public $indent = 4; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return PHP_CodeSniffer_Tokens::$scopeOpeners; }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile All the tokens found in the document. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // If this is an inline condition (ie. there is no scope opener), then // return, as this is not a new scope. if (isset($tokens[$stackPtr]['scope_closer']) === false) { return; } $scopeStart = $tokens[$stackPtr]['scope_opener']; $scopeEnd = $tokens[$stackPtr]['scope_closer']; // If the scope closer doesn't think it belongs to this scope opener // then the opener is sharing its closer with other tokens. We only // want to process the closer once, so skip this one. if (isset($tokens[$scopeEnd]['scope_condition']) === false || $tokens[$scopeEnd]['scope_condition'] !== $stackPtr ) { return; } // We need to actually find the first piece of content on this line, // because if this is a method with tokens before it (public, static etc) // or an if with an else before it, then we need to start the scope // checking from there, rather than the current token. $lineStart = ($stackPtr - 1); for ($lineStart; $lineStart > 0; $lineStart--) { if (strpos($tokens[$lineStart]['content'], $phpcsFile->eolChar) !== false) { break; } } $lineStart++; $startColumn = 1; if ($tokens[$lineStart]['code'] === T_WHITESPACE) { $startColumn = $tokens[($lineStart + 1)]['column']; } else if ($tokens[$lineStart]['code'] === T_INLINE_HTML) { $trimmed = ltrim($tokens[$lineStart]['content']); if ($trimmed === '') { $startColumn = $tokens[($lineStart + 1)]['column']; } else { $startColumn = (strlen($tokens[$lineStart]['content']) - strlen($trimmed)); } } // Check that the closing brace is on it's own line. $lastContent = $phpcsFile->findPrevious( array( T_WHITESPACE, T_INLINE_HTML, T_OPEN_TAG, ), ($scopeEnd - 1), $scopeStart, true ); if ($tokens[$lastContent]['line'] === $tokens[$scopeEnd]['line']) { $error = 'Closing brace must be on a line by itself'; $fix = $phpcsFile->addFixableError($error, $scopeEnd, 'Line'); if ($fix === true) { $phpcsFile->fixer->addNewlineBefore($scopeEnd); } return; } // Check now that the closing brace is lined up correctly. $lineStart = ($scopeEnd - 1); for ($lineStart; $lineStart > 0; $lineStart--) { if (strpos($tokens[$lineStart]['content'], $phpcsFile->eolChar) !== false) { break; } } $lineStart++; $braceIndent = 0; if ($tokens[$lineStart]['code'] === T_WHITESPACE) { $braceIndent = ($tokens[($lineStart + 1)]['column'] - 1); } else if ($tokens[$lineStart]['code'] === T_INLINE_HTML) { $trimmed = ltrim($tokens[$lineStart]['content']); if ($trimmed === '') { $braceIndent = ($tokens[($lineStart + 1)]['column'] - 1); } else { $braceIndent = (strlen($tokens[$lineStart]['content']) - strlen($trimmed) - 1); } } $fix = false; if ($tokens[$stackPtr]['code'] === T_CASE || $tokens[$stackPtr]['code'] === T_DEFAULT ) { // BREAK statements should be indented n spaces from the // CASE or DEFAULT statement. $expectedIndent = ($startColumn + $this->indent - 1); if ($braceIndent !== $expectedIndent) { $error = 'Case breaking statement indented incorrectly; expected %s spaces, found %s'; $data = array( $expectedIndent, $braceIndent, ); $fix = $phpcsFile->addFixableError($error, $scopeEnd, 'BreakIndent', $data); } } else { $expectedIndent = ($startColumn - 1); if ($braceIndent !== $expectedIndent) { $error = 'Closing brace indented incorrectly; expected %s spaces, found %s'; $data = array( $expectedIndent, $braceIndent, ); $fix = $phpcsFile->addFixableError($error, $scopeEnd, 'Indent', $data); } }//end if if ($fix === true && $phpcsFile->fixer->enabled === true) { $spaces = str_repeat(' ', $expectedIndent); if ($braceIndent === 0) { $phpcsFile->fixer->addContentBefore($lineStart, $spaces); } else { $phpcsFile->fixer->replaceToken($lineStart, ltrim($tokens[$lineStart]['content'])); $phpcsFile->fixer->addContentBefore($lineStart, $spaces); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Sniffs/WhiteSpace/ScopeIndentSniff.php0000644000076700000240000000270112647543456030362 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('Generic_Sniffs_WhiteSpace_ScopeIndentSniff', true) === false) { $error = 'Class Generic_Sniffs_WhiteSpace_ScopeIndentSniff not found'; throw new PHP_CodeSniffer_Exception($error); } /** * PEAR_Sniffs_Whitespace_ScopeIndentSniff. * * Checks that control structures are structured correctly, and their content * is indented correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Sniffs_WhiteSpace_ScopeIndentSniff extends Generic_Sniffs_WhiteSpace_ScopeIndentSniff { /** * Any scope openers that should not cause an indent. * * @var array(int) */ protected $nonIndentingScopes = array(T_SWITCH); }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Classes/ClassDeclarationUnitTest.inc0000644000076700000240000000252212647543456031272 0ustar gsherwoodstaffsetLogger(new class {}); var_dump(new class(10) extends SomeClass implements SomeInterface { private $num; public function __construct($num) { $this->num = $num; } use SomeTrait; }); PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Classes/ClassDeclarationUnitTest.php0000644000076700000240000000403012647543456031304 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ClassDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_Classes_ClassDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 21 => 1, 22 => 1, 23 => 1, 27 => 1, 33 => 1, 38 => 1, 49 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Commenting/ClassCommentUnitTest.inc0000644000076700000240000000353712647543456031161 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 1.0 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Extra_Description_Newlines { }//end class /** * Sample class comment * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version * @link http://pear.php.net/package/PHP_CodeSniffer */ class Missing_Newlines_Before_Tags { }//end class /** * Simple class comment * * @category _wrong_category * @package PHP_CodeSniffer * @package ADDITIONAL PACKAGE TAG * @subpackage SUBPACKAGE TAG * @author Original Author * @author Greg Sherwood gsherwood@squiz.net * @author Mr T * @author * @copyright 1997~1994 The PHP Group * @license http://www.php.net/license/3_0.txt * @version INVALID VERSION CONTENT * @see * @see * @link sdfsdf * @see Net_Sample::Net_Sample() * @see Net_Other * @deprecated asd * @unknown Unknown tag * @since Class available since Release 1.2.0 */ class Checking_Tags { class Sub_Class { }//end class }//end class /** * * */ class Empty_Class_Doc { }//end class /** * * */ interface Empty_Interface_Doc { }//end interface ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Commenting/ClassCommentUnitTest.php0000644000076700000240000000427012647543456031172 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for ClassCommentSniff. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_Commenting_ClassCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 4 => 1, 15 => 1, 51 => 1, 63 => 1, 65 => 2, 66 => 1, 68 => 1, 70 => 1, 71 => 1, 72 => 1, 74 => 2, 75 => 1, 76 => 1, 77 => 1, 85 => 1, 96 => 5, 106 => 5, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 71 => 1, 73 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Commenting/FileCommentUnitTest.inc0000644000076700000240000000252112647543456030763 0ustar gsherwoodstaff * @author Greg Sherwood gsherwood@squiz.net * @author Mr T * @author * @copyright 1997~1994 The PHP Group * @copyright 1997~1994 The PHP Group * @license http://www.php.net/license/3_0.txt * @see * @see * @version INVALID VERSION CONTENT * @see Net_Sample::Net_Sample() * @see Net_Other * @deprecated asd * @since Class available since Release 1.2.0 * @summary An unknown summary tag * @package '' * @subpackage !! */ ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Commenting/FileCommentUnitTest.php0000644000076700000240000000515112647543456031003 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for FunctionCommentSniff. * * Verifies that : *
    *
  • A doc comment exists.
  • *
  • Short description must start with a capital letter and end with a period.
  • *
  • There must be one blank newline after the short description.
  • *
  • A PHP version is specified.
  • *
  • Check the order of the tags.
  • *
  • Check the indentation of each tag.
  • *
  • Check required and optional tags and the format of their content.
  • *
* * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_Commenting_FileCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 21 => 1, 23 => 2, 24 => 1, 26 => 1, 28 => 1, 29 => 1, 30 => 1, 31 => 1, 32 => 2, 33 => 1, 34 => 1, 35 => 1, 40 => 2, 41 => 2, 42 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 29 => 1, 30 => 1, 34 => 1, 42 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Commenting/FunctionCommentUnitTest.inc0000644000076700000240000001163412647543456031676 0ustar gsherwoodstaff line numbers for each token. * * @param array $tokens The array of tokens to process. * @param object $tokenizer The tokenizer being used to process this file. * @param string $eolChar The EOL character to use for splitting strings. * * @return void */ public function foo(&$tokens, $tokenizer, $eolChar) { }//end foo() /** * Gettext. * */ public function _() { return $foo; } class Baz { /** * The PHP5 constructor * * No return tag */ public function __construct() { } } /** * Complete a step. * * @param string $status Status of step to complete. * @param array $array Array. * @param string $note Optional note. * * @return void */ public function completeStep($status, array $array = [Class1::class, 'test'], $note = '') { echo 'foo'; } /** * Variadic function. * * @param string $name1 Comment. * @param string ...$name2 Comment. * * @return void */ public function myFunction(string $name1, string ...$name2) { } /** * Variadic function. * * @param string $name1 Comment. * @param string $name2 Comment. * * @return void */ public function myFunction(string $name1, string ...$name2) { } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Commenting/FunctionCommentUnitTest.php0000644000076700000240000000475312647543456031720 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for FunctionCommentSniff. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_Commenting_FunctionCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 5 => 1, 10 => 1, 12 => 1, 13 => 1, 14 => 1, 15 => 1, 28 => 1, 76 => 1, 87 => 1, 103 => 1, 109 => 1, 112 => 1, 122 => 1, 123 => 2, 124 => 2, 125 => 1, 126 => 1, 137 => 1, 138 => 1, 139 => 1, 152 => 1, 155 => 1, 165 => 1, 172 => 1, 183 => 1, 190 => 2, 206 => 1, 234 => 1, 272 => 1, 313 => 1, 317 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Commenting/InlineCommentUnitTest.inc0000644000076700000240000000060612647543456031324 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the InlineComment sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_Commenting_InlineCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 15 => 1, 24 => 1, 25 => 1, 27 => 1, 28 => 1, 29 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/ControlStructures/ControlSignatureUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/ControlStructures/ControlSignatureUnitTest.in0000644000076700000240000000323012647543456033342 0ustar gsherwoodstaff 0); do { echo $i; } while ($i > 0); do { echo $i; } while ($i > 0); do { echo $i; } while ($i > 0); do{ echo $i; }while($i > 0); // while while ($i < 1) { echo $i; } while($i < 1){ echo $i; } while ($i < 1) { echo $i; } // for for ($i = 1; $i < 1; $i++) { echo $i; } for($i = 1; $i < 1; $i++){ echo $i; } for ($i = 1; $i < 1; $i++) { echo $i; } // foreach foreach ($items as $item) { echo $item; } foreach($items as $item){ echo $item; } for ($items as $item) { echo $item; } // if if ($i == 0) { $i = 1; } if($i == 0){ $i = 1; } if ($i == 0) { $i = 1; } // else if ($i == 0) { $i = 1; } else { $i = 0; } if ($i == 0) { $i = 1; }else{ $i = 0; } if ($i == 0) { $i = 1; } else { $i = 0; } // else if ($i == 0) { $i = 1; } else { $i = 0; } if ($i == 0) { $i = 1; }else{ $i = 0; } if ($i == 0) { $i = 1; } else { $i = 0; } // else if if ($i == 0) { $i = 1; } else if ($i == 2) { $i = 0; } if ($i == 0) { $i = 1; } elseif ($i == 2) { $i = 0; } if ($i == 0) { $i = 1; }else if($i == 2){ $i = 0; } if ($i == 0) { $i = 1; }elseif($i == 2){ $i = 0; } if ($i == 0) { $i = 1; } else if ($i == 2) { $i = 0; } if ($i == 0) { $i = 1; } elseif ($1 == 2) { $i = 0; } if ($i == 0) { // this is ok because comments are allowed $i = 1; } if ($i == 0) {// this is ok because comments are allowed $i = 1; } if ($i == 0) { /* this is ok because comments are allowed*/ $i = 1; } if ($i == 0) { // this is not ok $i = 1; } if ($i == 0) /* this is ok */ { } if ($i == 0) { } else { } ?>././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/ControlStructures/ControlSignatureUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/ControlStructures/ControlSignatureUnitTest.ph0000644000076700000240000000465712647543456033361 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ControlSignature sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_ControlStructures_ControlSignatureUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 9 => 1, 14 => 1, 20 => 1, 22 => 1, 32 => 1, 36 => 1, 44 => 1, 48 => 1, 56 => 1, 60 => 1, 68 => 1, 72 => 1, 84 => 1, 88 => 2, 100 => 1, 104 => 2, 122 => 2, 128 => 1, 132 => 3, 133 => 2, 147 => 1, 157 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/ControlStructures/MultiLineConditionUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/ControlStructures/MultiLineConditionUnitTest.0000644000076700000240000000455112647543456033271 0ustar gsherwoodstaff

some text

errorCode() == 401 || // comment $IPP->errorCode() == 3200) /* long comment here */ { return false; } if ($IPP->errorCode() == 401 || // comment $IPP->errorCode() == 3200) // long comment here { return false; } if ($IPP->errorCode() == 401 // Comment explaining the next condition here. || $IPP->errorCode() == 3200 ) { return false; } ?> ././@LongLink000 155 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/ControlStructures/MultiLineConditionUnitTest.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/ControlStructures/MultiLineConditionUnitTest.0000644000076700000240000000453712647543456033275 0ustar gsherwoodstaff

some text

errorCode() == 401 // comment || $IPP->errorCode() == 3200 /* long comment here */ ) { return false; } if ($IPP->errorCode() == 401 // comment || $IPP->errorCode() == 3200 // long comment here ) { return false; } if ($IPP->errorCode() == 401 // Comment explaining the next condition here. || $IPP->errorCode() == 3200 ) { return false; } ?> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/ControlStructures/MultiLineConditionUnitTest.jsPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/ControlStructures/MultiLineConditionUnitTest.0000644000076700000240000000355212647543456033271 0ustar gsherwoodstaffif (blah(param)) { } if ((condition1 || condition2) && condition3 && condition4 && condition5 ) { } if ((condition1 || condition2) && condition3 && condition4 && condition5) { } if ((condition1 || condition2) && condition3 ) { } if ( (condition1 || condition2) && condition3 ) { } if ((condition1 || condition2) ) { } if ((condition1 || condition2) && condition3 && condition4 ) { } if ((condition1 || condition2) && condition3 && condition4 && condition5 ) { } if (($condition1 || $condition2) ) { } if ((condition1 || condition2) ) { } if ( ( condition1 || condition2 ) && condition3 ) { } if ( condition1 || condition2 || condition3 ) { } if (condition1 || condition2 || condition3 ) { } else if (condition1 || condition2 || condition3 ) { } if (condition1 || condition2 || condition3 ) { } else if ( condition1 || condition2 && condition3 ) { } if (condition1 || condition2 || condition3) { } if (condition1 || condition2 || condition3 ){ } if (condition1) console.info('bar'); if (condition1 || condition2 || condition3) console.info('bar'); if (condition1 || condition2 || condition3 ) console.info('bar'); if (!a(post) && (!a(context.header) ^ a(context.header, 'Content-Type')) ) { // ... } if (foo) { console.info('bar'); } // Should be no errors even though lines are // not exactly aligned together. Multi-line function // call takes precedence. if (array_key_exists(key, value) && foo.bar.baz( key, value2 ) ) { } if (true) { foo = true; }; if (foo == 401 || // comment bar == 3200) /* long comment here */ { return false; } if (foo == 401 || // comment bar == 3200) // long comment here { return false; } ././@LongLink000 154 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/ControlStructures/MultiLineConditionUnitTest.js.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/ControlStructures/MultiLineConditionUnitTest.0000644000076700000240000000353712647543456033274 0ustar gsherwoodstaffif (blah(param)) { } if ((condition1 || condition2) && condition3 && condition4 && condition5 ) { } if ((condition1 || condition2) && condition3 && condition4 && condition5) { } if ((condition1 || condition2) && condition3 ) { } if ((condition1 || condition2) && condition3 ) { } if ((condition1 || condition2) ) { } if ((condition1 || condition2) && condition3 && condition4 ) { } if ((condition1 || condition2) && condition3 && condition4 && condition5 ) { } if (($condition1 || $condition2) ) { } if ((condition1 || condition2) ) { } if ((condition1 || condition2) && condition3 ) { } if (condition1 || condition2 || condition3 ) { } if (condition1 || condition2 || condition3 ) { } else if (condition1 || condition2 || condition3 ) { } if (condition1 || condition2 || condition3 ) { } else if (condition1 || condition2 && condition3 ) { } if (condition1 || condition2 || condition3 ) { } if (condition1 || condition2 || condition3 ) { } if (condition1) console.info('bar'); if (condition1 || condition2 || condition3 ) console.info('bar'); if (condition1 || condition2 || condition3 ) console.info('bar'); if (!a(post) && (!a(context.header) ^ a(context.header, 'Content-Type')) ) { // ... } if (foo) { console.info('bar'); } // Should be no errors even though lines are // not exactly aligned together. Multi-line function // call takes precedence. if (array_key_exists(key, value) && foo.bar.baz( key, value2 ) ) { } if (true) { foo = true; }; if (foo == 401 // comment || bar == 3200 /* long comment here */ ) { return false; } if (foo == 401 // comment || bar == 3200 // long comment here ) { return false; } ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/ControlStructures/MultiLineConditionUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/ControlStructures/MultiLineConditionUnitTest.0000644000076700000240000000544612647543456033275 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the MultiLineCondition sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_ControlStructures_MultiLineConditionUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='MultiLineConditionUnitTest.inc') { $errors = array( 21 => 1, 22 => 1, 35 => 1, 40 => 1, 41 => 1, 42 => 1, 43 => 1, 49 => 1, 54 => 1, 57 => 1, 58 => 1, 59 => 1, 61 => 1, 67 => 1, 87 => 1, 88 => 1, 89 => 1, 90 => 1, 96 => 2, 101 => 1, 109 => 2, 125 => 1, 145 => 1, 153 => 1, ); if ($testFile === 'MultiLineConditionUnitTest.inc') { $errors[167] = 1; } return $errors; }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Files/IncludingFileUnitTest.inc0000644000076700000240000000317712647543456030247 0ustar gsherwoodstaff
Some content goes here.

    Some content goes here.
    
    
Some content goes here.

    Some content goes here.
    
    
* @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the IncludingFile sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_Files_IncludingFileUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 4 => 1, 5 => 1, 11 => 1, 12 => 1, 16 => 1, 17 => 1, 33 => 1, 34 => 1, 47 => 1, 48 => 1, 64 => 1, 65 => 1, 73 => 1, 74 => 1, 85 => 1, 86 => 1, 98 => 1, 99 => 2, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Formatting/MultiLineAssignmentUnitTest.inc0000644000076700000240000000135612647543456032533 0ustar gsherwoodstaffadditionalHeaderData[$this->strApplicationName] = $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax')); $GLOBALS['TSFE']->additionalHeaderData[$this->strApplicationName] = $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax')); $GLOBALS['TSFE']->additionalHeaderData[$this->strApplicationName] = $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax')); $GLOBALS['TSFE']->additionalHeaderData[$this->strApplicationName] = $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax')); $GLOBALS['TSFE']->additionalHeaderData[$this->strApplicationName] = 'boo' $var='string'; function getInstalledStandards( $includeGeneric=false, $standardsDir='' ) { } ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Formatting/MultiLineAssignmentUnitTest.php0000644000076700000240000000353112647543456032546 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the MultiLineAssignment sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_Formatting_MultiLineAssignmentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 6 => 1, 8 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Functions/FunctionCallSignatureUnitTest.inc0000644000076700000240000001171212647543456032676 0ustar gsherwoodstaffgetFoo() ->doBar( $this->getX() // no comma here ->doY() // this is still the first method argument ->doZ() // this is still the first method argument ); } $var = myFunction( $foo, $bar ); // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature allowMultipleArguments false fputs( STDOUT, "Examples: $ {$app} , --all $ {$app} --all", $something ); $array = array(); array_map( function($x) { return trim($x, $y); }, $foo, $array ); $bar = new stdClass( 4, /* thanks */ 5, /* PSR-2 */ 6 ); public function doSomething() { return $this->getFoo() ->doBar( $this->getX() // no comma here ->doY() // this is still the first method argument ->doZ() // this is still the first method argument ); } doError( 404, // status code 'Not Found', // error name 'Check your id' // fix ); // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature allowMultipleArguments true // Don't report errors for closing braces. Leave that to other sniffs. foo( [ 'this', 'is', 'an', 'array' ], [ 'this', 'is', 'an', 'array' ], array( 'this', 'is', 'an', 'array' ), array( 'this', 'is', 'an', 'array' ), function($x) { echo 'wee'; return trim($x); } ); function foo() { myFunction( 'string'. // comment // comment 'string'. /* comment * comment */ 'string'. ); } // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesAfterOpen 1 // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesBeforeClose 1 test($arg, $arg2); test( $arg, $arg2 ); test( $arg, $arg2 ); // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesAfterOpen 0 // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesBeforeClose 0 ?>
  • log(// ... 'error', sprintf( 'Message: %s', isset($e->getData()['object']['evidence_details']) ? $e->getData()['object']['evidence_details']['due_by'] : '' ), array($e->getData()['object']) ); ?>
    $class ] ); ?>
    function ($x) { return true; }, 'baz' => false ) ); $qux = array_filter( $quux, function ($x) { return $x; } ); array_filter( [1, 2], function ($i) : bool { return $i === 0; } ); ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Functions/FunctionCallSignatureUnitTest.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Functions/FunctionCallSignatureUnitTest.inc.f0000644000076700000240000001174112647543456033124 0ustar gsherwoodstaffgetFoo() ->doBar( $this->getX() // no comma here ->doY() // this is still the first method argument ->doZ() // this is still the first method argument ); } $var = myFunction( $foo, $bar ); // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature allowMultipleArguments false fputs( STDOUT, "Examples: $ {$app} , --all $ {$app} --all", $something ); $array = array(); array_map( function($x) { return trim($x, $y); }, $foo, $array ); $bar = new stdClass( 4, /* thanks */ 5, /* PSR-2 */ 6 ); public function doSomething() { return $this->getFoo() ->doBar( $this->getX() // no comma here ->doY() // this is still the first method argument ->doZ() // this is still the first method argument ); } doError( 404, // status code 'Not Found', // error name 'Check your id' // fix ); // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature allowMultipleArguments true // Don't report errors for closing braces. Leave that to other sniffs. foo( [ 'this', 'is', 'an', 'array' ], [ 'this', 'is', 'an', 'array' ], array( 'this', 'is', 'an', 'array' ), array( 'this', 'is', 'an', 'array' ), function($x) { echo 'wee'; return trim($x); } ); function foo() { myFunction( 'string'. // comment // comment 'string'. /* comment * comment */ 'string'. ); } // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesAfterOpen 1 // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesBeforeClose 1 test( $arg, $arg2 ); test( $arg, $arg2 ); test( $arg, $arg2 ); // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesAfterOpen 0 // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesBeforeClose 0 ?>
  • log(// ... 'error', sprintf( 'Message: %s', isset($e->getData()['object']['evidence_details']) ? $e->getData()['object']['evidence_details']['due_by'] : '' ), array($e->getData()['object']) ); ?>
    $class ] ); ?>
    function ($x) { return true; }, 'baz' => false ) ); $qux = array_filter( $quux, function ($x) { return $x; } ); array_filter( [1, 2], function ($i) : bool { return $i === 0; } ); PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Functions/FunctionCallSignatureUnitTest.js0000644000076700000240000000342012647543456032536 0ustar gsherwoodstafftest( ); test(); test(arg, arg2); test (); test( ); test() ; test( arg); test( arg ); test ( arg ); if (foo(arg) === true) { } var something = get(arg1, arg2); var something = get(arg1, arg2) ; var something = get(arg1, arg2) ; make_foo(string/*the string*/, true/*test*/); make_foo(string/*the string*/, true/*test*/ ); make_foo(string /*the string*/, true /*test*/); make_foo(/*the string*/string, /*test*/true); make_foo( /*the string*/string, /*test*/true); // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesAfterOpen 1 // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesBeforeClose 1 test(arg, arg2); test( arg, arg2 ); test( arg, arg2 ); // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesAfterOpen 0 // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesBeforeClose 0 this.init = function(data) { a.b('').a(function(itemid, target) { b( itemid, target, { reviewData: _reviewData, pageid: itemid }, '', function() { var _showAspectItems = function(itemid) { a.a(a.c(''), ''); a.b(a.c('-' + itemid), ''); }; a.foo(function(itemid, target) { _foo(itemid); }); } ); }); }; a.prototype = { a: function() { this.addItem( { /** * @return void */ a: function() { }, /** * @return void */ a: function() { }, } ); } }; ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Functions/FunctionCallSignatureUnitTest.js.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Functions/FunctionCallSignatureUnitTest.js.fi0000644000076700000240000000351412647543456033137 0ustar gsherwoodstafftest( ); test(); test(arg, arg2); test(); test(); test(); test(arg); test(arg); test(arg); if (foo(arg) === true) { } var something = get(arg1, arg2); var something = get(arg1, arg2); var something = get(arg1, arg2); make_foo(string/*the string*/, true/*test*/); make_foo(string/*the string*/, true/*test*/); make_foo(string /*the string*/, true /*test*/); make_foo(/*the string*/string, /*test*/true); make_foo(/*the string*/string, /*test*/true); // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesAfterOpen 1 // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesBeforeClose 1 test( arg, arg2 ); test( arg, arg2 ); test( arg, arg2 ); // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesAfterOpen 0 // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature requiredSpacesBeforeClose 0 this.init = function(data) { a.b('').a( function(itemid, target) { b( itemid, target, { reviewData: _reviewData, pageid: itemid }, '', function() { var _showAspectItems = function(itemid) { a.a(a.c(''), ''); a.b(a.c('-' + itemid), ''); }; a.foo( function(itemid, target) { _foo(itemid); } ); } ); } ); }; a.prototype = { a: function() { this.addItem( { /** * @return void */ a: function() { }, /** * @return void */ a: function() { }, } ); } }; PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Functions/FunctionCallSignatureUnitTest.php0000644000076700000240000000666112647543456032723 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the FunctionCallSignature sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_Functions_FunctionCallSignatureUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='FunctionCallSignatureUnitTest.inc') { if ($testFile === 'FunctionCallSignatureUnitTest.js') { return array( 5 => 1, 6 => 2, 7 => 1, 8 => 1, 9 => 2, 10 => 3, 17 => 1, 18 => 1, 21 => 1, 24 => 1, 28 => 2, 30 => 2, 35 => 1, 49 => 1, 51 => 1, 54 => 1, 70 => 1, 71 => 1, ); } return array( 5 => 1, 6 => 2, 7 => 1, 8 => 1, 9 => 2, 10 => 3, 17 => 1, 18 => 1, 31 => 1, 34 => 1, 43 => 2, 57 => 1, 59 => 1, 63 => 1, 64 => 1, 82 => 1, 93 => 1, 100 => 1, 106 => 2, 119 => 1, 120 => 1, 129 => 1, 137 => 1, 142 => 2, 171 => 1, 180 => 1, 181 => 1, 194 => 1, 213 => 2, 215 => 2, 274 => 1, 275 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Functions/FunctionDeclarationUnitTest.inc0000644000076700000240000000614512647543456032372 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the FunctionDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_Functions_FunctionDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 4 => 1, 5 => 1, 9 => 1, 10 => 1, 11 => 1, 14 => 1, 17 => 1, 44 => 1, 52 => 1, 61 => 2, 98 => 1, 110 => 2, 120 => 3, 121 => 1, 140 => 1, 145 => 1, 161 => 2, 162 => 2, 164 => 2, 167 => 2, 171 => 1, 173 => 1, 201 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/Functions/ValidDefaultValueUnitTest.inc0000644000076700000240000000256112647543456031776 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ValidDefaultValue sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_Functions_ValidDefaultValueUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 29 => 1, 34 => 1, 39 => 1, 71 => 1, 76 => 1, 81 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/NamingConventions/ValidClassNameUnitTest.inc0000644000076700000240000000101512647543456032743 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/NamingConventions/ValidClassNameUnitTest.php0000644000076700000240000000423112647543456032764 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ValidClassName sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_NamingConventions_ValidClassNameUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 5 => 1, 7 => 2, 9 => 1, 19 => 1, 24 => 1, 26 => 2, 28 => 1, 38 => 1, 40 => 2, 42 => 2, 44 => 1, 46 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/NamingConventions/ValidFunctionNameUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/NamingConventions/ValidFunctionNameUnitTest.i0000644000076700000240000001373212647543456033153 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ValidFunctionName sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_NamingConventions_ValidFunctionNameUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { $errors = array( 11 => 1, 12 => 1, 13 => 1, 14 => 1, 15 => 1, 16 => 1, 17 => 1, 18 => 1, 19 => 1, 20 => 1, 24 => 1, 25 => 1, 26 => 1, 27 => 1, 28 => 1, 29 => 1, 30 => 1, 31 => 1, 32 => 1, 33 => 1, 35 => 1, 36 => 1, 37 => 1, 38 => 1, 39 => 1, 40 => 1, 43 => 1, 44 => 1, 45 => 1, 46 => 1, 50 => 1, 51 => 1, 52 => 1, 53 => 1, 56 => 1, 57 => 1, 58 => 1, 59 => 1, 67 => 1, 68 => 1, 69 => 1, 70 => 1, 71 => 1, 72 => 1, 73 => 1, 74 => 1, 75 => 1, 76 => 1, 80 => 1, 81 => 1, 82 => 1, 83 => 1, 84 => 1, 85 => 1, 86 => 1, 87 => 1, 88 => 1, 89 => 1, 91 => 1, 92 => 1, 93 => 1, 94 => 1, 95 => 1, 96 => 1, 99 => 1, 100 => 1, 101 => 1, 102 => 1, 106 => 1, 107 => 1, 108 => 1, 109 => 1, 112 => 1, 113 => 1, 114 => 1, 115 => 1, 121 => 1, 122 => 1, 123 => 1, 124 => 1, 125 => 1, 126 => 1, 127 => 1, 128 => 1, 129 => 1, 130 => 1, 149 => 1, 151 => 1, 152 => 1, 155 => 1, 156 => 1, 157 => 1, 158 => 1, 159 => 1, 160 => 1, 161 => 1, 162 => 1, 163 => 1, 164 => 1, 165 => 1, 166 => 1, 167 => 1, 169 => 1, 170 => 1, 171 => 1, 173 => 1, 174 => 1, 175 => 1, 207 => 1, ); return $errors; }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/NamingConventions/ValidVariableNameUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/NamingConventions/ValidVariableNameUnitTest.i0000644000076700000240000000301512647543456033104 0ustar gsherwoodstaffdef["POP_{$cc}_A"]}' and POP_{$cc}_B = '{$this->def["POP_{$cc}_B"]}')"; } } class mpgResponse{ var $term_id; var $currentTag; function characterHandler($parser,$data){ switch($this->currentTag) { case "term_id": { $this->term_id=$data; break; } } }//end characterHandler }//end class mpgResponse class foo { const bar = << ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/NamingConventions/ValidVariableNameUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/NamingConventions/ValidVariableNameUnitTest.p0000644000076700000240000000365012647543456033120 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ValidVariableName sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_NamingConventions_ValidVariableNameUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 12 => 1, 17 => 1, 22 => 1, 92 => 1, 93 => 1, 94 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/WhiteSpace/ObjectOperatorIndentUnitTest.inc0000644000076700000240000000153412647543456032604 0ustar gsherwoodstaffsomeFunction("some", "parameter") ->someOtherFunc(23, 42)-> someOtherFunc2($one, $two) ->someOtherFunc3(23, 42) ->andAThirdFunction(); $someObject->someFunction("some", "parameter") ->someOtherFunc(23, 42); $someObject->someFunction("some", "parameter")->someOtherFunc(23, 42); $someObject->someFunction("some", "parameter") ->someOtherFunc(23, 42); func( $bar->foo() ) ->bar(); func( $bar->foo() ) ->bar( $bar->foo() ->bar() ->func() ); $object ->setBar($foo) ->setFoo($bar); if ($bar) { $object ->setBar($foo) ->setFoo($bar); } $response -> CompletedTrackDetails -> TrackDetails -> Events; $response -> CompletedTrackDetails -> TrackDetails -> Events; $response -> CompletedTrackDetails -> TrackDetails -> Events; PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/WhiteSpace/ObjectOperatorIndentUnitTest.php0000644000076700000240000000376512647543456032632 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ObjectOperatorIndent sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_WhiteSpace_ObjectOperatorIndentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 2, 6 => 1, 15 => 1, 27 => 1, 37 => 1, 38 => 1, 48 => 1, 49 => 1, 50 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/WhiteSpace/ScopeClosingBraceUnitTest.inc0000644000076700000240000000351112647543456032042 0ustar gsherwoodstaff{$property} =& new $class_name($this->db_index); $this->modules[$module] =& $this->{$property}; } foreach ($elements as $element) { if ($something) { // Do IF. } else if ($somethingElse) { // Do ELSE. } } switch ($foo) { case 1: switch ($bar) { default: if ($something) { echo $string{1}; } else if ($else) { switch ($else) { case 1: // Do something. break; default: // Do something. break; } } } break; case 2: // Do something; break; } switch ($httpResponseCode) { case 100: case 101: case 102: default: return 'Unknown'; } switch ($httpResponseCode) { case 100: case 101: case 102: return 'Processing.'; default: return 'Unknown'; } switch($i) { case 1: {} } switch ($httpResponseCode) { case 100: case 101: case 102: exit; default: exit; } if ($foo): if ($bar): $foo = 1; elseif ($baz): $foo = 2; endif; endif; if ($foo): elseif ($baz): $foo = 2; endif; ?>
    ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/WhiteSpace/ScopeClosingBraceUnitTest.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/WhiteSpace/ScopeClosingBraceUnitTest.inc.fixe0000644000076700000240000000354212647543456033000 0ustar gsherwoodstaff{$property} =& new $class_name($this->db_index); $this->modules[$module] =& $this->{$property}; } foreach ($elements as $element) { if ($something) { // Do IF. } else if ($somethingElse) { // Do ELSE. } } switch ($foo) { case 1: switch ($bar) { default: if ($something) { echo $string{1}; } else if ($else) { switch ($else) { case 1: // Do something. break; default: // Do something. break; } } } break; case 2: // Do something; break; } switch ($httpResponseCode) { case 100: case 101: case 102: default: return 'Unknown'; } switch ($httpResponseCode) { case 100: case 101: case 102: return 'Processing.'; default: return 'Unknown'; } switch($i) { case 1: { } } switch ($httpResponseCode) { case 100: case 101: case 102: exit; default: exit; } if ($foo): if ($bar): $foo = 1; elseif ($baz): $foo = 2; endif; endif; if ($foo): elseif ($baz): $foo = 2; endif; ?>
    PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/WhiteSpace/ScopeClosingBraceUnitTest.php0000644000076700000240000000421512647543456032062 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ScopeClosingBrace sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_WhiteSpace_ScopeClosingBraceUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 11 => 1, 13 => 1, 24 => 1, 30 => 1, 61 => 1, 65 => 1, 85 => 1, 89 => 1, 98 => 1, 122 => 1, 127 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/Tests/WhiteSpace/ScopeIndentUnitTest.inc0000644000076700000240000001347612647543456030743 0ustar gsherwoodstaffhello(); // error here } function hello() // error here { // no error here as brackets can be put anywhere in the pear standard echo 'hello'; } function hello2() { if (TRUE) { // error here echo 'hello'; // no error here as its more than 4 spaces. } else { echo 'bye'; // error here } while (TRUE) { echo 'hello'; // error here } do { // error here echo 'hello'; // error here } while (TRUE); } function hello3() { switch ($hello) { case 'hello': break; } } } ?>
    
    
    validate()) {
        $safe = $form->getSubmitValues();
    }
    ?>
    
    open(); // error here } public function open() { // Some inline stuff that shouldn't error if (TRUE) echo 'hello'; foreach ($tokens as $token) echo $token; } /** * This is a comment 1. * This is a comment 2. * This is a comment 3. * This is a comment 4. */ public function close() { // All ok. if (TRUE) { if (TRUE) { } else if (FALSE) { foreach ($tokens as $token) { switch ($token) { case '1': case '2': if (true) { if (false) { if (false) { if (false) { echo 'hello'; } } } } break; case '5': break; } do { while (true) { foreach ($tokens as $token) { for ($i = 0; $i < $token; $i++) { echo 'hello'; } } } } while (true); } } } } /* This is another c style comment 1. This is another c style comment 2. This is another c style comment 3. This is another c style comment 4. This is another c style comment 5. */ /* * * * */ /** */ /* This comment has a newline in it. */ public function read() { echo 'hello'; // no errors below. $array = array( 'this', 'that' => array( 'hello', 'hello again' => array( 'hello', ), ), ); } } abstract class Test3 { public function parse() { foreach ($t as $ndx => $token) { if (is_array($token)) { echo 'here'; } else { $ts[] = array("token" => $token, "value" => ''); $last = count($ts) - 1; switch ($token) { case '(': if ($last >= 3 && $ts[0]['token'] != T_CLASS && $ts[$last - 2]['token'] == T_OBJECT_OPERATOR && $ts[$last - 3]['token'] == T_VARIABLE ) { if (true) { echo 'hello'; } } array_push($braces, $token); break; } } } } } public function test() { $o = << * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ScopeIndent sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PEAR_Tests_WhiteSpace_ScopeIndentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 7 => 1, 10 => 1, 17 => 1, 20 => 1, 24 => 1, 25 => 1, 27 => 1, 28 => 1, 29 => 1, 30 => 1, 58 => 1, 123 => 1, 224 => 1, 225 => 1, 279 => 1, 284 => 1, 311 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PEAR/ruleset.xml0000644000076700000240000000236312647543456023375 0ustar gsherwoodstaff The PEAR coding standard. 0 PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PHPCS/ruleset.xml0000644000076700000240000000436112647543456023523 0ustar gsherwoodstaff The coding standard for PHP_CodeSniffer itself. */Tests/* PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR1/Docs/Classes/ClassDeclarationStandard.xml0000644000076700000240000000161212647543456031065 0ustar gsherwoodstaff class Bar { } ]]> class Bar { } class Baz { } ]]> namespace Foo; class Bar { } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR1/Docs/Files/SideEffectsStandard.xml0000644000076700000240000000113612647543456027504 0ustar gsherwoodstaff echo "Class Foo loaded." ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR1/Sniffs/Classes/ClassDeclarationSniff.php0000644000076700000240000000563312647543456030730 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Class Declaration Test. * * Checks the declaration of the class is correct. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR1_Sniffs_Classes_ClassDeclarationSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_CLASS, T_INTERFACE, T_TRAIT, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param integer $stackPtr The position of the current token in * the token stack. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['scope_closer']) === false) { return; } $errorData = array(strtolower($tokens[$stackPtr]['content'])); $nextClass = $phpcsFile->findNext(array(T_CLASS, T_INTERFACE, T_TRAIT), ($tokens[$stackPtr]['scope_closer'] + 1)); if ($nextClass !== false) { $error = 'Each %s must be in a file by itself'; $phpcsFile->addError($error, $nextClass, 'MultipleClasses', $errorData); $phpcsFile->recordMetric($stackPtr, 'One class per file', 'no'); } else { $phpcsFile->recordMetric($stackPtr, 'One class per file', 'yes'); } if (version_compare(PHP_VERSION, '5.3.0') >= 0) { $namespace = $phpcsFile->findNext(array(T_NAMESPACE, T_CLASS, T_INTERFACE, T_TRAIT), 0); if ($tokens[$namespace]['code'] !== T_NAMESPACE) { $error = 'Each %s must be in a namespace of at least one level (a top-level vendor name)'; $phpcsFile->addError($error, $stackPtr, 'MissingNamespace', $errorData); $phpcsFile->recordMetric($stackPtr, 'Class defined in namespace', 'no'); } else { $phpcsFile->recordMetric($stackPtr, 'Class defined in namespace', 'yes'); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR1/Sniffs/Files/SideEffectsSniff.php0000644000076700000240000001743112647543456027345 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PSR1_Sniffs_Files_SideEffectsSniff. * * Ensures a file declare new symbols and causes no other side effects, or executes * logic with side effects, but not both. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR1_Sniffs_Files_SideEffectsSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the token stack. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $result = $this->_searchForConflict($phpcsFile, 0, ($phpcsFile->numTokens - 1), $tokens); if ($result['symbol'] !== null && $result['effect'] !== null) { $error = 'A file should declare new symbols (classes, functions, constants, etc.) and cause no other side effects, or it should execute logic with side effects, but should not do both. The first symbol is defined on line %s and the first side effect is on line %s.'; $data = array( $tokens[$result['symbol']]['line'], $tokens[$result['effect']]['line'], ); $phpcsFile->addWarning($error, 0, 'FoundWithSymbols', $data); $phpcsFile->recordMetric($stackPtr, 'Declarations and side effects mixed', 'yes'); } else { $phpcsFile->recordMetric($stackPtr, 'Declarations and side effects mixed', 'no'); } // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() /** * Searches for symbol declarations and side effects. * * Returns the positions of both the first symbol declared and the first * side effect in the file. A NULL value for either indicates nothing was * found. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $start The token to start searching from. * @param int $end The token to search to. * @param array $tokens The stack of tokens that make up * the file. * * @return array */ private function _searchForConflict(PHP_CodeSniffer_File $phpcsFile, $start, $end, $tokens) { $symbols = array( T_CLASS => T_CLASS, T_INTERFACE => T_INTERFACE, T_TRAIT => T_TRAIT, T_FUNCTION => T_FUNCTION, ); $conditions = array( T_IF => T_IF, T_ELSE => T_ELSE, T_ELSEIF => T_ELSEIF, ); $firstSymbol = null; $firstEffect = null; for ($i = $start; $i <= $end; $i++) { // Ignore whitespace and comments. if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$i]['code']]) === true) { continue; } // Ignore PHP tags. if ($tokens[$i]['code'] === T_OPEN_TAG || $tokens[$i]['code'] === T_CLOSE_TAG ) { continue; } // Ignore entire namespace, declare, const and use statements. if ($tokens[$i]['code'] === T_NAMESPACE || $tokens[$i]['code'] === T_USE || $tokens[$i]['code'] === T_DECLARE || $tokens[$i]['code'] === T_CONST ) { if (isset($tokens[$i]['scope_opener']) === true) { $i = $tokens[$i]['scope_closer']; } else { $semicolon = $phpcsFile->findNext(T_SEMICOLON, ($i + 1)); if ($semicolon !== false) { $i = $semicolon; } } continue; } // Ignore function/class prefixes. if (isset(PHP_CodeSniffer_Tokens::$methodPrefixes[$tokens[$i]['code']]) === true) { continue; } // Detect and skip over symbols. if (isset($symbols[$tokens[$i]['code']]) === true && isset($tokens[$i]['scope_closer']) === true ) { if ($firstSymbol === null) { $firstSymbol = $i; } $i = $tokens[$i]['scope_closer']; continue; } else if ($tokens[$i]['code'] === T_STRING && strtolower($tokens[$i]['content']) === 'define' ) { $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($i - 1), null, true); if ($tokens[$prev]['code'] !== T_OBJECT_OPERATOR) { if ($firstSymbol === null) { $firstSymbol = $i; } $semicolon = $phpcsFile->findNext(T_SEMICOLON, ($i + 1)); if ($semicolon !== false) { $i = $semicolon; } continue; } }//end if // Conditional statements are allowed in symbol files as long as the // contents is only a symbol definition. So don't count these as effects // in this case. if (isset($conditions[$tokens[$i]['code']]) === true) { if (isset($tokens[$i]['scope_opener']) === false) { // Probably an "else if", so just ignore. continue; } $result = $this->_searchForConflict( $phpcsFile, ($tokens[$i]['scope_opener'] + 1), ($tokens[$i]['scope_closer'] - 1), $tokens ); if ($result['symbol'] !== null) { if ($firstSymbol === null) { $firstSymbol = $result['symbol']; } if ($result['effect'] !== null) { // Found a conflict. $firstEffect = $result['effect']; break; } } if ($firstEffect === null) { $firstEffect = $result['effect']; } $i = $tokens[$i]['scope_closer']; continue; }//end if if ($firstEffect === null) { $firstEffect = $i; } if ($firstSymbol !== null) { // We have a conflict we have to report, so no point continuing. break; } }//end for return array( 'symbol' => $firstSymbol, 'effect' => $firstEffect, ); }//end _searchForConflict() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR1/Sniffs/Methods/CamelCapsMethodNameSniff.php0000644000076700000240000000637412647543456031320 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff not found'); } /** * PSR1_Sniffs_Methods_CamelCapsMethodNameSniff. * * Ensures method names are defined using camel case. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR1_Sniffs_Methods_CamelCapsMethodNameSniff extends Generic_Sniffs_NamingConventions_CamelCapsFunctionNameSniff { /** * Processes the tokens within the scope. * * @param PHP_CodeSniffer_File $phpcsFile The file being processed. * @param int $stackPtr The position where this token was * found. * @param int $currScope The position of the current scope. * * @return void */ protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope) { $methodName = $phpcsFile->getDeclarationName($stackPtr); if ($methodName === null) { // Ignore closures. return; } // Ignore magic methods. if (preg_match('|^__|', $methodName) !== 0) { $magicPart = strtolower(substr($methodName, 2)); if (isset($this->magicMethods[$magicPart]) === true || isset($this->methodsDoubleUnderscore[$magicPart]) === true ) { return; } } $testName = ltrim($methodName, '_'); if ($testName !== '' && PHP_CodeSniffer::isCamelCaps($testName, false, true, false) === false) { $error = 'Method name "%s" is not in camel caps format'; $className = $phpcsFile->getDeclarationName($currScope); $errorData = array($className.'::'.$methodName); $phpcsFile->addError($error, $stackPtr, 'NotCamelCaps', $errorData); $phpcsFile->recordMetric($stackPtr, 'CamelCase method name', 'no'); } else { $phpcsFile->recordMetric($stackPtr, 'CamelCase method name', 'yes'); } }//end processTokenWithinScope() /** * Processes the tokens outside the scope. * * @param PHP_CodeSniffer_File $phpcsFile The file being processed. * @param int $stackPtr The position where this token was * found. * * @return void */ protected function processTokenOutsideScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { }//end processTokenOutsideScope() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR1/Tests/Classes/ClassDeclarationUnitTest.1.inc0000644000076700000240000000004012647543456031420 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ClassDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR1_Tests_Classes_ClassDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='') { if ($testFile === 'ClassDeclarationUnitTest.2.inc') { return array(); } if (version_compare(PHP_VERSION, '5.3.0') >= 0) { return array( 2 => 1, 3 => 2, ); } else { return array( 3 => 1, ); } }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR1/Tests/Files/SideEffectsUnitTest.1.inc0000644000076700000240000000175212647543456030051 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR1/Tests/Files/SideEffectsUnitTest.2.inc0000644000076700000240000000030012647543456030036 0ustar gsherwoodstaffdefine(); echo $object -> define(); PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR1/Tests/Files/SideEffectsUnitTest.3.inc0000644000076700000240000000015312647543456030045 0ustar gsherwoodstaff '; } printHead(); ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR1/Tests/Files/SideEffectsUnitTest.5.inc0000644000076700000240000000005312647543456030046 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR1/Tests/Files/SideEffectsUnitTest.php0000644000076700000240000000424012647543456027723 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the SideEffects sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR1_Tests_Files_SideEffectsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='') { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getWarningList($testFile='') { switch ($testFile) { case 'SideEffectsUnitTest.3.inc': case 'SideEffectsUnitTest.4.inc': case 'SideEffectsUnitTest.5.inc': return array( 1 => 1, ); default: return array(); }//end switch }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR1/Tests/Methods/CamelCapsMethodNameUnitTest.inc0000644000076700000240000000251512647543456031657 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR1/Tests/Methods/CamelCapsMethodNameUnitTest.php0000644000076700000240000000375712647543456031706 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the CamelCapsMethodName sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR1_Tests_Methods_CamelCapsMethodNameUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 6 => 1, 7 => 1, 11 => 1, 12 => 1, 13 => 1, 17 => 1, 21 => 1, 25 => 1, 26 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR1/ruleset.xml0000644000076700000240000000272712647543456023377 0ustar gsherwoodstaff The PSR1 coding standard. 0 PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Docs/Classes/ClassDeclarationStandard.xml0000644000076700000240000000170612647543456031072 0ustar gsherwoodstaff class Foo { } ]]> class Foo { } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Docs/Classes/PropertyDeclarationStandard.xml0000644000076700000240000000261612647543456031652 0ustar gsherwoodstaff bar; } ]]> _bar; } ]]> private $bar; } ]]> var $bar; } ]]> $bar, $baz; } ]]> ././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Docs/ControlStructures/ControlStructureSpacingStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Docs/ControlStructures/ControlStructureSpacingStand0000644000076700000240000000110512647543456033357 0ustar gsherwoodstaff $foo) { $var = 1; } ]]> $foo ) { $var = 1; } ]]> ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Docs/ControlStructures/ElseIfDeclarationStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Docs/ControlStructures/ElseIfDeclarationStandard.xm0000644000076700000240000000110512647543456033140 0ustar gsherwoodstaff elseif ($bar) { $var = 2; } ]]> else if ($bar) { $var = 2; } ]]> ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Docs/ControlStructures/SwitchDeclarationStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Docs/ControlStructures/SwitchDeclarationStandard.xm0000644000076700000240000000472112647543456033241 0ustar gsherwoodstaff case 'bar': break; } ]]> case 'bar': break; } ]]> 'bar': break; } ]]> 'bar': break; } ]]> : break; default: break; } ]]> : break; default : break; } ]]> break; } ]]> break; } ]]> // no break default: break; } ]]> : break; } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Docs/Files/EndFileNewlineStandard.xml0000644000076700000240000000024212647543456030146 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Docs/Methods/MethodDeclarationStandard.xml0000644000076700000240000000225112647543456031247 0ustar gsherwoodstaff bar() { } } ]]> _bar() { } } ]]> final public static function bar() { } } ]]> static public final function bar() { } } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Docs/Namespaces/NamespaceDeclarationStandard.xml0000644000076700000240000000104312647543456032375 0ustar gsherwoodstaff use \Baz; ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Docs/Namespaces/UseDeclarationStandard.xml0000644000076700000240000000243612647543456031244 0ustar gsherwoodstaff \Foo, \Bar; ]]> class Baz { } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Sniffs/Classes/ClassDeclarationSniff.php0000644000076700000240000004717212647543456030735 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PEAR_Sniffs_Classes_ClassDeclarationSniff', true) === false) { $error = 'Class PEAR_Sniffs_Classes_ClassDeclarationSniff not found'; throw new PHP_CodeSniffer_Exception($error); } /** * Class Declaration Test. * * Checks the declaration of the class and its inheritance is correct. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Sniffs_Classes_ClassDeclarationSniff extends PEAR_Sniffs_Classes_ClassDeclarationSniff { /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { // We want all the errors from the PEAR standard, plus some of our own. parent::process($phpcsFile, $stackPtr); // Just in case. $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['scope_opener']) === false) { return; } $this->processOpen($phpcsFile, $stackPtr); $this->processClose($phpcsFile, $stackPtr); }//end process() /** * Processes the opening section of a class declaration. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function processOpen(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $stackPtrType = strtolower($tokens[$stackPtr]['content']); // Check alignment of the keyword and braces. if ($tokens[($stackPtr - 1)]['code'] === T_WHITESPACE) { $prevContent = $tokens[($stackPtr - 1)]['content']; if ($prevContent !== $phpcsFile->eolChar) { $blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar)); $spaces = strlen($blankSpace); if (in_array($tokens[($stackPtr - 2)]['code'], array(T_ABSTRACT, T_FINAL)) === true && $spaces !== 1 ) { $prevContent = strtolower($tokens[($stackPtr - 2)]['content']); $error = 'Expected 1 space between %s and %s keywords; %s found'; $data = array( $prevContent, $stackPtrType, $spaces, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeKeyword', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr - 1), ' '); } } } else if ($tokens[($stackPtr - 2)]['code'] === T_ABSTRACT || $tokens[($stackPtr - 2)]['code'] === T_FINAL ) { $prevContent = strtolower($tokens[($stackPtr - 2)]['content']); $error = 'Expected 1 space between %s and %s keywords; newline found'; $data = array( $prevContent, $stackPtrType, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NewlineBeforeKeyword', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr - 1), ' '); } }//end if }//end if // We'll need the indent of the class/interface declaration for later. $classIndent = 0; for ($i = ($stackPtr - 1); $i > 0; $i--) { if ($tokens[$i]['line'] === $tokens[$stackPtr]['line']) { continue; } // We changed lines. if ($tokens[($i + 1)]['code'] === T_WHITESPACE) { $classIndent = strlen($tokens[($i + 1)]['content']); } break; } $className = $phpcsFile->findNext(T_STRING, $stackPtr); // Spacing of the keyword. $gap = $tokens[($stackPtr + 1)]['content']; if (strlen($gap) !== 1) { $found = strlen($gap); $error = 'Expected 1 space between %s keyword and %s name; %s found'; $data = array( $stackPtrType, $stackPtrType, $found, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterKeyword', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' '); } } // Check after the class/interface name. if ($tokens[($className + 2)]['line'] === $tokens[$className]['line']) { $gap = $tokens[($className + 1)]['content']; if (strlen($gap) !== 1) { $found = strlen($gap); $error = 'Expected 1 space after %s name; %s found'; $data = array( $stackPtrType, $found, ); $fix = $phpcsFile->addFixableError($error, $className, 'SpaceAfterName', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($className + 1), ' '); } } } $openingBrace = $tokens[$stackPtr]['scope_opener']; // Check positions of the extends and implements keywords. foreach (array('extends', 'implements') as $keywordType) { $keyword = $phpcsFile->findNext(constant('T_'.strtoupper($keywordType)), ($stackPtr + 1), $openingBrace); if ($keyword !== false) { if ($tokens[$keyword]['line'] !== $tokens[$stackPtr]['line']) { $error = 'The '.$keywordType.' keyword must be on the same line as the %s name'; $data = array($stackPtrType); $fix = $phpcsFile->addFixableError($error, $keyword, ucfirst($keywordType).'Line', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($stackPtr + 1); $i < $keyword; $i++) { if ($tokens[$i]['line'] !== $tokens[($i + 1)]['line']) { $phpcsFile->fixer->substrToken($i, 0, (strlen($phpcsFile->eolChar) * -1)); } } $phpcsFile->fixer->addContentBefore($keyword, ' '); $phpcsFile->fixer->endChangeset(); } } else { // Check the whitespace before. Whitespace after is checked // later by looking at the whitespace before the first class name // in the list. $gap = strlen($tokens[($keyword - 1)]['content']); if ($gap !== 1) { $error = 'Expected 1 space before '.$keywordType.' keyword; %s found'; $data = array($gap); $fix = $phpcsFile->addFixableError($error, $keyword, 'SpaceBefore'.ucfirst($keywordType), $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($keyword - 1), ' '); } } }//end if }//end if }//end foreach // Check each of the extends/implements class names. If the extends/implements // keyword is the last content on the line, it means we need to check for // the multi-line format, so we do not include the class names // from the extends/implements list in the following check. // Note that classes can only extend one other class, so they can't use a // multi-line extends format, whereas an interface can extend multiple // other interfaces, and so uses a multi-line extends format. if ($tokens[$stackPtr]['code'] === T_INTERFACE) { $keywordTokenType = T_EXTENDS; } else { $keywordTokenType = T_IMPLEMENTS; } $implements = $phpcsFile->findNext($keywordTokenType, ($stackPtr + 1), $openingBrace); $multiLineImplements = false; if ($implements !== false) { $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($openingBrace - 1), $implements, true); if ($tokens[$prev]['line'] !== $tokens[$implements]['line']) { $multiLineImplements = true; } } $find = array( T_STRING, $keywordTokenType, ); $classNames = array(); $nextClass = $phpcsFile->findNext($find, ($className + 2), ($openingBrace - 1)); while ($nextClass !== false) { $classNames[] = $nextClass; $nextClass = $phpcsFile->findNext($find, ($nextClass + 1), ($openingBrace - 1)); } $classCount = count($classNames); $checkingImplements = false; $implementsToken = null; foreach ($classNames as $i => $className) { if ($tokens[$className]['code'] === $keywordTokenType) { $checkingImplements = true; $implementsToken = $className; continue; } if ($checkingImplements === true && $multiLineImplements === true && ($tokens[($className - 1)]['code'] !== T_NS_SEPARATOR || $tokens[($className - 2)]['code'] !== T_STRING) ) { $prev = $phpcsFile->findPrevious( array( T_NS_SEPARATOR, T_WHITESPACE, ), ($className - 1), $implements, true ); if ($prev === $implementsToken && $tokens[$className]['line'] !== ($tokens[$prev]['line'] + 1)) { if ($keywordTokenType === T_EXTENDS) { $error = 'The first item in a multi-line extends list must be on the line following the extends keyword'; $fix = $phpcsFile->addFixableError($error, $className, 'FirstExtendsInterfaceSameLine'); } else { $error = 'The first item in a multi-line implements list must be on the line following the implements keyword'; $fix = $phpcsFile->addFixableError($error, $className, 'FirstInterfaceSameLine'); } if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($prev + 1); $i < $className; $i++) { if ($tokens[$i]['code'] !== T_WHITESPACE) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->addNewline($prev); $phpcsFile->fixer->endChangeset(); } } else if ($tokens[$prev]['line'] !== ($tokens[$className]['line'] - 1)) { if ($keywordTokenType === T_EXTENDS) { $error = 'Only one interface may be specified per line in a multi-line extends declaration'; $fix = $phpcsFile->addFixableError($error, $className, 'ExtendsInterfaceSameLine'); } else { $error = 'Only one interface may be specified per line in a multi-line implements declaration'; $fix = $phpcsFile->addFixableError($error, $className, 'InterfaceSameLine'); } if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($prev + 1); $i < $className; $i++) { if ($tokens[$i]['code'] !== T_WHITESPACE) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->addNewline($prev); $phpcsFile->fixer->endChangeset(); } } else { $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($className - 1), $implements); if ($tokens[$prev]['line'] !== $tokens[$className]['line']) { $found = 0; } else { $found = strlen($tokens[$prev]['content']); } $expected = ($classIndent + $this->indent); if ($found !== $expected) { $error = 'Expected %s spaces before interface name; %s found'; $data = array( $expected, $found, ); $fix = $phpcsFile->addFixableError($error, $className, 'InterfaceWrongIndent', $data); if ($fix === true) { $padding = str_repeat(' ', $expected); if ($found === 0) { $phpcsFile->fixer->addContent($prev, $padding); } else { $phpcsFile->fixer->replaceToken($prev, $padding); } } } }//end if } else if ($tokens[($className - 1)]['code'] !== T_NS_SEPARATOR || $tokens[($className - 2)]['code'] !== T_STRING ) { if ($tokens[($className - 1)]['code'] === T_COMMA || ($tokens[($className - 1)]['code'] === T_NS_SEPARATOR && $tokens[($className - 2)]['code'] === T_COMMA) ) { $error = 'Expected 1 space before "%s"; 0 found'; $data = array($tokens[$className]['content']); $fix = $phpcsFile->addFixableError($error, ($nextComma + 1), 'NoSpaceBeforeName', $data); if ($fix === true) { $phpcsFile->fixer->addContentBefore(($nextComma + 1), ' '); } } else { if ($tokens[($className - 1)]['code'] === T_NS_SEPARATOR) { $prev = ($className - 2); } else { $prev = ($className - 1); } $spaceBefore = strlen($tokens[$prev]['content']); if ($spaceBefore !== 1) { $error = 'Expected 1 space before "%s"; %s found'; $data = array( $tokens[$className]['content'], $spaceBefore, ); $fix = $phpcsFile->addFixableError($error, $className, 'SpaceBeforeName', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($prev, ' '); } } }//end if }//end if if ($tokens[($className + 1)]['code'] !== T_NS_SEPARATOR && $tokens[($className + 1)]['code'] !== T_COMMA ) { if ($i !== ($classCount - 1)) { // This is not the last class name, and the comma // is not where we expect it to be. if ($tokens[($className + 2)]['code'] !== $keywordTokenType) { $error = 'Expected 0 spaces between "%s" and comma; %s found'; $data = array( $tokens[$className]['content'], strlen($tokens[($className + 1)]['content']), ); $fix = $phpcsFile->addFixableError($error, $className, 'SpaceBeforeComma', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($className + 1), ''); } } } $nextComma = $phpcsFile->findNext(T_COMMA, $className); } else { $nextComma = ($className + 1); }//end if }//end foreach }//end processOpen() /** * Processes the closing section of a class declaration. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function processClose(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Check that the closing brace comes right after the code body. $closeBrace = $tokens[$stackPtr]['scope_closer']; $prevContent = $phpcsFile->findPrevious(T_WHITESPACE, ($closeBrace - 1), null, true); if ($prevContent !== $tokens[$stackPtr]['scope_opener'] && $tokens[$prevContent]['line'] !== ($tokens[$closeBrace]['line'] - 1) ) { $error = 'The closing brace for the %s must go on the next line after the body'; $data = array($tokens[$stackPtr]['content']); $fix = $phpcsFile->addFixableError($error, $closeBrace, 'CloseBraceAfterBody', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($prevContent + 1); $i < $closeBrace; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } if (strpos($tokens[$prevContent]['content'], $phpcsFile->eolChar) === false) { $phpcsFile->fixer->replaceToken($closeBrace, $phpcsFile->eolChar.$tokens[$closeBrace]['content']); } $phpcsFile->fixer->endChangeset(); } }//end if // Check the closing brace is on it's own line, but allow // for comments like "//end class". $nextContent = $phpcsFile->findNext(array(T_WHITESPACE, T_COMMENT), ($closeBrace + 1), null, true); if ($tokens[$nextContent]['content'] !== $phpcsFile->eolChar && $tokens[$nextContent]['line'] === $tokens[$closeBrace]['line'] ) { $type = strtolower($tokens[$stackPtr]['content']); $error = 'Closing %s brace must be on a line by itself'; $data = array($type); $phpcsFile->addError($error, $closeBrace, 'CloseBraceSameLine', $data); } }//end processClose() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Sniffs/Classes/PropertyDeclarationSniff.php0000644000076700000240000001014212647543456031477 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractVariableSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractVariableSniff not found'); } /** * Verifies that properties are declared correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Sniffs_Classes_PropertyDeclarationSniff extends PHP_CodeSniffer_Standards_AbstractVariableSniff { /** * Processes the function tokens within the class. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the token was found. * * @return void */ protected function processMemberVar(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[$stackPtr]['content'][1] === '_') { $error = 'Property name "%s" should not be prefixed with an underscore to indicate visibility'; $data = array($tokens[$stackPtr]['content']); $phpcsFile->addWarning($error, $stackPtr, 'Underscore', $data); } // Detect multiple properties defined at the same time. Throw an error // for this, but also only process the first property in the list so we don't // repeat errors. $find = PHP_CodeSniffer_Tokens::$scopeModifiers; $find = array_merge($find, array(T_VARIABLE, T_VAR, T_SEMICOLON)); $prev = $phpcsFile->findPrevious($find, ($stackPtr - 1)); if ($tokens[$prev]['code'] === T_VARIABLE) { return; } if ($tokens[$prev]['code'] === T_VAR) { $error = 'The var keyword must not be used to declare a property'; $phpcsFile->addError($error, $stackPtr, 'VarUsed'); } $next = $phpcsFile->findNext(array(T_VARIABLE, T_SEMICOLON), ($stackPtr + 1)); if ($tokens[$next]['code'] === T_VARIABLE) { $error = 'There must not be more than one property declared per statement'; $phpcsFile->addError($error, $stackPtr, 'Multiple'); } $modifier = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$scopeModifiers, $stackPtr); if (($modifier === false) || ($tokens[$modifier]['line'] !== $tokens[$stackPtr]['line'])) { $error = 'Visibility must be declared on property "%s"'; $data = array($tokens[$stackPtr]['content']); $phpcsFile->addError($error, $stackPtr, 'ScopeMissing', $data); } }//end processMemberVar() /** * Processes normal variables. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the token was found. * * @return void */ protected function processVariable(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { /* We don't care about normal variables. */ }//end processVariable() /** * Processes variables in double quoted strings. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the token was found. * * @return void */ protected function processVariableInString(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { /* We don't care about normal variables. */ }//end processVariableInString() }//end class ././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Sniffs/ControlStructures/ControlStructureSpacingSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Sniffs/ControlStructures/ControlStructureSpacingSni0000644000076700000240000001245612647543456033412 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PSR2_Sniffs_WhiteSpace_ControlStructureSpacingSniff. * * Checks that control structures have the correct spacing around brackets. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Sniffs_ControlStructures_ControlStructureSpacingSniff implements PHP_CodeSniffer_Sniff { /** * How many spaces should follow the opening bracket. * * @var int */ public $requiredSpacesAfterOpen = 0; /** * How many spaces should precede the closing bracket. * * @var int */ public $requiredSpacesBeforeClose = 0; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_IF, T_WHILE, T_FOREACH, T_FOR, T_SWITCH, T_DO, T_ELSE, T_ELSEIF, T_TRY, T_CATCH, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $this->requiredSpacesAfterOpen = (int) $this->requiredSpacesAfterOpen; $this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose; $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['parenthesis_opener']) === false || isset($tokens[$stackPtr]['parenthesis_closer']) === false ) { return; } $parenOpener = $tokens[$stackPtr]['parenthesis_opener']; $parenCloser = $tokens[$stackPtr]['parenthesis_closer']; $spaceAfterOpen = 0; if ($tokens[($parenOpener + 1)]['code'] === T_WHITESPACE) { if (strpos($tokens[($parenOpener + 1)]['content'], $phpcsFile->eolChar) !== false) { $spaceAfterOpen = 'newline'; } else { $spaceAfterOpen = strlen($tokens[($parenOpener + 1)]['content']); } } $phpcsFile->recordMetric($stackPtr, 'Spaces after control structure open parenthesis', $spaceAfterOpen); if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) { $error = 'Expected %s spaces after opening bracket; %s found'; $data = array( $this->requiredSpacesAfterOpen, $spaceAfterOpen, ); $fix = $phpcsFile->addFixableError($error, ($parenOpener + 1), 'SpacingAfterOpenBrace', $data); if ($fix === true) { $padding = str_repeat(' ', $this->requiredSpacesAfterOpen); if ($spaceAfterOpen === 0) { $phpcsFile->fixer->addContent($parenOpener, $padding); } else if ($spaceAfterOpen === 'newline') { $phpcsFile->fixer->replaceToken(($parenOpener + 1), ''); } else { $phpcsFile->fixer->replaceToken(($parenOpener + 1), $padding); } } } if ($tokens[$parenOpener]['line'] === $tokens[$parenCloser]['line']) { $spaceBeforeClose = 0; if ($tokens[($parenCloser - 1)]['code'] === T_WHITESPACE) { $spaceBeforeClose = strlen(ltrim($tokens[($parenCloser - 1)]['content'], $phpcsFile->eolChar)); } $phpcsFile->recordMetric($stackPtr, 'Spaces before control structure close parenthesis', $spaceBeforeClose); if ($spaceBeforeClose !== $this->requiredSpacesBeforeClose) { $error = 'Expected %s spaces before closing bracket; %s found'; $data = array( $this->requiredSpacesBeforeClose, $spaceBeforeClose, ); $fix = $phpcsFile->addFixableError($error, ($parenCloser - 1), 'SpaceBeforeCloseBrace', $data); if ($fix === true) { $padding = str_repeat(' ', $this->requiredSpacesBeforeClose); if ($spaceBeforeClose === 0) { $phpcsFile->fixer->addContentBefore($parenCloser, $padding); } else { $phpcsFile->fixer->replaceToken(($parenCloser - 1), $padding); } } } }//end if }//end process() }//end class ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Sniffs/ControlStructures/ElseIfDeclarationSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Sniffs/ControlStructures/ElseIfDeclarationSniff.php0000644000076700000240000000517312647543456033161 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PSR2_Sniffs_ControlStructures_ElseIfDeclarationSniff. * * Verifies that there are no else if statements. Elseif should be used instead. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Sniffs_ControlStructures_ElseIfDeclarationSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_ELSE, T_ELSEIF, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[$stackPtr]['code'] === T_ELSEIF) { $phpcsFile->recordMetric($stackPtr, 'Use of ELSE IF or ELSEIF', 'elseif'); return; } $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$next]['code'] === T_IF) { $phpcsFile->recordMetric($stackPtr, 'Use of ELSE IF or ELSEIF', 'else if'); $error = 'Usage of ELSE IF is discouraged; use ELSEIF instead'; $fix = $phpcsFile->addFixableWarning($error, $stackPtr, 'NotAllowed'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->replaceToken($stackPtr, 'elseif'); for ($i = ($stackPtr + 1); $i <= $next; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } } }//end process() }//end class ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Sniffs/ControlStructures/SwitchDeclarationSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Sniffs/ControlStructures/SwitchDeclarationSniff.php0000644000076700000240000002444312647543456033254 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PSR2_Sniffs_ControlStructures_SwitchDeclarationSniff. * * Ensures all switch statements are defined correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Sniffs_ControlStructures_SwitchDeclarationSniff implements PHP_CodeSniffer_Sniff { /** * The number of spaces code should be indented. * * @var int */ public $indent = 4; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_SWITCH); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // We can't process SWITCH statements unless we know where they start and end. if (isset($tokens[$stackPtr]['scope_opener']) === false || isset($tokens[$stackPtr]['scope_closer']) === false ) { return; } $switch = $tokens[$stackPtr]; $nextCase = $stackPtr; $caseAlignment = ($switch['column'] + $this->indent); $caseCount = 0; $foundDefault = false; while (($nextCase = $this->_findNextCase($phpcsFile, ($nextCase + 1), $switch['scope_closer'])) !== false) { if ($tokens[$nextCase]['code'] === T_DEFAULT) { $type = 'default'; $foundDefault = true; } else { $type = 'case'; $caseCount++; } if ($tokens[$nextCase]['content'] !== strtolower($tokens[$nextCase]['content'])) { $expected = strtolower($tokens[$nextCase]['content']); $error = strtoupper($type).' keyword must be lowercase; expected "%s" but found "%s"'; $data = array( $expected, $tokens[$nextCase]['content'], ); $fix = $phpcsFile->addFixableError($error, $nextCase, $type.'NotLower', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($nextCase, $expected); } } if ($type === 'case' && ($tokens[($nextCase + 1)]['code'] !== T_WHITESPACE || $tokens[($nextCase + 1)]['content'] !== ' ') ) { $error = 'CASE keyword must be followed by a single space'; $fix = $phpcsFile->addFixableError($error, $nextCase, 'SpacingAfterCase'); if ($fix === true) { if ($tokens[($nextCase + 1)]['code'] !== T_WHITESPACE) { $phpcsFile->fixer->addContent($nextCase, ' '); } else { $phpcsFile->fixer->replaceToken(($nextCase + 1), ' '); } } } $opener = $tokens[$nextCase]['scope_opener']; $nextCloser = $tokens[$nextCase]['scope_closer']; if ($tokens[$opener]['code'] === T_COLON) { if ($tokens[($opener - 1)]['code'] === T_WHITESPACE) { $error = 'There must be no space before the colon in a '.strtoupper($type).' statement'; $fix = $phpcsFile->addFixableError($error, $nextCase, 'SpaceBeforeColon'.strtoupper($type)); if ($fix === true) { $phpcsFile->fixer->replaceToken(($opener - 1), ''); } } $next = $phpcsFile->findNext(T_WHITESPACE, ($opener + 1), null, true); if ($tokens[$next]['line'] === $tokens[$opener]['line'] && $tokens[$next]['code'] === T_COMMENT ) { // Skip comments on the same line. $next = $phpcsFile->findNext(T_WHITESPACE, ($next + 1), null, true); } if ($tokens[$next]['line'] !== ($tokens[$opener]['line'] + 1)) { $error = 'The '.strtoupper($type).' body must start on the line following the statement'; $fix = $phpcsFile->addFixableError($error, $nextCase, 'BodyOnNextLine'.strtoupper($type)); if ($fix === true) { if ($tokens[$next]['line'] === $tokens[$opener]['line']) { $padding = str_repeat(' ', ($caseAlignment + $this->indent - 1)); $phpcsFile->fixer->addContentBefore($next, $phpcsFile->eolChar.$padding); } else { $phpcsFile->fixer->beginChangeset(); for ($i = ($opener + 1); $i < $next; $i++) { if ($tokens[$i]['line'] === $tokens[$next]['line']) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->addNewLineBefore($i); $phpcsFile->fixer->endChangeset(); } } }//end if if ($tokens[$nextCloser]['scope_condition'] === $nextCase) { // Only need to check some things once, even if the // closer is shared between multiple case statements, or even // the default case. $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($nextCloser - 1), $nextCase, true); if ($tokens[$prev]['line'] === $tokens[$nextCloser]['line']) { $error = 'Terminating statement must be on a line by itself'; $fix = $phpcsFile->addFixableError($error, $nextCloser, 'BreakNotNewLine'); if ($fix === true) { $phpcsFile->fixer->addNewLine($prev); $phpcsFile->fixer->replaceToken($nextCloser, trim($tokens[$nextCloser]['content'])); } } else { $diff = ($caseAlignment + $this->indent - $tokens[$nextCloser]['column']); if ($diff !== 0) { $error = 'Terminating statement must be indented to the same level as the CASE body'; $fix = $phpcsFile->addFixableError($error, $nextCloser, 'BreakIndent'); if ($fix === true) { if ($diff > 0) { $phpcsFile->fixer->addContentBefore($nextCloser, str_repeat(' ', $diff)); } else { $phpcsFile->fixer->substrToken(($nextCloser - 1), 0, $diff); } } } }//end if }//end if } else { $error = strtoupper($type).' statements must be defined using a colon'; $phpcsFile->addError($error, $nextCase, 'WrongOpener'.$type); }//end if // We only want cases from here on in. if ($type !== 'case') { continue; } $nextCode = $phpcsFile->findNext( T_WHITESPACE, ($tokens[$nextCase]['scope_opener'] + 1), $nextCloser, true ); if ($tokens[$nextCode]['code'] !== T_CASE && $tokens[$nextCode]['code'] !== T_DEFAULT) { // This case statement has content. If the next case or default comes // before the closer, it means we dont have a terminating statement // and instead need a comment. $nextCode = $this->_findNextCase($phpcsFile, ($tokens[$nextCase]['scope_opener'] + 1), $nextCloser); if ($nextCode !== false) { $prevCode = $phpcsFile->findPrevious(T_WHITESPACE, ($nextCode - 1), $nextCase, true); if ($tokens[$prevCode]['code'] !== T_COMMENT) { $error = 'There must be a comment when fall-through is intentional in a non-empty case body'; $phpcsFile->addError($error, $nextCase, 'TerminatingComment'); } } } }//end while }//end process() /** * Find the next CASE or DEFAULT statement from a point in the file. * * Note that nested switches are ignored. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position to start looking at. * @param int $end The position to stop looking at. * * @return int | bool */ private function _findNextCase(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $end) { $tokens = $phpcsFile->getTokens(); while (($stackPtr = $phpcsFile->findNext(array(T_CASE, T_DEFAULT, T_SWITCH), $stackPtr, $end)) !== false) { // Skip nested SWITCH statements; they are handled on their own. if ($tokens[$stackPtr]['code'] === T_SWITCH) { $stackPtr = $tokens[$stackPtr]['scope_closer']; continue; } break; } return $stackPtr; }//end _findNextCase() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Sniffs/Files/ClosingTagSniff.php0000644000076700000240000000625212647543456027213 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PSR2_Sniffs_Files_LineEndingsSniff. * * Checks that the file does not end with a closing tag. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Sniffs_Files_ClosingTagSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Make sure this file only contains PHP code. for ($i = 0; $i < $phpcsFile->numTokens; $i++) { if ($tokens[$i]['code'] === T_INLINE_HTML && trim($tokens[$i]['content']) !== '' ) { return $phpcsFile->numTokens; } } // Find the last non-empty token. for ($last = ($phpcsFile->numTokens - 1); $last > 0; $last--) { if (trim($tokens[$last]['content']) !== '') { break; } } if ($tokens[$last]['code'] === T_CLOSE_TAG) { $error = 'A closing tag is not permitted at the end of a PHP file'; $fix = $phpcsFile->addFixableError($error, $last, 'NotAllowed'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->replaceToken($last, $phpcsFile->eolChar); $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($last - 1), null, true); if ($tokens[$prev]['code'] !== T_SEMICOLON && $tokens[$prev]['code'] !== T_CLOSE_CURLY_BRACKET ) { $phpcsFile->fixer->addContent($prev, ';'); } $phpcsFile->fixer->endChangeset(); } $phpcsFile->recordMetric($stackPtr, 'PHP closing tag at end of PHP-only file', 'yes'); } else { $phpcsFile->recordMetric($stackPtr, 'PHP closing tag at end of PHP-only file', 'no'); } // Ignore the rest of the file. return $phpcsFile->numTokens; }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Sniffs/Files/EndFileNewlineSniff.php0000644000076700000240000000731212647543456030007 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Generic_Sniffs_Files_EndFileNewlineSniff. * * Ensures the file ends with a newline character. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Sniffs_Files_EndFileNewlineSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { if ($phpcsFile->findNext(T_INLINE_HTML, ($stackPtr + 1)) !== false) { return ($phpcsFile->numTokens + 1); } // Skip to the end of the file. $tokens = $phpcsFile->getTokens(); $lastToken = ($phpcsFile->numTokens - 1); // Hard-coding the expected \n in this sniff as it is PSR-2 specific and // PSR-2 enforces the use of unix style newlines. if (substr($tokens[$lastToken]['content'], -1) !== "\n") { $error = 'Expected 1 newline at end of file; 0 found'; $fix = $phpcsFile->addFixableError($error, $lastToken, 'NoneFound'); if ($fix === true) { $phpcsFile->fixer->addNewline($lastToken); } $phpcsFile->recordMetric($stackPtr, 'Number of newlines at EOF', '0'); return ($phpcsFile->numTokens + 1); } // Go looking for the last non-empty line. $lastLine = $tokens[$lastToken]['line']; if ($tokens[$lastToken]['code'] === T_WHITESPACE) { $lastCode = $phpcsFile->findPrevious(T_WHITESPACE, ($lastToken - 1), null, true); } else { $lastCode = $lastToken; } $lastCodeLine = $tokens[$lastCode]['line']; $blankLines = ($lastLine - $lastCodeLine + 1); $phpcsFile->recordMetric($stackPtr, 'Number of newlines at EOF', $blankLines); if ($blankLines > 1) { $error = 'Expected 1 blank line at end of file; %s found'; $data = array($blankLines); $fix = $phpcsFile->addFixableError($error, $lastCode, 'TooMany', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->replaceToken($lastCode, rtrim($tokens[$lastCode]['content'])); for ($i = ($lastCode + 1); $i < $lastToken; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->replaceToken($lastToken, $phpcsFile->eolChar); $phpcsFile->fixer->endChangeset(); } } // Skip the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Sniffs/Methods/FunctionCallSignatureSniff.php0000644000076700000240000000630412647543456031763 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PSR2_Sniffs_Methods_FunctionCallSignatureSniff. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Sniffs_Methods_FunctionCallSignatureSniff extends PEAR_Sniffs_Functions_FunctionCallSignatureSniff { /** * If TRUE, multiple arguments can be defined per line in a multi-line call. * * @var bool */ public $allowMultipleArguments = false; /** * Processes single-line calls. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param int $openBracket The position of the opening bracket * in the stack passed in $tokens. * @param array $tokens The stack of tokens that make up * the file. * * @return void */ public function isMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $openBracket, $tokens) { // If the first argument is on a new line, this is a multi-line // function call, even if there is only one argument. $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($openBracket + 1), null, true); if ($tokens[$next]['line'] !== $tokens[$stackPtr]['line']) { return true; } $closeBracket = $tokens[$openBracket]['parenthesis_closer']; $end = $phpcsFile->findEndOfStatement($openBracket + 1); while ($tokens[$end]['code'] === T_COMMA) { // If the next bit of code is not on the same line, this is a // multi-line function call. $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($end + 1), $closeBracket, true); if ($next === false) { return false; } if ($tokens[$next]['line'] !== $tokens[$end]['line']) { return true; } $end = $phpcsFile->findEndOfStatement($next); } // We've reached the last argument, so see if the next content // (should be the close bracket) is also on the same line. $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($end + 1), $closeBracket, true); if ($next !== false && $tokens[$next]['line'] !== $tokens[$end]['line']) { return true; } return false; }//end isMultiLineCall() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Sniffs/Methods/MethodDeclarationSniff.php0000644000076700000240000001272412647543456031111 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found'); } /** * PSR2_Sniffs_Methods_MethodDeclarationSniff. * * Checks that the method declaration is correct. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Sniffs_Methods_MethodDeclarationSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff { /** * Constructs a Squiz_Sniffs_Scope_MethodScopeSniff. */ public function __construct() { parent::__construct(array(T_CLASS, T_INTERFACE), array(T_FUNCTION)); }//end __construct() /** * Processes the function tokens within the class. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the token was found. * @param int $currScope The current scope opener token. * * @return void */ protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope) { $tokens = $phpcsFile->getTokens(); $methodName = $phpcsFile->getDeclarationName($stackPtr); if ($methodName === null) { // Ignore closures. return; } if ($methodName[0] === '_' && isset($methodName[1]) === true && $methodName[1] !== '_') { $error = 'Method name "%s" should not be prefixed with an underscore to indicate visibility'; $data = array($methodName); $phpcsFile->addWarning($error, $stackPtr, 'Underscore', $data); } $visibility = 0; $static = 0; $abstract = 0; $final = 0; $find = PHP_CodeSniffer_Tokens::$methodPrefixes; $find[] = T_WHITESPACE; $prev = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true); $prefix = $stackPtr; while (($prefix = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$methodPrefixes, ($prefix - 1), $prev)) !== false) { switch ($tokens[$prefix]['code']) { case T_STATIC: $static = $prefix; break; case T_ABSTRACT: $abstract = $prefix; break; case T_FINAL: $final = $prefix; break; default: $visibility = $prefix; break; } } $fixes = array(); if ($visibility !== 0 && $final > $visibility) { $error = 'The final declaration must precede the visibility declaration'; $fix = $phpcsFile->addFixableError($error, $final, 'FinalAfterVisibility'); if ($fix === true) { $fixes[$final] = ''; $fixes[($final + 1)] = ''; if (isset($fixes[$visibility]) === true) { $fixes[$visibility] = 'final '.$fixes[$visibility]; } else { $fixes[$visibility] = 'final '.$tokens[$visibility]['content']; } } } if ($visibility !== 0 && $abstract > $visibility) { $error = 'The abstract declaration must precede the visibility declaration'; $fix = $phpcsFile->addFixableError($error, $abstract, 'AbstractAfterVisibility'); if ($fix === true) { $fixes[$abstract] = ''; $fixes[($abstract + 1)] = ''; if (isset($fixes[$visibility]) === true) { $fixes[$visibility] = 'abstract '.$fixes[$visibility]; } else { $fixes[$visibility] = 'abstract '.$tokens[$visibility]['content']; } } } if ($static !== 0 && $static < $visibility) { $error = 'The static declaration must come after the visibility declaration'; $fix = $phpcsFile->addFixableError($error, $static, 'StaticBeforeVisibility'); if ($fix === true) { $fixes[$static] = ''; $fixes[($static + 1)] = ''; if (isset($fixes[$visibility]) === true) { $fixes[$visibility] = $fixes[$visibility].' static'; } else { $fixes[$visibility] = $tokens[$visibility]['content'].' static'; } } } // Batch all the fixes together to reduce the possibility of conflicts. if (empty($fixes) === false) { $phpcsFile->fixer->beginChangeset(); foreach ($fixes as $stackPtr => $content) { $phpcsFile->fixer->replaceToken($stackPtr, $content); } $phpcsFile->fixer->endChangeset(); } }//end processTokenWithinScope() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Sniffs/Namespaces/NamespaceDeclarationSniff.php0000644000076700000240000000600512647543456032234 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PSR2_Sniffs_Namespaces_NamespaceDeclarationSniff. * * Ensures namespaces are declared correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Sniffs_Namespaces_NamespaceDeclarationSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_NAMESPACE); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); for ($i = ($stackPtr + 1); $i < ($phpcsFile->numTokens - 1); $i++) { if ($tokens[$i]['line'] === $tokens[$stackPtr]['line']) { continue; } break; } // The $i var now points to the first token on the line after the // namespace declaration, which must be a blank line. $next = $phpcsFile->findNext(T_WHITESPACE, $i, $phpcsFile->numTokens, true); if ($next === false) { return; } $diff = ($tokens[$next]['line'] - $tokens[$i]['line']); if ($diff === 1) { return; } if ($diff < 0) { $diff = 0; } $error = 'There must be one blank line after the namespace declaration'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'BlankLineAfter'); if ($fix === true) { if ($diff === 0) { $phpcsFile->fixer->addNewlineBefore($i); } else { $phpcsFile->fixer->beginChangeset(); for ($x = $i; $x < $next; $x++) { if ($tokens[$x]['line'] === $tokens[$next]['line']) { break; } $phpcsFile->fixer->replaceToken($x, ''); } $phpcsFile->fixer->addNewline($i); $phpcsFile->fixer->endChangeset(); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Sniffs/Namespaces/UseDeclarationSniff.php0000644000076700000240000001314012647543456031072 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * PSR2_Sniffs_Namespaces_UseDeclarationSniff. * * Ensures USE blocks are declared correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Sniffs_Namespaces_UseDeclarationSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_USE); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { if ($this->_shouldIgnoreUse($phpcsFile, $stackPtr) === true) { return; } $tokens = $phpcsFile->getTokens(); // One space after the use keyword. if ($tokens[($stackPtr + 1)]['content'] !== ' ') { $error = 'There must be a single space after the USE keyword'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterUse'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' '); } } // Only one USE declaration allowed per statement. $next = $phpcsFile->findNext(array(T_COMMA, T_SEMICOLON), ($stackPtr + 1)); if ($tokens[$next]['code'] === T_COMMA) { $error = 'There must be one USE keyword per declaration'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'MultipleDeclarations'); if ($fix === true) { $phpcsFile->fixer->replaceToken($next, ';'.$phpcsFile->eolChar.'use '); } } // Make sure this USE comes after the first namespace declaration. $prev = $phpcsFile->findPrevious(T_NAMESPACE, ($stackPtr - 1)); if ($prev !== false) { $first = $phpcsFile->findNext(T_NAMESPACE, 1); if ($prev !== $first) { $error = 'USE declarations must go after the first namespace declaration'; $phpcsFile->addError($error, $stackPtr, 'UseAfterNamespace'); } } // Only interested in the last USE statement from here onwards. $nextUse = $phpcsFile->findNext(T_USE, ($stackPtr + 1)); while ($this->_shouldIgnoreUse($phpcsFile, $nextUse) === true) { $nextUse = $phpcsFile->findNext(T_USE, ($nextUse + 1)); if ($nextUse === false) { break; } } if ($nextUse !== false) { return; } $end = $phpcsFile->findNext(T_SEMICOLON, ($stackPtr + 1)); $next = $phpcsFile->findNext(T_WHITESPACE, ($end + 1), null, true); if ($tokens[$next]['code'] === T_CLOSE_TAG) { return; } $diff = ($tokens[$next]['line'] - $tokens[$end]['line'] - 1); if ($diff !== 1) { if ($diff < 0) { $diff = 0; } $error = 'There must be one blank line after the last USE statement; %s found;'; $data = array($diff); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterLastUse', $data); if ($fix === true) { if ($diff === 0) { $phpcsFile->fixer->addNewline($end); } else { $phpcsFile->fixer->beginChangeset(); for ($i = ($end + 1); $i < $next; $i++) { if ($tokens[$i]['line'] === $tokens[$next]['line']) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->addNewline($end); $phpcsFile->fixer->endChangeset(); } } }//end if }//end process() /** * Check if this use statement is part of the namespace block. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ private function _shouldIgnoreUse(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Ignore USE keywords inside closures. $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$next]['code'] === T_OPEN_PARENTHESIS) { return true; } // Ignore USE keywords for traits. if ($phpcsFile->hasCondition($stackPtr, array(T_CLASS, T_TRAIT)) === true) { return true; } return false; }//end _shouldIgnoreUse() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Classes/ClassDeclarationUnitTest.inc0000644000076700000240000000411112647543456031265 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ClassDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Tests_Classes_ClassDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 7 => 3, 12 => 1, 13 => 1, 17 => 1, 19 => 2, 20 => 1, 21 => 1, 22 => 1, 25 => 1, 27 => 2, 34 => 1, 35 => 2, 44 => 1, 45 => 1, 63 => 1, 95 => 1, 116 => 1, 118 => 1, 119 => 1, 124 => 1, 130 => 2, 131 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Classes/PropertyDeclarationUnitTest.inc0000644000076700000240000000060712647543456032052 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Classes/PropertyDeclarationUnitTest.php0000644000076700000240000000374612647543456032077 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the PropertyDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Tests_Classes_PropertyDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 7 => 1, 9 => 2, 10 => 1, 16 => 1, 17 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 12 => 1, 13 => 1, 14 => 1, ); }//end getWarningList() }//end class ?> ././@LongLink000 154 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/ControlStructures/ControlStructureSpacingUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/ControlStructures/ControlStructureSpacingUnit0000644000076700000240000000216012647543456033441 0ustar gsherwoodstaff $that) {} foreach ( $something as $blah => $that ) {} foreach ( $something as $blah => $that ) {} // @codingStandardsChangeSetting PSR2.ControlStructures.ControlStructureSpacing requiredSpacesAfterOpen 0 // @codingStandardsChangeSetting PSR2.ControlStructures.ControlStructureSpacing requiredSpacesBeforeClose 0 $binary = b"binary string"; ././@LongLink000 162 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/ControlStructures/ControlStructureSpacingUnitTest.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/ControlStructures/ControlStructureSpacingUnit0000644000076700000240000000214012647543456033437 0ustar gsherwoodstaff $that ) {} foreach ( $something as $blah => $that ) {} foreach ( $something as $blah => $that ) {} // @codingStandardsChangeSetting PSR2.ControlStructures.ControlStructureSpacing requiredSpacesAfterOpen 0 // @codingStandardsChangeSetting PSR2.ControlStructures.ControlStructureSpacing requiredSpacesBeforeClose 0 $binary = b"binary string"; ././@LongLink000 154 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/ControlStructures/ControlStructureSpacingUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/ControlStructures/ControlStructureSpacingUnit0000644000076700000240000000404712647543456033447 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the FunctionSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Tests_ControlStructures_ControlStructureSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 4 => 1, 14 => 2, 26 => 2, 27 => 2, 31 => 1, 41 => 2, 43 => 2, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/ControlStructures/ElseIfDeclarationUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/ControlStructures/ElseIfDeclarationUnitTest.i0000644000076700000240000000027512647543456033204 0ustar gsherwoodstaff././@LongLink000 154 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/ControlStructures/ElseIfDeclarationUnitTest.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/ControlStructures/ElseIfDeclarationUnitTest.i0000644000076700000240000000027312647543456033202 0ustar gsherwoodstaff././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/ControlStructures/ElseIfDeclarationUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/ControlStructures/ElseIfDeclarationUnitTest.p0000644000076700000240000000350412647543456033211 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ElseIfDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Tests_ControlStructures_ElseIfDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 4 => 1, 12 => 1, ); }//end getWarningList() }//end class ?> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/ControlStructures/SwitchDeclarationUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/ControlStructures/SwitchDeclarationUnitTest.i0000644000076700000240000000416412647543456033277 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the SwitchDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Tests_ControlStructures_SwitchDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 10 => 1, 11 => 1, 14 => 1, 16 => 1, 20 => 1, 23 => 1, 29 => 1, 33 => 1, 37 => 2, 108 => 2, 109 => 1, 111 => 1, 113 => 2, 114 => 1, 128 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Files/ClosingTagUnitTest.1.inc0000644000076700000240000000006512647543456027714 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Files/ClosingTagUnitTest.1.inc.fixed0000644000076700000240000000006312647543456031010 0ustar gsherwoodstaff
    PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Files/ClosingTagUnitTest.3.inc0000644000076700000240000000012112647543456027707 0ustar gsherwoodstaff A: B: C: PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Files/ClosingTagUnitTest.4.inc0000644000076700000240000000003312647543456027712 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Files/ClosingTagUnitTest.4.inc.fixed0000644000076700000240000000003212647543456031007 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Files/ClosingTagUnitTest.php0000644000076700000240000000406012647543456027572 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ClosingTag sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Tests_Files_ClosingTagUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='') { switch ($testFile) { case 'ClosingTagUnitTest.1.inc': return array(11 => 1); case 'ClosingTagUnitTest.4.inc': case 'ClosingTagUnitTest.5.inc': return array(1 => 1); default: return array(); } }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Files/EndFileNewlineUnitTest.1.inc0000644000076700000240000000002312647543456030504 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Files/EndFileNewlineUnitTest.5.inc0000644000076700000240000000005712647543456030517 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the EndFileNewline sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Tests_Files_EndFileNewlineUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='') { switch ($testFile) { case 'EndFileNewlineUnitTest.1.inc': case 'EndFileNewlineUnitTest.3.inc': case 'EndFileNewlineUnitTest.6.inc': case 'EndFileNewlineUnitTest.7.inc': return array( 2 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getWarningList($testFile='') { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Methods/FunctionCallSignatureUnitTest.inc0000644000076700000240000000275512647543456032337 0ustar gsherwoodstaffget('/hello/{name}', function ($name) use ($app) { return 'Hello '.$app->escape($name); }, array( '1', '2', '3', )); // error somefunction2($foo, $bar, [ // ... ], $baz); // ok somefunction3(// ... $foo, $bar, [ // ... ], $baz ); // ok somefunction4(' this should not give an error because it\'s actually one line call with multi-line string '); // ok somefunction5("hey, multi-line string with some extra args", $foo, 12); // error somefunction6(' but args in a new line are not ok… ', $foo ); $this->setFoo(true ? 1 : 2, false, array( 'value', 'more')); $this->setFoo('some' . 'long' . 'text', 'string'); foo(bar(), $a); foo();bar(); foo( true ); myFunction(<< function ($x) { return true; }, 'baz' => false ) ); $qux = array_filter( $quux, function ($x) { return $x; } ); $this->listeners[] = $events->getSharedManager()->attach( 'Zend\Mvc\Application', MvcEvent::EVENT_DISPATCH, [$this, 'selectLayout'], 100 ); ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Methods/FunctionCallSignatureUnitTest.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Methods/FunctionCallSignatureUnitTest.inc.fix0000644000076700000240000000304212647543456033112 0ustar gsherwoodstaffget('/hello/{name}', function ($name) use ($app) { return 'Hello '.$app->escape($name); }, array( '1', '2', '3', )); // error somefunction2( $foo, $bar, [ // ... ], $baz ); // ok somefunction3(// ... $foo, $bar, [ // ... ], $baz ); // ok somefunction4(' this should not give an error because it\'s actually one line call with multi-line string '); // ok somefunction5("hey, multi-line string with some extra args", $foo, 12); // error somefunction6( ' but args in a new line are not ok… ', $foo ); $this->setFoo(true ? 1 : 2, false, array( 'value', 'more')); $this->setFoo('some' . 'long' . 'text', 'string'); foo(bar(), $a); foo();bar(); foo( true ); myFunction(<< function ($x) { return true; }, 'baz' => false ) ); $qux = array_filter( $quux, function ($x) { return $x; } ); $this->listeners[] = $events->getSharedManager()->attach( 'Zend\Mvc\Application', MvcEvent::EVENT_DISPATCH, [$this, 'selectLayout'], 100 ); PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Methods/FunctionCallSignatureUnitTest.php0000644000076700000240000000414212647543456032345 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the FunctionCallSignature sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Tests_Methods_FunctionCallSignatureUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 18 => 3, 21 => 1, 48 => 1, 87 => 1, 90 => 1, 91 => 1, 103 => 1, 111 => 1, 117 => 4, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Methods/MethodDeclarationUnitTest.inc0000644000076700000240000000101612647543456031447 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Methods/MethodDeclarationUnitTest.inc.fixed0000644000076700000240000000101612647543456032545 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Methods/MethodDeclarationUnitTest.php0000644000076700000240000000362412647543456031474 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the MethodDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Tests_Methods_MethodDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 9 => 1, 11 => 1, 13 => 1, 15 => 3, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 5 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Namespaces/NamespaceDeclarationUnitTest.inc0000644000076700000240000000026012647543456032577 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the NamespaceDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Tests_Namespaces_NamespaceDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 6 => 1, 9 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Namespaces/UseDeclarationUnitTest.1.inc0000644000076700000240000000057212647543456031604 0ustar gsherwoodstaff ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Namespaces/UseDeclarationUnitTest.2.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Namespaces/UseDeclarationUnitTest.2.inc.fixed0000644000076700000240000000025012647543456032674 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Namespaces/UseDeclarationUnitTest.3.inc0000644000076700000240000000030612647543456031601 0ustar gsherwoodstaff

    PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/Tests/Namespaces/UseDeclarationUnitTest.php0000644000076700000240000000433012647543456031457 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the UseDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PSR2_Tests_Namespaces_UseDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='') { switch ($testFile) { case 'UseDeclarationUnitTest.2.inc': return array( 4 => 1, 5 => 1, 10 => 2, ); case 'UseDeclarationUnitTest.3.inc': return array( 4 => 1, 6 => 1, ); default: return array(); }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/PSR2/ruleset.xml0000644000076700000240000002223512647543456023374 0ustar gsherwoodstaff The PSR-2 coding standard. 0 0 0 0 0 PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/Arrays/ArrayBracketSpacingStandard.xml0000644000076700000240000000105512647543456031764 0ustar gsherwoodstaff ['bar']; ]]> [ 'bar' ]; ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/Arrays/ArrayDeclarationStandard.xml0000644000076700000240000000623012647543456031331 0ustar gsherwoodstaff array keyword must be lowercase. ]]> array('val1', 'val2'); ]]> Array('val1', 'val2'); ]]> array keyword. ]]> 'key1' => 'value1', 'key2' => 'value2', ); ]]> 'key1' => 'value1', 'key2' => 'value2', ); ]]> array keyword. The closing parenthesis must be aligned with the start of the array keyword. ]]> 'key1' => 'value1', 'key2' => 'value2', ); ]]> 'key1' => 'value1', 'key2' => 'value2', ); ]]> => 'ValueTen', 'keyTwenty' => 'ValueTwenty', ); ]]> => 'ValueTen', 'keyTwenty' => 'ValueTwenty', ); ]]> 'value1', 'key2' => 'value2', 'key3' => 'value3', ); ]]> 'value1', 'key2' => 'value2', 'key3' => 'value3' ); ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/Classes/LowercaseClassKeywordsStandard.xml0000644000076700000240000000114012647543456032676 0ustar gsherwoodstaff final class Foo extends Bar { } ]]> Final Class Foo Extends Bar { } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/Classes/SelfMemberReferenceStandard.xml0000644000076700000240000000247212647543456032105 0ustar gsherwoodstaff self::foo(); ]]> SELF::foo(); ]]> ::foo(); ]]> :: foo(); ]]> self::bar(); } } ]]> Foo { public static function bar() { } public static function baz() { Foo::bar(); } } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/Commenting/DocCommentAlignmentStandard.xml0000644000076700000240000000151512647543456032634 0ustar gsherwoodstaff * @see foo() */ ]]> * @see foo() */ ]]> @see foo() */ ]]> @see foo() */ ]]> ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/Commenting/FunctionCommentThrowTagStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/Commenting/FunctionCommentThrowTagStandard.xm0000644000076700000240000000120712647543456033357 0ustar gsherwoodstaff @throws Exception all the time * @return void */ function foo() { throw new Exception('Danger!'); } ]]> ././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/ControlStructures/ForEachLoopDeclarationStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/ControlStructures/ForEachLoopDeclarationStand0000644000076700000240000000176112647543456033415 0ustar gsherwoodstaff $foo as $bar => $baz) { echo $baz; } ]]> $foo as $bar=>$baz ) { echo $baz; } ]]> as $bar => $baz) { echo $baz; } ]]> AS $bar => $baz) { echo $baz; } ]]> ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/ControlStructures/ForLoopDeclarationStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/ControlStructures/ForLoopDeclarationStandard.0000644000076700000240000000253212647543456033376 0ustar gsherwoodstaff $i = 0; $i < 10; $i++) { echo $i; } ]]> $i = 0; $i < 10; $i++ ) { echo $i; } ]]> ; $i < 10; $i++) { echo $i; } ]]> ; $i < 10 ; $i++) { echo $i; } ]]> $i < 10; $i++) { echo $i; } ]]> $i < 10;$i++) { echo $i; } ]]> ././@LongLink000 151 0003733 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/ControlStructures/LowercaseDeclarationStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/ControlStructures/LowercaseDeclarationStandar0000644000076700000240000000104212647543456033513 0ustar gsherwoodstaff if ($foo) { $bar = true; } ]]> IF ($foo) { $bar = true; } ]]> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/Functions/FunctionDuplicateArgumentStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/Functions/FunctionDuplicateArgumentStandard.x0000644000076700000240000000100512647543456033401 0ustar gsherwoodstaff isset($foo)) { echo $foo; } ]]> isSet($foo)) { echo $foo; } ]]> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/Functions/LowercaseFunctionKeywordsStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/Functions/LowercaseFunctionKeywordsStandard.x0000644000076700000240000000103612647543456033444 0ustar gsherwoodstaff function foo() { return true; } ]]> FUNCTION foo() { return true; } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/Scope/StaticThisUsageStandard.xml0000644000076700000240000000116412647543456030762 0ustar gsherwoodstaff static function bar() { return self::$staticMember; } } ]]> static function bar() { return $this->$staticMember; } } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/Strings/EchoedStringsStandard.xml0000644000076700000240000000074512647543456031043 0ustar gsherwoodstaff "Hello"; ]]> ("Hello"); ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/WhiteSpace/CastSpacingStandard.xml0000644000076700000240000000073312647543456031101 0ustar gsherwoodstaff int)'42'; ]]> int )'42'; ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/WhiteSpace/FunctionOpeningBraceStandard.xml0000644000076700000240000000161212647543456032741 0ustar gsherwoodstaff { } ]]> { } ]]> return 42; } ]]> return 42; } ]]> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/WhiteSpace/LanguageConstructSpacingStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/WhiteSpace/LanguageConstructSpacingStandard.x0000644000076700000240000000106212647543456033302 0ustar gsherwoodstaff "hi"; ]]> "hi"; ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/WhiteSpace/ObjectOperatorSpacingStandard.xml0000644000076700000240000000100112647543456033116 0ustar gsherwoodstaff ) should not have any space around it. ]]> ->bar(); ]]> -> bar(); ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/WhiteSpace/ScopeKeywordSpacingStandard.xml0000644000076700000240000000110012647543456032612 0ustar gsherwoodstaff static function foo() { } ]]> static function foo() { } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Docs/WhiteSpace/SemicolonSpacingStandard.xml0000644000076700000240000000067612647543456032145 0ustar gsherwoodstaff ; ]]> ; ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Arrays/ArrayBracketSpacingSniff.php0000644000076700000240000001060112647543456031615 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Arrays_ArrayBracketSpacingSniff. * * Ensure that there are no spaces around square brackets. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Arrays_ArrayBracketSpacingSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_OPEN_SQUARE_BRACKET, T_CLOSE_SQUARE_BRACKET, ); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The current file being checked. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // PHP 5.4 introduced a shorthand array declaration syntax, so we need // to ignore the these type of array declarations because this sniff is // only dealing with array usage. if ($tokens[$stackPtr]['code'] === T_OPEN_SQUARE_BRACKET) { $openBracket = $stackPtr; } else { $openBracket = $tokens[$stackPtr]['bracket_opener']; } $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($openBracket - 1), null, true); if ($tokens[$prev]['code'] === T_EQUAL) { return; } // Square brackets can not have a space before them. $prevType = $tokens[($stackPtr - 1)]['code']; if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$prevType]) === true) { $nonSpace = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 2), null, true); $expected = $tokens[$nonSpace]['content'].$tokens[$stackPtr]['content']; $found = $phpcsFile->getTokensAsString($nonSpace, ($stackPtr - $nonSpace)).$tokens[$stackPtr]['content']; $error = 'Space found before square bracket; expected "%s" but found "%s"'; $data = array( $expected, $found, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeBracket', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr - 1), ''); } } // Open square brackets can't ever have spaces after them. if ($tokens[$stackPtr]['code'] === T_OPEN_SQUARE_BRACKET) { $nextType = $tokens[($stackPtr + 1)]['code']; if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$nextType]) === true) { $nonSpace = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 2), null, true); $expected = $tokens[$stackPtr]['content'].$tokens[$nonSpace]['content']; $found = $phpcsFile->getTokensAsString($stackPtr, ($nonSpace - $stackPtr + 1)); $error = 'Space found after square bracket; expected "%s" but found "%s"'; $data = array( $expected, $found, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterBracket', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ''); } } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Arrays/ArrayDeclarationSniff.php0000644000076700000240000011261512647543456031172 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * A test to ensure that arrays conform to the array coding standard. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Arrays_ArrayDeclarationSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_ARRAY, T_OPEN_SHORT_ARRAY, ); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The current file being checked. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[$stackPtr]['code'] === T_ARRAY) { $phpcsFile->recordMetric($stackPtr, 'Short array syntax used', 'no'); // Array keyword should be lower case. if ($tokens[$stackPtr]['content'] !== strtolower($tokens[$stackPtr]['content'])) { if ($tokens[$stackPtr]['content'] === strtoupper($tokens[$stackPtr]['content'])) { $phpcsFile->recordMetric($stackPtr, 'Array keyword case', 'upper'); } else { $phpcsFile->recordMetric($stackPtr, 'Array keyword case', 'mixed'); } $error = 'Array keyword should be lower case; expected "array" but found "%s"'; $data = array($tokens[$stackPtr]['content']); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NotLowerCase', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, 'array'); } } else { $phpcsFile->recordMetric($stackPtr, 'Array keyword case', 'lower'); } $arrayStart = $tokens[$stackPtr]['parenthesis_opener']; if (isset($tokens[$arrayStart]['parenthesis_closer']) === false) { return; } $arrayEnd = $tokens[$arrayStart]['parenthesis_closer']; if ($arrayStart !== ($stackPtr + 1)) { $error = 'There must be no space between the "array" keyword and the opening parenthesis'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterKeyword'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($stackPtr + 1); $i < $arrayStart; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } } } else { $phpcsFile->recordMetric($stackPtr, 'Short array syntax used', 'yes'); $arrayStart = $stackPtr; $arrayEnd = $tokens[$stackPtr]['bracket_closer']; }//end if // Check for empty arrays. $content = $phpcsFile->findNext(T_WHITESPACE, ($arrayStart + 1), ($arrayEnd + 1), true); if ($content === $arrayEnd) { // Empty array, but if the brackets aren't together, there's a problem. if (($arrayEnd - $arrayStart) !== 1) { $error = 'Empty array declaration must have no space between the parentheses'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceInEmptyArray'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($arrayStart + 1); $i < $arrayEnd; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } // We can return here because there is nothing else to check. All code // below can assume that the array is not empty. return; } } if ($tokens[$arrayStart]['line'] === $tokens[$arrayEnd]['line']) { $this->processSingleLineArray($phpcsFile, $stackPtr, $arrayStart, $arrayEnd); } else { $this->processMultiLineArray($phpcsFile, $stackPtr, $arrayStart, $arrayEnd); } }//end process() /** * Processes a single-line array definition. * * @param PHP_CodeSniffer_File $phpcsFile The current file being checked. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param int $arrayStart The token that starts the array definition. * @param int $arrayEnd The token that ends the array definition. * * @return void */ public function processSingleLineArray(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $arrayStart, $arrayEnd) { $tokens = $phpcsFile->getTokens(); // Check if there are multiple values. If so, then it has to be multiple lines // unless it is contained inside a function call or condition. $valueCount = 0; $commas = array(); for ($i = ($arrayStart + 1); $i < $arrayEnd; $i++) { // Skip bracketed statements, like function calls. if ($tokens[$i]['code'] === T_OPEN_PARENTHESIS) { $i = $tokens[$i]['parenthesis_closer']; continue; } if ($tokens[$i]['code'] === T_COMMA) { // Before counting this comma, make sure we are not // at the end of the array. $next = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), $arrayEnd, true); if ($next !== false) { $valueCount++; $commas[] = $i; } else { // There is a comma at the end of a single line array. $error = 'Comma not allowed after last value in single-line array declaration'; $fix = $phpcsFile->addFixableError($error, $i, 'CommaAfterLast'); if ($fix === true) { $phpcsFile->fixer->replaceToken($i, ''); } } } }//end for // Now check each of the double arrows (if any). $nextArrow = $arrayStart; while (($nextArrow = $phpcsFile->findNext(T_DOUBLE_ARROW, ($nextArrow + 1), $arrayEnd)) !== false) { if ($tokens[($nextArrow - 1)]['code'] !== T_WHITESPACE) { $content = $tokens[($nextArrow - 1)]['content']; $error = 'Expected 1 space between "%s" and double arrow; 0 found'; $data = array($content); $fix = $phpcsFile->addFixableError($error, $nextArrow, 'NoSpaceBeforeDoubleArrow', $data); if ($fix === true) { $phpcsFile->fixer->addContentBefore($nextArrow, ' '); } } else { $spaceLength = $tokens[($nextArrow - 1)]['length']; if ($spaceLength !== 1) { $content = $tokens[($nextArrow - 2)]['content']; $error = 'Expected 1 space between "%s" and double arrow; %s found'; $data = array( $content, $spaceLength, ); $fix = $phpcsFile->addFixableError($error, $nextArrow, 'SpaceBeforeDoubleArrow', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($nextArrow - 1), ' '); } } }//end if if ($tokens[($nextArrow + 1)]['code'] !== T_WHITESPACE) { $content = $tokens[($nextArrow + 1)]['content']; $error = 'Expected 1 space between double arrow and "%s"; 0 found'; $data = array($content); $fix = $phpcsFile->addFixableError($error, $nextArrow, 'NoSpaceAfterDoubleArrow', $data); if ($fix === true) { $phpcsFile->fixer->addContent($nextArrow, ' '); } } else { $spaceLength = $tokens[($nextArrow + 1)]['length']; if ($spaceLength !== 1) { $content = $tokens[($nextArrow + 2)]['content']; $error = 'Expected 1 space between double arrow and "%s"; %s found'; $data = array( $content, $spaceLength, ); $fix = $phpcsFile->addFixableError($error, $nextArrow, 'SpaceAfterDoubleArrow', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($nextArrow + 1), ' '); } } }//end if }//end while if ($valueCount > 0) { $conditionCheck = $phpcsFile->findPrevious(array(T_OPEN_PARENTHESIS, T_SEMICOLON), ($stackPtr - 1), null, false); if ($conditionCheck === false || $tokens[$conditionCheck]['line'] !== $tokens[$stackPtr]['line'] ) { $error = 'Array with multiple values cannot be declared on a single line'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SingleLineNotAllowed'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->addNewline($arrayStart); $phpcsFile->fixer->addNewlineBefore($arrayEnd); $phpcsFile->fixer->endChangeset(); } return; } // We have a multiple value array that is inside a condition or // function. Check its spacing is correct. foreach ($commas as $comma) { if ($tokens[($comma + 1)]['code'] !== T_WHITESPACE) { $content = $tokens[($comma + 1)]['content']; $error = 'Expected 1 space between comma and "%s"; 0 found'; $data = array($content); $fix = $phpcsFile->addFixableError($error, $comma, 'NoSpaceAfterComma', $data); if ($fix === true) { $phpcsFile->fixer->addContent($comma, ' '); } } else { $spaceLength = $tokens[($comma + 1)]['length']; if ($spaceLength !== 1) { $content = $tokens[($comma + 2)]['content']; $error = 'Expected 1 space between comma and "%s"; %s found'; $data = array( $content, $spaceLength, ); $fix = $phpcsFile->addFixableError($error, $comma, 'SpaceAfterComma', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($comma + 1), ' '); } } }//end if if ($tokens[($comma - 1)]['code'] === T_WHITESPACE) { $content = $tokens[($comma - 2)]['content']; $spaceLength = $tokens[($comma - 1)]['length']; $error = 'Expected 0 spaces between "%s" and comma; %s found'; $data = array( $content, $spaceLength, ); $fix = $phpcsFile->addFixableError($error, $comma, 'SpaceBeforeComma', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($comma - 1), ''); } } }//end foreach }//end if }//end processSingleLineArray() /** * Processes a multi-line array definition. * * @param PHP_CodeSniffer_File $phpcsFile The current file being checked. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param int $arrayStart The token that starts the array definition. * @param int $arrayEnd The token that ends the array definition. * * @return void */ public function processMultiLineArray(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $arrayStart, $arrayEnd) { $tokens = $phpcsFile->getTokens(); $keywordStart = $tokens[$stackPtr]['column']; // Check the closing bracket is on a new line. $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($arrayEnd - 1), $arrayStart, true); if ($tokens[$lastContent]['line'] === $tokens[$arrayEnd]['line']) { $error = 'Closing parenthesis of array declaration must be on a new line'; $fix = $phpcsFile->addFixableError($error, $arrayEnd, 'CloseBraceNewLine'); if ($fix === true) { $phpcsFile->fixer->addNewlineBefore($arrayEnd); } } else if ($tokens[$arrayEnd]['column'] !== $keywordStart) { // Check the closing bracket is lined up under the "a" in array. $expected = ($keywordStart - 1); $found = ($tokens[$arrayEnd]['column'] - 1); $error = 'Closing parenthesis not aligned correctly; expected %s space(s) but found %s'; $data = array( $expected, $found, ); $fix = $phpcsFile->addFixableError($error, $arrayEnd, 'CloseBraceNotAligned', $data); if ($fix === true) { if ($found === 0) { $phpcsFile->fixer->addContent(($arrayEnd - 1), str_repeat(' ', $expected)); } else { $phpcsFile->fixer->replaceToken(($arrayEnd - 1), str_repeat(' ', $expected)); } } }//end if $nextToken = $stackPtr; $keyUsed = false; $singleUsed = false; $indices = array(); $maxLength = 0; if ($tokens[$stackPtr]['code'] === T_ARRAY) { $lastToken = $tokens[$stackPtr]['parenthesis_opener']; } else { $lastToken = $stackPtr; } // Find all the double arrows that reside in this scope. for ($nextToken = ($stackPtr + 1); $nextToken < $arrayEnd; $nextToken++) { // Skip bracketed statements, like function calls. if ($tokens[$nextToken]['code'] === T_OPEN_PARENTHESIS && (isset($tokens[$nextToken]['parenthesis_owner']) === false || $tokens[$nextToken]['parenthesis_owner'] !== $stackPtr) ) { $nextToken = $tokens[$nextToken]['parenthesis_closer']; continue; } if ($tokens[$nextToken]['code'] === T_ARRAY) { // Let subsequent calls of this test handle nested arrays. if ($tokens[$lastToken]['code'] !== T_DOUBLE_ARROW) { $indices[] = array('value' => $nextToken); $lastToken = $nextToken; } $nextToken = $tokens[$tokens[$nextToken]['parenthesis_opener']]['parenthesis_closer']; $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($nextToken + 1), null, true); if ($tokens[$nextToken]['code'] !== T_COMMA) { $nextToken--; } else { $lastToken = $nextToken; } continue; } if ($tokens[$nextToken]['code'] === T_OPEN_SHORT_ARRAY) { // Let subsequent calls of this test handle nested arrays. if ($tokens[$lastToken]['code'] !== T_DOUBLE_ARROW) { $indices[] = array('value' => $nextToken); $lastToken = $nextToken; } $nextToken = $tokens[$nextToken]['bracket_closer']; $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($nextToken + 1), null, true); if ($tokens[$nextToken]['code'] !== T_COMMA) { $nextToken--; } else { $lastToken = $nextToken; } continue; } if ($tokens[$nextToken]['code'] === T_CLOSURE) { if ($tokens[$lastToken]['code'] !== T_DOUBLE_ARROW) { $indices[] = array('value' => $nextToken); $lastToken = $nextToken; } $nextToken = $tokens[$nextToken]['scope_closer']; $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($nextToken + 1), null, true); if ($tokens[$nextToken]['code'] !== T_COMMA) { $nextToken--; } else { $lastToken = $nextToken; } continue; } if ($tokens[$nextToken]['code'] !== T_DOUBLE_ARROW && $tokens[$nextToken]['code'] !== T_COMMA ) { continue; } $currentEntry = array(); if ($tokens[$nextToken]['code'] === T_COMMA) { $stackPtrCount = 0; if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) { $stackPtrCount = count($tokens[$stackPtr]['nested_parenthesis']); } $commaCount = 0; if (isset($tokens[$nextToken]['nested_parenthesis']) === true) { $commaCount = count($tokens[$nextToken]['nested_parenthesis']); if ($tokens[$stackPtr]['code'] === T_ARRAY) { // Remove parenthesis that are used to define the array. $commaCount--; } } if ($commaCount > $stackPtrCount) { // This comma is inside more parenthesis than the ARRAY keyword, // then there it is actually a comma used to separate arguments // in a function call. continue; } if ($keyUsed === true && $tokens[$lastToken]['code'] === T_COMMA) { $error = 'No key specified for array entry; first entry specifies key'; $phpcsFile->addError($error, $nextToken, 'NoKeySpecified'); return; } if ($keyUsed === false) { if ($tokens[($nextToken - 1)]['code'] === T_WHITESPACE) { $content = $tokens[($nextToken - 2)]['content']; if ($tokens[($nextToken - 1)]['content'] === $phpcsFile->eolChar) { $spaceLength = 'newline'; } else { $spaceLength = $tokens[($nextToken - 1)]['length']; } $error = 'Expected 0 spaces between "%s" and comma; %s found'; $data = array( $content, $spaceLength, ); $fix = $phpcsFile->addFixableError($error, $nextToken, 'SpaceBeforeComma', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($nextToken - 1), ''); } } $valueContent = $phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, ($lastToken + 1), $nextToken, true ); $indices[] = array('value' => $valueContent); $singleUsed = true; }//end if $lastToken = $nextToken; continue; }//end if if ($tokens[$nextToken]['code'] === T_DOUBLE_ARROW) { if ($singleUsed === true) { $error = 'Key specified for array entry; first entry has no key'; $phpcsFile->addError($error, $nextToken, 'KeySpecified'); return; } $currentEntry['arrow'] = $nextToken; $keyUsed = true; // Find the start of index that uses this double arrow. $indexEnd = $phpcsFile->findPrevious(T_WHITESPACE, ($nextToken - 1), $arrayStart, true); $indexStart = $phpcsFile->findStartOfStatement($indexEnd); if ($indexStart === $indexEnd) { $currentEntry['index'] = $indexEnd; $currentEntry['index_content'] = $tokens[$indexEnd]['content']; } else { $currentEntry['index'] = $indexStart; $currentEntry['index_content'] = $phpcsFile->getTokensAsString($indexStart, ($indexEnd - $indexStart + 1)); } $indexLength = strlen($currentEntry['index_content']); if ($maxLength < $indexLength) { $maxLength = $indexLength; } // Find the value of this index. $nextContent = $phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, ($nextToken + 1), $arrayEnd, true ); $currentEntry['value'] = $nextContent; $indices[] = $currentEntry; $lastToken = $nextToken; }//end if }//end for // Check for mutli-line arrays that should be single-line. $singleValue = false; if (empty($indices) === true) { $singleValue = true; } else if (count($indices) === 1 && $tokens[$lastToken]['code'] === T_COMMA) { // There may be another array value without a comma. $exclude = PHP_CodeSniffer_Tokens::$emptyTokens; $exclude[] = T_COMMA; $nextContent = $phpcsFile->findNext($exclude, ($indices[0]['value'] + 1), $arrayEnd, true); if ($nextContent === false) { $singleValue = true; } } if ($singleValue === true) { // Array cannot be empty, so this is a multi-line array with // a single value. It should be defined on single line. $error = 'Multi-line array contains a single value; use single-line array instead'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'MultiLineNotAllowed'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($arrayStart + 1); $i < $arrayEnd; $i++) { if ($tokens[$i]['code'] !== T_WHITESPACE) { break; } $phpcsFile->fixer->replaceToken($i, ''); } for ($i = ($arrayEnd - 1); $i > $arrayStart; $i--) { if ($tokens[$i]['code'] !== T_WHITESPACE) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } return; }//end if /* This section checks for arrays that don't specify keys. Arrays such as: array( 'aaa', 'bbb', 'd', ); */ if ($keyUsed === false && empty($indices) === false) { $count = count($indices); $lastIndex = $indices[($count - 1)]['value']; $trailingContent = $phpcsFile->findPrevious( PHP_CodeSniffer_Tokens::$emptyTokens, ($arrayEnd - 1), $lastIndex, true ); if ($tokens[$trailingContent]['code'] !== T_COMMA) { $phpcsFile->recordMetric($stackPtr, 'Array end comma', 'no'); $error = 'Comma required after last value in array declaration'; $fix = $phpcsFile->addFixableError($error, $trailingContent, 'NoCommaAfterLast'); if ($fix === true) { $phpcsFile->fixer->addContent($trailingContent, ','); } } else { $phpcsFile->recordMetric($stackPtr, 'Array end comma', 'yes'); } $lastValueLine = false; foreach ($indices as $value) { if (empty($value['value']) === true) { // Array was malformed and we couldn't figure out // the array value correctly, so we have to ignore it. // Other parts of this sniff will correct the error. continue; } if ($lastValueLine !== false && $tokens[$value['value']]['line'] === $lastValueLine) { $error = 'Each value in a multi-line array must be on a new line'; $fix = $phpcsFile->addFixableError($error, $value['value'], 'ValueNoNewline'); if ($fix === true) { if ($tokens[($value['value'] - 1)]['code'] === T_WHITESPACE) { $phpcsFile->fixer->replaceToken(($value['value'] - 1), ''); } $phpcsFile->fixer->addNewlineBefore($value['value']); } } else if ($tokens[($value['value'] - 1)]['code'] === T_WHITESPACE) { $expected = $keywordStart; $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $value['value'], true); $found = ($tokens[$first]['column'] - 1); if ($found !== $expected) { $error = 'Array value not aligned correctly; expected %s spaces but found %s'; $data = array( $expected, $found, ); $fix = $phpcsFile->addFixableError($error, $value['value'], 'ValueNotAligned', $data); if ($fix === true) { if ($found === 0) { $phpcsFile->fixer->addContent(($value['value'] - 1), str_repeat(' ', $expected)); } else { $phpcsFile->fixer->replaceToken(($value['value'] - 1), str_repeat(' ', $expected)); } } } }//end if $lastValueLine = $tokens[$value['value']]['line']; }//end foreach }//end if /* Below the actual indentation of the array is checked. Errors will be thrown when a key is not aligned, when a double arrow is not aligned, and when a value is not aligned correctly. If an error is found in one of the above areas, then errors are not reported for the rest of the line to avoid reporting spaces and columns incorrectly. Often fixing the first problem will fix the other 2 anyway. For example: $a = array( 'index' => '2', ); or $a = [ 'index' => '2', ]; In this array, the double arrow is indented too far, but this will also cause an error in the value's alignment. If the arrow were to be moved back one space however, then both errors would be fixed. */ $numValues = count($indices); $indicesStart = ($keywordStart + 1); $arrowStart = ($indicesStart + $maxLength + 1); $valueStart = ($arrowStart + 3); $indexLine = $tokens[$stackPtr]['line']; $lastIndexLine = null; foreach ($indices as $index) { if (isset($index['index']) === false) { // Array value only. if ($tokens[$index['value']]['line'] === $tokens[$stackPtr]['line'] && $numValues > 1) { $error = 'The first value in a multi-value array must be on a new line'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'FirstValueNoNewline'); if ($fix === true) { $phpcsFile->fixer->addNewlineBefore($index['value']); } } continue; } $lastIndexLine = $indexLine; $indexLine = $tokens[$index['index']]['line']; if ($indexLine === $tokens[$stackPtr]['line']) { $error = 'The first index in a multi-value array must be on a new line'; $fix = $phpcsFile->addFixableError($error, $index['index'], 'FirstIndexNoNewline'); if ($fix === true) { $phpcsFile->fixer->addNewlineBefore($index['index']); } continue; } if ($indexLine === $lastIndexLine) { $error = 'Each index in a multi-line array must be on a new line'; $fix = $phpcsFile->addFixableError($error, $index['index'], 'IndexNoNewline'); if ($fix === true) { if ($tokens[($index['index'] - 1)]['code'] === T_WHITESPACE) { $phpcsFile->fixer->replaceToken(($index['index'] - 1), ''); } $phpcsFile->fixer->addNewlineBefore($index['index']); } continue; } if ($tokens[$index['index']]['column'] !== $indicesStart) { $expected = ($indicesStart - 1); $found = ($tokens[$index['index']]['column'] - 1); $error = 'Array key not aligned correctly; expected %s spaces but found %s'; $data = array( $expected, $found, ); $fix = $phpcsFile->addFixableError($error, $index['index'], 'KeyNotAligned', $data); if ($fix === true) { if ($found === 0) { $phpcsFile->fixer->addContent(($index['index'] - 1), str_repeat(' ', $expected)); } else { $phpcsFile->fixer->replaceToken(($index['index'] - 1), str_repeat(' ', $expected)); } } continue; } if ($tokens[$index['arrow']]['column'] !== $arrowStart) { $expected = ($arrowStart - (strlen($index['index_content']) + $tokens[$index['index']]['column'])); $found = ($tokens[$index['arrow']]['column'] - (strlen($index['index_content']) + $tokens[$index['index']]['column'])); $error = 'Array double arrow not aligned correctly; expected %s space(s) but found %s'; $data = array( $expected, $found, ); $fix = $phpcsFile->addFixableError($error, $index['arrow'], 'DoubleArrowNotAligned', $data); if ($fix === true) { if ($found === 0) { $phpcsFile->fixer->addContent(($index['arrow'] - 1), str_repeat(' ', $expected)); } else { $phpcsFile->fixer->replaceToken(($index['arrow'] - 1), str_repeat(' ', $expected)); } } continue; } if ($tokens[$index['value']]['column'] !== $valueStart) { $expected = ($valueStart - ($tokens[$index['arrow']]['length'] + $tokens[$index['arrow']]['column'])); $found = ($tokens[$index['value']]['column'] - ($tokens[$index['arrow']]['length'] + $tokens[$index['arrow']]['column'])); if ($found < 0) { $found = 'newline'; } $error = 'Array value not aligned correctly; expected %s space(s) but found %s'; $data = array( $expected, $found, ); $fix = $phpcsFile->addFixableError($error, $index['arrow'], 'ValueNotAligned', $data); if ($fix === true) { if ($found === 'newline') { $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($index['value'] - 1), null, true); $phpcsFile->fixer->beginChangeset(); for ($i = ($prev + 1); $i < $index['value']; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->replaceToken(($index['value'] - 1), str_repeat(' ', $expected)); $phpcsFile->fixer->endChangeset(); } else if ($found === 0) { $phpcsFile->fixer->addContent(($index['value'] - 1), str_repeat(' ', $expected)); } else { $phpcsFile->fixer->replaceToken(($index['value'] - 1), str_repeat(' ', $expected)); } } }//end if // Check each line ends in a comma. $valueLine = $tokens[$index['value']]['line']; $nextComma = false; for ($i = $index['value']; $i < $arrayEnd; $i++) { // Skip bracketed statements, like function calls. if ($tokens[$i]['code'] === T_OPEN_PARENTHESIS) { $i = $tokens[$i]['parenthesis_closer']; $valueLine = $tokens[$i]['line']; continue; } if ($tokens[$i]['code'] === T_ARRAY) { $i = $tokens[$tokens[$i]['parenthesis_opener']]['parenthesis_closer']; $valueLine = $tokens[$i]['line']; continue; } // Skip to the end of multi-line strings. if (isset(PHP_CodeSniffer_Tokens::$stringTokens[$tokens[$i]['code']]) === true) { $i = $phpcsFile->findNext($tokens[$i]['code'], ($i + 1), null, true); $i--; $valueLine = $tokens[$i]['line']; continue; } if ($tokens[$i]['code'] === T_OPEN_SHORT_ARRAY) { $i = $tokens[$i]['bracket_closer']; $valueLine = $tokens[$i]['line']; continue; } if ($tokens[$i]['code'] === T_CLOSURE) { $i = $tokens[$i]['scope_closer']; $valueLine = $tokens[$i]['line']; continue; } if ($tokens[$i]['code'] === T_COMMA) { $nextComma = $i; break; } }//end for if ($nextComma === false || ($tokens[$nextComma]['line'] !== $valueLine)) { $error = 'Each line in an array declaration must end in a comma'; $fix = $phpcsFile->addFixableError($error, $index['value'], 'NoComma'); if ($fix === true) { // Find the end of the line and put a comma there. for ($i = ($index['value'] + 1); $i < $phpcsFile->numTokens; $i++) { if ($tokens[$i]['line'] > $valueLine) { break; } } $phpcsFile->fixer->addContentBefore(($i - 1), ','); } } // Check that there is no space before the comma. if ($nextComma !== false && $tokens[($nextComma - 1)]['code'] === T_WHITESPACE) { $content = $tokens[($nextComma - 2)]['content']; $spaceLength = $tokens[($nextComma - 1)]['length']; $error = 'Expected 0 spaces between "%s" and comma; %s found'; $data = array( $content, $spaceLength, ); $fix = $phpcsFile->addFixableError($error, $nextComma, 'SpaceBeforeComma', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($nextComma - 1), ''); } } }//end foreach }//end processMultiLineArray() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Classes/ClassDeclarationSniff.php0000644000076700000240000002111212647543456031304 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PSR2_Sniffs_Classes_ClassDeclarationSniff', true) === false) { $error = 'Class PSR2_Sniffs_Classes_ClassDeclarationSniff not found'; throw new PHP_CodeSniffer_Exception($error); } /** * Class Declaration Test. * * Checks the declaration of the class and its inheritance is correct. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Classes_ClassDeclarationSniff extends PSR2_Sniffs_Classes_ClassDeclarationSniff { /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { // We want all the errors from the PSR2 standard, plus some of our own. parent::process($phpcsFile, $stackPtr); $tokens = $phpcsFile->getTokens(); // Check that this is the only class or interface in the file. $nextClass = $phpcsFile->findNext(array(T_CLASS, T_INTERFACE), ($stackPtr + 1)); if ($nextClass !== false) { // We have another, so an error is thrown. $error = 'Only one interface or class is allowed in a file'; $phpcsFile->addError($error, $nextClass, 'MultipleClasses'); } }//end process() /** * Processes the opening section of a class declaration. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function processOpen(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { parent::processOpen($phpcsFile, $stackPtr); $tokens = $phpcsFile->getTokens(); if ($tokens[($stackPtr - 1)]['code'] === T_WHITESPACE) { $prevContent = $tokens[($stackPtr - 1)]['content']; if ($prevContent !== $phpcsFile->eolChar) { $blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar)); $spaces = strlen($blankSpace); if ($tokens[($stackPtr - 2)]['code'] !== T_ABSTRACT && $tokens[($stackPtr - 2)]['code'] !== T_FINAL ) { if ($spaces !== 0) { $type = strtolower($tokens[$stackPtr]['content']); $error = 'Expected 0 spaces before %s keyword; %s found'; $data = array( $type, $spaces, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeKeyword', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr - 1), ''); } } } }//end if }//end if }//end processOpen() /** * Processes the closing section of a class declaration. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function processClose(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['scope_closer']) === false) { return; } $closeBrace = $tokens[$stackPtr]['scope_closer']; // Check that the closing brace has one blank line after it. for ($nextContent = ($closeBrace + 1); $nextContent < $phpcsFile->numTokens; $nextContent++) { // Ignore comments on the same lines as the brace. if ($tokens[$nextContent]['line'] === $tokens[$closeBrace]['line'] && ($tokens[$nextContent]['code'] === T_WHITESPACE || $tokens[$nextContent]['code'] === T_COMMENT) ) { continue; } if ($tokens[$nextContent]['code'] !== T_WHITESPACE) { break; } } if ($nextContent === $phpcsFile->numTokens) { // Ignore the line check as this is the very end of the file. $difference = 1; } else { $difference = ($tokens[$nextContent]['line'] - $tokens[$closeBrace]['line'] - 1); } $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($closeBrace - 1), $stackPtr, true); if ($difference === -1 || $tokens[$lastContent]['line'] === $tokens[$closeBrace]['line'] ) { $error = 'Closing %s brace must be on a line by itself'; $data = array($tokens[$stackPtr]['content']); $fix = $phpcsFile->addFixableError($error, $closeBrace, 'CloseBraceSameLine', $data); if ($fix === true) { if ($difference === -1) { $phpcsFile->fixer->addNewlineBefore($nextContent); } if ($tokens[$lastContent]['line'] === $tokens[$closeBrace]['line']) { $phpcsFile->fixer->addNewlineBefore($closeBrace); } } } else if ($tokens[($closeBrace - 1)]['code'] === T_WHITESPACE) { $prevContent = $tokens[($closeBrace - 1)]['content']; if ($prevContent !== $phpcsFile->eolChar) { $blankSpace = substr($prevContent, strpos($prevContent, $phpcsFile->eolChar)); $spaces = strlen($blankSpace); if ($spaces !== 0) { if ($tokens[($closeBrace - 1)]['line'] !== $tokens[$closeBrace]['line']) { $error = 'Expected 0 spaces before closing brace; newline found'; $phpcsFile->addError($error, $closeBrace, 'NewLineBeforeCloseBrace'); } else { $error = 'Expected 0 spaces before closing brace; %s found'; $data = array($spaces); $fix = $phpcsFile->addFixableError($error, $closeBrace, 'SpaceBeforeCloseBrace', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($closeBrace - 1), ''); } } } } }//end if if ($difference !== -1 && $difference !== 1) { $error = 'Closing brace of a %s must be followed by a single blank line; found %s'; $data = array( $tokens[$stackPtr]['content'], $difference, ); $fix = $phpcsFile->addFixableError($error, $closeBrace, 'NewlinesAfterCloseBrace', $data); if ($fix === true) { if ($difference === 0) { $first = $phpcsFile->findFirstOnLine(array(), $nextContent, true); $phpcsFile->fixer->addNewlineBefore($first); } else { $phpcsFile->fixer->beginChangeset(); for ($i = ($closeBrace + 1); $i < $nextContent; $i++) { if ($tokens[$i]['line'] <= ($tokens[$closeBrace]['line'] + 1)) { continue; } else if ($tokens[$i]['line'] === $tokens[$nextContent]['line']) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } } }//end if }//end processClose() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Classes/ClassFileNameSniff.php0000644000076700000240000000501212647543456030540 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Classes_ClassFileNameSniff. * * Tests that the file name and the name of the class contained within the file * match. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Classes_ClassFileNameSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_CLASS, T_INTERFACE, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $fullPath = basename($phpcsFile->getFilename()); $fileName = substr($fullPath, 0, strrpos($fullPath, '.')); if ($fileName === '') { // No filename probably means STDIN, so we can't do this check. return; } $tokens = $phpcsFile->getTokens(); $decName = $phpcsFile->findNext(T_STRING, $stackPtr); if ($tokens[$decName]['content'] !== $fileName) { $error = '%s name doesn\'t match filename; expected "%s %s"'; $data = array( ucfirst($tokens[$stackPtr]['content']), $tokens[$stackPtr]['content'], $fileName, ); $phpcsFile->addError($error, $stackPtr, 'NoMatch', $data); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Classes/DuplicatePropertySniff.php0000644000076700000240000000572212647543456031561 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Classes_DuplicatePropertySniff. * * Ensures JS classes don't contain duplicate property names. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Classes_DuplicatePropertySniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('JS'); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OBJECT); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The current file being processed. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $properties = array(); $wantedTokens = array( T_PROPERTY, T_OBJECT, ); $next = $phpcsFile->findNext($wantedTokens, ($stackPtr + 1), $tokens[$stackPtr]['bracket_closer']); while ($next !== false && $next < $tokens[$stackPtr]['bracket_closer']) { if ($tokens[$next]['code'] === T_OBJECT) { // Skip nested objects. $next = $tokens[$next]['bracket_closer']; } else { $propName = $tokens[$next]['content']; if (isset($properties[$propName]) === true) { $error = 'Duplicate property definition found for "%s"; previously defined on line %s'; $data = array( $propName, $tokens[$properties[$propName]]['line'], ); $phpcsFile->addError($error, $next, 'Found', $data); } $properties[$propName] = $next; }//end if $next = $phpcsFile->findNext($wantedTokens, ($next + 1), $tokens[$stackPtr]['bracket_closer']); }//end while }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Classes/LowercaseClassKeywordsSniff.php0000644000076700000240000000502612647543456032541 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Classes_LowercaseClassKeywordsSniff. * * Ensures all class keywords are lowercase. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Classes_LowercaseClassKeywordsSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_CLASS, T_INTERFACE, T_TRAIT, T_EXTENDS, T_IMPLEMENTS, T_ABSTRACT, T_FINAL, T_VAR, T_CONST, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $content = $tokens[$stackPtr]['content']; if ($content !== strtolower($content)) { $error = '%s keyword must be lowercase; expected "%s" but found "%s"'; $data = array( strtoupper($content), strtolower($content), $content, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'FoundUppercase', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, strtolower($content)); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Classes/SelfMemberReferenceSniff.php0000644000076700000240000001630312647543456031737 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) { $error = 'Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found'; throw new PHP_CodeSniffer_Exception($error); } /** * Tests self member references. * * Verifies that : *
      *
    • self:: is used instead of Self::
    • *
    • self:: is used for local static member reference
    • *
    • self:: is used instead of self ::
    • *
    * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Classes_SelfMemberReferenceSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff { /** * Constructs a Squiz_Sniffs_Classes_SelfMemberReferenceSniff. */ public function __construct() { parent::__construct(array(T_CLASS), array(T_DOUBLE_COLON)); }//end __construct() /** * Processes the function tokens within the class. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the token was found. * @param int $currScope The current scope opener token. * * @return void */ protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope) { $tokens = $phpcsFile->getTokens(); $calledClassName = ($stackPtr - 1); if ($tokens[$calledClassName]['code'] === T_SELF) { if (strtolower($tokens[$calledClassName]['content']) !== $tokens[$calledClassName]['content']) { $error = 'Must use "self::" for local static member reference; found "%s::"'; $data = array($tokens[$calledClassName]['content']); $phpcsFile->addError($error, $calledClassName, 'IncorrectCase', $data); return; } } else if ($tokens[$calledClassName]['code'] === T_STRING) { // If the class is called with a namespace prefix, build fully qualified // namespace calls for both current scope class and requested class. if ($tokens[($calledClassName - 1)]['code'] === T_NS_SEPARATOR) { $declarationName = $this->getDeclarationNameWithNamespace($tokens, $calledClassName); $declarationName = substr($declarationName, 1); $fullQualifiedClassName = $this->getNamespaceOfScope($phpcsFile, $currScope); $fullQualifiedClassName .= '\\'.$phpcsFile->getDeclarationName($currScope); } else { $declarationName = $phpcsFile->getDeclarationName($currScope); $fullQualifiedClassName = $tokens[$calledClassName]['content']; } if ($declarationName === $fullQualifiedClassName) { // Class name is the same as the current class, which is not allowed // except if being used inside a closure. if ($phpcsFile->hasCondition($stackPtr, T_CLOSURE) === false) { $error = 'Must use "self::" for local static member reference'; $fix = $phpcsFile->addFixableError($error, $calledClassName, 'NotUsed'); if ($fix === true) { $prev = $phpcsFile->findPrevious(array(T_NS_SEPARATOR, T_STRING), ($stackPtr - 1), null, true); $phpcsFile->fixer->beginChangeset(); for ($i = ($prev + 1); $i < $stackPtr; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->replaceToken($stackPtr, 'self::'); $phpcsFile->fixer->endChangeset(); } return; } }//end if }//end if if ($tokens[($stackPtr - 1)]['code'] === T_WHITESPACE) { $found = strlen($tokens[($stackPtr - 1)]['content']); $error = 'Expected 0 spaces before double colon; %s found'; $data = array($found); $fix = $phpcsFile->addFixableError($error, $calledClassName, 'SpaceBefore', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr - 1), ''); } } if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) { $found = strlen($tokens[($stackPtr + 1)]['content']); $error = 'Expected 0 spaces after double colon; %s found'; $data = array($found); $fix = $phpcsFile->addFixableError($error, $calledClassName, 'SpaceAfter', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ''); } } }//end processTokenWithinScope() /** * Returns the declaration names for classes/interfaces/functions with a namespace. * * @param array $tokens Token stack for this file * @param int $stackPtr The position where the namespace building will start. * * @return string */ protected function getDeclarationNameWithNamespace(array $tokens, $stackPtr) { $nameParts = array(); $currentPointer = $stackPtr; while ($tokens[$currentPointer]['code'] === T_NS_SEPARATOR || $tokens[$currentPointer]['code'] === T_STRING ) { $nameParts[] = $tokens[$currentPointer]['content']; $currentPointer--; } $nameParts = array_reverse($nameParts); return implode('', $nameParts); }//end getDeclarationNameWithNamespace() /** * Returns the namespace declaration of a file. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the search for the * namespace declaration will start. * * @return string */ protected function getNamespaceOfScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $namespace = '\\'; $namespaceDeclaration = $phpcsFile->findPrevious(T_NAMESPACE, $stackPtr); if ($namespaceDeclaration !== false) { $endOfNamespaceDeclaration = $phpcsFile->findNext(T_SEMICOLON, $namespaceDeclaration); $namespace = $this->getDeclarationNameWithNamespace( $phpcsFile->getTokens(), ($endOfNamespaceDeclaration - 1) ); } return $namespace; }//end getNamespaceOfScope() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Classes/ValidClassNameSniff.php0000644000076700000240000000654112647543456030730 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Classes_ValidClassNameSniff. * * Ensures classes are in camel caps, and the first letter is capitalised * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Classes_ValidClassNameSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_CLASS, T_INTERFACE, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The current file being processed. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['scope_opener']) === false) { $error = 'Possible parse error: %s missing opening or closing brace'; $data = array($tokens[$stackPtr]['content']); $phpcsFile->addWarning($error, $stackPtr, 'MissingBrace', $data); return; } // Determine the name of the class or interface. Note that we cannot // simply look for the first T_STRING because a class name // starting with the number will be multiple tokens. $opener = $tokens[$stackPtr]['scope_opener']; $nameStart = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), $opener, true); $nameEnd = $phpcsFile->findNext(T_WHITESPACE, $nameStart, $opener); if ($nameEnd === false) { $name = $tokens[$nameStart]['content']; } else { $name = trim($phpcsFile->getTokensAsString($nameStart, ($nameEnd - $nameStart))); } // Check for camel caps format. $valid = PHP_CodeSniffer::isCamelCaps($name, true, true, false); if ($valid === false) { $type = ucfirst($tokens[$stackPtr]['content']); $error = '%s name "%s" is not in camel caps format'; $data = array( $type, $name, ); $phpcsFile->addError($error, $stackPtr, 'NotCamelCaps', $data); $phpcsFile->recordMetric($stackPtr, 'CamelCase class name', 'no'); } else { $phpcsFile->recordMetric($stackPtr, 'CamelCase class name', 'yes'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/BlockCommentSniff.php0000644000076700000240000003022612647543456031157 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Commenting_BlockCommentSniff. * * Verifies that block comments are used appropriately. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Commenting_BlockCommentSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_COMMENT, T_DOC_COMMENT_OPEN_TAG, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The current file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // If it's an inline comment, return. if (substr($tokens[$stackPtr]['content'], 0, 2) !== '/*') { return; } // If this is a function/class/interface doc block comment, skip it. // We are only interested in inline doc block comments. if ($tokens[$stackPtr]['code'] === T_DOC_COMMENT_OPEN_TAG) { $nextToken = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true); $ignore = array( T_CLASS => true, T_INTERFACE => true, T_TRAIT => true, T_FUNCTION => true, T_PUBLIC => true, T_PRIVATE => true, T_FINAL => true, T_PROTECTED => true, T_STATIC => true, T_ABSTRACT => true, T_CONST => true, T_VAR => true, ); if (isset($ignore[$tokens[$nextToken]['code']]) === true) { return; } $prevToken = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); if ($tokens[$prevToken]['code'] === T_OPEN_TAG) { return; } $error = 'Block comments must be started with /*'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'WrongStart'); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, '/*'); } $end = $tokens[$stackPtr]['comment_closer']; if ($tokens[$end]['content'] !== '*/') { $error = 'Block comments must be ended with */'; $fix = $phpcsFile->addFixableError($error, $end, 'WrongEnd'); if ($fix === true) { $phpcsFile->fixer->replaceToken($end, '*/'); } } return; }//end if $commentLines = array($stackPtr); $nextComment = $stackPtr; $lastLine = $tokens[$stackPtr]['line']; $commentString = $tokens[$stackPtr]['content']; // Construct the comment into an array. while (($nextComment = $phpcsFile->findNext(T_WHITESPACE, ($nextComment + 1), null, true)) !== false) { if ($tokens[$nextComment]['code'] !== $tokens[$stackPtr]['code']) { // Found the next bit of code. break; } if (($tokens[$nextComment]['line'] - 1) !== $lastLine) { // Not part of the block. break; } $lastLine = $tokens[$nextComment]['line']; $commentLines[] = $nextComment; $commentString .= $tokens[$nextComment]['content']; if ($tokens[$nextComment]['code'] === T_DOC_COMMENT_CLOSE_TAG) { break; } } $commentText = str_replace($phpcsFile->eolChar, '', $commentString); $commentText = trim($commentText, '/* '); if ($commentText === '') { $error = 'Empty block comment not allowed'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Empty'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->replaceToken($stackPtr, ''); $lastToken = array_pop($commentLines); for ($i = ($stackPtr + 1); $i <= $lastToken; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } return; } if (count($commentLines) === 1) { $error = 'Single line block comment not allowed; use inline ("// text") comment instead'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SingleLine'); if ($fix === true) { $comment = '// '.$commentText.$phpcsFile->eolChar; $phpcsFile->fixer->replaceToken($stackPtr, $comment); } return; } $content = trim($tokens[$stackPtr]['content']); if ($content !== '/*' && $content !== '/**') { $error = 'Block comment text must start on a new line'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoNewLine'); if ($fix === true) { $comment = preg_replace( '/^(\s*\/\*\*?)/', '$1'.$phpcsFile->eolChar.' ', $tokens[$stackPtr]['content'], 1 ); $phpcsFile->fixer->replaceToken($stackPtr, $comment); } return; } $starColumn = ($tokens[$stackPtr]['column'] + 3); // Make sure first line isn't blank. if (trim($tokens[$commentLines[1]]['content']) === '') { $error = 'Empty line not allowed at start of comment'; $fix = $phpcsFile->addFixableError($error, $commentLines[1], 'HasEmptyLine'); if ($fix === true) { $phpcsFile->fixer->replaceToken($commentLines[1], ''); } } else { // Check indentation of first line. $content = $tokens[$commentLines[1]]['content']; $commentText = ltrim($content); $leadingSpace = (strlen($content) - strlen($commentText)); if ($leadingSpace !== $starColumn) { $expected = $starColumn.' space'; if ($starColumn !== 1) { $expected .= 's'; } $data = array( $expected, $leadingSpace, ); $error = 'First line of comment not aligned correctly; expected %s but found %s'; $fix = $phpcsFile->addFixableError($error, $commentLines[1], 'FirstLineIndent', $data); if ($fix === true) { $newContent = str_repeat(' ', $starColumn).ltrim($content); $phpcsFile->fixer->replaceToken($commentLines[1], $newContent); } } if (preg_match('/^\p{Ll}/u', $commentText) === 1) { $error = 'Block comments must start with a capital letter'; $phpcsFile->addError($error, $commentLines[1], 'NoCapital'); } }//end if // Check that each line of the comment is indented past the star. foreach ($commentLines as $line) { $leadingSpace = (strlen($tokens[$line]['content']) - strlen(ltrim($tokens[$line]['content']))); // First and last lines (comment opener and closer) are handled separately. if ($line === $commentLines[(count($commentLines) - 1)] || $line === $commentLines[0]) { continue; } // First comment line was handled above. if ($line === $commentLines[1]) { continue; } // If it's empty, continue. if (trim($tokens[$line]['content']) === '') { continue; } if ($leadingSpace < $starColumn) { $expected = $starColumn.' space'; if ($starColumn !== 1) { $expected .= 's'; } $data = array( $expected, $leadingSpace, ); $error = 'Comment line indented incorrectly; expected at least %s but found %s'; $fix = $phpcsFile->addFixableError($error, $line, 'LineIndent', $data); if ($fix === true) { $newContent = str_repeat(' ', $starColumn).ltrim($tokens[$line]['content']); $phpcsFile->fixer->replaceToken($line, $newContent); } } }//end foreach // Finally, test the last line is correct. $lastIndex = (count($commentLines) - 1); $content = trim($tokens[$commentLines[$lastIndex]]['content']); if ($content !== '*/' && $content !== '**/') { $error = 'Comment closer must be on a new line'; $phpcsFile->addError($error, $commentLines[$lastIndex]); } else { $content = $tokens[$commentLines[$lastIndex]]['content']; $commentText = ltrim($content); $leadingSpace = (strlen($content) - strlen($commentText)); if ($leadingSpace !== ($tokens[$stackPtr]['column'] - 1)) { $expected = ($tokens[$stackPtr]['column'] - 1); if ($expected === 1) { $expected .= ' space'; } else { $expected .= ' spaces'; } $data = array( $expected, $leadingSpace, ); $error = 'Last line of comment aligned incorrectly; expected %s but found %s'; $phpcsFile->addError($error, $commentLines[$lastIndex], 'LastLineIndent', $data); } }//end if // Check that the lines before and after this comment are blank. $contentBefore = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if (isset($tokens[$contentBefore]['scope_closer']) === true && $tokens[$contentBefore]['scope_opener'] === $contentBefore ) { if (($tokens[$stackPtr]['line'] - $tokens[$contentBefore]['line']) !== 1) { $error = 'Empty line not required before block comment'; $phpcsFile->addError($error, $stackPtr, 'HasEmptyLineBefore'); } } else { if (($tokens[$stackPtr]['line'] - $tokens[$contentBefore]['line']) < 2) { $error = 'Empty line required before block comment'; $phpcsFile->addError($error, $stackPtr, 'NoEmptyLineBefore'); } } $commentCloser = $commentLines[$lastIndex]; $contentAfter = $phpcsFile->findNext(T_WHITESPACE, ($commentCloser + 1), null, true); if ($contentAfter !== false && ($tokens[$contentAfter]['line'] - $tokens[$commentCloser]['line']) < 2) { $error = 'Empty line required after block comment'; $phpcsFile->addError($error, $commentCloser, 'NoEmptyLineAfter'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/ClassCommentSniff.php0000644000076700000240000001045512647543456031174 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Parses and verifies the class doc comment. * * Verifies that : *
      *
    • A class doc comment exists.
    • *
    • There is exactly one blank line before the class comment.
    • *
    • There are no blank lines after the class comment.
    • *
    • Short and long descriptions end with a full stop and start with capital letter.
    • *
    • There is a blank line between descriptions.
    • *
    * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Commenting_ClassCommentSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_CLASS); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $find = PHP_CodeSniffer_Tokens::$methodPrefixes; $find[] = T_WHITESPACE; $commentEnd = $phpcsFile->findPrevious($find, ($stackPtr - 1), null, true); if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG && $tokens[$commentEnd]['code'] !== T_COMMENT ) { $phpcsFile->addError('Missing class doc comment', $stackPtr, 'Missing'); return; } // Try and determine if this is a file comment instead of a class comment. // We assume that if this is the first comment after the open PHP tag, then // it is most likely a file comment instead of a class comment. if ($tokens[$commentEnd]['code'] === T_DOC_COMMENT_CLOSE_TAG) { $start = ($tokens[$commentEnd]['comment_opener'] - 1); } else { $start = $phpcsFile->findPrevious(T_COMMENT, ($commentEnd - 1), null, true); } $prev = $phpcsFile->findPrevious(T_WHITESPACE, $start, null, true); if ($tokens[$prev]['code'] === T_OPEN_TAG) { $prevOpen = $phpcsFile->findPrevious(T_OPEN_TAG, ($prev - 1)); if ($prevOpen === false) { // This is a comment directly after the first open tag, // so probably a file comment. $phpcsFile->addError('Missing class doc comment', $stackPtr, 'Missing'); return; } } if ($tokens[$commentEnd]['code'] === T_COMMENT) { $phpcsFile->addError('You must use "/**" style comments for a class comment', $stackPtr, 'WrongStyle'); return; } if ($tokens[$commentEnd]['line'] !== ($tokens[$stackPtr]['line'] - 1)) { $error = 'There must be no blank lines after the class comment'; $phpcsFile->addError($error, $commentEnd, 'SpacingAfter'); } $commentStart = $tokens[$commentEnd]['comment_opener']; if ($tokens[$prev]['line'] !== ($tokens[$commentStart]['line'] - 2)) { $error = 'There must be exactly one blank line before the class comment'; $phpcsFile->addError($error, $commentStart, 'SpacingBefore'); } foreach ($tokens[$commentStart]['comment_tags'] as $tag) { $error = '%s tag is not allowed in class comment'; $data = array($tokens[$tag]['content']); $phpcsFile->addWarning($error, $tag, 'TagNotAllowed', $data); } }//end process() }//end class ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/ClosingDeclarationCommentSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/ClosingDeclarationCommentSniff.p0000644000076700000240000001242512647543456033342 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Commenting_ClosingDeclarationCommentSniff. * * Checks the //end ... comments on classes, interfaces and functions. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Commenting_ClosingDeclarationCommentSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_FUNCTION, T_CLASS, T_INTERFACE, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens.. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[$stackPtr]['code'] === T_FUNCTION) { $methodProps = $phpcsFile->getMethodProperties($stackPtr); // Abstract methods do not require a closing comment. if ($methodProps['is_abstract'] === true) { return; } // Closures do not require a closing comment. if ($methodProps['is_closure'] === true) { return; } // If this function is in an interface then we don't require // a closing comment. if ($phpcsFile->hasCondition($stackPtr, T_INTERFACE) === true) { return; } if (isset($tokens[$stackPtr]['scope_closer']) === false) { $error = 'Possible parse error: non-abstract method defined as abstract'; $phpcsFile->addWarning($error, $stackPtr, 'Abstract'); return; } $decName = $phpcsFile->getDeclarationName($stackPtr); $comment = '//end '.$decName.'()'; } else if ($tokens[$stackPtr]['code'] === T_CLASS) { $comment = '//end class'; } else { $comment = '//end interface'; }//end if if (isset($tokens[$stackPtr]['scope_closer']) === false) { $error = 'Possible parse error: %s missing opening or closing brace'; $data = array($tokens[$stackPtr]['content']); $phpcsFile->addWarning($error, $stackPtr, 'MissingBrace', $data); return; } $closingBracket = $tokens[$stackPtr]['scope_closer']; if ($closingBracket === null) { // Possible inline structure. Other tests will handle it. return; } $error = 'Expected '.$comment; if (isset($tokens[($closingBracket + 1)]) === false || $tokens[($closingBracket + 1)]['code'] !== T_COMMENT) { $next = $phpcsFile->findNext(T_WHITESPACE, ($closingBracket + 1), null, true); if (rtrim($tokens[$next]['content']) === $comment) { // The comment isn't really missing; it is just in the wrong place. $fix = $phpcsFile->addFixableError($error.' directly after closing brace', $closingBracket, 'Misplaced'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($closingBracket + 1); $i < $next; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } // Just in case, because indentation fixes can add indents onto // these comments and cause us to be unable to fix them. $phpcsFile->fixer->replaceToken($next, $comment.$phpcsFile->eolChar); $phpcsFile->fixer->endChangeset(); } } else { $fix = $phpcsFile->addFixableError($error, $closingBracket, 'Missing'); if ($fix === true) { $phpcsFile->fixer->replaceToken($closingBracket, '}'.$comment.$phpcsFile->eolChar); } } return; }//end if if (rtrim($tokens[($closingBracket + 1)]['content']) !== $comment) { $fix = $phpcsFile->addFixableError($error, $closingBracket, 'Incorrect'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($closingBracket + 1), $comment.$phpcsFile->eolChar); } return; } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/DocCommentAlignmentSniff.php0000644000076700000240000001372612647543456032477 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Commenting_DocCommentAlignmentSniff. * * Tests that the stars in a doc comment align correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Commenting_DocCommentAlignmentSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_DOC_COMMENT_OPEN_TAG); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // We are only interested in function/class/interface doc block comments. $ignore = PHP_CodeSniffer_Tokens::$emptyTokens; if ($phpcsFile->tokenizerType === 'JS') { $ignore[] = T_EQUAL; $ignore[] = T_STRING; $ignore[] = T_OBJECT_OPERATOR; } $nextToken = $phpcsFile->findNext($ignore, ($stackPtr + 1), null, true); $ignore = array( T_CLASS => true, T_INTERFACE => true, T_FUNCTION => true, T_PUBLIC => true, T_PRIVATE => true, T_PROTECTED => true, T_STATIC => true, T_ABSTRACT => true, T_PROPERTY => true, T_OBJECT => true, T_PROTOTYPE => true, ); if (isset($ignore[$tokens[$nextToken]['code']]) === false) { // Could be a file comment. $prevToken = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); if ($tokens[$prevToken]['code'] !== T_OPEN_TAG) { return; } } // There must be one space after each star (unless it is an empty comment line) // and all the stars must be aligned correctly. $requiredColumn = ($tokens[$stackPtr]['column'] + 1); $endComment = $tokens[$stackPtr]['comment_closer']; for ($i = ($stackPtr + 1); $i <= $endComment; $i++) { if ($tokens[$i]['code'] !== T_DOC_COMMENT_STAR && $tokens[$i]['code'] !== T_DOC_COMMENT_CLOSE_TAG ) { continue; } if ($tokens[$i]['code'] === T_DOC_COMMENT_CLOSE_TAG) { // Can't process the close tag if it is not the first thing on the line. $prev = $phpcsFile->findPrevious(T_DOC_COMMENT_WHITESPACE, ($i - 1), $stackPtr, true); if ($tokens[$prev]['line'] === $tokens[$i]['line']) { continue; } } if ($tokens[$i]['column'] !== $requiredColumn) { $error = 'Expected %s space(s) before asterisk; %s found'; $data = array( ($requiredColumn - 1), ($tokens[$i]['column'] - 1), ); $fix = $phpcsFile->addFixableError($error, $i, 'SpaceBeforeStar', $data); if ($fix === true) { $padding = str_repeat(' ', ($requiredColumn - 1)); if ($tokens[$i]['column'] === 1) { $phpcsFile->fixer->addContentBefore($i, $padding); } else { $phpcsFile->fixer->replaceToken(($i - 1), $padding); } } } if ($tokens[$i]['code'] !== T_DOC_COMMENT_STAR) { continue; } if ($tokens[($i + 2)]['line'] !== $tokens[$i]['line']) { // Line is empty. continue; } if ($tokens[($i + 1)]['code'] !== T_DOC_COMMENT_WHITESPACE) { $error = 'Expected 1 space after asterisk; 0 found'; $fix = $phpcsFile->addFixableError($error, $i, 'NoSpaceAfterStar'); if ($fix === true) { $phpcsFile->fixer->addContent($i, ' '); } } else if ($tokens[($i + 2)]['code'] === T_DOC_COMMENT_TAG && $tokens[($i + 1)]['content'] !== ' ' ) { $error = 'Expected 1 space after asterisk; %s found'; $data = array(strlen($tokens[($i + 1)]['content'])); $fix = $phpcsFile->addFixableError($error, $i, 'SpaceAfterStar', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($i + 1), ' '); } } }//end for }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/EmptyCatchCommentSniff.php0000644000076700000240000000422212647543456032163 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Commenting_EmptyCatchCommentSniff. * * Checks for empty Catch clause. Catch clause must at least have comment * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Commenting_EmptyCatchCommentSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_CATCH); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile All the tokens found in the document. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $scopeStart = $tokens[$stackPtr]['scope_opener']; $firstContent = $phpcsFile->findNext(T_WHITESPACE, ($scopeStart + 1), $tokens[$stackPtr]['scope_closer'], true); if ($firstContent === false) { $error = 'Empty CATCH statement must have a comment to explain why the exception is not handled'; $phpcsFile->addError($error, $scopeStart, 'Missing'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/FileCommentSniff.php0000644000076700000240000001601612647543456031005 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Parses and verifies the file doc comment. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Commenting_FileCommentSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return int */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $this->currentFile = $phpcsFile; $tokens = $phpcsFile->getTokens(); $commentStart = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$commentStart]['code'] === T_COMMENT) { $phpcsFile->addError('You must use "/**" style comments for a file comment', $commentStart, 'WrongStyle'); return ($phpcsFile->numTokens + 1); } else if ($commentStart === false || $tokens[$commentStart]['code'] !== T_DOC_COMMENT_OPEN_TAG) { $phpcsFile->addError('Missing file doc comment', $stackPtr, 'Missing'); return ($phpcsFile->numTokens + 1); } $commentEnd = $tokens[$commentStart]['comment_closer']; // No blank line between the open tag and the file comment. if ($tokens[$commentStart]['line'] > ($tokens[$stackPtr]['line'] + 1)) { $error = 'There must be no blank lines before the file comment'; $phpcsFile->addError($error, $stackPtr, 'SpacingAfterOpen'); } // Exactly one blank line after the file comment. $next = $phpcsFile->findNext(T_WHITESPACE, ($commentEnd + 1), null, true); if ($tokens[$next]['line'] !== ($tokens[$commentEnd]['line'] + 2)) { $error = 'There must be exactly one blank line after the file comment'; $phpcsFile->addError($error, $commentEnd, 'SpacingAfterComment'); } // Required tags in correct order. $required = array( '@package' => true, '@subpackage' => true, '@author' => true, '@copyright' => true, ); $foundTags = array(); foreach ($tokens[$commentStart]['comment_tags'] as $tag) { $name = $tokens[$tag]['content']; $isRequired = isset($required[$name]); if ($isRequired === true && in_array($name, $foundTags) === true) { $error = 'Only one %s tag is allowed in a file comment'; $data = array($name); $phpcsFile->addError($error, $tag, 'Duplicate'.ucfirst(substr($name, 1)).'Tag', $data); } $foundTags[] = $name; if ($isRequired === false) { continue; } $string = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $tag, $commentEnd); if ($string === false || $tokens[$string]['line'] !== $tokens[$tag]['line']) { $error = 'Content missing for %s tag in file comment'; $data = array($name); $phpcsFile->addError($error, $tag, 'Empty'.ucfirst(substr($name, 1)).'Tag', $data); continue; } if ($name === '@author') { if ($tokens[$string]['content'] !== 'Squiz Pty Ltd ') { $error = 'Expected "Squiz Pty Ltd " for author tag'; $fix = $phpcsFile->addFixableError($error, $tag, 'IncorrectAuthor'); if ($fix === true) { $expected = 'Squiz Pty Ltd '; $phpcsFile->fixer->replaceToken($string, $expected); } } } else if ($name === '@copyright') { if (preg_match('/^([0-9]{4})(-[0-9]{4})? (Squiz Pty Ltd \(ABN 77 084 670 600\))$/', $tokens[$string]['content']) === 0) { $error = 'Expected "xxxx-xxxx Squiz Pty Ltd (ABN 77 084 670 600)" for copyright declaration'; $fix = $phpcsFile->addFixableError($error, $tag, 'IncorrectCopyright'); if ($fix === true) { $matches = array(); preg_match('/^(([0-9]{4})(-[0-9]{4})?)?.*$/', $tokens[$string]['content'], $matches); if (isset($matches[1]) === false) { $matches[1] = date('Y'); } $expected = $matches[1].' Squiz Pty Ltd (ABN 77 084 670 600)'; $phpcsFile->fixer->replaceToken($string, $expected); } } }//end if }//end foreach // Check if the tags are in the correct position. $pos = 0; foreach ($required as $tag => $true) { if (in_array($tag, $foundTags) === false) { $error = 'Missing %s tag in file comment'; $data = array($tag); $phpcsFile->addError($error, $commentEnd, 'Missing'.ucfirst(substr($tag, 1)).'Tag', $data); } if (isset($foundTags[$pos]) === false) { break; } if ($foundTags[$pos] !== $tag) { $error = 'The tag in position %s should be the %s tag'; $data = array( ($pos + 1), $tag, ); $phpcsFile->addError($error, $tokens[$commentStart]['comment_tags'][$pos], ucfirst(substr($tag, 1)).'TagOrder', $data); } $pos++; }//end foreach // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/FunctionCommentThrowTagSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/FunctionCommentThrowTagSniff.php0000644000076700000240000001735512647543456033402 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) { $error = 'Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found'; throw new PHP_CodeSniffer_Exception($error); } /** * Verifies that a @throws tag exists for a function that throws exceptions. * Verifies the number of @throws tags and the number of throw tokens matches. * Verifies the exception type. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Commenting_FunctionCommentThrowTagSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff { /** * Constructs a Squiz_Sniffs_Commenting_FunctionCommentThrowTagSniff. */ public function __construct() { parent::__construct(array(T_FUNCTION), array(T_THROW)); }//end __construct() /** * Processes the function tokens within the class. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the token was found. * @param int $currScope The current scope opener token. * * @return void */ protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope) { // Is this the first throw token within the current function scope? // If so, we have to validate other throw tokens within the same scope. $previousThrow = $phpcsFile->findPrevious(T_THROW, ($stackPtr - 1), $currScope); if ($previousThrow !== false) { return; } $tokens = $phpcsFile->getTokens(); $find = PHP_CodeSniffer_Tokens::$methodPrefixes; $find[] = T_WHITESPACE; $commentEnd = $phpcsFile->findPrevious($find, ($currScope - 1), null, true); if ($tokens[$commentEnd]['code'] === T_COMMENT) { // Inline comments might just be closing comments for // control structures or functions instead of function comments // using the wrong comment type. If there is other code on the line, // assume they relate to that code. $prev = $phpcsFile->findPrevious($find, ($commentEnd - 1), null, true); if ($prev !== false && $tokens[$prev]['line'] === $tokens[$commentEnd]['line']) { $commentEnd = $prev; } } if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG && $tokens[$commentEnd]['code'] !== T_COMMENT ) { // Function doesn't have a doc comment. return; } // Find the position where the current function scope ends. $currScopeEnd = 0; if (isset($tokens[$currScope]['scope_closer']) === true) { $currScopeEnd = $tokens[$currScope]['scope_closer']; } // Find all the exception type token within the current scope. $throwTokens = array(); $currPos = $stackPtr; if ($currScopeEnd !== 0) { while ($currPos < $currScopeEnd && $currPos !== false) { /* If we can't find a NEW, we are probably throwing a variable, so we ignore it, but they still need to provide at least one @throws tag, even through we don't know the exception class. */ $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($currPos + 1), null, true); if ($tokens[$nextToken]['code'] === T_NEW) { $currException = $phpcsFile->findNext( array( T_NS_SEPARATOR, T_STRING, ), $currPos, $currScopeEnd, false, null, true ); if ($currException !== false) { $endException = $phpcsFile->findNext( array( T_NS_SEPARATOR, T_STRING, ), ($currException + 1), $currScopeEnd, true, null, true ); if ($endException === false) { $throwTokens[] = $tokens[$currException]['content']; } else { $throwTokens[] = $phpcsFile->getTokensAsString($currException, ($endException - $currException)); } }//end if }//end if $currPos = $phpcsFile->findNext(T_THROW, ($currPos + 1), $currScopeEnd); }//end while }//end if // Only need one @throws tag for each type of exception thrown. $throwTokens = array_unique($throwTokens); $throwTags = array(); $commentStart = $tokens[$commentEnd]['comment_opener']; foreach ($tokens[$commentStart]['comment_tags'] as $tag) { if ($tokens[$tag]['content'] !== '@throws') { continue; } if ($tokens[($tag + 2)]['code'] === T_DOC_COMMENT_STRING) { $exception = $tokens[($tag + 2)]['content']; $space = strpos($exception, ' '); if ($space !== false) { $exception = substr($exception, 0, $space); } $throwTags[$exception] = true; } } if (empty($throwTags) === true) { $error = 'Missing @throws tag in function comment'; $phpcsFile->addError($error, $commentEnd, 'Missing'); return; } else if (empty($throwTokens) === true) { // If token count is zero, it means that only variables are being // thrown, so we need at least one @throws tag (checked above). // Nothing more to do. return; } // Make sure @throws tag count matches throw token count. $tokenCount = count($throwTokens); $tagCount = count($throwTags); if ($tokenCount !== $tagCount) { $error = 'Expected %s @throws tag(s) in function comment; %s found'; $data = array( $tokenCount, $tagCount, ); $phpcsFile->addError($error, $commentEnd, 'WrongNumber', $data); return; } foreach ($throwTokens as $throw) { if (isset($throwTags[$throw]) === false) { $error = 'Missing @throws tag for "%s" exception'; $data = array($throw); $phpcsFile->addError($error, $commentEnd, 'Missing', $data); } } }//end processTokenWithinScope() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php0000644000076700000240000006332312647543456031716 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PEAR_Sniffs_Commenting_FunctionCommentSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class PEAR_Sniffs_Commenting_FunctionCommentSniff not found'); } /** * Parses and verifies the doc comments for functions. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Commenting_FunctionCommentSniff extends PEAR_Sniffs_Commenting_FunctionCommentSniff { /** * Process the return comment of this function comment. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param int $commentStart The position in the stack where the comment started. * * @return void */ protected function processReturn(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart) { $tokens = $phpcsFile->getTokens(); // Skip constructor and destructor. $methodName = $phpcsFile->getDeclarationName($stackPtr); $isSpecialMethod = ($methodName === '__construct' || $methodName === '__destruct'); $return = null; foreach ($tokens[$commentStart]['comment_tags'] as $tag) { if ($tokens[$tag]['content'] === '@return') { if ($return !== null) { $error = 'Only 1 @return tag is allowed in a function comment'; $phpcsFile->addError($error, $tag, 'DuplicateReturn'); return; } $return = $tag; } } if ($isSpecialMethod === true) { return; } if ($return !== null) { $content = $tokens[($return + 2)]['content']; if (empty($content) === true || $tokens[($return + 2)]['code'] !== T_DOC_COMMENT_STRING) { $error = 'Return type missing for @return tag in function comment'; $phpcsFile->addError($error, $return, 'MissingReturnType'); } else { // Check return type (can be multiple, separated by '|'). $typeNames = explode('|', $content); $suggestedNames = array(); foreach ($typeNames as $i => $typeName) { $suggestedName = PHP_CodeSniffer::suggestType($typeName); if (in_array($suggestedName, $suggestedNames) === false) { $suggestedNames[] = $suggestedName; } } $suggestedType = implode('|', $suggestedNames); if ($content !== $suggestedType) { $error = 'Expected "%s" but found "%s" for function return type'; $data = array( $suggestedType, $content, ); $fix = $phpcsFile->addFixableError($error, $return, 'InvalidReturn', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($return + 2), $suggestedType); } } // If the return type is void, make sure there is // no return statement in the function. if ($content === 'void') { if (isset($tokens[$stackPtr]['scope_closer']) === true) { $endToken = $tokens[$stackPtr]['scope_closer']; for ($returnToken = $stackPtr; $returnToken < $endToken; $returnToken++) { if ($tokens[$returnToken]['code'] === T_CLOSURE) { $returnToken = $tokens[$returnToken]['scope_closer']; continue; } if ($tokens[$returnToken]['code'] === T_RETURN || $tokens[$returnToken]['code'] === T_YIELD ) { break; } } if ($returnToken !== $endToken) { // If the function is not returning anything, just // exiting, then there is no problem. $semicolon = $phpcsFile->findNext(T_WHITESPACE, ($returnToken + 1), null, true); if ($tokens[$semicolon]['code'] !== T_SEMICOLON) { $error = 'Function return type is void, but function contains return statement'; $phpcsFile->addError($error, $return, 'InvalidReturnVoid'); } } }//end if } else if ($content !== 'mixed') { // If return type is not void, there needs to be a return statement // somewhere in the function that returns something. if (isset($tokens[$stackPtr]['scope_closer']) === true) { $endToken = $tokens[$stackPtr]['scope_closer']; $returnToken = $phpcsFile->findNext(array(T_RETURN, T_YIELD), $stackPtr, $endToken); if ($returnToken === false) { $error = 'Function return type is not void, but function has no return statement'; $phpcsFile->addError($error, $return, 'InvalidNoReturn'); } else { $semicolon = $phpcsFile->findNext(T_WHITESPACE, ($returnToken + 1), null, true); if ($tokens[$semicolon]['code'] === T_SEMICOLON) { $error = 'Function return type is not void, but function is returning void here'; $phpcsFile->addError($error, $returnToken, 'InvalidReturnNotVoid'); } } } }//end if }//end if } else { $error = 'Missing @return tag in function comment'; $phpcsFile->addError($error, $tokens[$commentStart]['comment_closer'], 'MissingReturn'); }//end if }//end processReturn() /** * Process any throw tags that this function comment has. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param int $commentStart The position in the stack where the comment started. * * @return void */ protected function processThrows(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart) { $tokens = $phpcsFile->getTokens(); $throws = array(); foreach ($tokens[$commentStart]['comment_tags'] as $pos => $tag) { if ($tokens[$tag]['content'] !== '@throws') { continue; } $exception = null; $comment = null; if ($tokens[($tag + 2)]['code'] === T_DOC_COMMENT_STRING) { $matches = array(); preg_match('/([^\s]+)(?:\s+(.*))?/', $tokens[($tag + 2)]['content'], $matches); $exception = $matches[1]; if (isset($matches[2]) === true && trim($matches[2]) !== '') { $comment = $matches[2]; } } if ($exception === null) { $error = 'Exception type and comment missing for @throws tag in function comment'; $phpcsFile->addError($error, $tag, 'InvalidThrows'); } else if ($comment === null) { $error = 'Comment missing for @throws tag in function comment'; $phpcsFile->addError($error, $tag, 'EmptyThrows'); } else { // Any strings until the next tag belong to this comment. if (isset($tokens[$commentStart]['comment_tags'][($pos + 1)]) === true) { $end = $tokens[$commentStart]['comment_tags'][($pos + 1)]; } else { $end = $tokens[$commentStart]['comment_closer']; } for ($i = ($tag + 3); $i < $end; $i++) { if ($tokens[$i]['code'] === T_DOC_COMMENT_STRING) { $comment .= ' '.$tokens[$i]['content']; } } // Starts with a capital letter and ends with a fullstop. $firstChar = $comment{0}; if (strtoupper($firstChar) !== $firstChar) { $error = '@throws tag comment must start with a capital letter'; $phpcsFile->addError($error, ($tag + 2), 'ThrowsNotCapital'); } $lastChar = substr($comment, -1); if ($lastChar !== '.') { $error = '@throws tag comment must end with a full stop'; $phpcsFile->addError($error, ($tag + 2), 'ThrowsNoFullStop'); } }//end if }//end foreach }//end processThrows() /** * Process the function parameter comments. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param int $commentStart The position in the stack where the comment started. * * @return void */ protected function processParams(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $commentStart) { $tokens = $phpcsFile->getTokens(); $params = array(); $maxType = 0; $maxVar = 0; foreach ($tokens[$commentStart]['comment_tags'] as $pos => $tag) { if ($tokens[$tag]['content'] !== '@param') { continue; } $type = ''; $typeSpace = 0; $var = ''; $varSpace = 0; $comment = ''; $commentLines = array(); if ($tokens[($tag + 2)]['code'] === T_DOC_COMMENT_STRING) { $matches = array(); preg_match('/([^$&.]+)(?:((?:\.\.\.)?(?:\$|&)[^\s]+)(?:(\s+)(.*))?)?/', $tokens[($tag + 2)]['content'], $matches); $typeLen = strlen($matches[1]); $type = trim($matches[1]); $typeSpace = ($typeLen - strlen($type)); $typeLen = strlen($type); if ($typeLen > $maxType) { $maxType = $typeLen; } if (isset($matches[2]) === true) { $var = $matches[2]; $varLen = strlen($var); if ($varLen > $maxVar) { $maxVar = $varLen; } if (isset($matches[4]) === true) { $varSpace = strlen($matches[3]); $comment = $matches[4]; $commentLines[] = array( 'comment' => $comment, 'token' => ($tag + 2), 'indent' => $varSpace, ); // Any strings until the next tag belong to this comment. if (isset($tokens[$commentStart]['comment_tags'][($pos + 1)]) === true) { $end = $tokens[$commentStart]['comment_tags'][($pos + 1)]; } else { $end = $tokens[$commentStart]['comment_closer']; } for ($i = ($tag + 3); $i < $end; $i++) { if ($tokens[$i]['code'] === T_DOC_COMMENT_STRING) { $indent = 0; if ($tokens[($i - 1)]['code'] === T_DOC_COMMENT_WHITESPACE) { $indent = strlen($tokens[($i - 1)]['content']); } $comment .= ' '.$tokens[$i]['content']; $commentLines[] = array( 'comment' => $tokens[$i]['content'], 'token' => $i, 'indent' => $indent, ); } } } else { $error = 'Missing parameter comment'; $phpcsFile->addError($error, $tag, 'MissingParamComment'); $commentLines[] = array('comment' => ''); }//end if } else { $error = 'Missing parameter name'; $phpcsFile->addError($error, $tag, 'MissingParamName'); }//end if } else { $error = 'Missing parameter type'; $phpcsFile->addError($error, $tag, 'MissingParamType'); }//end if $params[] = array( 'tag' => $tag, 'type' => $type, 'var' => $var, 'comment' => $comment, 'commentLines' => $commentLines, 'type_space' => $typeSpace, 'var_space' => $varSpace, ); }//end foreach $realParams = $phpcsFile->getMethodParameters($stackPtr); $foundParams = array(); // We want to use ... for all variable length arguments, so added // this prefix to the variable name so comparisons are easier. foreach ($realParams as $pos => $param) { if ($param['variable_length'] === true) { $realParams[$pos]['name'] = '...'.$realParams[$pos]['name']; } } foreach ($params as $pos => $param) { // If the type is empty, the whole line is empty. if ($param['type'] === '') { continue; } // Check the param type value. $typeNames = explode('|', $param['type']); foreach ($typeNames as $typeName) { $suggestedName = PHP_CodeSniffer::suggestType($typeName); if ($typeName !== $suggestedName) { $error = 'Expected "%s" but found "%s" for parameter type'; $data = array( $suggestedName, $typeName, ); $fix = $phpcsFile->addFixableError($error, $param['tag'], 'IncorrectParamVarName', $data); if ($fix === true) { $content = $suggestedName; $content .= str_repeat(' ', $param['type_space']); $content .= $param['var']; $content .= str_repeat(' ', $param['var_space']); if (isset($param['commentLines'][0]) === true) { $content .= $param['commentLines'][0]['comment']; } $phpcsFile->fixer->replaceToken(($param['tag'] + 2), $content); } } else if (count($typeNames) === 1) { // Check type hint for array and custom type. $suggestedTypeHint = ''; if (strpos($suggestedName, 'array') !== false || substr($suggestedName, -2) === '[]') { $suggestedTypeHint = 'array'; } else if (strpos($suggestedName, 'callable') !== false) { $suggestedTypeHint = 'callable'; } else if (strpos($suggestedName, 'callback') !== false) { $suggestedTypeHint = 'callable'; } else if (in_array($typeName, PHP_CodeSniffer::$allowedTypes) === false) { $suggestedTypeHint = $suggestedName; } else if (version_compare(PHP_VERSION, '7.0.0') >= 0) { if ($typeName === 'string') { $suggestedTypeHint = 'string'; } else if ($typeName === 'int' || $typeName === 'integer') { $suggestedTypeHint = 'int'; } else if ($typeName === 'float') { $suggestedTypeHint = 'float'; } else if ($typeName === 'bool' || $typeName === 'boolean') { $suggestedTypeHint = 'bool'; } } if ($suggestedTypeHint !== '' && isset($realParams[$pos]) === true) { $typeHint = $realParams[$pos]['type_hint']; if ($typeHint === '') { $error = 'Type hint "%s" missing for %s'; $data = array( $suggestedTypeHint, $param['var'], ); $errorCode = 'TypeHintMissing'; if ($suggestedTypeHint === 'string' || $suggestedTypeHint === 'int' || $suggestedTypeHint === 'float' || $suggestedTypeHint === 'bool' ) { $errorCode = 'Scalar'.$errorCode; } $phpcsFile->addError($error, $stackPtr, $errorCode, $data); } else if ($typeHint !== substr($suggestedTypeHint, (strlen($typeHint) * -1))) { $error = 'Expected type hint "%s"; found "%s" for %s'; $data = array( $suggestedTypeHint, $typeHint, $param['var'], ); $phpcsFile->addError($error, $stackPtr, 'IncorrectTypeHint', $data); }//end if } else if ($suggestedTypeHint === '' && isset($realParams[$pos]) === true) { $typeHint = $realParams[$pos]['type_hint']; if ($typeHint !== '') { $error = 'Unknown type hint "%s" found for %s'; $data = array( $typeHint, $param['var'], ); $phpcsFile->addError($error, $stackPtr, 'InvalidTypeHint', $data); } }//end if }//end if }//end foreach if ($param['var'] === '') { continue; } $foundParams[] = $param['var']; // Check number of spaces after the type. $spaces = ($maxType - strlen($param['type']) + 1); if ($param['type_space'] !== $spaces) { $error = 'Expected %s spaces after parameter type; %s found'; $data = array( $spaces, $param['type_space'], ); $fix = $phpcsFile->addFixableError($error, $param['tag'], 'SpacingAfterParamType', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $content = $param['type']; $content .= str_repeat(' ', $spaces); $content .= $param['var']; $content .= str_repeat(' ', $param['var_space']); $content .= $param['commentLines'][0]['comment']; $phpcsFile->fixer->replaceToken(($param['tag'] + 2), $content); // Fix up the indent of additional comment lines. foreach ($param['commentLines'] as $lineNum => $line) { if ($lineNum === 0 || $param['commentLines'][$lineNum]['indent'] === 0 ) { continue; } $newIndent = ($param['commentLines'][$lineNum]['indent'] + $spaces - $param['type_space']); $phpcsFile->fixer->replaceToken( ($param['commentLines'][$lineNum]['token'] - 1), str_repeat(' ', $newIndent) ); } $phpcsFile->fixer->endChangeset(); }//end if }//end if // Make sure the param name is correct. if (isset($realParams[$pos]) === true) { $realName = $realParams[$pos]['name']; if ($realName !== $param['var']) { $code = 'ParamNameNoMatch'; $data = array( $param['var'], $realName, ); $error = 'Doc comment for parameter %s does not match '; if (strtolower($param['var']) === strtolower($realName)) { $error .= 'case of '; $code = 'ParamNameNoCaseMatch'; } $error .= 'actual variable name %s'; $phpcsFile->addError($error, $param['tag'], $code, $data); } } else if (substr($param['var'], -4) !== ',...') { // We must have an extra parameter comment. $error = 'Superfluous parameter comment'; $phpcsFile->addError($error, $param['tag'], 'ExtraParamComment'); }//end if if ($param['comment'] === '') { continue; } // Check number of spaces after the var name. $spaces = ($maxVar - strlen($param['var']) + 1); if ($param['var_space'] !== $spaces) { $error = 'Expected %s spaces after parameter name; %s found'; $data = array( $spaces, $param['var_space'], ); $fix = $phpcsFile->addFixableError($error, $param['tag'], 'SpacingAfterParamName', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $content = $param['type']; $content .= str_repeat(' ', $param['type_space']); $content .= $param['var']; $content .= str_repeat(' ', $spaces); $content .= $param['commentLines'][0]['comment']; $phpcsFile->fixer->replaceToken(($param['tag'] + 2), $content); // Fix up the indent of additional comment lines. foreach ($param['commentLines'] as $lineNum => $line) { if ($lineNum === 0 || $param['commentLines'][$lineNum]['indent'] === 0 ) { continue; } $newIndent = ($param['commentLines'][$lineNum]['indent'] + $spaces - $param['var_space']); $phpcsFile->fixer->replaceToken( ($param['commentLines'][$lineNum]['token'] - 1), str_repeat(' ', $newIndent) ); } $phpcsFile->fixer->endChangeset(); }//end if }//end if // Param comments must start with a capital letter and end with the full stop. if (preg_match('/^(\p{Ll}|\P{L})/u', $param['comment']) === 1) { $error = 'Parameter comment must start with a capital letter'; $phpcsFile->addError($error, $param['tag'], 'ParamCommentNotCapital'); } $lastChar = substr($param['comment'], -1); if ($lastChar !== '.') { $error = 'Parameter comment must end with a full stop'; $phpcsFile->addError($error, $param['tag'], 'ParamCommentFullStop'); } }//end foreach $realNames = array(); foreach ($realParams as $realParam) { $realNames[] = $realParam['name']; } // Report missing comments. $diff = array_diff($realNames, $foundParams); foreach ($diff as $neededParam) { $error = 'Doc comment for parameter "%s" missing'; $data = array($neededParam); $phpcsFile->addError($error, $commentStart, 'MissingParamTag', $data); } }//end processParams() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/InlineCommentSniff.php0000644000076700000240000002715612647543456031353 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Commenting_InlineCommentSniff. * * Checks that there is adequate spacing between comments. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Commenting_InlineCommentSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_COMMENT, T_DOC_COMMENT_OPEN_TAG, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // If this is a function/class/interface doc block comment, skip it. // We are only interested in inline doc block comments, which are // not allowed. if ($tokens[$stackPtr]['code'] === T_DOC_COMMENT_OPEN_TAG) { $nextToken = $phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true ); $ignore = array( T_CLASS, T_INTERFACE, T_TRAIT, T_FUNCTION, T_CLOSURE, T_PUBLIC, T_PRIVATE, T_PROTECTED, T_FINAL, T_STATIC, T_ABSTRACT, T_CONST, T_PROPERTY, ); if (in_array($tokens[$nextToken]['code'], $ignore) === true) { return; } if ($phpcsFile->tokenizerType === 'JS') { // We allow block comments if a function or object // is being assigned to a variable. $ignore = PHP_CodeSniffer_Tokens::$emptyTokens; $ignore[] = T_EQUAL; $ignore[] = T_STRING; $ignore[] = T_OBJECT_OPERATOR; $nextToken = $phpcsFile->findNext($ignore, ($nextToken + 1), null, true); if ($tokens[$nextToken]['code'] === T_FUNCTION || $tokens[$nextToken]['code'] === T_CLOSURE || $tokens[$nextToken]['code'] === T_OBJECT || $tokens[$nextToken]['code'] === T_PROTOTYPE ) { return; } } $prevToken = $phpcsFile->findPrevious( PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true ); if ($tokens[$prevToken]['code'] === T_OPEN_TAG) { return; } if ($tokens[$stackPtr]['content'] === '/**') { $error = 'Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead'; $phpcsFile->addError($error, $stackPtr, 'DocBlock'); } }//end if if ($tokens[$stackPtr]['content']{0} === '#') { $error = 'Perl-style comments are not allowed; use "// Comment" instead'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'WrongStyle'); if ($fix === true) { $comment = ltrim($tokens[$stackPtr]['content'], "# \t"); $phpcsFile->fixer->replaceToken($stackPtr, "// $comment"); } } // We don't want end of block comments. If the last comment is a closing // curly brace. $previousContent = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if ($tokens[$previousContent]['line'] === $tokens[$stackPtr]['line']) { if ($tokens[$previousContent]['code'] === T_CLOSE_CURLY_BRACKET) { return; } // Special case for JS files. if ($tokens[$previousContent]['code'] === T_COMMA || $tokens[$previousContent]['code'] === T_SEMICOLON ) { $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($previousContent - 1), null, true); if ($tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) { return; } } } $comment = rtrim($tokens[$stackPtr]['content']); // Only want inline comments. if (substr($comment, 0, 2) !== '//') { return; } if (trim(substr($comment, 2)) !== '') { $spaceCount = 0; $tabFound = false; $commentLength = strlen($comment); for ($i = 2; $i < $commentLength; $i++) { if ($comment[$i] === "\t") { $tabFound = true; break; } if ($comment[$i] !== ' ') { break; } $spaceCount++; } $fix = false; if ($tabFound === true) { $error = 'Tab found before comment text; expected "// %s" but found "%s"'; $data = array( ltrim(substr($comment, 2)), $comment, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'TabBefore', $data); } else if ($spaceCount === 0) { $error = 'No space found before comment text; expected "// %s" but found "%s"'; $data = array( substr($comment, 2), $comment, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBefore', $data); } else if ($spaceCount > 1) { $error = 'Expected 1 space before comment text but found %s; use block comment if you need indentation'; $data = array( $spaceCount, substr($comment, (2 + $spaceCount)), $comment, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBefore', $data); }//end if if ($fix === true) { $newComment = '// '.ltrim($tokens[$stackPtr]['content'], "/\t "); $phpcsFile->fixer->replaceToken($stackPtr, $newComment); } }//end if // The below section determines if a comment block is correctly capitalised, // and ends in a full-stop. It will find the last comment in a block, and // work its way up. $nextComment = $phpcsFile->findNext(array(T_COMMENT), ($stackPtr + 1), null, false); if (($nextComment !== false) && (($tokens[$nextComment]['line']) === ($tokens[$stackPtr]['line'] + 1)) ) { return; } $topComment = $stackPtr; $lastComment = $stackPtr; while (($topComment = $phpcsFile->findPrevious(array(T_COMMENT), ($lastComment - 1), null, false)) !== false) { if ($tokens[$topComment]['line'] !== ($tokens[$lastComment]['line'] - 1)) { break; } $lastComment = $topComment; } $topComment = $lastComment; $commentText = ''; for ($i = $topComment; $i <= $stackPtr; $i++) { if ($tokens[$i]['code'] === T_COMMENT) { $commentText .= trim(substr($tokens[$i]['content'], 2)); } } if ($commentText === '') { $error = 'Blank comments are not allowed'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Empty'); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, ''); } return; } if (preg_match('/^\p{Ll}/u', $commentText) === 1) { $error = 'Inline comments must start with a capital letter'; $phpcsFile->addError($error, $topComment, 'NotCapital'); } // Only check the end of comment character if the start of the comment // is a letter, indicating that the comment is just standard text. if (preg_match('/^\p{L}/u', $commentText) === 1) { $commentCloser = $commentText[(strlen($commentText) - 1)]; $acceptedClosers = array( 'full-stops' => '.', 'exclamation marks' => '!', 'or question marks' => '?', ); if (in_array($commentCloser, $acceptedClosers) === false) { $error = 'Inline comments must end in %s'; $ender = ''; foreach ($acceptedClosers as $closerName => $symbol) { $ender .= ' '.$closerName.','; } $ender = trim($ender, ' ,'); $data = array($ender); $phpcsFile->addError($error, $stackPtr, 'InvalidEndChar', $data); } } // Finally, the line below the last comment cannot be empty if this inline // comment is on a line by itself. if ($tokens[$previousContent]['line'] < $tokens[$stackPtr]['line']) { $start = false; for ($i = ($stackPtr + 1); $i < $phpcsFile->numTokens; $i++) { if ($tokens[$i]['line'] === ($tokens[$stackPtr]['line'] + 1)) { if ($tokens[$i]['code'] !== T_WHITESPACE) { return; } } else if ($tokens[$i]['line'] > ($tokens[$stackPtr]['line'] + 1)) { break; } } $error = 'There must be no blank line following an inline comment'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfter'); if ($fix === true) { $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); $phpcsFile->fixer->beginChangeset(); for ($i = ($stackPtr + 1); $i < $next; $i++) { if ($tokens[$i]['line'] === $tokens[$next]['line']) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } }//end if }//end process() }//end class ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/LongConditionClosingCommentSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/LongConditionClosingCommentSniff0000644000076700000240000001676012647543456033433 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_ControlStructures_LongConditionClosingCommentSniff. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Commenting_LongConditionClosingCommentSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * The openers that we are interested in. * * @var array(int) */ private static $_openers = array( T_SWITCH, T_IF, T_FOR, T_FOREACH, T_WHILE, T_TRY, T_CASE, ); /** * The length that a code block must be before * requiring a closing comment. * * @var int */ protected $lineLimit = 20; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_CLOSE_CURLY_BRACKET); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['scope_condition']) === false) { // No scope condition. It is a function closer. return; } $startCondition = $tokens[$tokens[$stackPtr]['scope_condition']]; $startBrace = $tokens[$tokens[$stackPtr]['scope_opener']]; $endBrace = $tokens[$stackPtr]; // We are only interested in some code blocks. if (in_array($startCondition['code'], self::$_openers) === false) { return; } if ($startCondition['code'] === T_IF) { // If this is actually and ELSE IF, skip it as the brace // will be checked by the original IF. $else = $phpcsFile->findPrevious(T_WHITESPACE, ($tokens[$stackPtr]['scope_condition'] - 1), null, true); if ($tokens[$else]['code'] === T_ELSE) { return; } // IF statements that have an ELSE block need to use // "end if" rather than "end else" or "end elseif". do { $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$nextToken]['code'] === T_ELSE || $tokens[$nextToken]['code'] === T_ELSEIF) { // Check for ELSE IF (2 tokens) as opposed to ELSEIF (1 token). if ($tokens[$nextToken]['code'] === T_ELSE && isset($tokens[$nextToken]['scope_closer']) === false ) { $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($nextToken + 1), null, true); if ($tokens[$nextToken]['code'] !== T_IF || isset($tokens[$nextToken]['scope_closer']) === false ) { // Not an ELSE IF or is an inline ELSE IF. break; } } if (isset($tokens[$nextToken]['scope_closer']) === false) { // There isn't going to be anywhere to print the "end if" comment // because there is no closer. return; } // The end brace becomes the ELSE's end brace. $stackPtr = $tokens[$nextToken]['scope_closer']; $endBrace = $tokens[$stackPtr]; } else { break; }//end if } while (isset($tokens[$nextToken]['scope_closer']) === true); }//end if if ($startCondition['code'] === T_TRY) { // TRY statements need to check until the end of all CATCH statements. do { $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$nextToken]['code'] === T_CATCH) { // The end brace becomes the CATCH's end brace. $stackPtr = $tokens[$nextToken]['scope_closer']; $endBrace = $tokens[$stackPtr]; } else { break; } } while (isset($tokens[$nextToken]['scope_closer']) === true); } $lineDifference = ($endBrace['line'] - $startBrace['line']); $expected = '//end '.$startCondition['content']; $comment = $phpcsFile->findNext(array(T_COMMENT), $stackPtr, null, false); if (($comment === false) || ($tokens[$comment]['line'] !== $endBrace['line'])) { if ($lineDifference >= $this->lineLimit) { $error = 'End comment for long condition not found; expected "%s"'; $data = array($expected); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Missing', $data); if ($fix === true) { $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($next !== false && $tokens[$next]['line'] === $tokens[$stackPtr]['line']) { $expected .= $phpcsFile->eolChar; } $phpcsFile->fixer->addContent($stackPtr, $expected); } } return; } if (($comment - $stackPtr) !== 1) { $error = 'Space found before closing comment; expected "%s"'; $data = array($expected); $phpcsFile->addError($error, $stackPtr, 'SpacingBefore', $data); } if (trim($tokens[$comment]['content']) !== $expected) { $found = trim($tokens[$comment]['content']); $error = 'Incorrect closing comment; expected "%s" but found "%s"'; $data = array( $expected, $found, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Invalid', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($comment, $expected.$phpcsFile->eolChar); } return; } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/PostStatementCommentSniff.php0000644000076700000240000000602012647543456032732 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Commenting_PostStatementCommentSniff. * * Checks to ensure that there are no comments after statements. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Commenting_PostStatementCommentSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_COMMENT); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (substr($tokens[$stackPtr]['content'], 0, 2) !== '//') { return; } $commentLine = $tokens[$stackPtr]['line']; $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if ($tokens[$lastContent]['line'] !== $commentLine) { return; } if ($tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) { return; } // Special case for JS files. if ($tokens[$lastContent]['code'] === T_COMMA || $tokens[$lastContent]['code'] === T_SEMICOLON ) { $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($lastContent - 1), null, true); if ($tokens[$lastContent]['code'] === T_CLOSE_CURLY_BRACKET) { return; } } $error = 'Comments may not appear after statements'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Found'); if ($fix === true) { $phpcsFile->fixer->addNewlineBefore($stackPtr); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Commenting/VariableCommentSniff.php0000644000076700000240000001475212647543456031660 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractVariableSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractVariableSniff not found'); } /** * Parses and verifies the variable doc comment. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Commenting_VariableCommentSniff extends PHP_CodeSniffer_Standards_AbstractVariableSniff { /** * Called to process class member vars. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function processMemberVar(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $commentToken = array( T_COMMENT, T_DOC_COMMENT_CLOSE_TAG, ); $commentEnd = $phpcsFile->findPrevious($commentToken, $stackPtr); if ($commentEnd === false) { $phpcsFile->addError('Missing member variable doc comment', $stackPtr, 'Missing'); return; } if ($tokens[$commentEnd]['code'] === T_COMMENT) { $phpcsFile->addError('You must use "/**" style comments for a member variable comment', $stackPtr, 'WrongStyle'); return; } else if ($tokens[$commentEnd]['code'] !== T_DOC_COMMENT_CLOSE_TAG) { $phpcsFile->addError('Missing member variable doc comment', $stackPtr, 'Missing'); return; } else { // Make sure the comment we have found belongs to us. $commentFor = $phpcsFile->findNext(array(T_VARIABLE, T_CLASS, T_INTERFACE), ($commentEnd + 1)); if ($commentFor !== $stackPtr) { $phpcsFile->addError('Missing member variable doc comment', $stackPtr, 'Missing'); return; } } $commentStart = $tokens[$commentEnd]['comment_opener']; $foundVar = null; foreach ($tokens[$commentStart]['comment_tags'] as $tag) { if ($tokens[$tag]['content'] === '@var') { if ($foundVar !== null) { $error = 'Only one @var tag is allowed in a member variable comment'; $phpcsFile->addError($error, $tag, 'DuplicateVar'); } else { $foundVar = $tag; } } else if ($tokens[$tag]['content'] === '@see') { // Make sure the tag isn't empty. $string = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $tag, $commentEnd); if ($string === false || $tokens[$string]['line'] !== $tokens[$tag]['line']) { $error = 'Content missing for @see tag in member variable comment'; $phpcsFile->addError($error, $tag, 'EmptySees'); } } else { $error = '%s tag is not allowed in member variable comment'; $data = array($tokens[$tag]['content']); $phpcsFile->addWarning($error, $tag, 'TagNotAllowed', $data); }//end if }//end foreach // The @var tag is the only one we require. if ($foundVar === null) { $error = 'Missing @var tag in member variable comment'; $phpcsFile->addError($error, $commentEnd, 'MissingVar'); return; } $firstTag = $tokens[$commentStart]['comment_tags'][0]; if ($foundVar !== null && $tokens[$firstTag]['content'] !== '@var') { $error = 'The @var tag must be the first tag in a member variable comment'; $phpcsFile->addError($error, $foundVar, 'VarOrder'); } // Make sure the tag isn't empty and has the correct padding. $string = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $foundVar, $commentEnd); if ($string === false || $tokens[$string]['line'] !== $tokens[$foundVar]['line']) { $error = 'Content missing for @var tag in member variable comment'; $phpcsFile->addError($error, $foundVar, 'EmptyVar'); return; } $varType = $tokens[($foundVar + 2)]['content']; $suggestedType = PHP_CodeSniffer::suggestType($varType); if ($varType !== $suggestedType) { $error = 'Expected "%s" but found "%s" for @var tag in member variable comment'; $data = array( $suggestedType, $varType, ); $phpcsFile->addError($error, ($foundVar + 2), 'IncorrectVarType', $data); } }//end processMemberVar() /** * Called to process a normal variable. * * Not required for this sniff. * * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this token was found. * @param int $stackPtr The position where the double quoted * string was found. * * @return void */ protected function processVariable(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { }//end processVariable() /** * Called to process variables found in double quoted strings. * * Not required for this sniff. * * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this token was found. * @param int $stackPtr The position where the double quoted * string was found. * * @return void */ protected function processVariableInString(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { }//end processVariableInString() }//end class ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/ControlStructures/ControlSignatureSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/ControlStructures/ControlSignatureSniff.php0000644000076700000240000002306412647543456033532 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Verifies that control statements conform to their coding standards. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_ControlStructures_ControlSignatureSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return int[] */ public function register() { return array( T_TRY, T_CATCH, T_DO, T_WHILE, T_FOR, T_IF, T_FOREACH, T_ELSE, T_ELSEIF, T_SWITCH, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[($stackPtr + 1)]) === false) { return; } // Single space after the keyword. $found = 1; if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE) { $found = 0; } else if ($tokens[($stackPtr + 1)]['content'] !== ' ') { if (strpos($tokens[($stackPtr + 1)]['content'], $phpcsFile->eolChar) !== false) { $found = 'newline'; } else { $found = strlen($tokens[($stackPtr + 1)]['content']); } } if ($found !== 1) { $error = 'Expected 1 space after %s keyword; %s found'; $data = array( strtoupper($tokens[$stackPtr]['content']), $found, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterKeyword', $data); if ($fix === true) { if ($found === 0) { $phpcsFile->fixer->addContent($stackPtr, ' '); } else { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' '); } } } // Single space after closing parenthesis. if (isset($tokens[$stackPtr]['parenthesis_closer']) === true && isset($tokens[$stackPtr]['scope_opener']) === true ) { $closer = $tokens[$stackPtr]['parenthesis_closer']; $opener = $tokens[$stackPtr]['scope_opener']; $content = $phpcsFile->getTokensAsString(($closer + 1), ($opener - $closer - 1)); if ($content !== ' ') { $error = 'Expected 1 space after closing parenthesis; found %s'; if (trim($content) === '') { $found = strlen($content); } else { $found = '"'.str_replace($phpcsFile->eolChar, '\n', $content).'"'; } $fix = $phpcsFile->addFixableError($error, $closer, 'SpaceAfterCloseParenthesis', array($found)); if ($fix === true) { if ($closer === ($opener - 1)) { $phpcsFile->fixer->addContent($closer, ' '); } else { $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->addContent($closer, ' '.$tokens[$opener]['content']); $phpcsFile->fixer->replaceToken($opener, ''); if ($tokens[$opener]['line'] !== $tokens[$closer]['line']) { $next = $phpcsFile->findNext(T_WHITESPACE, ($opener + 1), null, true); if ($tokens[$next]['line'] !== $tokens[$opener]['line']) { for ($i = ($opener + 1); $i < $next; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } } } $phpcsFile->fixer->endChangeset(); } } }//end if }//end if // Single newline after opening brace. if (isset($tokens[$stackPtr]['scope_opener']) === true) { $opener = $tokens[$stackPtr]['scope_opener']; for ($next = ($opener + 1); $next < $phpcsFile->numTokens; $next++) { $code = $tokens[$next]['code']; if ($code === T_WHITESPACE || ($code === T_INLINE_HTML && trim($tokens[$next]['content']) === '') ) { continue; } // Skip all empty tokens on the same line as the opener. if ($tokens[$next]['line'] === $tokens[$opener]['line'] && (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$code]) === true || $code === T_CLOSE_TAG) ) { continue; } // We found the first bit of a code, or a comment on the // following line. break; }//end for if ($tokens[$next]['line'] === $tokens[$opener]['line']) { $error = 'Newline required after opening brace'; $fix = $phpcsFile->addFixableError($error, $opener, 'NewlineAfterOpenBrace'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($opener + 1); $i < $next; $i++) { if (trim($tokens[$i]['content']) !== '') { break; } // Remove whitespace. $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->addContent($opener, $phpcsFile->eolChar); $phpcsFile->fixer->endChangeset(); } }//end if } else if ($tokens[$stackPtr]['code'] === T_WHILE) { // Zero spaces after parenthesis closer. $closer = $tokens[$stackPtr]['parenthesis_closer']; $found = 0; if ($tokens[($closer + 1)]['code'] === T_WHITESPACE) { if (strpos($tokens[($closer + 1)]['content'], $phpcsFile->eolChar) !== false) { $found = 'newline'; } else { $found = strlen($tokens[($closer + 1)]['content']); } } if ($found !== 0) { $error = 'Expected 0 spaces before semicolon; %s found'; $data = array($found); $fix = $phpcsFile->addFixableError($error, $closer, 'SpaceBeforeSemicolon', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($closer + 1), ''); } } }//end if // Only want to check multi-keyword structures from here on. if ($tokens[$stackPtr]['code'] === T_DO) { if (isset($tokens[$stackPtr]['scope_closer']) === false) { return; } $closer = $tokens[$stackPtr]['scope_closer']; } else if ($tokens[$stackPtr]['code'] === T_ELSE || $tokens[$stackPtr]['code'] === T_ELSEIF || $tokens[$stackPtr]['code'] === T_CATCH ) { $closer = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); if ($closer === false || $tokens[$closer]['code'] !== T_CLOSE_CURLY_BRACKET) { return; } } else { return; } // Single space after closing brace. $found = 1; if ($tokens[($closer + 1)]['code'] !== T_WHITESPACE) { $found = 0; } else if ($tokens[($closer + 1)]['content'] !== ' ') { if (strpos($tokens[($closer + 1)]['content'], $phpcsFile->eolChar) !== false) { $found = 'newline'; } else { $found = strlen($tokens[($closer + 1)]['content']); } } if ($found !== 1) { $error = 'Expected 1 space after closing brace; %s found'; $data = array($found); $fix = $phpcsFile->addFixableError($error, $closer, 'SpaceAfterCloseBrace', $data); if ($fix === true) { if ($found === 0) { $phpcsFile->fixer->addContent($closer, ' '); } else { $phpcsFile->fixer->replaceToken(($closer + 1), ' '); } } } }//end process() }//end class ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/ControlStructures/ElseIfDeclarationSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/ControlStructures/ElseIfDeclarationSniff.ph0000644000076700000240000000376412647543456033372 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_ControlStructures_ElseIfDeclarationSniff. * * Verifies that there are not elseif statements. The else and the if should * be separated by a space. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_ControlStructures_ElseIfDeclarationSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_ELSEIF); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $error = 'Usage of ELSEIF not allowed; use ELSE IF instead'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NotAllowed'); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, 'else if'); } }//end process() }//end class ././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/ControlStructures/ForEachLoopDeclarationSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/ControlStructures/ForEachLoopDeclarationSni0000644000076700000240000002442712647543456033441 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_ControlStructures_ForEachLoopDeclarationSniff. * * Verifies that there is a space between each condition of foreach loops. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_ControlStructures_ForEachLoopDeclarationSniff implements PHP_CodeSniffer_Sniff { /** * How many spaces should follow the opening bracket. * * @var int */ public $requiredSpacesAfterOpen = 0; /** * How many spaces should precede the closing bracket. * * @var int */ public $requiredSpacesBeforeClose = 0; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_FOREACH); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $this->requiredSpacesAfterOpen = (int) $this->requiredSpacesAfterOpen; $this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose; $tokens = $phpcsFile->getTokens(); $openingBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr); if ($openingBracket === false) { $error = 'Possible parse error: FOREACH has no opening parenthesis'; $phpcsFile->addWarning($error, $stackPtr, 'MissingOpenParenthesis'); return; } if (isset($tokens[$openingBracket]['parenthesis_closer']) === false) { $error = 'Possible parse error: FOREACH has no closing parenthesis'; $phpcsFile->addWarning($error, $stackPtr, 'MissingCloseParenthesis'); return; } $closingBracket = $tokens[$openingBracket]['parenthesis_closer']; if ($this->requiredSpacesAfterOpen === 0 && $tokens[($openingBracket + 1)]['code'] === T_WHITESPACE) { $error = 'Space found after opening bracket of FOREACH loop'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceAfterOpen'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($openingBracket + 1), ''); } } else if ($this->requiredSpacesAfterOpen > 0) { $spaceAfterOpen = 0; if ($tokens[($openingBracket + 1)]['code'] === T_WHITESPACE) { $spaceAfterOpen = strlen($tokens[($openingBracket + 1)]['content']); } if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) { $error = 'Expected %s spaces after opening bracket; %s found'; $data = array( $this->requiredSpacesAfterOpen, $spaceAfterOpen, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterOpen', $data); if ($fix === true) { $padding = str_repeat(' ', $this->requiredSpacesAfterOpen); if ($spaceAfterOpen === 0) { $phpcsFile->fixer->addContent($openingBracket, $padding); } else { $phpcsFile->fixer->replaceToken(($openingBracket + 1), $padding); } } } }//end if if ($this->requiredSpacesBeforeClose === 0 && $tokens[($closingBracket - 1)]['code'] === T_WHITESPACE) { $error = 'Space found before closing bracket of FOREACH loop'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeClose'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($closingBracket - 1), ''); } } else if ($this->requiredSpacesBeforeClose > 0) { $spaceBeforeClose = 0; if ($tokens[($closingBracket - 1)]['code'] === T_WHITESPACE) { $spaceBeforeClose = strlen($tokens[($closingBracket - 1)]['content']); } if ($spaceBeforeClose !== $this->requiredSpacesBeforeClose) { $error = 'Expected %s spaces before closing bracket; %s found'; $data = array( $this->requiredSpacesBeforeClose, $spaceBeforeClose, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceBeforeClose', $data); if ($fix === true) { $padding = str_repeat(' ', $this->requiredSpacesBeforeClose); if ($spaceBeforeClose === 0) { $phpcsFile->fixer->addContentBefore($closingBracket, $padding); } else { $phpcsFile->fixer->replaceToken(($closingBracket - 1), $padding); } } } }//end if $asToken = $phpcsFile->findNext(T_AS, $openingBracket); if ($asToken === false) { $error = 'Possible parse error: FOREACH has no AS statement'; $phpcsFile->addWarning($error, $stackPtr, 'MissingAs'); return; } $content = $tokens[$asToken]['content']; if ($content !== strtolower($content)) { $expected = strtolower($content); $error = 'AS keyword must be lowercase; expected "%s" but found "%s"'; $data = array( $expected, $content, ); $fix = $phpcsFile->addFixableError($error, $asToken, 'AsNotLower', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($asToken, $expected); } } $doubleArrow = $phpcsFile->findNext(T_DOUBLE_ARROW, $asToken, $closingBracket); if ($doubleArrow !== false) { if ($tokens[($doubleArrow - 1)]['code'] !== T_WHITESPACE) { $error = 'Expected 1 space before "=>"; 0 found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBeforeArrow'); if ($fix === true) { $phpcsFile->fixer->addContentBefore($doubleArrow, ' '); } } else { if (strlen($tokens[($doubleArrow - 1)]['content']) !== 1) { $spaces = strlen($tokens[($doubleArrow - 1)]['content']); $error = 'Expected 1 space before "=>"; %s found'; $data = array($spaces); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeArrow', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($doubleArrow - 1), ' '); } } } if ($tokens[($doubleArrow + 1)]['code'] !== T_WHITESPACE) { $error = 'Expected 1 space after "=>"; 0 found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfterArrow'); if ($fix === true) { $phpcsFile->fixer->addContent($doubleArrow, ' '); } } else { if (strlen($tokens[($doubleArrow + 1)]['content']) !== 1) { $spaces = strlen($tokens[($doubleArrow + 1)]['content']); $error = 'Expected 1 space after "=>"; %s found'; $data = array($spaces); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterArrow', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($doubleArrow + 1), ' '); } } } }//end if if ($tokens[($asToken - 1)]['code'] !== T_WHITESPACE) { $error = 'Expected 1 space before "as"; 0 found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBeforeAs'); if ($fix === true) { $phpcsFile->fixer->addContentBefore($asToken, ' '); } } else { if (strlen($tokens[($asToken - 1)]['content']) !== 1) { $spaces = strlen($tokens[($asToken - 1)]['content']); $error = 'Expected 1 space before "as"; %s found'; $data = array($spaces); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeAs', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($asToken - 1), ' '); } } } if ($tokens[($asToken + 1)]['code'] !== T_WHITESPACE) { $error = 'Expected 1 space after "as"; 0 found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfterAs'); if ($fix === true) { $phpcsFile->fixer->addContent($asToken, ' '); } } else { if (strlen($tokens[($asToken + 1)]['content']) !== 1) { $spaces = strlen($tokens[($asToken + 1)]['content']); $error = 'Expected 1 space after "as"; %s found'; $data = array($spaces); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterAs', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($asToken + 1), ' '); } } } }//end process() }//end class ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/ControlStructures/ForLoopDeclarationSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/ControlStructures/ForLoopDeclarationSniff.p0000644000076700000240000002341012647543456033421 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_ControlStructures_ForLoopDeclarationSniff. * * Verifies that there is a space between each condition of for loops. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_ControlStructures_ForLoopDeclarationSniff implements PHP_CodeSniffer_Sniff { /** * How many spaces should follow the opening bracket. * * @var int */ public $requiredSpacesAfterOpen = 0; /** * How many spaces should precede the closing bracket. * * @var int */ public $requiredSpacesBeforeClose = 0; /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_FOR); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $this->requiredSpacesAfterOpen = (int) $this->requiredSpacesAfterOpen; $this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose; $tokens = $phpcsFile->getTokens(); $openingBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr); if ($openingBracket === false) { $error = 'Possible parse error: no opening parenthesis for FOR keyword'; $phpcsFile->addWarning($error, $stackPtr, 'NoOpenBracket'); return; } $closingBracket = $tokens[$openingBracket]['parenthesis_closer']; if ($this->requiredSpacesAfterOpen === 0 && $tokens[($openingBracket + 1)]['code'] === T_WHITESPACE) { $error = 'Space found after opening bracket of FOR loop'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterOpen'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($openingBracket + 1), ''); } } else if ($this->requiredSpacesAfterOpen > 0) { $spaceAfterOpen = 0; if ($tokens[($openingBracket + 1)]['code'] === T_WHITESPACE) { $spaceAfterOpen = strlen($tokens[($openingBracket + 1)]['content']); } if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) { $error = 'Expected %s spaces after opening bracket; %s found'; $data = array( $this->requiredSpacesAfterOpen, $spaceAfterOpen, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterOpen', $data); if ($fix === true) { $padding = str_repeat(' ', $this->requiredSpacesAfterOpen); if ($spaceAfterOpen === 0) { $phpcsFile->fixer->addContent($openingBracket, $padding); } else { $phpcsFile->fixer->replaceToken(($openingBracket + 1), $padding); } } } }//end if if ($this->requiredSpacesBeforeClose === 0 && $tokens[($closingBracket - 1)]['code'] === T_WHITESPACE) { $error = 'Space found before closing bracket of FOR loop'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeClose'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($closingBracket - 1), ''); } } else if ($this->requiredSpacesBeforeClose > 0) { $spaceBeforeClose = 0; if ($tokens[($closingBracket - 1)]['code'] === T_WHITESPACE) { $spaceBeforeClose = strlen($tokens[($closingBracket - 1)]['content']); } if ($this->requiredSpacesBeforeClose !== $spaceBeforeClose) { $error = 'Expected %s spaces before closing bracket; %s found'; $data = array( $this->requiredSpacesBeforeClose, $spaceBeforeClose, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeClose', $data); if ($fix === true) { $padding = str_repeat(' ', $this->requiredSpacesBeforeClose); if ($spaceBeforeClose === 0) { $phpcsFile->fixer->addContentBefore($closingBracket, $padding); } else { $phpcsFile->fixer->replaceToken(($closingBracket - 1), $padding); } } } }//end if $firstSemicolon = $phpcsFile->findNext(T_SEMICOLON, $openingBracket, $closingBracket); // Check whitespace around each of the tokens. if ($firstSemicolon !== false) { if ($tokens[($firstSemicolon - 1)]['code'] === T_WHITESPACE) { $error = 'Space found before first semicolon of FOR loop'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeFirst'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($firstSemicolon - 1), ''); } } if ($tokens[($firstSemicolon + 1)]['code'] !== T_WHITESPACE && $tokens[($firstSemicolon + 1)]['code'] !== T_SEMICOLON ) { $error = 'Expected 1 space after first semicolon of FOR loop; 0 found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfterFirst'); if ($fix === true) { $phpcsFile->fixer->addContent($firstSemicolon, ' '); } } else { if (strlen($tokens[($firstSemicolon + 1)]['content']) !== 1) { $spaces = strlen($tokens[($firstSemicolon + 1)]['content']); $error = 'Expected 1 space after first semicolon of FOR loop; %s found'; $data = array($spaces); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterFirst', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($firstSemicolon + 1), ' '); } } } $secondSemicolon = $phpcsFile->findNext(T_SEMICOLON, ($firstSemicolon + 1)); if ($secondSemicolon !== false) { if ($tokens[($secondSemicolon - 1)]['code'] === T_WHITESPACE && $tokens[($firstSemicolon + 1)]['code'] !== T_SEMICOLON ) { $error = 'Space found before second semicolon of FOR loop'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeSecond'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($secondSemicolon - 1), ''); } } if (($secondSemicolon + 1) !== $closingBracket && $tokens[($secondSemicolon + 1)]['code'] !== T_WHITESPACE ) { $error = 'Expected 1 space after second semicolon of FOR loop; 0 found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfterSecond'); if ($fix === true) { $phpcsFile->fixer->addContent($secondSemicolon, ' '); } } else { if (strlen($tokens[($secondSemicolon + 1)]['content']) !== 1) { $spaces = strlen($tokens[($secondSemicolon + 1)]['content']); $data = array($spaces); if (($secondSemicolon + 2) === $closingBracket) { $error = 'Expected no space after second semicolon of FOR loop; %s found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterSecondNoThird', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($secondSemicolon + 1), ''); } } else { $error = 'Expected 1 space after second semicolon of FOR loop; %s found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterSecond', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($secondSemicolon + 1), ' '); } } } }//end if }//end if }//end if }//end process() }//end class ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/ControlStructures/InlineIfDeclarationSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/ControlStructures/InlineIfDeclarationSniff.0000644000076700000240000001234112647543456033357 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_ControlStructures_InlineIfDeclarationSniff. * * Tests the spacing of shorthand IF statements. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_ControlStructures_InlineIfDeclarationSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_INLINE_THEN); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $openBracket = null; $closeBracket = null; if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) { $parens = $tokens[$stackPtr]['nested_parenthesis']; $openBracket = array_pop($parens); $closeBracket = $tokens[$openBracket]['parenthesis_closer']; } // Find the beginning of the statement. If we don't find a // semicolon (end of statement) or comma (end of array value) // then assume the content before the closing parenthesis is the end. $else = $phpcsFile->findNext(T_INLINE_ELSE, ($stackPtr + 1)); $statementEnd = $phpcsFile->findNext(array(T_SEMICOLON, T_COMMA), ($else + 1), $closeBracket); if ($statementEnd === false) { $statementEnd = $phpcsFile->findPrevious(T_WHITESPACE, ($closeBracket - 1), null, true); } // Make sure it's all on the same line. if ($tokens[$statementEnd]['line'] !== $tokens[$stackPtr]['line']) { $error = 'Inline shorthand IF statement must be declared on a single line'; $phpcsFile->addError($error, $stackPtr, 'NotSingleLine'); return; } // Make sure there are spaces around the question mark. $contentBefore = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); $contentAfter = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$contentBefore]['code'] !== T_CLOSE_PARENTHESIS) { $error = 'Inline shorthand IF statement requires brackets around comparison'; $phpcsFile->addError($error, $stackPtr, 'NoBrackets'); return; } $spaceBefore = ($tokens[$stackPtr]['column'] - ($tokens[$contentBefore]['column'] + strlen($tokens[$contentBefore]['content']))); if ($spaceBefore !== 1) { $error = 'Inline shorthand IF statement requires 1 space before THEN; %s found'; $data = array($spaceBefore); $phpcsFile->addError($error, $stackPtr, 'SpacingBeforeThen', $data); } $spaceAfter = (($tokens[$contentAfter]['column']) - ($tokens[$stackPtr]['column'] + 1)); if ($spaceAfter !== 1) { $error = 'Inline shorthand IF statement requires 1 space after THEN; %s found'; $data = array($spaceAfter); $phpcsFile->addError($error, $stackPtr, 'SpacingAfterThen', $data); } // Make sure the ELSE has the correct spacing. $inlineElse = $phpcsFile->findNext(T_INLINE_ELSE, ($stackPtr + 1), $statementEnd, false); $contentBefore = $phpcsFile->findPrevious(T_WHITESPACE, ($inlineElse - 1), null, true); $contentAfter = $phpcsFile->findNext(T_WHITESPACE, ($inlineElse + 1), null, true); $spaceBefore = ($tokens[$inlineElse]['column'] - ($tokens[$contentBefore]['column'] + strlen($tokens[$contentBefore]['content']))); if ($spaceBefore !== 1) { $error = 'Inline shorthand IF statement requires 1 space before ELSE; %s found'; $data = array($spaceBefore); $phpcsFile->addError($error, $inlineElse, 'SpacingBeforeElse', $data); } $spaceAfter = (($tokens[$contentAfter]['column']) - ($tokens[$inlineElse]['column'] + 1)); if ($spaceAfter !== 1) { $error = 'Inline shorthand IF statement requires 1 space after ELSE; %s found'; $data = array($spaceAfter); $phpcsFile->addError($error, $inlineElse, 'SpacingAfterElse', $data); } }//end process() }//end class ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/ControlStructures/LowercaseDeclarationSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/ControlStructures/LowercaseDeclarationSniff0000644000076700000240000000510012647543456033523 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_ControlStructures_LowercaseDeclarationSniff. * * Ensures all control structure keywords are lowercase. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_ControlStructures_LowercaseDeclarationSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_IF, T_ELSE, T_ELSEIF, T_FOREACH, T_FOR, T_DO, T_SWITCH, T_WHILE, T_TRY, T_CATCH, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $content = $tokens[$stackPtr]['content']; if ($content !== strtolower($content)) { $error = '%s keyword must be lowercase; expected "%s" but found "%s"'; $data = array( strtoupper($content), strtolower($content), $content, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'FoundUppercase', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, strtolower($content)); } } }//end process() }//end class ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/ControlStructures/SwitchDeclarationSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/ControlStructures/SwitchDeclarationSniff.ph0000644000076700000240000003400012647543456033447 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_ControlStructures_SwitchDeclarationSniff. * * Ensures all the breaks and cases are aligned correctly according to their * parent switch's alignment and enforces other switch formatting. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_ControlStructures_SwitchDeclarationSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * The number of spaces code should be indented. * * @var int */ public $indent = 4; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_SWITCH); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // We can't process SWITCH statements unless we know where they start and end. if (isset($tokens[$stackPtr]['scope_opener']) === false || isset($tokens[$stackPtr]['scope_closer']) === false ) { return; } $switch = $tokens[$stackPtr]; $nextCase = $stackPtr; $caseAlignment = ($switch['column'] + $this->indent); $caseCount = 0; $foundDefault = false; while (($nextCase = $phpcsFile->findNext(array(T_CASE, T_DEFAULT, T_SWITCH), ($nextCase + 1), $switch['scope_closer'])) !== false) { // Skip nested SWITCH statements; they are handled on their own. if ($tokens[$nextCase]['code'] === T_SWITCH) { $nextCase = $tokens[$nextCase]['scope_closer']; continue; } if ($tokens[$nextCase]['code'] === T_DEFAULT) { $type = 'Default'; $foundDefault = true; } else { $type = 'Case'; $caseCount++; } if ($tokens[$nextCase]['content'] !== strtolower($tokens[$nextCase]['content'])) { $expected = strtolower($tokens[$nextCase]['content']); $error = strtoupper($type).' keyword must be lowercase; expected "%s" but found "%s"'; $data = array( $expected, $tokens[$nextCase]['content'], ); $fix = $phpcsFile->addFixableError($error, $nextCase, $type.'NotLower', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($nextCase, $expected); } } if ($tokens[$nextCase]['column'] !== $caseAlignment) { $error = strtoupper($type).' keyword must be indented '.$this->indent.' spaces from SWITCH keyword'; $fix = $phpcsFile->addFixableError($error, $nextCase, $type.'Indent'); if ($fix === true) { $padding = str_repeat(' ', ($caseAlignment - 1)); if ($tokens[$nextCase]['column'] === 1 || $tokens[($nextCase - 1)]['code'] !== T_WHITESPACE ) { $phpcsFile->fixer->addContentBefore($nextCase, $padding); } else { $phpcsFile->fixer->replaceToken(($nextCase - 1), $padding); } } } if ($type === 'Case' && ($tokens[($nextCase + 1)]['type'] !== 'T_WHITESPACE' || $tokens[($nextCase + 1)]['content'] !== ' ') ) { $error = 'CASE keyword must be followed by a single space'; $fix = $phpcsFile->addFixableError($error, $nextCase, 'SpacingAfterCase'); if ($fix === true) { if ($tokens[($nextCase + 1)]['type'] !== 'T_WHITESPACE') { $phpcsFile->fixer->addContent($nextCase, ' '); } else { $phpcsFile->fixer->replaceToken(($nextCase + 1), ' '); } } } if (isset($tokens[$nextCase]['scope_opener']) === false) { $error = 'Possible parse error: CASE missing opening colon'; $phpcsFile->addWarning($error, $nextCase, 'MissingColon'); continue; } $opener = $tokens[$nextCase]['scope_opener']; if ($tokens[($opener - 1)]['type'] === 'T_WHITESPACE') { $error = 'There must be no space before the colon in a '.strtoupper($type).' statement'; $fix = $phpcsFile->addFixableError($error, $nextCase, 'SpaceBeforeColon'.$type); if ($fix === true) { $phpcsFile->fixer->replaceToken(($opener - 1), ''); } } $nextBreak = $tokens[$nextCase]['scope_closer']; if ($tokens[$nextBreak]['code'] === T_BREAK || $tokens[$nextBreak]['code'] === T_RETURN || $tokens[$nextBreak]['code'] === T_CONTINUE || $tokens[$nextBreak]['code'] === T_THROW || $tokens[$nextBreak]['code'] === T_EXIT ) { if ($tokens[$nextBreak]['scope_condition'] === $nextCase) { // Only need to check a couple of things once, even if the // break is shared between multiple case statements, or even // the default case. if ($tokens[$nextBreak]['column'] !== $caseAlignment) { $error = 'Case breaking statement must be indented '.$this->indent.' spaces from SWITCH keyword'; $fix = $phpcsFile->addFixableError($error, $nextBreak, 'BreakIndent'); if ($fix === true) { $padding = str_repeat(' ', ($caseAlignment - 1)); if ($tokens[$nextBreak]['column'] === 1 || $tokens[($nextBreak - 1)]['code'] !== T_WHITESPACE ) { $phpcsFile->fixer->addContentBefore($nextBreak, $padding); } else { $phpcsFile->fixer->replaceToken(($nextBreak - 1), $padding); } } } $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($nextBreak - 1), $stackPtr, true); if ($tokens[$prev]['line'] !== ($tokens[$nextBreak]['line'] - 1)) { $error = 'Blank lines are not allowed before case breaking statements'; $phpcsFile->addError($error, $nextBreak, 'SpacingBeforeBreak'); } $nextLine = $tokens[$tokens[$stackPtr]['scope_closer']]['line']; $semicolon = $phpcsFile->findEndOfStatement($nextBreak); for ($i = ($semicolon + 1); $i < $tokens[$stackPtr]['scope_closer']; $i++) { if ($tokens[$i]['type'] !== 'T_WHITESPACE') { $nextLine = $tokens[$i]['line']; break; } } if ($type === 'Case') { // Ensure the BREAK statement is followed by // a single blank line, or the end switch brace. if ($nextLine !== ($tokens[$semicolon]['line'] + 2) && $i !== $tokens[$stackPtr]['scope_closer']) { $error = 'Case breaking statements must be followed by a single blank line'; $fix = $phpcsFile->addFixableError($error, $nextBreak, 'SpacingAfterBreak'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($semicolon + 1); $i <= $tokens[$stackPtr]['scope_closer']; $i++) { if ($tokens[$i]['line'] === $nextLine) { $phpcsFile->fixer->addNewlineBefore($i); break; } if ($tokens[$i]['line'] === $tokens[$semicolon]['line']) { continue; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } }//end if } else { // Ensure the BREAK statement is not followed by a blank line. if ($nextLine !== ($tokens[$semicolon]['line'] + 1)) { $error = 'Blank lines are not allowed after the DEFAULT case\'s breaking statement'; $phpcsFile->addError($error, $nextBreak, 'SpacingAfterDefaultBreak'); } }//end if $caseLine = $tokens[$nextCase]['line']; $nextLine = $tokens[$nextBreak]['line']; for ($i = ($opener + 1); $i < $nextBreak; $i++) { if ($tokens[$i]['type'] !== 'T_WHITESPACE') { $nextLine = $tokens[$i]['line']; break; } } if ($nextLine !== ($caseLine + 1)) { $error = 'Blank lines are not allowed after '.strtoupper($type).' statements'; $phpcsFile->addError($error, $nextCase, 'SpacingAfter'.$type); } }//end if if ($tokens[$nextBreak]['code'] === T_BREAK) { if ($type === 'Case') { // Ensure empty CASE statements are not allowed. // They must have some code content in them. A comment is not enough. // But count RETURN statements as valid content if they also // happen to close the CASE statement. $foundContent = false; for ($i = ($tokens[$nextCase]['scope_opener'] + 1); $i < $nextBreak; $i++) { if ($tokens[$i]['code'] === T_CASE) { $i = $tokens[$i]['scope_opener']; continue; } if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$i]['code']]) === false) { $foundContent = true; break; } } if ($foundContent === false) { $error = 'Empty CASE statements are not allowed'; $phpcsFile->addError($error, $nextCase, 'EmptyCase'); } } else { // Ensure empty DEFAULT statements are not allowed. // They must (at least) have a comment describing why // the default case is being ignored. $foundContent = false; for ($i = ($tokens[$nextCase]['scope_opener'] + 1); $i < $nextBreak; $i++) { if ($tokens[$i]['type'] !== 'T_WHITESPACE') { $foundContent = true; break; } } if ($foundContent === false) { $error = 'Comment required for empty DEFAULT case'; $phpcsFile->addError($error, $nextCase, 'EmptyDefault'); } }//end if }//end if } else if ($type === 'Default') { $error = 'DEFAULT case must have a breaking statement'; $phpcsFile->addError($error, $nextCase, 'DefaultNoBreak'); }//end if }//end while if ($foundDefault === false) { $error = 'All SWITCH statements must contain a DEFAULT case'; $phpcsFile->addError($error, $stackPtr, 'MissingDefault'); } if ($tokens[$switch['scope_closer']]['column'] !== $switch['column']) { $error = 'Closing brace of SWITCH statement must be aligned with SWITCH keyword'; $phpcsFile->addError($error, $switch['scope_closer'], 'CloseBraceAlign'); } if ($caseCount === 0) { $error = 'SWITCH statements must contain at least one CASE statement'; $phpcsFile->addError($error, $stackPtr, 'MissingCase'); } }//end process() }//end class ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/ClassDefinitionClosingBraceSpaceSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/ClassDefinitionClosingBraceSpaceSniff.p0000644000076700000240000001004012647543456033100 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_ClassDefinitionClosingBraceSpaceSniff. * * Ensure there is a single blank line after the closing brace of a class definition. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_ClassDefinitionClosingBraceSpaceSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_CLOSE_CURLY_BRACKET); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($next === false) { return; } if ($tokens[$next]['code'] !== T_CLOSE_TAG) { $found = (($tokens[$next]['line'] - $tokens[$stackPtr]['line']) - 1); if ($found !== 1) { $error = 'Expected one blank line after closing brace of class definition; %s found'; $data = array($found); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterClose', $data); if ($fix === true) { if ($found === 0) { $phpcsFile->fixer->addNewline($stackPtr); } else { $nextContent = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); $phpcsFile->fixer->beginChangeset(); for ($i = ($stackPtr + 1); $i < ($nextContent - 1); $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->addNewline($i); $phpcsFile->fixer->endChangeset(); } } }//end if }//end if // Ignore nested style definitions from here on. The spacing before the closing brace // (a single blank line) will be enforced by the above check, which ensures there is a // blank line after the last nested class. $found = $phpcsFile->findPrevious( T_CLOSE_CURLY_BRACKET, ($stackPtr - 1), $tokens[$stackPtr]['bracket_opener'] ); if ($found !== false) { return; } $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); if ($prev === false) { return; } if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) { $error = 'Closing brace of class definition must be on new line'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'ContentBeforeClose'); if ($fix === true) { $phpcsFile->fixer->addNewlineBefore($stackPtr); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/ClassDefinitionNameSpacingSniff.php0000644000076700000240000000725312647543456032322 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_ClassDefinitionNameSpacingSniff. * * Ensure there are no blank lines between the names of classes/IDs. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_ClassDefinitionNameSpacingSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_OPEN_CURLY_BRACKET); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Do not check nested style definitions as, for example, in @media style rules. $nested = $phpcsFile->findNext(T_OPEN_CURLY_BRACKET, ($stackPtr + 1), $tokens[$stackPtr]['bracket_closer']); if ($nested !== false) { return; } // Find the first blank line before this opening brace, unless we get // to another style definition, comment or the start of the file. $endTokens = array( T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET, T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET, T_OPEN_TAG => T_OPEN_TAG, ); $endTokens += PHP_CodeSniffer_Tokens::$commentTokens; $foundContent = false; $currentLine = $tokens[$stackPtr]['line']; for ($i = ($stackPtr - 1); $i >= 0; $i--) { if (isset($endTokens[$tokens[$i]['code']]) === true) { break; } if ($tokens[$i]['line'] === $currentLine) { if ($tokens[$i]['code'] !== T_WHITESPACE) { $foundContent = true; } continue; } // We changed lines. if ($foundContent === false) { // Before we throw an error, make sure we are not looking // at a gap before the style definition. $prev = $phpcsFile->findPrevious(T_WHITESPACE, $i, null, true); if ($prev !== false && isset($endTokens[$tokens[$prev]['code']]) === false ) { $error = 'Blank lines are not allowed between class names'; $phpcsFile->addError($error, ($i + 1), 'BlankLinesFound'); } break; } $foundContent = false; $currentLine = $tokens[$i]['line']; }//end for }//end process() }//end class ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/ClassDefinitionOpeningBraceSpaceSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/ClassDefinitionOpeningBraceSpaceSniff.p0000644000076700000240000001150412647543456033107 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_ClassDefinitionOpeningBraceSpaceSniff. * * Ensure there is a single space before the opening brace in a class definition * and the content starts on the next line. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_ClassDefinitionOpeningBraceSpaceSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_OPEN_CURLY_BRACKET); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[($stackPtr - 1)]['code'] !== T_WHITESPACE) { $error = 'Expected 1 space before opening brace of class definition; 0 found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoneBefore'); if ($fix === true) { $phpcsFile->fixer->addContentBefore($stackPtr, ' '); } } else { $content = $tokens[($stackPtr - 1)]['content']; if ($content !== ' ') { $length = strlen($content); if ($length === 1) { $length = 'tab'; } $error = 'Expected 1 space before opening brace of class definition; %s found'; $data = array($length); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Before', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr - 1), ' '); } } }//end if $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true); if ($next === false) { return; } // Check for nested class definitions. $nested = false; $found = $phpcsFile->findNext( T_OPEN_CURLY_BRACKET, ($stackPtr + 1), $tokens[$stackPtr]['bracket_closer'] ); if ($found !== false) { $nested = true; } if ($tokens[$next]['line'] === $tokens[$stackPtr]['line']) { $error = 'Opening brace should be the last content on the line'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'ContentBefore'); if ($fix === true) { $phpcsFile->fixer->addNewline($stackPtr); } } else { $foundLines = ($tokens[$next]['line'] - $tokens[$stackPtr]['line'] - 1); if ($nested === true) { if ($foundLines !== 1) { $error = 'Expected 1 blank line after opening brace of nesting class definition; %s found'; $data = array($foundLines); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'AfterNesting', $data); if ($fix === true) { if ($foundLines === 0) { $phpcsFile->fixer->addNewline($stackPtr); } else { $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); $phpcsFile->fixer->beginChangeset(); for ($i = ($stackPtr + 1); $i < ($next + 1); $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->addNewline($stackPtr); $phpcsFile->fixer->endChangeset(); } } }//end if }//end if }//end if }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/ColonSpacingSniff.php0000644000076700000240000000757012647543456027517 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_ColonSpacingSniff. * * Ensure there is no space before a colon and one space after it. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_ColonSpacingSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_COLON); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); if ($tokens[$prev]['code'] !== T_STYLE) { // The colon is not part of a style definition. return; } if ($tokens[$prev]['content'] === 'progid') { // Special case for IE filters. return; } if ($tokens[($stackPtr - 1)]['code'] === T_WHITESPACE) { $error = 'There must be no space before a colon in a style definition'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Before'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr - 1), ''); } } if ($tokens[($stackPtr + 1)]['code'] === T_SEMICOLON) { // Empty style definition, ignore it. return; } if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE) { $error = 'Expected 1 space after colon in style definition; 0 found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoneAfter'); if ($fix === true) { $phpcsFile->fixer->addContent($stackPtr, ' '); } } else { $content = $tokens[($stackPtr + 1)]['content']; if (strpos($content, $phpcsFile->eolChar) === false) { $length = strlen($content); if ($length !== 1) { $error = 'Expected 1 space after colon in style definition; %s found'; $data = array($length); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'After', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' '); } } } else { $error = 'Expected 1 space after colon in style definition; newline found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'AfterNewline'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' '); } } }//end if }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/ColourDefinitionSniff.php0000644000076700000240000000575612647543456030420 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_ColourDefinitionSniff. * * Ensure colours are defined in upper-case and use shortcuts where possible. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_ColourDefinitionSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_COLOUR); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $colour = $tokens[$stackPtr]['content']; $expected = strtoupper($colour); if ($colour !== $expected) { $error = 'CSS colours must be defined in uppercase; expected %s but found %s'; $data = array( $expected, $colour, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NotUpper', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, $expected); } } // Now check if shorthand can be used. if (strlen($colour) !== 7) { return; } if ($colour{1} === $colour{2} && $colour{3} === $colour{4} && $colour{5} === $colour{6}) { $expected = '#'.$colour{1}.$colour{3}.$colour{5}; $error = 'CSS colours must use shorthand if available; expected %s but found %s'; $data = array( $expected, $colour, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Shorthand', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, $expected); } } }//end process() }//end class ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/DisallowMultipleStyleDefinitionsSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/DisallowMultipleStyleDefinitionsSniff.p0000644000076700000240000000454712647543456033320 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_DisallowMultipleStyleDefinitionsSniff. * * Ensure that each style definition is on a line by itself. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_DisallowMultipleStyleDefinitionsSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_STYLE); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $next = $phpcsFile->findNext(T_STYLE, ($stackPtr + 1)); if ($next === false) { return; } if ($tokens[$next]['content'] === 'progid') { // Special case for IE filters. return; } if ($tokens[$next]['line'] === $tokens[$stackPtr]['line']) { $error = 'Each style definition must be on a line by itself'; $fix = $phpcsFile->addFixableError($error, $next, 'Found'); if ($fix === true) { $phpcsFile->fixer->addNewlineBefore($next); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/DuplicateClassDefinitionSniff.php0000644000076700000240000000652512647543456032050 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_DuplicateClassDefinitionSniff. * * Check for duplicate class definitions that can be merged into one. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_DuplicateClassDefinitionSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Find the content of each class definition name. $classNames = array(); $next = $phpcsFile->findNext(T_OPEN_CURLY_BRACKET, ($stackPtr + 1)); if ($next === false) { // No class definitions in the file. return; } $find = array( T_CLOSE_CURLY_BRACKET, T_COMMENT, T_OPEN_TAG, ); while ($next !== false) { $prev = $phpcsFile->findPrevious($find, ($next - 1)); // Create a sorted name for the class so we can compare classes // even when the individual names are all over the place. $name = ''; for ($i = ($prev + 1); $i < $next; $i++) { $name .= $tokens[$i]['content']; } $name = trim($name); $name = str_replace("\n", ' ', $name); $name = preg_replace('|[\s]+|', ' ', $name); $name = str_replace(', ', ',', $name); $names = explode(',', $name); sort($names); $name = implode(',', $names); if (isset($classNames[$name]) === true) { $first = $classNames[$name]; $error = 'Duplicate class definition found; first defined on line %s'; $data = array($tokens[$first]['line']); $phpcsFile->addError($error, $next, 'Found', $data); } else { $classNames[$name] = $next; } $next = $phpcsFile->findNext(T_OPEN_CURLY_BRACKET, ($next + 1)); }//end while }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/DuplicateStyleDefinitionSniff.php0000644000076700000240000000544012647543456032076 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_DuplicateStyleDefinitionSniff. * * Check for duplicate style definitions in the same class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_DuplicateStyleDefinitionSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_OPEN_CURLY_BRACKET); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Find the content of each style definition name. $styleNames = array(); $next = $stackPtr; $end = $tokens[$stackPtr]['bracket_closer']; do { $next = $phpcsFile->findNext(array(T_STYLE, T_OPEN_CURLY_BRACKET), ($next + 1), $end); if ($next === false) { // Class definition is empty. break; } if ($tokens[$next]['code'] === T_OPEN_CURLY_BRACKET) { $next = $tokens[$next]['bracket_closer']; continue; } $name = $tokens[$next]['content']; if (isset($styleNames[$name]) === true) { $first = $styleNames[$name]; $error = 'Duplicate style definition found; first defined on line %s'; $data = array($tokens[$first]['line']); $phpcsFile->addError($error, $next, 'Found', $data); } else { $styleNames[$name] = $next; } } while ($next !== false); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/EmptyClassDefinitionSniff.php0000644000076700000240000000405512647543456031230 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_EmptyClassDefinitionSniff. * * Ensure that class definitions are not empty. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_EmptyClassDefinitionSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_OPEN_CURLY_BRACKET); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true); if ($next === false || $tokens[$next]['code'] === T_CLOSE_CURLY_BRACKET) { $error = 'Class definition is empty'; $phpcsFile->addError($error, $stackPtr, 'Found'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/EmptyStyleDefinitionSniff.php0000644000076700000240000000410712647543456031261 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_EmptyStyleDefinitionSniff. * * Ensure that style definitions are not empty. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_EmptyStyleDefinitionSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_STYLE); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $next = $phpcsFile->findNext(array(T_WHITESPACE, T_COLON), ($stackPtr + 1), null, true); if ($next === false || $tokens[$next]['code'] === T_SEMICOLON || $tokens[$next]['line'] !== $tokens[$stackPtr]['line']) { $error = 'Style definition is empty'; $phpcsFile->addError($error, $stackPtr, 'Found'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/ForbiddenStylesSniff.php0000644000076700000240000001366512647543456030242 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_ForbiddenStylesSniff. * * Bans the use of some styles, such as deprecated or browser-specific styles. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_ForbiddenStylesSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * A list of forbidden styles with their alternatives. * * The value is NULL if no alternative exists. i.e., the * function should just not be used. * * @var array(string => string|null) */ protected $forbiddenStyles = array( '-moz-border-radius' => 'border-radius', '-webkit-border-radius' => 'border-radius', '-moz-border-radius-topleft' => 'border-top-left-radius', '-moz-border-radius-topright' => 'border-top-right-radius', '-moz-border-radius-bottomright' => 'border-bottom-right-radius', '-moz-border-radius-bottomleft' => 'border-bottom-left-radius', '-moz-box-shadow' => 'box-shadow', '-webkit-box-shadow' => 'box-shadow', ); /** * A cache of forbidden style names, for faster lookups. * * @var array(string) */ protected $forbiddenStyleNames = array(); /** * If true, forbidden styles will be considered regular expressions. * * @var bool */ protected $patternMatch = false; /** * If true, an error will be thrown; otherwise a warning. * * @var bool */ public $error = true; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { $this->forbiddenStyleNames = array_keys($this->forbiddenStyles); if ($this->patternMatch === true) { foreach ($this->forbiddenStyleNames as $i => $name) { $this->forbiddenStyleNames[$i] = '/'.$name.'/i'; } } return array(T_STYLE); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $style = strtolower($tokens[$stackPtr]['content']); $pattern = null; if ($this->patternMatch === true) { $count = 0; $pattern = preg_replace( $this->forbiddenStyleNames, $this->forbiddenStyleNames, $style, 1, $count ); if ($count === 0) { return; } // Remove the pattern delimiters and modifier. $pattern = substr($pattern, 1, -2); } else { if (in_array($style, $this->forbiddenStyleNames) === false) { return; } }//end if $this->addError($phpcsFile, $stackPtr, $style, $pattern); }//end process() /** * Generates the error or warning for this sniff. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the forbidden style * in the token array. * @param string $style The name of the forbidden style. * @param string $pattern The pattern used for the match. * * @return void */ protected function addError($phpcsFile, $stackPtr, $style, $pattern=null) { $data = array($style); $error = 'The use of style %s is '; if ($this->error === true) { $type = 'Found'; $error .= 'forbidden'; } else { $type = 'Discouraged'; $error .= 'discouraged'; } if ($pattern === null) { $pattern = $style; } if ($this->forbiddenStyles[$pattern] !== null) { $data[] = $this->forbiddenStyles[$pattern]; if ($this->error === true) { $fix = $phpcsFile->addFixableError($error.'; use %s instead', $stackPtr, $type.'WithAlternative', $data); } else { $fix = $phpcsFile->addFixableWarning($error.'; use %s instead', $stackPtr, $type.'WithAlternative', $data); } if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, $this->forbiddenStyles[$pattern]); } } else { if ($this->error === true) { $phpcsFile->addError($error, $stackPtr, $type, $data); } else { $phpcsFile->addWarning($error, $stackPtr, $type, $data); } } }//end addError() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/IndentationSniff.php0000644000076700000240000001127012647543456027404 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_IndentationSniff. * * Ensures styles are indented 4 spaces. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_IndentationSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * The number of spaces code should be indented. * * @var int */ public $indent = 4; /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $numTokens = (count($tokens) - 2); $indentLevel = 0; $nestingLevel = 0; for ($i = 1; $i < $numTokens; $i++) { if ($tokens[$i]['code'] === T_COMMENT) { // Don't check the indent of comments. continue; } if ($tokens[$i]['code'] === T_OPEN_CURLY_BRACKET) { $indentLevel++; // Check for nested class definitions. $found = $phpcsFile->findNext( T_OPEN_CURLY_BRACKET, ($i + 1), $tokens[$i]['bracket_closer'] ); if ($found !== false) { $nestingLevel = $indentLevel; } } if (($tokens[$i]['code'] === T_CLOSE_CURLY_BRACKET && $tokens[$i]['line'] !== $tokens[($i - 1)]['line']) || ($tokens[($i + 1)]['code'] === T_CLOSE_CURLY_BRACKET && $tokens[$i]['line'] === $tokens[($i + 1)]['line']) ) { $indentLevel--; if ($indentLevel === 0) { $nestingLevel = 0; } } if ($tokens[$i]['column'] !== 1) { continue; } // We started a new line, so check indent. if ($tokens[$i]['code'] === T_WHITESPACE) { $content = str_replace($phpcsFile->eolChar, '', $tokens[$i]['content']); $foundIndent = strlen($content); } else { $foundIndent = 0; } $expectedIndent = ($indentLevel * $this->indent); if ($expectedIndent > 0 && strpos($tokens[$i]['content'], $phpcsFile->eolChar) !== false ) { if ($nestingLevel !== $indentLevel) { $error = 'Blank lines are not allowed in class definitions'; $fix = $phpcsFile->addFixableError($error, $i, 'BlankLine'); if ($fix === true) { $phpcsFile->fixer->replaceToken($i, ''); } } } else if ($foundIndent !== $expectedIndent) { $error = 'Line indented incorrectly; expected %s spaces, found %s'; $data = array( $expectedIndent, $foundIndent, ); $fix = $phpcsFile->addFixableError($error, $i, 'Incorrect', $data); if ($fix === true) { $indent = str_repeat(' ', $expectedIndent); if ($foundIndent === 0) { $phpcsFile->fixer->addContentBefore($i, $indent); } else { $phpcsFile->fixer->replaceToken($i, $indent); } } }//end if }//end for }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/LowercaseStyleDefinitionSniff.php0000644000076700000240000000644312647543456032114 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_LowercaseStyleDefinitionSniff. * * Ensure that all style definitions are in lowercase. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_LowercaseStyleDefinitionSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_OPEN_CURLY_BRACKET); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $start = ($stackPtr + 1); $end = ($tokens[$stackPtr]['bracket_closer'] - 1); $inStyle = null; for ($i = $start; $i <= $end; $i++) { // Skip nested definitions as they are checked individually. if ($tokens[$i]['code'] === T_OPEN_CURLY_BRACKET) { $i = $tokens[$i]['bracket_closer']; continue; } if ($tokens[$i]['code'] === T_STYLE) { $inStyle = $tokens[$i]['content']; } if ($tokens[$i]['code'] === T_SEMICOLON) { $inStyle = null; } if ($inStyle === 'progid') { // Special case for IE filters. continue; } if ($tokens[$i]['code'] === T_STYLE || ($inStyle !== null && $tokens[$i]['code'] === T_STRING) ) { $expected = strtolower($tokens[$i]['content']); if ($expected !== $tokens[$i]['content']) { $error = 'Style definitions must be lowercase; expected %s but found %s'; $data = array( $expected, $tokens[$i]['content'], ); $fix = $phpcsFile->addFixableError($error, $i, 'FoundUpper', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($i, $expected); } } } }//end for }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/MissingColonSniff.php0000644000076700000240000000572712647543456027546 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_MissingColonSniff. * * Ensure that all style definitions have a colon. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_MissingColonSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_OPEN_CURLY_BRACKET); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $lastLine = $tokens[$stackPtr]['line']; $end = $tokens[$stackPtr]['bracket_closer']; $endLine = $tokens[$end]['line']; // Do not check nested style definitions as, for example, in @media style rules. $nested = $phpcsFile->findNext(T_OPEN_CURLY_BRACKET, ($stackPtr + 1), $end); if ($nested !== false) { return; } $foundColon = false; $foundString = false; for ($i = ($stackPtr + 1); $i <= $end; $i++) { if ($tokens[$i]['line'] !== $lastLine) { // We changed lines. if ($foundColon === false && $foundString !== false) { // We didn't find a colon on the previous line. $error = 'No style definition found on line; check for missing colon'; $phpcsFile->addError($error, $foundString, 'Found'); } $foundColon = false; $foundString = false; $lastLine = $tokens[$i]['line']; } if ($tokens[$i]['code'] === T_STRING) { $foundString = $i; } else if ($tokens[$i]['code'] === T_COLON) { $foundColon = $i; } }//end for }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/NamedColoursSniff.php0000644000076700000240000000624012647543456027524 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_NamedColoursSniff. * * Ensure colour names are not used. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_NamedColoursSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * A list of named colours. * * This is the list of standard colours defined in the CSS spec. * * @var array */ public $colourNames = array( 'aqua' => 'aqua', 'black' => 'black', 'blue' => 'blue', 'fuchsia' => 'fuchsia', 'gray' => 'gray', 'green' => 'green', 'lime' => 'lime', 'maroon' => 'maroon', 'navy' => 'navy', 'olive' => 'olive', 'orange' => 'orange', 'purple' => 'purple', 'red' => 'red', 'silver' => 'silver', 'teal' => 'teal', 'white' => 'white', 'yellow' => 'yellow', ); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_STRING); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[($stackPtr - 1)]['code'] === T_HASH || $tokens[($stackPtr - 1)]['code'] === T_STRING_CONCAT ) { // Class name. return; } if (isset($this->colourNames[strtolower($tokens[$stackPtr]['content'])]) === true) { $error = 'Named colours are forbidden; use hex, rgb, or rgba values instead'; $phpcsFile->addError($error, $stackPtr, 'Forbidden'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/OpacitySniff.php0000644000076700000240000000712312647543456026542 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_OpacitySniff. * * Ensure that opacity values start with a 0 if it is not a whole number. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_OpacitySniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_STYLE); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[$stackPtr]['content'] !== 'opacity') { return; } $next = $phpcsFile->findNext(array(T_COLON, T_WHITESPACE), ($stackPtr + 1), null, true); if ($next === false || ($tokens[$next]['code'] !== T_DNUMBER && $tokens[$next]['code'] !== T_LNUMBER) ) { return; } $value = $tokens[$next]['content']; if ($tokens[$next]['code'] === T_LNUMBER) { if ($value !== '0' && $value !== '1') { $error = 'Opacity values must be between 0 and 1'; $phpcsFile->addError($error, $next, 'Invalid'); } } else { if (strlen($value) > 3) { $error = 'Opacity values must have a single value after the decimal point'; $phpcsFile->addError($error, $next, 'SpacingAfterPoint'); } else if ($value === '0.0' || $value === '1.0') { $error = 'Opacity value does not require decimal point; use %s instead'; $data = array($value{0}); $fix = $phpcsFile->addFixableError($error, $next, 'PointNotRequired', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($next, $value{0}); } } else if ($value{0} === '.') { $error = 'Opacity values must not start with a decimal point; use 0%s instead'; $data = array($value); $fix = $phpcsFile->addFixableError($error, $next, 'StartWithPoint', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($next, '0'.$value); } } else if ($value{0} !== '0') { $error = 'Opacity values must be between 0 and 1'; $phpcsFile->addError($error, $next, 'Invalid'); }//end if }//end if }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/SemicolonSpacingSniff.php0000644000076700000240000000505112647543456030365 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_SemicolonSpacingSniff. * * Ensure each style definition has a semi-colon and it is spaced correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_SemicolonSpacingSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_STYLE); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $semicolon = $phpcsFile->findNext(T_SEMICOLON, ($stackPtr + 1)); if ($semicolon === false || $tokens[$semicolon]['line'] !== $tokens[$stackPtr]['line']) { $error = 'Style definitions must end with a semicolon'; $phpcsFile->addError($error, $stackPtr, 'NotAtEnd'); return; } if ($tokens[($semicolon - 1)]['code'] === T_WHITESPACE) { $length = strlen($tokens[($semicolon - 1)]['content']); $error = 'Expected 0 spaces before semicolon in style definition; %s found'; $data = array($length); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpaceFound', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($semicolon - 1), ''); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/CSS/ShorthandSizeSniff.php0000644000076700000240000001416412647543456027722 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_CSS_ShorthandSizeSniff. * * Ensure sizes are defined using shorthand notation where possible, except in the * case where shorthand becomes 3 values. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_CSS_ShorthandSizeSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('CSS'); /** * A list of styles that we shouldn't check. * * These have values that looks like sizes, but are not. * * @var array */ public $excludeStyles = array( 'background-position' => 'background-position', 'box-shadow' => 'box-shadow', 'transform-origin' => 'transform-origin', '-webkit-transform-origin' => '-webkit-transform-origin', '-ms-transform-origin' => '-ms-transform-origin', ); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_STYLE); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Some styles look like shorthand but are not actually a set of 4 sizes. $style = strtolower($tokens[$stackPtr]['content']); if (isset($this->excludeStyles[$style]) === true) { return; } // Get the whole style content. $end = $phpcsFile->findNext(T_SEMICOLON, ($stackPtr + 1)); $origContent = $phpcsFile->getTokensAsString(($stackPtr + 1), ($end - $stackPtr - 1)); $origContent = trim($origContent, ': '); // Account for a !important annotation. $content = $origContent; if (substr($content, -10) === '!important') { $content = substr($content, 0, -10); $content = trim($content); } // Check if this style value is a set of numbers with optional prefixes. $content = preg_replace('/\s+/', ' ', $content); $values = array(); $num = preg_match_all( '/([0-9]+)([a-zA-Z]{2}\s+|%\s+|\s+)/', $content.' ', $values, PREG_SET_ORDER ); // Only interested in styles that have multiple sizes defined. if ($num < 2) { return; } // Rebuild the content we matched to ensure we got everything. $matched = ''; foreach ($values as $value) { $matched .= $value[0]; } if ($content !== trim($matched)) { return; } if ($num === 3) { $expected = trim($content.' '.$values[1][1].$values[1][2]); $error = 'Shorthand syntax not allowed here; use %s instead'; $data = array($expected); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NotAllowed', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); if (substr($origContent, -10) === '!important') { $expected .= ' !important'; } $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 2), null, true); $phpcsFile->fixer->replaceToken($next, $expected); for ($next++; $next < $end; $next++) { $phpcsFile->fixer->replaceToken($next, ''); } $phpcsFile->fixer->endChangeset(); } return; }//end if if ($num === 2) { if ($values[0][0] !== $values[1][0]) { // Both values are different, so it is already shorthand. return; } } else if ($values[0][0] !== $values[2][0] || $values[1][0] !== $values[3][0]) { // Can't shorthand this. return; } if ($values[0][0] === $values[1][0]) { // All values are the same. $expected = $values[0][0]; } else { $expected = $values[0][0].' '.$values[1][0]; } $expected = preg_replace('/\s+/', ' ', trim($expected)); $error = 'Size definitions must use shorthand if available; expected "%s" but found "%s"'; $data = array( $expected, $content, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NotUsed', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); if (substr($origContent, -10) === '!important') { $expected .= ' !important'; } $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 2), null, true); $phpcsFile->fixer->replaceToken($next, $expected); for ($next++; $next < $end; $next++) { $phpcsFile->fixer->replaceToken($next, ''); } $phpcsFile->fixer->endChangeset(); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Debug/JavaScriptLintSniff.php0000644000076700000240000000567112647543456030433 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Debug_JavaScriptLintSniff. * * Runs JavaScript Lint on the file. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Debug_JavaScriptLintSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('JS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $fileName = $phpcsFile->getFilename(); $jslPath = PHP_CodeSniffer::getConfigData('jsl_path'); if (is_null($jslPath) === true) { return; } $cmd = '"'.$jslPath.'" -nologo -nofilelisting -nocontext -nosummary -output-format __LINE__:__ERROR__ -process "'.$fileName.'"'; $msg = exec($cmd, $output, $retval); // Variable $exitCode is the last line of $output if no error occurs, on // error it is numeric. Try to handle various error conditions and // provide useful error reporting. if ($retval === 2 || $retval === 4) { if (is_array($output) === true) { $msg = join('\n', $output); } throw new PHP_CodeSniffer_Exception("Failed invoking JavaScript Lint, retval was [$retval], output was [$msg]"); } if (is_array($output) === true) { foreach ($output as $finding) { $split = strpos($finding, ':'); $line = substr($finding, 0, $split); $message = substr($finding, ($split + 1)); $phpcsFile->addWarningOnLine(trim($message), $line, 'ExternalTool'); } } // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Debug/JSLintSniff.php0000644000076700000240000000525412647543456026676 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Debug_JSLintSniff. * * Runs jslint.js on the file. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Debug_JSLintSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('JS'); /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void * @throws PHP_CodeSniffer_Exception If jslint.js could not be run */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $fileName = $phpcsFile->getFilename(); $rhinoPath = PHP_CodeSniffer::getConfigData('rhino_path'); $jslintPath = PHP_CodeSniffer::getConfigData('jslint_path'); if ($rhinoPath === null || $jslintPath === null) { return; } $cmd = "$rhinoPath \"$jslintPath\" \"$fileName\""; $msg = exec($cmd, $output, $retval); if (is_array($output) === true) { foreach ($output as $finding) { $matches = array(); $numMatches = preg_match('/Lint at line ([0-9]+).*:(.*)$/', $finding, $matches); if ($numMatches === 0) { continue; } $line = (int) $matches[1]; $message = 'jslint says: '.trim($matches[2]); $phpcsFile->addWarningOnLine($message, $line, 'ExternalTool'); } } // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Files/FileExtensionSniff.php0000644000076700000240000000536412647543456030325 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Files_FileExtensionSniff. * * Tests that classes and interfaces are not declared in .php files * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Files_FileExtensionSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return int */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $fileName = $phpcsFile->getFileName(); $extension = substr($fileName, strrpos($fileName, '.')); $nextClass = $phpcsFile->findNext(array(T_CLASS, T_INTERFACE, T_TRAIT), $stackPtr); if ($nextClass !== false) { $phpcsFile->recordMetric($stackPtr, 'File extension for class files', $extension); if ($extension === '.php') { $error = '%s found in ".php" file; use ".inc" extension instead'; $data = array(ucfirst($tokens[$nextClass]['content'])); $phpcsFile->addError($error, $stackPtr, 'ClassFound', $data); } } else { $phpcsFile->recordMetric($stackPtr, 'File extension for non-class files', $extension); if ($extension === '.inc') { $error = 'No interface or class found in ".inc" file; use ".php" extension instead'; $phpcsFile->addError($error, $stackPtr, 'NoClass'); } } // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Formatting/OperatorBracketSniff.php0000644000076700000240000003470712647543456031713 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Formatting_OperationBracketSniff. * * Tests that all arithmetic operations are bracketed. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Formatting_OperatorBracketSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return PHP_CodeSniffer_Tokens::$operators; }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($phpcsFile->tokenizerType === 'JS' && $tokens[$stackPtr]['code'] === T_PLUS) { // JavaScript uses the plus operator for string concatenation as well // so we cannot accurately determine if it is a string concat or addition. // So just ignore it. return; } // If the & is a reference, then we don't want to check for brackets. if ($tokens[$stackPtr]['code'] === T_BITWISE_AND && $phpcsFile->isReference($stackPtr) === true) { return; } // There is one instance where brackets aren't needed, which involves // the minus sign being used to assign a negative number to a variable. if ($tokens[$stackPtr]['code'] === T_MINUS) { // Check to see if we are trying to return -n. $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); if ($tokens[$prev]['code'] === T_RETURN) { return; } $number = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$number]['code'] === T_LNUMBER || $tokens[$number]['code'] === T_DNUMBER) { $previous = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if ($previous !== false) { $isAssignment = in_array($tokens[$previous]['code'], PHP_CodeSniffer_Tokens::$assignmentTokens); $isEquality = in_array($tokens[$previous]['code'], PHP_CodeSniffer_Tokens::$equalityTokens); $isComparison = in_array($tokens[$previous]['code'], PHP_CodeSniffer_Tokens::$comparisonTokens); if ($isAssignment === true || $isEquality === true || $isComparison === true) { // This is a negative assignment or comparison. // We need to check that the minus and the number are // adjacent. if (($number - $stackPtr) !== 1) { $error = 'No space allowed between minus sign and number'; $phpcsFile->addError($error, $stackPtr, 'SpacingAfterMinus'); } return; } } } }//end if $lastBracket = false; if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) { $parenthesis = array_reverse($tokens[$stackPtr]['nested_parenthesis'], true); foreach ($parenthesis as $bracket => $endBracket) { $prevToken = $phpcsFile->findPrevious(T_WHITESPACE, ($bracket - 1), null, true); $prevCode = $tokens[$prevToken]['code']; if ($prevCode === T_ISSET) { // This operation is inside an isset() call, but has // no bracket of it's own. break; } if ($prevCode === T_STRING || $prevCode === T_SWITCH) { // We allow very simple operations to not be bracketed. // For example, ceil($one / $two). $allowed = array( T_VARIABLE, T_LNUMBER, T_DNUMBER, T_STRING, T_WHITESPACE, T_THIS, T_SELF, T_OBJECT_OPERATOR, T_DOUBLE_COLON, T_OPEN_SQUARE_BRACKET, T_CLOSE_SQUARE_BRACKET, T_MODULUS, ); for ($prev = ($stackPtr - 1); $prev > $bracket; $prev--) { if (in_array($tokens[$prev]['code'], $allowed) === true) { continue; } if ($tokens[$prev]['code'] === T_CLOSE_PARENTHESIS) { $prev = $tokens[$prev]['parenthesis_opener']; } else { break; } } if ($prev !== $bracket) { break; } for ($next = ($stackPtr + 1); $next < $endBracket; $next++) { if (in_array($tokens[$next]['code'], $allowed) === true) { continue; } if ($tokens[$next]['code'] === T_OPEN_PARENTHESIS) { $next = $tokens[$next]['parenthesis_closer']; } else { break; } } if ($next !== $endBracket) { break; } }//end if if (in_array($prevCode, PHP_CodeSniffer_Tokens::$scopeOpeners) === true) { // This operation is inside a control structure like FOREACH // or IF, but has no bracket of it's own. // The only control structure allowed to do this is SWITCH. if ($prevCode !== T_SWITCH) { break; } } if ($prevCode === T_OPEN_PARENTHESIS) { // These are two open parenthesis in a row. If the current // one doesn't enclose the operator, go to the previous one. if ($endBracket < $stackPtr) { continue; } } $lastBracket = $bracket; break; }//end foreach }//end if if ($lastBracket === false) { // It is not in a bracketed statement at all. $previousToken = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true, null, true); if ($previousToken !== false) { // A list of tokens that indicate that the token is not // part of an arithmetic operation. $invalidTokens = array( T_COMMA, T_COLON, T_OPEN_PARENTHESIS, T_OPEN_SQUARE_BRACKET, T_OPEN_SHORT_ARRAY, T_CASE, ); if (in_array($tokens[$previousToken]['code'], $invalidTokens) === false) { $this->addMissingBracketsError($phpcsFile, $stackPtr); } return; } } else if ($tokens[$lastBracket]['parenthesis_closer'] < $stackPtr) { // There are a set of brackets in front of it that don't include it. $this->addMissingBracketsError($phpcsFile, $stackPtr); return; } else { // We are enclosed in a set of bracket, so the last thing to // check is that we are not also enclosed in square brackets // like this: ($array[$index + 1]), which is invalid. $brackets = array( T_OPEN_SQUARE_BRACKET, T_CLOSE_SQUARE_BRACKET, ); $squareBracket = $phpcsFile->findPrevious($brackets, ($stackPtr - 1), $lastBracket); if ($squareBracket !== false && $tokens[$squareBracket]['code'] === T_OPEN_SQUARE_BRACKET) { $closeSquareBracket = $phpcsFile->findNext($brackets, ($stackPtr + 1)); if ($closeSquareBracket !== false && $tokens[$closeSquareBracket]['code'] === T_CLOSE_SQUARE_BRACKET) { $this->addMissingBracketsError($phpcsFile, $stackPtr); } } return; }//end if $lastAssignment = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$assignmentTokens, $stackPtr, null, false, null, true); if ($lastAssignment !== false && $lastAssignment > $lastBracket) { $this->addMissingBracketsError($phpcsFile, $stackPtr); } }//end process() /** * Add and fix the missing brackets error. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function addMissingBracketsError(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $error = 'Arithmetic operation must be bracketed'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'MissingBrackets'); if ($fix === false || $phpcsFile->fixer->enabled === false) { return; } $tokens = $phpcsFile->getTokens(); $allowed = array( T_VARIABLE => true, T_LNUMBER => true, T_DNUMBER => true, T_STRING => true, T_WHITESPACE => true, T_THIS => true, T_SELF => true, T_OBJECT_OPERATOR => true, T_DOUBLE_COLON => true, T_MODULUS => true, T_ISSET => true, T_ARRAY => true, ); // Find the first token in the expression. for ($before = ($stackPtr - 1); $before > 0; $before--) { // Special case for plus operators because we can't tell if they are used // for addition or string contact. So assume string concat to be safe. if ($phpcsFile->tokenizerType === 'JS' && $tokens[$before]['code'] === T_PLUS) { break; } if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$before]['code']]) === true || isset(PHP_CodeSniffer_Tokens::$operators[$tokens[$before]['code']]) === true || isset(PHP_CodeSniffer_Tokens::$castTokens[$tokens[$before]['code']]) === true || isset($allowed[$tokens[$before]['code']]) === true ) { continue; } if ($tokens[$before]['code'] === T_CLOSE_PARENTHESIS) { $before = $tokens[$before]['parenthesis_opener']; continue; } if ($tokens[$before]['code'] === T_CLOSE_SQUARE_BRACKET) { $before = $tokens[$before]['bracket_opener']; continue; } break; }//end for $before = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($before + 1), null, true); // Find the last token in the expression. for ($after = ($stackPtr + 1); $after < $phpcsFile->numTokens; $after++) { // Special case for plus operators because we can't tell if they are used // for addition or string contact. So assume string concat to be safe. if ($phpcsFile->tokenizerType === 'JS' && $tokens[$after]['code'] === T_PLUS) { break; } if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$after]['code']]) === true || isset(PHP_CodeSniffer_Tokens::$operators[$tokens[$after]['code']]) === true || isset(PHP_CodeSniffer_Tokens::$castTokens[$tokens[$after]['code']]) === true || isset($allowed[$tokens[$after]['code']]) === true ) { continue; } if ($tokens[$after]['code'] === T_OPEN_PARENTHESIS) { $after = $tokens[$after]['parenthesis_closer']; continue; } if ($tokens[$after]['code'] === T_OPEN_SQUARE_BRACKET) { $after = $tokens[$after]['bracket_closer']; continue; } break; }//end for $after = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($after - 1), null, true); // Can only fix this error if both tokens are available for fixing. // Adding one bracket without the other will create parse errors. $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->replaceToken($before, '('.$tokens[$before]['content']); $phpcsFile->fixer->replaceToken($after, $tokens[$after]['content'].')'); $phpcsFile->fixer->endChangeset(); }//end addMissingBracketsError() }//end class ././@LongLink000 156 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Functions/FunctionDeclarationArgumentSpacingSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Functions/FunctionDeclarationArgumentSpacin0000644000076700000240000004267112647543456033501 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Functions_FunctionDeclarationArgumentSpacingSniff. * * Checks that arguments in function declarations are spaced correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Functions_FunctionDeclarationArgumentSpacingSniff implements PHP_CodeSniffer_Sniff { /** * How many spaces should surround the equals signs. * * @var int */ public $equalsSpacing = 0; /** * How many spaces should follow the opening bracket. * * @var int */ public $requiredSpacesAfterOpen = 0; /** * How many spaces should precede the closing bracket. * * @var int */ public $requiredSpacesBeforeClose = 0; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_FUNCTION, T_CLOSURE, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['parenthesis_opener']) === false || isset($tokens[$stackPtr]['parenthesis_closer']) === false || $tokens[$stackPtr]['parenthesis_opener'] === null || $tokens[$stackPtr]['parenthesis_closer'] === null ) { return; } $this->equalsSpacing = (int) $this->equalsSpacing; $this->requiredSpacesAfterOpen = (int) $this->requiredSpacesAfterOpen; $this->requiredSpacesBeforeClose = (int) $this->requiredSpacesBeforeClose; $openBracket = $tokens[$stackPtr]['parenthesis_opener']; $this->processBracket($phpcsFile, $openBracket); if ($tokens[$stackPtr]['code'] === T_CLOSURE) { $use = $phpcsFile->findNext(T_USE, ($tokens[$openBracket]['parenthesis_closer'] + 1), $tokens[$stackPtr]['scope_opener']); if ($use !== false) { $openBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($use + 1), null); $this->processBracket($phpcsFile, $openBracket); } } }//end process() /** * Processes the contents of a single set of brackets. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $openBracket The position of the open bracket * in the stack passed in $tokens. * * @return void */ public function processBracket(PHP_CodeSniffer_File $phpcsFile, $openBracket) { $tokens = $phpcsFile->getTokens(); $closeBracket = $tokens[$openBracket]['parenthesis_closer']; $multiLine = ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']); $nextParam = $openBracket; $params = array(); while (($nextParam = $phpcsFile->findNext(T_VARIABLE, ($nextParam + 1), $closeBracket)) !== false) { $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($nextParam + 1), ($closeBracket + 1), true); if ($nextToken === false) { break; } $nextCode = $tokens[$nextToken]['code']; if ($nextCode === T_EQUAL) { // Check parameter default spacing. $spacesBefore = 0; if (($nextToken - $nextParam) > 1) { $spacesBefore = strlen($tokens[($nextParam + 1)]['content']); } if ($spacesBefore !== $this->equalsSpacing) { $error = 'Incorrect spacing between argument "%s" and equals sign; expected '.$this->equalsSpacing.' but found %s'; $data = array( $tokens[$nextParam]['content'], $spacesBefore, ); $fix = $phpcsFile->addFixableError($error, $nextToken, 'SpaceBeforeEquals', $data); if ($fix === true) { $padding = str_repeat(' ', $this->equalsSpacing); if ($spacesBefore === 0) { $phpcsFile->fixer->addContentBefore($nextToken, $padding); } else { $phpcsFile->fixer->replaceToken(($nextToken - 1), $padding); } } }//end if $spacesAfter = 0; if ($tokens[($nextToken + 1)]['code'] === T_WHITESPACE) { $spacesAfter = strlen($tokens[($nextToken + 1)]['content']); } if ($spacesAfter !== $this->equalsSpacing) { $error = 'Incorrect spacing between default value and equals sign for argument "%s"; expected '.$this->equalsSpacing.' but found %s'; $data = array( $tokens[$nextParam]['content'], $spacesAfter, ); $fix = $phpcsFile->addFixableError($error, $nextToken, 'SpaceAfterDefault', $data); if ($fix === true) { $padding = str_repeat(' ', $this->equalsSpacing); if ($spacesAfter === 0) { $phpcsFile->fixer->addContent($nextToken, $padding); } else { $phpcsFile->fixer->replaceToken(($nextToken + 1), $padding); } } }//end if }//end if // Find and check the comma (if there is one). $nextComma = $phpcsFile->findNext(T_COMMA, ($nextParam + 1), $closeBracket); if ($nextComma !== false) { // Comma found. if ($tokens[($nextComma - 1)]['code'] === T_WHITESPACE) { $error = 'Expected 0 spaces between argument "%s" and comma; %s found'; $data = array( $tokens[$nextParam]['content'], strlen($tokens[($nextComma - 1)]['content']), ); $fix = $phpcsFile->addFixableError($error, $nextToken, 'SpaceBeforeComma', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($nextComma - 1), ''); } } } // Take references into account when expecting the // location of whitespace. $checkToken = ($nextParam - 1); if ($tokens[$checkToken]['code'] === T_ELLIPSIS) { $checkToken--; } if ($phpcsFile->isReference($checkToken) === true) { $whitespace = ($checkToken - 1); } else { $whitespace = $checkToken; } if (empty($params) === false) { // This is not the first argument in the function declaration. $arg = $tokens[$nextParam]['content']; if ($tokens[$whitespace]['code'] === T_WHITESPACE) { $gap = strlen($tokens[$whitespace]['content']); // Before we throw an error, make sure there is no type hint. $comma = $phpcsFile->findPrevious(T_COMMA, ($nextParam - 1)); $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($comma + 1), null, true); if ($phpcsFile->isReference($nextToken) === true) { $nextToken++; } if ($nextToken !== $nextParam) { // There was a type hint, so check the spacing between // the hint and the variable as well. $hint = $tokens[$nextToken]['content']; if ($gap !== 1) { $error = 'Expected 1 space between type hint and argument "%s"; %s found'; $data = array( $arg, $gap, ); $fix = $phpcsFile->addFixableError($error, $nextToken, 'SpacingAfterHint', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($whitespace, ' '); } } if ($multiLine === false) { if ($tokens[($comma + 1)]['code'] !== T_WHITESPACE) { $error = 'Expected 1 space between comma and type hint "%s"; 0 found'; $data = array($hint); $fix = $phpcsFile->addFixableError($error, $nextToken, 'NoSpaceBeforeHint', $data); if ($fix === true) { $phpcsFile->fixer->addContent($comma, ' '); } } else { $gap = strlen($tokens[($comma + 1)]['content']); if ($gap !== 1) { $error = 'Expected 1 space between comma and type hint "%s"; %s found'; $data = array( $hint, $gap, ); $fix = $phpcsFile->addFixableError($error, $nextToken, 'SpacingBeforeHint', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($comma + 1), ' '); } } }//end if }//end if } else if ($gap !== 1) { // Just make sure this is not actually an indent. if ($tokens[$whitespace]['line'] === $tokens[($whitespace - 1)]['line']) { $error = 'Expected 1 space between comma and argument "%s"; %s found'; $data = array( $arg, $gap, ); $fix = $phpcsFile->addFixableError($error, $nextToken, 'SpacingBeforeArg', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($whitespace, ' '); } } }//end if } else { $error = 'Expected 1 space between comma and argument "%s"; 0 found'; $data = array($arg); $fix = $phpcsFile->addFixableError($error, $nextToken, 'NoSpaceBeforeArg', $data); if ($fix === true) { $phpcsFile->fixer->addContent($whitespace, ' '); } }//end if } else { $gap = 0; if ($tokens[$whitespace]['code'] === T_WHITESPACE) { $gap = strlen($tokens[$whitespace]['content']); } $arg = $tokens[$nextParam]['content']; // Before we throw an error, make sure there is no type hint. $bracket = $phpcsFile->findPrevious(T_OPEN_PARENTHESIS, ($nextParam - 1)); $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($bracket + 1), null, true); if ($phpcsFile->isReference($nextToken) === true) { $nextToken++; } if ($nextToken !== $nextParam) { // There was a type hint, so check the spacing between // the hint and the variable as well. $hint = $tokens[$nextToken]['content']; if ($gap !== 1) { $error = 'Expected 1 space between type hint and argument "%s"; %s found'; $data = array( $arg, $gap, ); $fix = $phpcsFile->addFixableError($error, $nextToken, 'SpacingAfterHint', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($nextToken + 1), ' '); } } $spaceAfterOpen = 0; if ($tokens[($bracket + 1)]['code'] === T_WHITESPACE) { $spaceAfterOpen = strlen($tokens[($bracket + 1)]['content']); } if ($multiLine === false && $spaceAfterOpen !== $this->requiredSpacesAfterOpen) { $error = 'Expected %s spaces between opening bracket and type hint "%s"; %s found'; $data = array( $this->requiredSpacesAfterOpen, $hint, $spaceAfterOpen, ); $fix = $phpcsFile->addFixableError($error, $nextToken, 'SpacingAfterOpenHint', $data); if ($fix === true) { $padding = str_repeat(' ', $this->requiredSpacesAfterOpen); if ($gap === 0) { $phpcsFile->fixer->addContent($openBracket, $padding); } else { $phpcsFile->fixer->replaceToken(($openBracket + 1), $padding); } } } } else if ($multiLine === false && $gap !== $this->requiredSpacesAfterOpen) { $error = 'Expected %s spaces between opening bracket and argument "%s"; %s found'; $data = array( $this->requiredSpacesAfterOpen, $arg, $gap, ); $fix = $phpcsFile->addFixableError($error, $nextToken, 'SpacingAfterOpen', $data); if ($fix === true) { $padding = str_repeat(' ', $this->requiredSpacesAfterOpen); if ($gap === 0) { $phpcsFile->fixer->addContent($openBracket, $padding); } else { $phpcsFile->fixer->replaceToken(($openBracket + 1), $padding); } } }//end if }//end if $params[] = $nextParam; }//end while $gap = 0; if ($tokens[($closeBracket - 1)]['code'] === T_WHITESPACE) { $gap = strlen($tokens[($closeBracket - 1)]['content']); } if (empty($params) === true) { // There are no parameters for this function. if (($closeBracket - $openBracket) !== 1) { $error = 'Expected 0 spaces between brackets of function declaration; %s found'; $data = array($gap); $fix = $phpcsFile->addFixableError($error, $openBracket, 'SpacingBetween', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($openBracket + 1), ''); } } } else if ($multiLine === false && $gap !== $this->requiredSpacesBeforeClose) { $lastParam = array_pop($params); $error = 'Expected %s spaces between argument "%s" and closing bracket; %s found'; $data = array( $this->requiredSpacesBeforeClose, $tokens[$lastParam]['content'], $gap, ); $fix = $phpcsFile->addFixableError($error, $closeBracket, 'SpacingBeforeClose', $data); if ($fix === true) { $padding = str_repeat(' ', $this->requiredSpacesBeforeClose); if ($gap === 0) { $phpcsFile->fixer->addContentBefore($closeBracket, $padding); } else { $phpcsFile->fixer->replaceToken(($closeBracket - 1), $padding); } } }//end if }//end processBracket() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Functions/FunctionDeclarationSniff.php0000644000076700000240000000311112647543456032376 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractPatternSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractPatternSniff not found'); } /** * Squiz_Sniffs_Functions_FunctionDeclarationSniff. * * Checks the function declaration is correct. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Functions_FunctionDeclarationSniff extends PHP_CodeSniffer_Standards_AbstractPatternSniff { /** * Returns an array of patterns to check are correct. * * @return array */ protected function getPatterns() { return array( 'function abc(...);', 'function abc(...)', 'abstract function abc(...);', ); }//end getPatterns() }//end class ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Functions/FunctionDuplicateArgumentSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Functions/FunctionDuplicateArgumentSniff.ph0000644000076700000240000000476412647543456033425 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Functions_FunctionDuplicateArgumentSpacingSniff. * * Checks that duplicate arguments are not used in function declarations. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Functions_FunctionDuplicateArgumentSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_FUNCTION); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $openBracket = $tokens[$stackPtr]['parenthesis_opener']; $closeBracket = $tokens[$stackPtr]['parenthesis_closer']; $foundVariables = array(); for ($i = ($openBracket + 1); $i < $closeBracket; $i++) { if ($tokens[$i]['code'] === T_VARIABLE) { $variable = $tokens[$i]['content']; if (in_array($variable, $foundVariables) === true) { $error = 'Variable "%s" appears more than once in function declaration'; $data = array($variable); $phpcsFile->addError($error, $i, 'Found', $data); } else { $foundVariables[] = $variable; } } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Functions/GlobalFunctionSniff.php0000644000076700000240000000437712647543456031370 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Functions_GlobalFunctionSniff. * * Tests for functions outside of classes. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Functions_GlobalFunctionSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_FUNCTION); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (empty($tokens[$stackPtr]['conditions']) === true) { $functionName = $phpcsFile->getDeclarationName($stackPtr); if ($functionName === null) { return; } // Special exception for __autoload as it needs to be global. if ($functionName !== '__autoload') { $error = 'Consider putting global function "%s" in a static class'; $data = array($functionName); $phpcsFile->addWarning($error, $stackPtr, 'Found', $data); } } }//end process() }//end class ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Functions/LowercaseFunctionKeywordsSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Functions/LowercaseFunctionKeywordsSniff.ph0000644000076700000240000000446012647543456033455 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Functions_LowercaseFunctionKeywordsSniff. * * Ensures all class keywords are lowercase. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Functions_LowercaseFunctionKeywordsSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_FUNCTION, T_PUBLIC, T_PRIVATE, T_PROTECTED, T_STATIC, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $content = $tokens[$stackPtr]['content']; if ($content !== strtolower($content)) { $error = '%s keyword must be lowercase; expected "%s" but found "%s"'; $data = array( strtoupper($content), strtolower($content), $content, ); $phpcsFile->addError($error, $stackPtr, 'FoundUppercase', $data); } }//end process() }//end class ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Functions/MultiLineFunctionDeclarationSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Functions/MultiLineFunctionDeclarationSniff0000644000076700000240000001334312647543456033443 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PEAR_Sniffs_Functions_FunctionDeclarationSniff', true) === false) { $error = 'Class PEAR_Sniffs_Functions_FunctionDeclarationSniff not found'; throw new PHP_CodeSniffer_Exception($error); } /** * Squiz_Sniffs_Functions_MultiLineFunctionDeclarationSniff. * * Ensure single and multi-line function declarations are defined correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Functions_MultiLineFunctionDeclarationSniff extends PEAR_Sniffs_Functions_FunctionDeclarationSniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Processes multi-line declarations. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * @param array $tokens The stack of tokens that make up * the file. * * @return void */ public function processMultiLineDeclaration(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $tokens) { // We do everything the parent sniff does, and a bit more. parent::processMultiLineDeclaration($phpcsFile, $stackPtr, $tokens); $openBracket = $tokens[$stackPtr]['parenthesis_opener']; $this->processBracket($phpcsFile, $openBracket, $tokens, 'function'); if ($tokens[$stackPtr]['code'] !== T_CLOSURE) { return; } $use = $phpcsFile->findNext(T_USE, ($tokens[$stackPtr]['parenthesis_closer'] + 1), $tokens[$stackPtr]['scope_opener']); if ($use === false) { return; } $openBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, ($use + 1), null); $this->processBracket($phpcsFile, $openBracket, $tokens, 'use'); // Also check spacing. if ($tokens[($use - 1)]['code'] === T_WHITESPACE) { $gap = strlen($tokens[($use - 1)]['content']); } else { $gap = 0; } }//end processMultiLineDeclaration() /** * Processes the contents of a single set of brackets. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $openBracket The position of the open bracket * in the stack passed in $tokens. * @param array $tokens The stack of tokens that make up * the file. * @param string $type The type of the token the brackets * belong to (function or use). * * @return void */ public function processBracket(PHP_CodeSniffer_File $phpcsFile, $openBracket, $tokens, $type='function') { $errorPrefix = ''; if ($type === 'use') { $errorPrefix = 'Use'; } $closeBracket = $tokens[$openBracket]['parenthesis_closer']; // The open bracket should be the last thing on the line. if ($tokens[$openBracket]['line'] !== $tokens[$closeBracket]['line']) { $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($openBracket + 1), null, true); if ($tokens[$next]['line'] !== ($tokens[$openBracket]['line'] + 1)) { $error = 'The first parameter of a multi-line '.$type.' declaration must be on the line after the opening bracket'; $fix = $phpcsFile->addFixableError($error, $next, $errorPrefix.'FirstParamSpacing'); if ($fix === true) { $phpcsFile->fixer->addNewline($openBracket); } } } // Each line between the brackets should contain a single parameter. $lastComma = null; for ($i = ($openBracket + 1); $i < $closeBracket; $i++) { // Skip brackets, like arrays, as they can contain commas. if (isset($tokens[$i]['bracket_opener']) === true) { $i = $tokens[$i]['bracket_closer']; continue; } if (isset($tokens[$i]['parenthesis_opener']) === true) { $i = $tokens[$i]['parenthesis_closer']; continue; } if ($tokens[$i]['code'] !== T_COMMA) { continue; } $next = $phpcsFile->findNext(T_WHITESPACE, ($i + 1), null, true); if ($tokens[$next]['line'] !== ($tokens[$i]['line'] + 1)) { $error = 'Multi-line '.$type.' declarations must define one parameter per line'; $fix = $phpcsFile->addFixableError($error, $next, $errorPrefix.'OneParamPerLine'); if ($fix === true) { $phpcsFile->fixer->addNewline($i); } } }//end for }//end processBracket() }//end class ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/NamingConventions/ValidFunctionNameSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/NamingConventions/ValidFunctionNameSniff.ph0000644000076700000240000000506012647543456033325 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff not found'); } /** * Squiz_Sniffs_NamingConventions_ValidFunctionNameSniff. * * Ensures method names are correct depending on whether they are public * or private, and that functions are named correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_NamingConventions_ValidFunctionNameSniff extends PEAR_Sniffs_NamingConventions_ValidFunctionNameSniff { /** * Processes the tokens outside the scope. * * @param PHP_CodeSniffer_File $phpcsFile The file being processed. * @param int $stackPtr The position where this token was * found. * * @return void */ protected function processTokenOutsideScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $functionName = $phpcsFile->getDeclarationName($stackPtr); if ($functionName === null) { return; } $errorData = array($functionName); // Does this function claim to be magical? if (preg_match('|^__|', $functionName) !== 0) { $error = 'Function name "%s" is invalid; only PHP magic methods should be prefixed with a double underscore'; $phpcsFile->addError($error, $stackPtr, 'DoubleUnderscore', $errorData); return; } if (PHP_CodeSniffer::isCamelCaps($functionName, false, true, false) === false) { $error = 'Function name "%s" is not in camel caps format'; $phpcsFile->addError($error, $stackPtr, 'NotCamelCaps', $errorData); } }//end processTokenOutsideScope() }//end class ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/NamingConventions/ValidVariableNameSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/NamingConventions/ValidVariableNameSniff.ph0000644000076700000240000002205312647543456033266 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractVariableSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractVariableSniff not found'); } /** * Squiz_Sniffs_NamingConventions_ValidVariableNameSniff. * * Checks the naming of variables and member variables. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_NamingConventions_ValidVariableNameSniff extends PHP_CodeSniffer_Standards_AbstractVariableSniff { /** * Tokens to ignore so that we can find a DOUBLE_COLON. * * @var array */ private $_ignore = array( T_WHITESPACE, T_COMMENT, ); /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ protected function processVariable(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $varName = ltrim($tokens[$stackPtr]['content'], '$'); $phpReservedVars = array( '_SERVER', '_GET', '_POST', '_REQUEST', '_SESSION', '_ENV', '_COOKIE', '_FILES', 'GLOBALS', 'http_response_header', 'HTTP_RAW_POST_DATA', 'php_errormsg', ); // If it's a php reserved var, then its ok. if (in_array($varName, $phpReservedVars) === true) { return; } $objOperator = $phpcsFile->findNext(array(T_WHITESPACE), ($stackPtr + 1), null, true); if ($tokens[$objOperator]['code'] === T_OBJECT_OPERATOR) { // Check to see if we are using a variable from an object. $var = $phpcsFile->findNext(array(T_WHITESPACE), ($objOperator + 1), null, true); if ($tokens[$var]['code'] === T_STRING) { $bracket = $phpcsFile->findNext(array(T_WHITESPACE), ($var + 1), null, true); if ($tokens[$bracket]['code'] !== T_OPEN_PARENTHESIS) { $objVarName = $tokens[$var]['content']; // There is no way for us to know if the var is public or // private, so we have to ignore a leading underscore if there is // one and just check the main part of the variable name. $originalVarName = $objVarName; if (substr($objVarName, 0, 1) === '_') { $objVarName = substr($objVarName, 1); } if (PHP_CodeSniffer::isCamelCaps($objVarName, false, true, false) === false) { $error = 'Variable "%s" is not in valid camel caps format'; $data = array($originalVarName); $phpcsFile->addError($error, $var, 'NotCamelCaps', $data); } }//end if }//end if }//end if // There is no way for us to know if the var is public or private, // so we have to ignore a leading underscore if there is one and just // check the main part of the variable name. $originalVarName = $varName; if (substr($varName, 0, 1) === '_') { $objOperator = $phpcsFile->findPrevious(array(T_WHITESPACE), ($stackPtr - 1), null, true); if ($tokens[$objOperator]['code'] === T_DOUBLE_COLON) { // The variable lives within a class, and is referenced like // this: MyClass::$_variable, so we don't know its scope. $inClass = true; } else { $inClass = $phpcsFile->hasCondition($stackPtr, array(T_CLASS, T_INTERFACE, T_TRAIT)); } if ($inClass === true) { $varName = substr($varName, 1); } } if (PHP_CodeSniffer::isCamelCaps($varName, false, true, false) === false) { $error = 'Variable "%s" is not in valid camel caps format'; $data = array($originalVarName); $phpcsFile->addError($error, $stackPtr, 'NotCamelCaps', $data); } }//end processVariable() /** * Processes class member variables. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ protected function processMemberVar(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $varName = ltrim($tokens[$stackPtr]['content'], '$'); $memberProps = $phpcsFile->getMemberProperties($stackPtr); if (empty($memberProps) === true) { // Couldn't get any info about this variable, which // generally means it is invalid or possibly has a parse // error. Any errors will be reported by the core, so // we can ignore it. return; } $public = ($memberProps['scope'] !== 'private'); $errorData = array($varName); if ($public === true) { if (substr($varName, 0, 1) === '_') { $error = '%s member variable "%s" must not contain a leading underscore'; $data = array( ucfirst($memberProps['scope']), $errorData[0], ); $phpcsFile->addError($error, $stackPtr, 'PublicHasUnderscore', $data); return; } } else { if (substr($varName, 0, 1) !== '_') { $error = 'Private member variable "%s" must contain a leading underscore'; $phpcsFile->addError($error, $stackPtr, 'PrivateNoUnderscore', $errorData); return; } } if (PHP_CodeSniffer::isCamelCaps($varName, false, $public, false) === false) { $error = 'Member variable "%s" is not in valid camel caps format'; $phpcsFile->addError($error, $stackPtr, 'MemberNotCamelCaps', $errorData); } }//end processMemberVar() /** * Processes the variable found within a double quoted string. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the double quoted * string. * * @return void */ protected function processVariableInString(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $phpReservedVars = array( '_SERVER', '_GET', '_POST', '_REQUEST', '_SESSION', '_ENV', '_COOKIE', '_FILES', 'GLOBALS', 'http_response_header', 'HTTP_RAW_POST_DATA', 'php_errormsg', ); if (preg_match_all('|[^\\\]\${?([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)|', $tokens[$stackPtr]['content'], $matches) !== 0) { foreach ($matches[1] as $varName) { // If it's a php reserved var, then its ok. if (in_array($varName, $phpReservedVars) === true) { continue; } if (PHP_CodeSniffer::isCamelCaps($varName, false, true, false) === false) { $error = 'Variable "%s" is not in valid camel caps format'; $data = array($varName); $phpcsFile->addError($error, $stackPtr, 'StringNotCamelCaps', $data); } } } }//end processVariableInString() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Objects/DisallowObjectStringIndexSniff.php0000644000076700000240000000561312647543456033161 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Ensures that object indexes are written in dot notation. * * @category PHP * @package PHP_CodeSniffer * @author Sertan Danis * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Objects_DisallowObjectStringIndexSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('JS'); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_SQUARE_BRACKET); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Check if the next non whitespace token is a string. $index = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$index]['code'] !== T_CONSTANT_ENCAPSED_STRING) { return; } // Make sure it is the only thing in the square brackets. $next = $phpcsFile->findNext(T_WHITESPACE, ($index + 1), null, true); if ($tokens[$next]['code'] !== T_CLOSE_SQUARE_BRACKET) { return; } // Allow indexes that have dots in them because we can't write // them in dot notation. $content = trim($tokens[$index]['content'], '"\' '); if (strpos($content, '.') !== false) { return; } // Also ignore reserved words. if ($content === 'super') { return; } // Token before the opening square bracket cannot be a var name. $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if ($tokens[$prev]['code'] === T_STRING) { $error = 'Object indexes must be written in dot notation'; $phpcsFile->addError($error, $prev, 'Found'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Objects/ObjectInstantiationSniff.php0000644000076700000240000000474112647543456032051 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Objects_ObjectInstantiationSniff. * * Ensures objects are assigned to a variable when instantiated. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Objects_ObjectInstantiationSniff implements PHP_CodeSniffer_Sniff { /** * Registers the token types that this sniff wishes to listen to. * * @return array */ public function register() { return array(T_NEW); }//end register() /** * Process the tokens that this sniff is listening for. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $allowedTokens = PHP_CodeSniffer_Tokens::$emptyTokens; $allowedTokens[] = T_BITWISE_AND; $prev = $phpcsFile->findPrevious($allowedTokens, ($stackPtr - 1), null, true); $allowedTokens = array( T_EQUAL => true, T_DOUBLE_ARROW => true, T_THROW => true, T_RETURN => true, T_INLINE_THEN => true, T_INLINE_ELSE => true, ); if (isset($allowedTokens[$tokens[$prev]['code']]) === false) { $error = 'New objects must be assigned to a variable'; $phpcsFile->addError($error, $stackPtr, 'NotAssigned'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Objects/ObjectMemberCommaSniff.php0000644000076700000240000000426612647543456031413 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Objects_ObjectMemberCommaSniff. * * Ensures the last member of an object is not followed by a comma. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Objects_ObjectMemberCommaSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('JS'); /** * Registers the token types that this sniff wishes to listen to. * * @return array */ public function register() { return array(T_CLOSE_OBJECT); }//end register() /** * Process the tokens that this sniff is listening for. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); if ($tokens[$prev]['code'] === T_COMMA) { $error = 'Last member of object must not be followed by a comma'; $fix = $phpcsFile->addFixableError($error, $prev, 'Missing'); if ($fix === true) { $phpcsFile->fixer->replaceToken($prev, ''); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Operators/ComparisonOperatorUsageSniff.php0000644000076700000240000002060112647543456033267 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * A Sniff to enforce the use of IDENTICAL type operators rather than EQUAL operators. * * The use of === true is enforced over implicit true statements, * for example: * * * if ($a) * { * ... * } * * * should be: * * * if ($a === true) * { * ... * } * * * It also enforces the use of === false over ! operators. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Operators_ComparisonOperatorUsageSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * A list of valid comparison operators. * * @var array */ private static $_validOps = array( T_IS_IDENTICAL, T_IS_NOT_IDENTICAL, T_LESS_THAN, T_GREATER_THAN, T_IS_GREATER_OR_EQUAL, T_IS_SMALLER_OR_EQUAL, T_INSTANCEOF, ); /** * A list of invalid operators with their alternatives. * * @var array(int => string) */ private static $_invalidOps = array( 'PHP' => array( T_IS_EQUAL => '===', T_IS_NOT_EQUAL => '!==', T_BOOLEAN_NOT => '=== FALSE', ), 'JS' => array( T_IS_EQUAL => '===', T_IS_NOT_EQUAL => '!==', ), ); /** * Registers the token types that this sniff wishes to listen to. * * @return array */ public function register() { return array( T_IF, T_ELSEIF, T_INLINE_THEN, T_WHILE, T_FOR, ); }//end register() /** * Process the tokens that this sniff is listening for. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where the token * was found. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $tokenizer = $phpcsFile->tokenizerType; if ($tokens[$stackPtr]['code'] === T_INLINE_THEN) { $end = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); if ($tokens[$end]['code'] !== T_CLOSE_PARENTHESIS) { // This inline IF statement does not have its condition // bracketed, so we need to guess where it starts. for ($i = ($end - 1); $i >= 0; $i--) { if ($tokens[$i]['code'] === T_SEMICOLON) { // Stop here as we assume it is the end // of the previous statement. break; } else if ($tokens[$i]['code'] === T_OPEN_TAG) { // Stop here as this is the start of the file. break; } else if ($tokens[$i]['code'] === T_CLOSE_CURLY_BRACKET) { // Stop if this is the closing brace of // a code block. if (isset($tokens[$i]['scope_opener']) === true) { break; } } else if ($tokens[$i]['code'] === T_OPEN_CURLY_BRACKET) { // Stop if this is the opening brace of // a code block. if (isset($tokens[$i]['scope_closer']) === true) { break; } } }//end for $start = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($i + 1), null, true); } else { if (isset($tokens[$stackPtr]['parenthesis_opener']) === false) { return; } $start = $tokens[$end]['parenthesis_opener']; }//end if } else if ($tokens[$stackPtr]['code'] === T_FOR) { if (isset($tokens[$stackPtr]['parenthesis_opener']) === false) { return; } $openingBracket = $tokens[$stackPtr]['parenthesis_opener']; $closingBracket = $tokens[$stackPtr]['parenthesis_closer']; $start = $phpcsFile->findNext(T_SEMICOLON, $openingBracket, $closingBracket); $end = $phpcsFile->findNext(T_SEMICOLON, ($start + 1), $closingBracket); if ($start === false || $end === false) { return; } } else { if (isset($tokens[$stackPtr]['parenthesis_opener']) === false) { return; } $start = $tokens[$stackPtr]['parenthesis_opener']; $end = $tokens[$stackPtr]['parenthesis_closer']; }//end if $requiredOps = 0; $foundOps = 0; for ($i = $start; $i <= $end; $i++) { $type = $tokens[$i]['code']; if (in_array($type, array_keys(self::$_invalidOps[$tokenizer])) === true) { $error = 'Operator %s prohibited; use %s instead'; $data = array( $tokens[$i]['content'], self::$_invalidOps[$tokenizer][$type], ); $phpcsFile->addError($error, $i, 'NotAllowed', $data); $foundOps++; } else if (in_array($type, self::$_validOps) === true) { $foundOps++; } if ($phpcsFile->tokenizerType !== 'JS') { if ($tokens[$i]['code'] === T_BOOLEAN_AND || $tokens[$i]['code'] === T_BOOLEAN_OR) { $requiredOps++; // When the instanceof operator is used with another operator // like ===, you can get more ops than are required. if ($foundOps > $requiredOps) { $foundOps = $requiredOps; } // If we get to here and we have not found the right number of // comparison operators, then we must have had an implicit // true operation ie. if ($a) instead of the required // if ($a === true), so let's add an error. if ($requiredOps !== $foundOps) { $error = 'Implicit true comparisons prohibited; use === TRUE instead'; $phpcsFile->addError($error, $stackPtr, 'ImplicitTrue'); $foundOps++; } } }//end if }//end for $requiredOps++; if ($phpcsFile->tokenizerType !== 'JS') { if ($foundOps < $requiredOps) { $error = 'Implicit true comparisons prohibited; use === TRUE instead'; $phpcsFile->addError($error, $stackPtr, 'ImplicitTrue'); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Operators/IncrementDecrementUsageSniff.php0000644000076700000240000002027512647543456033223 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Operators_IncrementDecrementUsageSniff. * * Tests that the ++ operators are used when possible and not * used when it makes the code confusing. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Operators_IncrementDecrementUsageSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_EQUAL, T_PLUS_EQUAL, T_MINUS_EQUAL, T_INC, T_DEC, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[$stackPtr]['code'] === T_INC || $tokens[$stackPtr]['code'] === T_DEC) { $this->processIncDec($phpcsFile, $stackPtr); } else { $this->processAssignment($phpcsFile, $stackPtr); } }//end process() /** * Checks to ensure increment and decrement operators are not confusing. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ protected function processIncDec(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Work out where the variable is so we know where to // start looking for other operators. if ($tokens[($stackPtr - 1)]['code'] === T_VARIABLE) { $start = ($stackPtr + 1); } else { $start = ($stackPtr + 2); } $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, $start, null, true); if ($next === false) { return; } if (isset(PHP_CodeSniffer_Tokens::$arithmeticTokens[$tokens[$next]['code']]) === true) { $error = 'Increment and decrement operators cannot be used in an arithmetic operation'; $phpcsFile->addError($error, $stackPtr, 'NotAllowed'); return; } $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($start - 3), null, true); if ($prev === false) { return; } // Check if this is in a string concat. if ($tokens[$next]['code'] === T_STRING_CONCAT || $tokens[$prev]['code'] === T_STRING_CONCAT) { $error = 'Increment and decrement operators must be bracketed when used in string concatenation'; $phpcsFile->addError($error, $stackPtr, 'NoBrackets'); } }//end processIncDec() /** * Checks to ensure increment and decrement operators are used. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ protected function processAssignment(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $assignedVar = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); // Not an assignment, return. if ($tokens[$assignedVar]['code'] !== T_VARIABLE) { return; } $statementEnd = $phpcsFile->findNext(array(T_SEMICOLON, T_CLOSE_PARENTHESIS, T_CLOSE_SQUARE_BRACKET, T_CLOSE_CURLY_BRACKET), $stackPtr); // If there is anything other than variables, numbers, spaces or operators we need to return. $noiseTokens = $phpcsFile->findNext(array(T_LNUMBER, T_VARIABLE, T_WHITESPACE, T_PLUS, T_MINUS, T_OPEN_PARENTHESIS), ($stackPtr + 1), $statementEnd, true); if ($noiseTokens !== false) { return; } // If we are already using += or -=, we need to ignore // the statement if a variable is being used. if ($tokens[$stackPtr]['code'] !== T_EQUAL) { $nextVar = $phpcsFile->findNext(T_VARIABLE, ($stackPtr + 1), $statementEnd); if ($nextVar !== false) { return; } } if ($tokens[$stackPtr]['code'] === T_EQUAL) { $nextVar = ($stackPtr + 1); $previousVariable = ($stackPtr + 1); $variableCount = 0; while (($nextVar = $phpcsFile->findNext(T_VARIABLE, ($nextVar + 1), $statementEnd)) !== false) { $previousVariable = $nextVar; $variableCount++; } if ($variableCount !== 1) { return; } $nextVar = $previousVariable; if ($tokens[$nextVar]['content'] !== $tokens[$assignedVar]['content']) { return; } } // We have only one variable, and it's the same as what is being assigned, // so we need to check what is being added or subtracted. $nextNumber = ($stackPtr + 1); $previousNumber = ($stackPtr + 1); $numberCount = 0; while (($nextNumber = $phpcsFile->findNext(array(T_LNUMBER), ($nextNumber + 1), $statementEnd, false)) !== false) { $previousNumber = $nextNumber; $numberCount++; } if ($numberCount !== 1) { return; } $nextNumber = $previousNumber; if ($tokens[$nextNumber]['content'] === '1') { if ($tokens[$stackPtr]['code'] === T_EQUAL) { $opToken = $phpcsFile->findNext(array(T_PLUS, T_MINUS), ($nextVar + 1), $statementEnd); if ($opToken === false) { // Operator was before the variable, like: // $var = 1 + $var; // So we ignore it. return; } $operator = $tokens[$opToken]['content']; } else { $operator = substr($tokens[$stackPtr]['content'], 0, 1); } // If we are adding or subtracting negative value, the operator // needs to be reversed. if ($tokens[$stackPtr]['code'] !== T_EQUAL) { $negative = $phpcsFile->findPrevious(T_MINUS, ($nextNumber - 1), $stackPtr); if ($negative !== false) { if ($operator === '+') { $operator = '-'; } else { $operator = '+'; } } } $expected = $tokens[$assignedVar]['content'].$operator.$operator; $found = $phpcsFile->getTokensAsString($assignedVar, ($statementEnd - $assignedVar + 1)); if ($operator === '+') { $error = 'Increment'; } else { $error = 'Decrement'; } $error .= " operators should be used where possible; found \"$found\" but expected \"$expected\""; $phpcsFile->addError($error, $stackPtr); }//end if }//end processAssignment() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Operators/ValidLogicalOperatorsSniff.php0000644000076700000240000000462512647543456032715 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Operators_ValidLogicalOperatorsSniff. * * Checks to ensure that the logical operators 'and' and 'or' are not used. * Use the && and || operators instead. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Operators_ValidLogicalOperatorsSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_LOGICAL_AND, T_LOGICAL_OR, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The current file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $replacements = array( 'and' => '&&', 'or' => '||', ); $operator = strtolower($tokens[$stackPtr]['content']); if (isset($replacements[$operator]) === false) { return; } $error = 'Logical operator "%s" is prohibited; use "%s" instead'; $data = array( $operator, $replacements[$operator], ); $phpcsFile->addError($error, $stackPtr, 'NotAllowed', $data); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/CommentedOutCodeSniff.php0000644000076700000240000001721412647543456030331 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_PHP_CommentedOutCodeSniff. * * Warn about commented out code. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_CommentedOutCodeSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'CSS', ); /** * If a comment is more than $maxPercentage% code, a warning will be shown. * * @var int */ public $maxPercentage = 35; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_COMMENT); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Process whole comment blocks at once, so skip all but the first token. if ($stackPtr > 0 && $tokens[$stackPtr]['code'] === $tokens[($stackPtr - 1)]['code']) { return; } // Ignore comments at the end of code blocks. if (substr($tokens[$stackPtr]['content'], 0, 6) === '//end ') { return; } $content = ''; if ($phpcsFile->tokenizerType === 'PHP') { $content = 'numTokens; $i++) { if ($tokens[$stackPtr]['code'] !== $tokens[$i]['code']) { break; } /* Trim as much off the comment as possible so we don't have additional whitespace tokens or comment tokens */ $tokenContent = trim($tokens[$i]['content']); if (substr($tokenContent, 0, 2) === '//') { $tokenContent = substr($tokenContent, 2); } if (substr($tokenContent, 0, 1) === '#') { $tokenContent = substr($tokenContent, 1); } if (substr($tokenContent, 0, 3) === '/**') { $tokenContent = substr($tokenContent, 3); } if (substr($tokenContent, 0, 2) === '/*') { $tokenContent = substr($tokenContent, 2); } if (substr($tokenContent, -2) === '*/') { $tokenContent = substr($tokenContent, 0, -2); } if (substr($tokenContent, 0, 1) === '*') { $tokenContent = substr($tokenContent, 1); } $content .= $tokenContent.$phpcsFile->eolChar; }//end for $content = trim($content); if ($phpcsFile->tokenizerType === 'PHP') { $content .= ' ?>'; } // Quite a few comments use multiple dashes, equals signs etc // to frame comments and licence headers. $content = preg_replace('/[-=*]+/', '-', $content); // Because we are not really parsing code, the tokenizer can throw all sorts // of errors that don't mean anything, so ignore them. $oldErrors = ini_get('error_reporting'); ini_set('error_reporting', 0); try { $stringTokens = PHP_CodeSniffer_File::tokenizeString($content, $phpcsFile->tokenizer, $phpcsFile->eolChar); } catch (PHP_CodeSniffer_Exception $e) { // We couldn't check the comment, so ignore it. ini_set('error_reporting', $oldErrors); return; } ini_set('error_reporting', $oldErrors); $emptyTokens = array( T_WHITESPACE => true, T_STRING => true, T_STRING_CONCAT => true, T_ENCAPSED_AND_WHITESPACE => true, T_NONE => true, T_COMMENT => true, ); $numTokens = count($stringTokens); /* We know what the first two and last two tokens should be (because we put them there) so ignore this comment if those tokens were not parsed correctly. It obviously means this is not valid code. */ // First token is always the opening PHP tag. if ($stringTokens[0]['code'] !== T_OPEN_TAG) { return; } // Last token is always the closing PHP tag, unless something went wrong. if (isset($stringTokens[($numTokens - 1)]) === false || $stringTokens[($numTokens - 1)]['code'] !== T_CLOSE_TAG ) { return; } // Second last token is always whitespace or a comment, depending // on the code inside the comment. if ($phpcsFile->tokenizerType === 'PHP' && isset(PHP_CodeSniffer_Tokens::$emptyTokens[$stringTokens[($numTokens - 2)]['code']]) === false ) { return; } $numComment = 0; $numPossible = 0; $numCode = 0; for ($i = 0; $i < $numTokens; $i++) { if (isset($emptyTokens[$stringTokens[$i]['code']]) === true) { // Looks like comment. $numComment++; } else if (in_array($stringTokens[$i]['code'], PHP_CodeSniffer_Tokens::$comparisonTokens) === true || in_array($stringTokens[$i]['code'], PHP_CodeSniffer_Tokens::$arithmeticTokens) === true || $stringTokens[$i]['code'] === T_GOTO_LABEL ) { // Commented out HTML/XML and other docs contain a lot of these // characters, so it is best to not use them directly. $numPossible++; } else { // Looks like code. $numCode++; } } // We subtract 3 from the token number so we ignore the start/end tokens // and their surrounding whitespace. We take 2 off the number of code // tokens so we ignore the start/end tokens. if ($numTokens > 3) { $numTokens -= 3; } if ($numCode >= 2) { $numCode -= 2; } $percentCode = ceil((($numCode / $numTokens) * 100)); if ($percentCode > $this->maxPercentage) { // Just in case. $percentCode = min(100, $percentCode); $error = 'This comment is %s%% valid code; is this commented out code?'; $data = array($percentCode); $phpcsFile->addWarning($error, $stackPtr, 'Found', $data); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/DisallowBooleanStatementSniff.php0000644000076700000240000000434012647543456032072 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_PHP_DisallowBooleanStatementSniff. * * Ensures that boolean operators are only used inside control structure conditions. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_DisallowBooleanStatementSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return PHP_CodeSniffer_Tokens::$booleanOperators; }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) { $foundOwner = false; foreach ($tokens[$stackPtr]['nested_parenthesis'] as $open => $close) { if (isset($tokens[$open]['parenthesis_owner']) === true) { // Any owner means we are not just a simple statement. return; } } } $error = 'Boolean operators are not allowed outside of control structure conditions'; $phpcsFile->addError($error, $stackPtr, 'Found'); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/DisallowComparisonAssignmentSniff.php0000644000076700000240000000774112647543456033001 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_PHP_DisallowComparisonAssignmentSniff. * * Ensures that the value of a comparison is not assigned to a variable. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_DisallowComparisonAssignmentSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_EQUAL); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Ignore default value assignments in function definitions. $function = $phpcsFile->findPrevious(T_FUNCTION, ($stackPtr - 1), null, false, null, true); if ($function !== false) { $opener = $tokens[$function]['parenthesis_opener']; $closer = $tokens[$function]['parenthesis_closer']; if ($opener < $stackPtr && $closer > $stackPtr) { return; } } // Ignore values in array definitions. $array = $phpcsFile->findNext( T_ARRAY, ($stackPtr + 1), null, false, null, true ); if ($array !== false) { return; } // Ignore function calls. $ignore = array( T_STRING, T_WHITESPACE, T_OBJECT_OPERATOR, ); $next = $phpcsFile->findNext($ignore, ($stackPtr + 1), null, true); if ($tokens[$next]['code'] === T_OPEN_PARENTHESIS && $tokens[($next - 1)]['code'] === T_STRING ) { // Code will look like: $var = myFunction( // and will be ignored. return; } $endStatement = $phpcsFile->findNext(T_SEMICOLON, ($stackPtr + 1)); if ($tokens[$stackPtr]['conditions'] !== $tokens[$endStatement]['conditions']) { // This statement doesn't end with a semicolon, which is the case for // the last expression in a for loop. return; } for ($i = ($stackPtr + 1); $i < $endStatement; $i++) { if (isset(PHP_CodeSniffer_Tokens::$comparisonTokens[$tokens[$i]['code']]) === true || $tokens[$i]['code'] === T_INLINE_THEN ) { $error = 'The value of a comparison must not be assigned to a variable'; $phpcsFile->addError($error, $stackPtr, 'AssignedComparison'); break; } if (isset(PHP_CodeSniffer_Tokens::$booleanOperators[$tokens[$i]['code']]) === true || $tokens[$i]['code'] === T_BOOLEAN_NOT ) { $error = 'The value of a boolean operation must not be assigned to a variable'; $phpcsFile->addError($error, $stackPtr, 'AssignedBool'); break; } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/DisallowInlineIfSniff.php0000644000076700000240000000377012647543456030331 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Formatting_DisallowInlineIfSniff. * * Stops inline IF statements from being used. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_DisallowInlineIfSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_INLINE_THEN); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $phpcsFile->addError('Inline IF statements are not allowed', $stackPtr, 'Found'); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/DisallowMultipleAssignmentsSniff.php0000644000076700000240000001410712647543456032637 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_PHP_DisallowMultipleAssignmentsSniff. * * Ensures that there is only one value assignment on a line, and that it is * the first thing on the line. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_DisallowMultipleAssignmentsSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_EQUAL); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Ignore default value assignments in function definitions. $function = $phpcsFile->findPrevious(array(T_FUNCTION, T_CLOSURE), ($stackPtr - 1), null, false, null, true); if ($function !== false) { $opener = $tokens[$function]['parenthesis_opener']; $closer = $tokens[$function]['parenthesis_closer']; if ($opener < $stackPtr && $closer > $stackPtr) { return; } } /* The general rule is: Find an equal sign and go backwards along the line. If you hit an end bracket, skip to the opening bracket. When you find a variable, stop. That variable must be the first non-empty token on the line or in the statement. If not, throw an error. */ for ($varToken = ($stackPtr - 1); $varToken >= 0; $varToken--) { // Skip brackets. if (isset($tokens[$varToken]['parenthesis_opener']) === true && $tokens[$varToken]['parenthesis_opener'] < $varToken) { $varToken = $tokens[$varToken]['parenthesis_opener']; continue; } if (isset($tokens[$varToken]['bracket_opener']) === true) { $varToken = $tokens[$varToken]['bracket_opener']; continue; } if ($tokens[$varToken]['code'] === T_SEMICOLON) { // We've reached the next statement, so we // didn't find a variable. return; } if ($tokens[$varToken]['code'] === T_VARIABLE) { // We found our variable. break; } }//end for if ($varToken <= 0) { // Didn't find a variable. return; } // Deal with this type of variable: self::$var by setting the var // token to be "self" rather than "$var". if ($tokens[($varToken - 1)]['code'] === T_DOUBLE_COLON) { $varToken = ($varToken - 2); } // Deal with this type of variable: $obj->$var by setting the var // token to be "$obj" rather than "$var". if ($tokens[($varToken - 1)]['code'] === T_OBJECT_OPERATOR) { $varToken = ($varToken - 2); } // Deal with this type of variable: $$var by setting the var // token to be "$" rather than "$var". if ($tokens[($varToken - 1)]['content'] === '$') { $varToken--; } // Ignore member var definitions. $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($varToken - 1), null, true); if (isset(PHP_CodeSniffer_Tokens::$scopeModifiers[$tokens[$prev]['code']]) === true) { return; } if ($tokens[$prev]['code'] === T_STATIC) { return; } // Make sure this variable is the first thing in the statement. $varLine = $tokens[$varToken]['line']; $prevLine = 0; for ($i = ($varToken - 1); $i >= 0; $i--) { if ($tokens[$i]['code'] === T_SEMICOLON) { // We reached the end of the statement. return; } if ($tokens[$i]['code'] === T_INLINE_THEN) { // We reached the end of the inline THEN statement. return; } if ($tokens[$i]['code'] === T_INLINE_ELSE) { // We reached the end of the inline ELSE statement. return; } if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$i]['code']]) === false) { $prevLine = $tokens[$i]['line']; break; } }//end for // Ignore the first part of FOR loops as we are allowed to // assign variables there even though the variable is not the // first thing on the line. Also ignore WHILE loops. if ($tokens[$i]['code'] === T_OPEN_PARENTHESIS && isset($tokens[$i]['parenthesis_owner']) === true) { $owner = $tokens[$i]['parenthesis_owner']; if ($tokens[$owner]['code'] === T_FOR || $tokens[$owner]['code'] === T_WHILE) { return; } } if ($prevLine === $varLine) { $error = 'Assignments must be the first block of code on a line'; $phpcsFile->addError($error, $stackPtr, 'Found'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/DisallowObEndFlushSniff.php0000644000076700000240000000366712647543456030632 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Formatting_DisallowObEndFlushSniff. * * Checks the indenting used when an ob_start() call occurs. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_DisallowObEndFlushSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_STRING); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[$stackPtr]['content'] === 'ob_end_flush') { $phpcsFile->addError('Use of ob_end_flush() is not allowed; use ob_get_contents() and ob_end_clean() instead', $stackPtr, 'Found'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/DisallowSizeFunctionsInLoopsSniff.php0000644000076700000240000001045212647543456032736 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_PHP_DisallowSizeFunctionsInLoopsSniff. * * Bans the use of size-based functions in loop conditions. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_DisallowSizeFunctionsInLoopsSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * An array of functions we don't want in the condition of loops. * * @return array */ protected $forbiddenFunctions = array( 'PHP' => array( 'sizeof' => true, 'strlen' => true, 'count' => true, ), 'JS' => array('length' => true), ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_WHILE, T_FOR, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $tokenizer = $phpcsFile->tokenizerType; $openBracket = $tokens[$stackPtr]['parenthesis_opener']; $closeBracket = $tokens[$stackPtr]['parenthesis_closer']; if ($tokens[$stackPtr]['code'] === T_FOR) { // We only want to check the condition in FOR loops. $start = $phpcsFile->findNext(T_SEMICOLON, ($openBracket + 1)); $end = $phpcsFile->findPrevious(T_SEMICOLON, ($closeBracket - 1)); } else { $start = $openBracket; $end = $closeBracket; } for ($i = ($start + 1); $i < $end; $i++) { if ($tokens[$i]['code'] === T_STRING && isset($this->forbiddenFunctions[$tokenizer][$tokens[$i]['content']]) === true ) { $functionName = $tokens[$i]['content']; if ($tokenizer === 'JS') { // Needs to be in the form object.function to be valid. $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($i - 1), null, true); if ($prev === false || $tokens[$prev]['code'] !== T_OBJECT_OPERATOR) { continue; } $functionName = 'object.'.$functionName; } else { // Make sure it isn't a member var. if ($tokens[($i - 1)]['code'] === T_OBJECT_OPERATOR) { continue; } $functionName .= '()'; } $error = 'The use of %s inside a loop condition is not allowed; assign the return value to a variable and use the variable in the loop condition instead'; $data = array($functionName); $phpcsFile->addError($error, $i, 'Found', $data); }//end if }//end for }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/DiscouragedFunctionsSniff.php0000644000076700000240000000332312647543456031251 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('Generic_Sniffs_PHP_ForbiddenFunctionsSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class Generic_Sniffs_PHP_ForbiddenFunctionsSniff not found'); } /** * Squiz_Sniffs_PHP_DiscouragedFunctionsSniff. * * Discourages the use of debug functions. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_DiscouragedFunctionsSniff extends Generic_Sniffs_PHP_ForbiddenFunctionsSniff { /** * A list of forbidden functions with their alternatives. * * The value is NULL if no alternative exists. IE, the * function should just not be used. * * @var array(string => string|null) */ public $forbiddenFunctions = array( 'error_log' => null, 'print_r' => null, 'var_dump' => null, ); /** * If true, an error will be thrown; otherwise a warning. * * @var bool */ public $error = false; }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/EmbeddedPhpSniff.php0000644000076700000240000004073212647543456027275 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_PHP_EmbeddedPhpSniff. * * Checks the indentation of embedded PHP code segments. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_EmbeddedPhpSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // If the close php tag is on the same line as the opening // then we have an inline embedded PHP block. $closeTag = $phpcsFile->findNext(T_CLOSE_TAG, $stackPtr); if ($closeTag === false || $tokens[$stackPtr]['line'] !== $tokens[$closeTag]['line']) { $this->_validateMultilineEmbeddedPhp($phpcsFile, $stackPtr); } else { $this->_validateInlineEmbeddedPhp($phpcsFile, $stackPtr); } }//end process() /** * Validates embedded PHP that exists on multiple lines. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ private function _validateMultilineEmbeddedPhp(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $prevTag = $phpcsFile->findPrevious(T_OPEN_TAG, ($stackPtr - 1)); if ($prevTag === false) { // This is the first open tag. return; } $firstContent = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); $closingTag = $phpcsFile->findNext(T_CLOSE_TAG, $stackPtr); if ($closingTag !== false) { $nextContent = $phpcsFile->findNext(T_WHITESPACE, ($closingTag + 1), $phpcsFile->numTokens, true); if ($nextContent === false) { // Final closing tag. It will be handled elsewhere. return; } // We have an opening and a closing tag, that lie within other content. if ($firstContent === $closingTag) { $error = 'Empty embedded PHP tag found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Empty'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = $stackPtr; $i <= $closingTag; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } return; } }//end if if ($tokens[$firstContent]['line'] === $tokens[$stackPtr]['line']) { $error = 'Opening PHP tag must be on a line by itself'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'ContentAfterOpen'); if ($fix === true) { $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $stackPtr, true); $padding = (strlen($tokens[$first]['content']) - strlen(ltrim($tokens[$first]['content']))); $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->addNewline($stackPtr); $phpcsFile->fixer->addContent($stackPtr, str_repeat(' ', $padding)); $phpcsFile->fixer->endChangeset(); } } else { // Check the indent of the first line, except if it is a scope closer. if (isset($tokens[$firstContent]['scope_closer']) === false || $tokens[$firstContent]['scope_closer'] !== $firstContent ) { // Check for a blank line at the top. if ($tokens[$firstContent]['line'] > ($tokens[$stackPtr]['line'] + 1)) { // Find a token on the blank line to throw the error on. $i = $stackPtr; do { $i++; } while ($tokens[$i]['line'] !== ($tokens[$stackPtr]['line'] + 1)); $error = 'Blank line found at start of embedded PHP content'; $fix = $phpcsFile->addFixableError($error, $i, 'SpacingBefore'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($stackPtr + 1); $i < $firstContent; $i++) { if ($tokens[$i]['line'] === $tokens[$firstContent]['line'] || $tokens[$i]['line'] === $tokens[$stackPtr]['line'] ) { continue; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } }//end if $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $stackPtr); if ($first === false) { $first = $phpcsFile->findFirstOnLine(T_INLINE_HTML, $stackPtr); $indent = (strlen($tokens[$first]['content']) - strlen(ltrim($tokens[$first]['content']))); } else { $indent = ($tokens[($first + 1)]['column'] - 1); } $contentColumn = ($tokens[$firstContent]['column'] - 1); if ($contentColumn !== $indent) { $error = 'First line of embedded PHP code must be indented %s spaces; %s found'; $data = array( $indent, $contentColumn, ); $fix = $phpcsFile->addFixableError($error, $firstContent, 'Indent', $data); if ($fix === true) { $padding = str_repeat(' ', $indent); if ($contentColumn === 0) { $phpcsFile->fixer->addContentBefore($firstContent, $padding); } else { $phpcsFile->fixer->replaceToken(($firstContent - 1), $padding); } } } }//end if }//end if $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if ($tokens[$lastContent]['line'] === $tokens[$stackPtr]['line'] && trim($tokens[$lastContent]['content']) !== '' ) { $error = 'Opening PHP tag must be on a line by itself'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'ContentBeforeOpen'); if ($fix === true) { $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $stackPtr); if ($first === false) { $first = $phpcsFile->findFirstOnLine(T_INLINE_HTML, $stackPtr); $padding = (strlen($tokens[$first]['content']) - strlen(ltrim($tokens[$first]['content']))); } else { $padding = ($tokens[($first + 1)]['column'] - 1); } $phpcsFile->fixer->addContentBefore($stackPtr, $phpcsFile->eolChar.str_repeat(' ', $padding)); } } else { // Find the first token on the first non-empty line we find. for ($first = ($stackPtr - 1); $first > 0; $first--) { if ($tokens[$first]['line'] === $tokens[$stackPtr]['line']) { continue; } else if (trim($tokens[$first]['content']) !== '') { $first = $phpcsFile->findFirstOnLine(array(), $first, true); break; } } $expected = 0; if ($tokens[$first]['code'] === T_INLINE_HTML && trim($tokens[$first]['content']) !== '' ) { $expected = (strlen($tokens[$first]['content']) - strlen(ltrim($tokens[$first]['content']))); } else if ($tokens[$first]['code'] === T_WHITESPACE) { $expected = ($tokens[($first + 1)]['column'] - 1); } $expected += 4; $found = ($tokens[$stackPtr]['column'] - 1); if ($found > $expected) { $error = 'Opening PHP tag indent incorrect; expected no more than %s spaces but found %s'; $data = array( $expected, $found, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'OpenTagIndent', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr - 1), str_repeat(' ', $expected)); } } }//end if if ($closingTag === false) { return; } $lastContent = $phpcsFile->findPrevious(T_WHITESPACE, ($closingTag - 1), ($stackPtr + 1), true); $nextContent = $phpcsFile->findNext(T_WHITESPACE, ($closingTag + 1), null, true); if ($tokens[$lastContent]['line'] === $tokens[$closingTag]['line']) { $error = 'Closing PHP tag must be on a line by itself'; $fix = $phpcsFile->addFixableError($error, $closingTag, 'ContentBeforeEnd'); if ($fix === true) { $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $closingTag, true); $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->addContentBefore($closingTag, str_repeat(' ', ($tokens[$first]['column'] - 1))); $phpcsFile->fixer->addNewlineBefore($closingTag); $phpcsFile->fixer->endChangeset(); } } else if ($tokens[$nextContent]['line'] === $tokens[$closingTag]['line']) { $error = 'Closing PHP tag must be on a line by itself'; $fix = $phpcsFile->addFixableError($error, $closingTag, 'ContentAfterEnd'); if ($fix === true) { $first = $phpcsFile->findFirstOnLine(T_WHITESPACE, $closingTag, true); $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->addNewline($closingTag); $phpcsFile->fixer->addContent($closingTag, str_repeat(' ', ($tokens[$first]['column'] - 1))); $phpcsFile->fixer->endChangeset(); } }//end if $next = $phpcsFile->findNext(T_OPEN_TAG, ($closingTag + 1)); if ($next === false) { return; } // Check for a blank line at the bottom. if ((isset($tokens[$lastContent]['scope_closer']) === false || $tokens[$lastContent]['scope_closer'] !== $lastContent) && $tokens[$lastContent]['line'] < ($tokens[$closingTag]['line'] - 1) ) { // Find a token on the blank line to throw the error on. $i = $closingTag; do { $i--; } while ($tokens[$i]['line'] !== ($tokens[$closingTag]['line'] - 1)); $error = 'Blank line found at end of embedded PHP content'; $fix = $phpcsFile->addFixableError($error, $i, 'SpacingAfter'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($lastContent + 1); $i < $closingTag; $i++) { if ($tokens[$i]['line'] === $tokens[$lastContent]['line'] || $tokens[$i]['line'] === $tokens[$closingTag]['line'] ) { continue; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } }//end if }//end _validateMultilineEmbeddedPhp() /** * Validates embedded PHP that exists on one line. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ private function _validateInlineEmbeddedPhp(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // We only want one line PHP sections, so return if the closing tag is // on the next line. $closeTag = $phpcsFile->findNext(T_CLOSE_TAG, $stackPtr, null, false); if ($tokens[$stackPtr]['line'] !== $tokens[$closeTag]['line']) { return; } // Check that there is one, and only one space at the start of the statement. $firstContent = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), ($closeTag - 1), true); if ($firstContent === false) { $error = 'Empty embedded PHP tag found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Empty'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = $stackPtr; $i <= $closeTag; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } return; } // The open tag token always contains a single space after it. $leadingSpace = 1; if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) { $leadingSpace = (strlen($tokens[($stackPtr + 1)]['content']) + 1); } if ($leadingSpace !== 1) { $error = 'Expected 1 space after opening PHP tag; %s found'; $data = array($leadingSpace); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterOpen', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ''); } } $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($closeTag - 1), $stackPtr, true); if ($tokens[$prev]['code'] !== T_SEMICOLON) { $error = 'Inline PHP statement must end with a semicolon'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSemicolon'); if ($fix === true) { $phpcsFile->fixer->addContent($prev, ';'); } } else { $statementCount = 1; for ($i = ($stackPtr + 1); $i < $prev; $i++) { if ($tokens[$i]['code'] === T_SEMICOLON) { $statementCount++; } } if ($statementCount > 1) { $error = 'Inline PHP statement must contain a single statement; %s found'; $data = array($statementCount); $phpcsFile->addError($error, $stackPtr, 'MultipleStatements', $data); } } $trailingSpace = 0; if ($tokens[($closeTag - 1)]['code'] === T_WHITESPACE) { $trailingSpace = strlen($tokens[($closeTag - 1)]['content']); } if ($trailingSpace !== 1) { $error = 'Expected 1 space before closing PHP tag; %s found'; $data = array($trailingSpace); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeClose', $data); if ($fix === true) { if ($trailingSpace === 0) { $phpcsFile->fixer->addContentBefore($closeTag, ' '); } else { $phpcsFile->fixer->replaceToken(($closeTag - 1), ' '); } } } }//end _validateInlineEmbeddedPhp() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/EvalSniff.php0000644000076700000240000000332212647543456026015 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_PHP_EvalSniff. * * The use of eval() is discouraged. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_EvalSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_EVAL); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $error = 'Use of eval() is discouraged'; $phpcsFile->addWarning($error, $stackPtr, 'Discouraged'); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/ForbiddenFunctionsSniff.php0000644000076700000240000000366012647543456030720 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('Generic_Sniffs_PHP_ForbiddenFunctionsSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class Generic_Sniffs_PHP_ForbiddenFunctionsSniff not found'); } /** * Squiz_Sniffs_PHP_ForbiddenFunctionsSniff. * * Discourages the use of alias functions that are kept in PHP for compatibility * with older versions. Can be used to forbid the use of any function. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_ForbiddenFunctionsSniff extends Generic_Sniffs_PHP_ForbiddenFunctionsSniff { /** * A list of forbidden functions with their alternatives. * * The value is NULL if no alternative exists. IE, the * function should just not be used. * * @var array(string => string|null) */ public $forbiddenFunctions = array( 'sizeof' => 'count', 'delete' => 'unset', 'print' => 'echo', 'is_null' => null, 'create_function' => null, ); }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/GlobalKeywordSniff.php0000644000076700000240000000400612647543456027673 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_PHP_GlobalKeywordSniff. * * Stops the usage of the "global" keyword. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_GlobalKeywordSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_GLOBAL); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $nextVar = $tokens[$phpcsFile->findNext(array(T_VARIABLE), $stackPtr)]; $varName = str_replace('$', '', $nextVar['content']); $error = 'Use of the "global" keyword is forbidden; use "$GLOBALS[\'%s\']" instead'; $data = array($varName); $phpcsFile->addError($error, $stackPtr, 'NotAllowed', $data); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/HeredocSniff.php0000644000076700000240000000357312647543456026507 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_PHP_HeredocSniff. * * Heredocs are prohibited. This test enforces that. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_HeredocSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_START_HEREDOC, T_START_NOWDOC, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $error = 'Use of heredoc and nowdoc syntax ("<<<") is not allowed; use standard strings or inline HTML instead'; $phpcsFile->addError($error, $stackPtr, 'NotAllowed'); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/InnerFunctionsSniff.php0000644000076700000240000000416212647543456030075 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_PHP_InnerFunctionsSniff. * * Ensures that functions within functions are never used. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_InnerFunctionsSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_FUNCTION); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($phpcsFile->hasCondition($stackPtr, T_FUNCTION) === true) { $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if ($tokens[$prev]['code'] === T_EQUAL) { // Ignore closures. return; } $error = 'The use of inner functions is forbidden'; $phpcsFile->addError($error, $stackPtr, 'NotAllowed'); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/LowercasePHPFunctionsSniff.php0000644000076700000240000000726312647543456031323 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_PHP_LowercasePHPFunctionsSniff. * * Ensures all calls to inbuilt PHP functions are lowercase. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_LowercasePHPFunctionsSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_STRING); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Make sure this is a function call. $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($next === false) { // Not a function call. return; } if ($tokens[$next]['code'] !== T_OPEN_PARENTHESIS) { // Not a function call. return; } $prev = $phpcsFile->findPrevious(array(T_WHITESPACE, T_BITWISE_AND), ($stackPtr - 1), null, true); if ($tokens[$prev]['code'] === T_FUNCTION) { // Function declaration, not a function call. return; } if ($tokens[$prev]['code'] === T_NS_SEPARATOR) { // Namespaced class/function, not an inbuilt function. return; } if ($tokens[$prev]['code'] === T_NEW) { // Object creation, not an inbuilt function. return; } if ($tokens[$prev]['code'] === T_OBJECT_OPERATOR) { // Not an inbuilt function. return; } if ($tokens[$prev]['code'] === T_DOUBLE_COLON) { // Not an inbuilt function. return; } // Make sure it is an inbuilt PHP function. // PHP_CodeSniffer doesn't include/require any files, so no // user defined global functions can exist, except for // PHP_CodeSniffer ones. $content = $tokens[$stackPtr]['content']; if (function_exists($content) === false) { return; } if ($content !== strtolower($content)) { $error = 'Calls to inbuilt PHP functions must be lowercase; expected "%s" but found "%s"'; $data = array( strtolower($content), $content, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'CallUppercase', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, strtolower($content)); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/PHP/NonExecutableCodeSniff.php0000644000076700000240000002412212647543456030456 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_PHP_NonExecutableCodeSniff. * * Warns about code that can never been executed. This happens when a function * returns before the code, or a break ends execution of a statement etc. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_PHP_NonExecutableCodeSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_BREAK, T_CONTINUE, T_RETURN, T_THROW, T_EXIT, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // If this token is preceded with an "or", it only relates to one line // and should be ignored. For example: fopen() or die(). $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); if ($tokens[$prev]['code'] === T_LOGICAL_OR) { return; } // Check if this token is actually part of a one-line IF or ELSE statement. for ($i = ($stackPtr - 1); $i > 0; $i--) { if ($tokens[$i]['code'] === T_CLOSE_PARENTHESIS) { $i = $tokens[$i]['parenthesis_opener']; continue; } else if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$i]['code']]) === true) { continue; } break; } if ($tokens[$i]['code'] === T_IF || $tokens[$i]['code'] === T_ELSE || $tokens[$i]['code'] === T_ELSEIF ) { return; } if ($tokens[$stackPtr]['code'] === T_RETURN) { $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$next]['code'] === T_SEMICOLON) { $next = $phpcsFile->findNext(T_WHITESPACE, ($next + 1), null, true); if ($tokens[$next]['code'] === T_CLOSE_CURLY_BRACKET) { // If this is the closing brace of a function // then this return statement doesn't return anything // and is not required anyway. $owner = $tokens[$next]['scope_condition']; if ($tokens[$owner]['code'] === T_FUNCTION) { $warning = 'Empty return statement not required here'; $phpcsFile->addWarning($warning, $stackPtr, 'ReturnNotRequired'); return; } } } } if (isset($tokens[$stackPtr]['scope_opener']) === true) { $owner = $tokens[$stackPtr]['scope_condition']; if ($tokens[$owner]['code'] === T_CASE || $tokens[$owner]['code'] === T_DEFAULT) { // This token closes the scope of a CASE or DEFAULT statement // so any code between this token and the next CASE, DEFAULT or // end of SWITCH token will not be executable. $next = $phpcsFile->findNext( array( T_CASE, T_DEFAULT, T_CLOSE_CURLY_BRACKET, ), ($stackPtr + 1) ); if ($next !== false) { $end = $phpcsFile->findNext(array(T_SEMICOLON), ($stackPtr + 1)); $lastLine = $tokens[$end]['line']; for ($i = ($stackPtr + 1); $i < $next; $i++) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$i]['code']]) === true) { continue; } $line = $tokens[$i]['line']; if ($line > $lastLine) { $type = substr($tokens[$stackPtr]['type'], 2); $warning = 'Code after %s statement cannot be executed'; $data = array($type); $phpcsFile->addWarning($warning, $i, 'Unreachable', $data); $lastLine = $line; } } }//end if // That's all we have to check for these types of statements. return; }//end if }//end if // This token may be part of an inline condition. // If we find a closing parenthesis that belongs to a condition // we should ignore this token. $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true); if (isset($tokens[$prev]['parenthesis_owner']) === true) { $owner = $tokens[$prev]['parenthesis_owner']; $ignore = array( T_IF => true, T_ELSE => true, T_ELSEIF => true, ); if (isset($ignore[$tokens[$owner]['code']]) === true) { return; } } $ourConditions = array_keys($tokens[$stackPtr]['conditions']); if (empty($ourConditions) === false) { $condition = array_pop($ourConditions); if (isset($tokens[$condition]['scope_closer']) === false) { return; } // Special case for BREAK statements sitting directly inside SWITCH // statements. If we get to this point, we know the BREAK is not being // used to close a CASE statement, so it is most likely non-executable // code itself (as is the case when you put return; break; at the end of // a case). So we need to ignore this token. if ($tokens[$condition]['code'] === T_SWITCH && $tokens[$stackPtr]['code'] === T_BREAK ) { return; } $closer = $tokens[$condition]['scope_closer']; // If the closer for our condition is shared with other openers, // we will need to throw errors from this token to the next // shared opener (if there is one), not to the scope closer. $nextOpener = null; for ($i = ($stackPtr + 1); $i < $closer; $i++) { if (isset($tokens[$i]['scope_closer']) === true) { if ($tokens[$i]['scope_closer'] === $closer) { // We found an opener that shares the same // closing token as us. $nextOpener = $i; break; } } }//end for if ($nextOpener === null) { $end = $closer; } else { $end = ($nextOpener - 1); } } else { // This token is in the global scope. if ($tokens[$stackPtr]['code'] === T_BREAK) { return; } // Throw an error for all lines until the end of the file. $end = ($phpcsFile->numTokens - 1); }//end if // Find the semicolon that ends this statement, skipping // nested statements like FOR loops and closures. for ($start = ($stackPtr + 1); $start < $phpcsFile->numTokens; $start++) { if ($start === $end) { break; } if ($tokens[$start]['code'] === T_OPEN_PARENTHESIS) { $start = $tokens[$start]['parenthesis_closer']; continue; } if ($tokens[$start]['code'] === T_OPEN_CURLY_BRACKET) { $start = $tokens[$start]['bracket_closer']; continue; } if ($tokens[$start]['code'] === T_SEMICOLON) { break; } }//end for $lastLine = $tokens[$start]['line']; for ($i = ($start + 1); $i < $end; $i++) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$i]['code']]) === true || isset(PHP_CodeSniffer_Tokens::$bracketTokens[$tokens[$i]['code']]) === true ) { continue; } // Skip whole functions and classes/interfaces because they are not // technically executed code, but rather declarations that may be used. if ($tokens[$i]['code'] === T_FUNCTION || $tokens[$i]['code'] === T_CLASS || $tokens[$i]['code'] === T_INTERFACE ) { $i = $tokens[$i]['scope_closer']; continue; } $line = $tokens[$i]['line']; if ($line > $lastLine) { $type = substr($tokens[$stackPtr]['type'], 2); $warning = 'Code after %s statement cannot be executed'; $data = array($type); $phpcsFile->addWarning($warning, $i, 'Unreachable', $data); $lastLine = $line; } }//end for }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Scope/MemberVarScopeSniff.php0000644000076700000240000000617012647543456030426 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractVariableSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractVariableSniff not found'); } /** * Verifies that class members have scope modifiers. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Scope_MemberVarScopeSniff extends PHP_CodeSniffer_Standards_AbstractVariableSniff { /** * Processes the function tokens within the class. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the token was found. * * @return void */ protected function processMemberVar(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $modifier = null; for ($i = ($stackPtr - 1); $i > 0; $i--) { if ($tokens[$i]['line'] < $tokens[$stackPtr]['line']) { break; } else if (isset(PHP_CodeSniffer_Tokens::$scopeModifiers[$tokens[$i]['code']]) === true) { $modifier = $i; break; } } if ($modifier === null) { $error = 'Scope modifier not specified for member variable "%s"'; $data = array($tokens[$stackPtr]['content']); $phpcsFile->addError($error, $stackPtr, 'Missing', $data); } }//end processMemberVar() /** * Processes normal variables. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the token was found. * * @return void */ protected function processVariable(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { /* We don't care about normal variables. */ }//end processVariable() /** * Processes variables in double quoted strings. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the token was found. * * @return void */ protected function processVariableInString(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { /* We don't care about normal variables. */ }//end processVariableInString() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Scope/MethodScopeSniff.php0000644000076700000240000000544412647543456027771 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found'); } /** * Verifies that class methods have scope modifiers. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Scope_MethodScopeSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff { /** * Constructs a Squiz_Sniffs_Scope_MethodScopeSniff. */ public function __construct() { parent::__construct(array(T_CLASS, T_INTERFACE), array(T_FUNCTION)); }//end __construct() /** * Processes the function tokens within the class. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the token was found. * @param int $currScope The current scope opener token. * * @return void */ protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope) { $tokens = $phpcsFile->getTokens(); $methodName = $phpcsFile->getDeclarationName($stackPtr); if ($methodName === null) { // Ignore closures. return; } if ($phpcsFile->hasCondition($stackPtr, T_FUNCTION) === true) { // Ignore nested functions. return; } $modifier = null; for ($i = ($stackPtr - 1); $i > 0; $i--) { if ($tokens[$i]['line'] < $tokens[$stackPtr]['line']) { break; } else if (isset(PHP_CodeSniffer_Tokens::$scopeModifiers[$tokens[$i]['code']]) === true) { $modifier = $i; break; } } if ($modifier === null) { $error = 'Visibility must be declared on method "%s"'; $data = array($methodName); $phpcsFile->addError($error, $stackPtr, 'Missing', $data); } }//end processTokenWithinScope() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Scope/StaticThisUsageSniff.php0000644000076700000240000000624112647543456030617 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found'); } /** * Squiz_Sniffs_Scope_StaticThisUsageSniff. * * Checks for usage of "$this" in static methods, which will cause * runtime errors. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Scope_StaticThisUsageSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff { /** * Constructs the test with the tokens it wishes to listen for. */ public function __construct() { parent::__construct(array(T_CLASS), array(T_FUNCTION)); }//end __construct() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The current file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * @param int $currScope A pointer to the start of the scope. * * @return void */ public function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope) { $tokens = $phpcsFile->getTokens(); $function = $tokens[($stackPtr + 2)]; if ($function['code'] !== T_STRING) { return; } $functionName = $function['content']; $classOpener = $tokens[$currScope]['scope_condition']; $className = $tokens[($classOpener + 2)]['content']; $methodProps = $phpcsFile->getMethodProperties($stackPtr); if ($methodProps['is_static'] === true) { if (isset($tokens[$stackPtr]['scope_closer']) === false) { // There is no scope opener or closer, so the function // must be abstract. return; } $thisUsage = $stackPtr; while (($thisUsage = $phpcsFile->findNext(array(T_VARIABLE), ($thisUsage + 1), $tokens[$stackPtr]['scope_closer'], false, '$this')) !== false) { if ($thisUsage === false) { return; } $error = 'Usage of "$this" in static methods will cause runtime errors'; $phpcsFile->addError($error, $thisUsage, 'Found'); } }//end if }//end processTokenWithinScope() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Strings/ConcatenationSpacingSniff.php0000644000076700000240000001077312647543456032232 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Strings_ConcatenationSpacingSniff. * * Makes sure there are no spaces between the concatenation operator (.) and * the strings being concatenated. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Strings_ConcatenationSpacingSniff implements PHP_CodeSniffer_Sniff { /** * The number of spaces before and after a string concat. * * @var int */ public $spacing = 0; /** * Allow newlines instead of spaces. * * @var boolean */ public $ignoreNewlines = false; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_STRING_CONCAT); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $this->spacing = (int) $this->spacing; $tokens = $phpcsFile->getTokens(); if ($tokens[($stackPtr - 1)]['code'] !== T_WHITESPACE) { $before = 0; } else { if ($tokens[($stackPtr - 2)]['line'] !== $tokens[$stackPtr]['line']) { $before = 'newline'; } else { $before = $tokens[($stackPtr - 1)]['length']; } } if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE) { $after = 0; } else { if ($tokens[($stackPtr + 2)]['line'] !== $tokens[$stackPtr]['line']) { $after = 'newline'; } else { $after = $tokens[($stackPtr + 1)]['length']; } } $phpcsFile->recordMetric($stackPtr, 'Spacing before string concat', $before); $phpcsFile->recordMetric($stackPtr, 'Spacing after string concat', $after); if (($before === $this->spacing || ($before === 'newline' && $this->ignoreNewlines === true)) && ($after === $this->spacing || ($after === 'newline' && $this->ignoreNewlines === true)) ) { return; } if ($this->spacing === 0) { $message = 'Concat operator must not be surrounded by spaces'; $data = array(); } else { if ($this->spacing > 1) { $message = 'Concat operator must be surrounded by %s spaces'; } else { $message = 'Concat operator must be surrounded by a single space'; } $data = array($this->spacing); } $fix = $phpcsFile->addFixableError($message, $stackPtr, 'PaddingFound', $data); if ($fix === true) { $padding = str_repeat(' ', $this->spacing); if ($before !== 'newline' || $this->ignoreNewlines === false) { if ($tokens[($stackPtr - 1)]['code'] === T_WHITESPACE) { $phpcsFile->fixer->replaceToken(($stackPtr - 1), $padding); } else if ($this->spacing > 0) { $phpcsFile->fixer->addContent(($stackPtr - 1), $padding); } } if ($after !== 'newline' || $this->ignoreNewlines === false) { if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), $padding); } else if ($this->spacing > 0) { $phpcsFile->fixer->addContent($stackPtr, $padding); } } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Strings/DoubleQuoteUsageSniff.php0000644000076700000240000001150112647543456031343 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Strings_DoubleQuoteUsageSniff. * * Makes sure that any use of Double Quotes ("") are warranted. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Strings_DoubleQuoteUsageSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_CONSTANT_ENCAPSED_STRING, T_DOUBLE_QUOTED_STRING, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // We are only interested in the first token in a multi-line string. if ($tokens[$stackPtr]['code'] === $tokens[($stackPtr - 1)]['code']) { return; } $workingString = $tokens[$stackPtr]['content']; $lastStringToken = $stackPtr; $i = ($stackPtr + 1); if (isset($tokens[$i]) === true) { while ($tokens[$i]['code'] === $tokens[$stackPtr]['code']) { $workingString .= $tokens[$i]['content']; $lastStringToken = $i; $i++; } } // Check if it's a double quoted string. if (strpos($workingString, '"') === false) { return; } // Make sure it's not a part of a string started in a previous line. // If it is, then we have already checked it. if ($workingString[0] !== '"') { return; } // The use of variables in double quoted strings is not allowed. if ($tokens[$stackPtr]['code'] === T_DOUBLE_QUOTED_STRING) { $stringTokens = token_get_all('addError($error, $stackPtr, 'ContainsVar', $data); } } return; }//end if $allowedChars = array( '\0', '\1', '\2', '\3', '\4', '\5', '\6', '\7', '\n', '\r', '\f', '\t', '\v', '\x', '\b', '\e', '\u', '\'', ); foreach ($allowedChars as $testChar) { if (strpos($workingString, $testChar) !== false) { return; } } $error = 'String %s does not require double quotes; use single quotes instead'; $data = array(str_replace("\n", '\n', $workingString)); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NotRequired', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $innerContent = substr($workingString, 1, -1); $innerContent = str_replace('\"', '"', $innerContent); $phpcsFile->fixer->replaceToken($stackPtr, "'$innerContent'"); while ($lastStringToken !== $stackPtr) { $phpcsFile->fixer->replaceToken($lastStringToken, ''); $lastStringToken--; } $phpcsFile->fixer->endChangeset(); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/Strings/EchoedStringsSniff.php0000644000076700000240000000676612647543456030710 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Strings_EchoedStringsSniff. * * Makes sure that any strings that are "echoed" are not enclosed in brackets * like a function call. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_Strings_EchoedStringsSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_ECHO); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $firstContent = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); // If the first non-whitespace token is not an opening parenthesis, then we are not concerned. if ($tokens[$firstContent]['code'] !== T_OPEN_PARENTHESIS) { $phpcsFile->recordMetric($stackPtr, 'Brackets around echoed strings', 'no'); return; } $end = $phpcsFile->findNext(array(T_SEMICOLON, T_CLOSE_TAG), $stackPtr, null, false); // If the token before the semi-colon is not a closing parenthesis, then we are not concerned. $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($end - 1), null, true); if ($tokens[$prev]['code'] !== T_CLOSE_PARENTHESIS) { $phpcsFile->recordMetric($stackPtr, 'Brackets around echoed strings', 'no'); return; } // If the parenthesis don't match, then we are not concerned. if ($tokens[$firstContent]['parenthesis_closer'] !== $prev) { $phpcsFile->recordMetric($stackPtr, 'Brackets around echoed strings', 'no'); return; } $phpcsFile->recordMetric($stackPtr, 'Brackets around echoed strings', 'yes'); if (($phpcsFile->findNext(PHP_CodeSniffer_Tokens::$operators, $stackPtr, $end, false)) === false) { // There are no arithmetic operators in this. $error = 'Echoed strings should not be bracketed'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'HasBracket'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $phpcsFile->fixer->replaceToken($firstContent, ''); $phpcsFile->fixer->replaceToken(($end - 1), ''); $phpcsFile->fixer->endChangeset(); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/CastSpacingSniff.php0000644000076700000240000000452612647543456030741 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_WhiteSpace_CastSpacingSniff. * * Ensure cast statements don't contain whitespace. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_WhiteSpace_CastSpacingSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return PHP_CodeSniffer_Tokens::$castTokens; }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $content = $tokens[$stackPtr]['content']; $expected = str_replace(' ', '', $content); $expected = str_replace("\t", '', $expected); if ($content !== $expected) { $error = 'Cast statements must not contain whitespace; expected "%s" but found "%s"'; $data = array( $expected, $content, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'ContainsWhiteSpace', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, $expected); } } }//end process() }//end class ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/ControlStructureSpacingSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/ControlStructureSpacingSniff.php0000644000076700000240000002722312647543456033407 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_WhiteSpace_ControlStructureSpacingSniff. * * Checks that control structures have the correct spacing around brackets. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_WhiteSpace_ControlStructureSpacingSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_IF, T_WHILE, T_FOREACH, T_FOR, T_SWITCH, T_DO, T_ELSE, T_ELSEIF, T_TRY, T_CATCH, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['parenthesis_opener']) === true && isset($tokens[$stackPtr]['parenthesis_closer']) === true ) { $parenOpener = $tokens[$stackPtr]['parenthesis_opener']; $parenCloser = $tokens[$stackPtr]['parenthesis_closer']; if ($tokens[($parenOpener + 1)]['code'] === T_WHITESPACE) { $gap = $tokens[($parenOpener + 1)]['length']; if ($gap === 0) { $phpcsFile->recordMetric($stackPtr, 'Spaces after control structure open parenthesis', 'newline'); $gap = 'newline'; } else { $phpcsFile->recordMetric($stackPtr, 'Spaces after control structure open parenthesis', $gap); } $error = 'Expected 0 spaces after opening bracket; %s found'; $data = array($gap); $fix = $phpcsFile->addFixableError($error, ($parenOpener + 1), 'SpacingAfterOpenBrace', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($parenOpener + 1), ''); } } else { $phpcsFile->recordMetric($stackPtr, 'Spaces after control structure open parenthesis', 0); } if ($tokens[$parenOpener]['line'] === $tokens[$parenCloser]['line'] && $tokens[($parenCloser - 1)]['code'] === T_WHITESPACE ) { $gap = $tokens[($parenCloser - 1)]['length']; $error = 'Expected 0 spaces before closing bracket; %s found'; $data = array($gap); $fix = $phpcsFile->addFixableError($error, ($parenCloser - 1), 'SpaceBeforeCloseBrace', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($parenCloser - 1), ''); } if ($gap === 0) { $phpcsFile->recordMetric($stackPtr, 'Spaces before control structure close parenthesis', 'newline'); } else { $phpcsFile->recordMetric($stackPtr, 'Spaces before control structure close parenthesis', $gap); } } else { $phpcsFile->recordMetric($stackPtr, 'Spaces before control structure close parenthesis', 0); } }//end if if (isset($tokens[$stackPtr]['scope_closer']) === false) { return; } $scopeOpener = $tokens[$stackPtr]['scope_opener']; $scopeCloser = $tokens[$stackPtr]['scope_closer']; for ($firstContent = ($scopeOpener + 1); $firstContent < $phpcsFile->numTokens; $firstContent++) { if ($tokens[$firstContent]['code'] !== T_WHITESPACE) { break; } } // We ignore spacing for some structures that tend to have their own rules. $ignore = array( T_FUNCTION => true, T_CLASS => true, T_INTERFACE => true, T_TRAIT => true, T_DOC_COMMENT_OPEN_TAG => true, ); if (isset($ignore[$tokens[$firstContent]['code']]) === false && $tokens[$firstContent]['line'] >= ($tokens[$scopeOpener]['line'] + 2) ) { $error = 'Blank line found at start of control structure'; $fix = $phpcsFile->addFixableError($error, $scopeOpener, 'SpacingAfterOpen'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $i = ($scopeOpener + 1); while ($tokens[$i]['line'] !== $tokens[$firstContent]['line']) { $phpcsFile->fixer->replaceToken($i, ''); $i++; } $phpcsFile->fixer->addNewline($scopeOpener); $phpcsFile->fixer->endChangeset(); } } if ($firstContent !== $scopeCloser) { $lastContent = $phpcsFile->findPrevious( T_WHITESPACE, ($scopeCloser - 1), null, true ); $lastNonEmptyContent = $phpcsFile->findPrevious( PHP_CodeSniffer_Tokens::$emptyTokens, ($scopeCloser - 1), null, true ); $checkToken = $lastContent; if (isset($tokens[$lastNonEmptyContent]['scope_condition']) === true) { $checkToken = $tokens[$lastNonEmptyContent]['scope_condition']; } if (isset($ignore[$tokens[$checkToken]['code']]) === false && $tokens[$lastContent]['line'] <= ($tokens[$scopeCloser]['line'] - 2) ) { $errorToken = $scopeCloser; for ($i = ($scopeCloser - 1); $i > $lastContent; $i--) { if ($tokens[$i]['line'] < $tokens[$scopeCloser]['line']) { $errorToken = $i; break; } } $error = 'Blank line found at end of control structure'; $fix = $phpcsFile->addFixableError($error, $errorToken, 'SpacingBeforeClose'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $i = ($scopeCloser - 1); for ($i = ($scopeCloser - 1); $i > $lastContent; $i--) { if ($tokens[$i]['line'] === $tokens[$scopeCloser]['line']) { continue; } if ($tokens[$i]['line'] === $tokens[$lastContent]['line']) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } }//end if }//end if $trailingContent = $phpcsFile->findNext( T_WHITESPACE, ($scopeCloser + 1), null, true ); if ($tokens[$trailingContent]['code'] === T_COMMENT) { // Special exception for code where the comment about // an ELSE or ELSEIF is written between the control structures. $nextCode = $phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, ($scopeCloser + 1), null, true ); if ($tokens[$nextCode]['code'] === T_ELSE || $tokens[$nextCode]['code'] === T_ELSEIF ) { $trailingContent = $nextCode; } }//end if if ($tokens[$trailingContent]['code'] === T_ELSE) { if ($tokens[$stackPtr]['code'] === T_IF) { // IF with ELSE. return; } } if ($tokens[$trailingContent]['code'] === T_WHILE && $tokens[$stackPtr]['code'] === T_DO ) { // DO with WHILE. return; } if ($tokens[$trailingContent]['code'] === T_CLOSE_TAG) { // At the end of the script or embedded code. return; } if (isset($tokens[$trailingContent]['scope_condition']) === true && $tokens[$trailingContent]['scope_condition'] !== $trailingContent && isset($tokens[$trailingContent]['scope_opener']) === true && $tokens[$trailingContent]['scope_opener'] !== $trailingContent ) { // Another control structure's closing brace. $owner = $tokens[$trailingContent]['scope_condition']; if ($tokens[$owner]['code'] === T_FUNCTION) { // The next content is the closing brace of a function // so normal function rules apply and we can ignore it. return; } if ($tokens[$owner]['code'] === T_CLOSURE && ($phpcsFile->hasCondition($stackPtr, T_FUNCTION) === true || $phpcsFile->hasCondition($stackPtr, T_CLOSURE) === true || isset($tokens[$stackPtr]['nested_parenthesis']) === true) ) { return; } if ($tokens[$trailingContent]['line'] !== ($tokens[$scopeCloser]['line'] + 1)) { $error = 'Blank line found after control structure'; $fix = $phpcsFile->addFixableError($error, $scopeCloser, 'LineAfterClose'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $i = ($scopeCloser + 1); while ($tokens[$i]['line'] !== $tokens[$trailingContent]['line']) { $phpcsFile->fixer->replaceToken($i, ''); $i++; } $phpcsFile->fixer->addNewline($scopeCloser); $phpcsFile->fixer->endChangeset(); } } } else if ($tokens[$trailingContent]['code'] !== T_ELSE && $tokens[$trailingContent]['code'] !== T_ELSEIF && $tokens[$trailingContent]['code'] !== T_CATCH && $tokens[$trailingContent]['line'] === ($tokens[$scopeCloser]['line'] + 1) ) { $error = 'No blank line found after control structure'; $fix = $phpcsFile->addFixableError($error, $scopeCloser, 'NoLineAfterClose'); if ($fix === true) { $phpcsFile->fixer->addNewline($scopeCloser); } }//end if }//end process() }//end class ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/FunctionClosingBraceSpaceSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/FunctionClosingBraceSpaceSniff.p0000644000076700000240000001543212647543456033225 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_WhiteSpace_FunctionClosingBraceSpaceSniff. * * Checks that there is one empty line before the closing brace of a function. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_WhiteSpace_FunctionClosingBraceSpaceSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_FUNCTION, T_CLOSURE, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['scope_closer']) === false) { // Probably an interface method. return; } $closeBrace = $tokens[$stackPtr]['scope_closer']; $prevContent = $phpcsFile->findPrevious(T_WHITESPACE, ($closeBrace - 1), null, true); // Special case for empty JS functions. if ($phpcsFile->tokenizerType === 'JS' && $prevContent === $tokens[$stackPtr]['scope_opener']) { // In this case, the opening and closing brace must be // right next to each other. if ($tokens[$stackPtr]['scope_closer'] !== ($tokens[$stackPtr]['scope_opener'] + 1)) { $error = 'The opening and closing braces of empty functions must be directly next to each other; e.g., function () {}'; $fix = $phpcsFile->addFixableError($error, $closeBrace, 'SpacingBetween'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($tokens[$stackPtr]['scope_opener'] + 1); $i < $closeBrace; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } } return; } $nestedFunction = false; if ($phpcsFile->hasCondition($stackPtr, T_FUNCTION) === true || $phpcsFile->hasCondition($stackPtr, T_CLOSURE) === true || isset($tokens[$stackPtr]['nested_parenthesis']) === true ) { $nestedFunction = true; } $braceLine = $tokens[$closeBrace]['line']; $prevLine = $tokens[$prevContent]['line']; $found = ($braceLine - $prevLine - 1); $afterKeyword = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); $beforeKeyword = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if ($nestedFunction === true) { if ($found < 0) { $error = 'Closing brace of nested function must be on a new line'; $fix = $phpcsFile->addFixableError($error, $closeBrace, 'ContentBeforeClose'); if ($fix === true) { $phpcsFile->fixer->addNewlineBefore($closeBrace); } } else if ($found > 0) { $error = 'Expected 0 blank lines before closing brace of nested function; %s found'; $data = array($found); $fix = $phpcsFile->addFixableError($error, $closeBrace, 'SpacingBeforeNestedClose', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $changeMade = false; for ($i = ($prevContent + 1); $i < $closeBrace; $i++) { // Try and maintain indentation. if ($tokens[$i]['line'] === ($braceLine - 1)) { break; } $phpcsFile->fixer->replaceToken($i, ''); $changeMade = true; } // Special case for when the last content contains the newline // token as well, like with a comment. if ($changeMade === false) { $phpcsFile->fixer->replaceToken(($prevContent + 1), ''); } $phpcsFile->fixer->endChangeset(); }//end if }//end if } else { if ($found !== 1) { if ($found < 0) { $found = 0; } $error = 'Expected 1 blank line before closing function brace; %s found'; $data = array($found); $fix = $phpcsFile->addFixableError($error, $closeBrace, 'SpacingBeforeClose', $data); if ($fix === true) { if ($found > 1) { $phpcsFile->fixer->beginChangeset(); for ($i = ($prevContent + 1); $i < ($closeBrace - 1); $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->replaceToken($i, $phpcsFile->eolChar); $phpcsFile->fixer->endChangeset(); } else { // Try and maintain indentation. if ($tokens[($closeBrace - 1)]['code'] === T_WHITESPACE) { $phpcsFile->fixer->addNewlineBefore($closeBrace - 1); } else { $phpcsFile->fixer->addNewlineBefore($closeBrace); } } } }//end if }//end if }//end process() }//end class ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/FunctionOpeningBraceSpaceSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/FunctionOpeningBraceSpaceSniff.p0000644000076700000240000000676712647543456033241 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_WhiteSpace_FunctionOpeningBraceSpaceSniff. * * Checks that there is no empty line after the opening brace of a function. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_WhiteSpace_FunctionOpeningBraceSpaceSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_FUNCTION, T_CLOSURE, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if (isset($tokens[$stackPtr]['scope_opener']) === false) { // Probably an interface method. return; } $openBrace = $tokens[$stackPtr]['scope_opener']; $nextContent = $phpcsFile->findNext(T_WHITESPACE, ($openBrace + 1), null, true); if ($nextContent === $tokens[$stackPtr]['scope_closer']) { // The next bit of content is the closing brace, so this // is an empty function and should have a blank line // between the opening and closing braces. return; } $braceLine = $tokens[$openBrace]['line']; $nextLine = $tokens[$nextContent]['line']; $found = ($nextLine - $braceLine - 1); if ($found > 0) { $error = 'Expected 0 blank lines after opening function brace; %s found'; $data = array($found); $fix = $phpcsFile->addFixableError($error, $openBrace, 'SpacingAfter', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($openBrace + 1); $i < $nextContent; $i++) { if ($tokens[$i]['line'] === $nextLine) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->addNewline($openBrace); $phpcsFile->fixer->endChangeset(); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/FunctionSpacingSniff.php0000644000076700000240000002100612647543456031624 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_WhiteSpace_FunctionSpacingSniff. * * Checks the separation between methods in a class or interface. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_WhiteSpace_FunctionSpacingSniff implements PHP_CodeSniffer_Sniff { /** * The number of blank lines between functions. * * @var int */ public $spacing = 2; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_FUNCTION); }//end register() /** * Processes this sniff when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $this->spacing = (int) $this->spacing; /* Check the number of blank lines after the function. */ if (isset($tokens[$stackPtr]['scope_closer']) === false) { // Must be an interface method, so the closer is the semicolon. $closer = $phpcsFile->findNext(T_SEMICOLON, $stackPtr); } else { $closer = $tokens[$stackPtr]['scope_closer']; } // Allow for comments on the same line as the closer. for ($nextLineToken = ($closer + 1); $nextLineToken < $phpcsFile->numTokens; $nextLineToken++) { if ($tokens[$nextLineToken]['line'] !== $tokens[$closer]['line']) { break; } } $foundLines = 0; if ($nextLineToken === ($phpcsFile->numTokens - 1)) { // We are at the end of the file. // Don't check spacing after the function because this // should be done by an EOF sniff. $foundLines = $this->spacing; } else { $nextContent = $phpcsFile->findNext(T_WHITESPACE, $nextLineToken, null, true); if ($nextContent === false) { // We are at the end of the file. // Don't check spacing after the function because this // should be done by an EOF sniff. $foundLines = $this->spacing; } else { $foundLines += ($tokens[$nextContent]['line'] - $tokens[$nextLineToken]['line']); } } if ($foundLines !== $this->spacing) { $error = 'Expected %s blank line'; if ($this->spacing !== 1) { $error .= 's'; } $error .= ' after function; %s found'; $data = array( $this->spacing, $foundLines, ); $fix = $phpcsFile->addFixableError($error, $closer, 'After', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = $nextLineToken; $i <= $nextContent; $i++) { if ($tokens[$i]['line'] === $tokens[$nextContent]['line']) { $phpcsFile->fixer->addContentBefore($i, str_repeat($phpcsFile->eolChar, $this->spacing)); break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); }//end if }//end if /* Check the number of blank lines before the function. */ $prevLineToken = null; for ($i = $stackPtr; $i > 0; $i--) { if (strpos($tokens[$i]['content'], $phpcsFile->eolChar) === false) { continue; } else { $prevLineToken = $i; break; } } if (is_null($prevLineToken) === true) { // Never found the previous line, which means // there are 0 blank lines before the function. $foundLines = 0; $prevContent = 0; } else { $currentLine = $tokens[$stackPtr]['line']; $prevContent = $phpcsFile->findPrevious(T_WHITESPACE, $prevLineToken, null, true); if ($tokens[$prevContent]['code'] === T_DOC_COMMENT_CLOSE_TAG && $tokens[$prevContent]['line'] === ($currentLine - 1) ) { // Account for function comments. $prevContent = $phpcsFile->findPrevious(T_WHITESPACE, ($tokens[$prevContent]['comment_opener'] - 1), null, true); } // Before we throw an error, check that we are not throwing an error // for another function. We don't want to error for no blank lines after // the previous function and no blank lines before this one as well. $prevLine = ($tokens[$prevContent]['line'] - 1); $i = ($stackPtr - 1); $foundLines = 0; while ($currentLine !== $prevLine && $currentLine > 1 && $i > 0) { if (isset($tokens[$i]['scope_condition']) === true) { $scopeCondition = $tokens[$i]['scope_condition']; if ($tokens[$scopeCondition]['code'] === T_FUNCTION) { // Found a previous function. return; } } else if ($tokens[$i]['code'] === T_FUNCTION) { // Found another interface function. return; } $currentLine = $tokens[$i]['line']; if ($currentLine === $prevLine) { break; } if ($tokens[($i - 1)]['line'] < $currentLine && $tokens[($i + 1)]['line'] > $currentLine) { // This token is on a line by itself. If it is whitespace, the line is empty. if ($tokens[$i]['code'] === T_WHITESPACE) { $foundLines++; } } $i--; }//end while }//end if if ($foundLines !== $this->spacing) { $error = 'Expected %s blank line'; if ($this->spacing !== 1) { $error .= 's'; } $error .= ' before function; %s found'; $data = array( $this->spacing, $foundLines, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Before', $data); if ($fix === true) { if ($prevContent === 0) { $nextSpace = 0; } else { $nextSpace = $phpcsFile->findNext(T_WHITESPACE, ($prevContent + 1), $stackPtr); if ($nextSpace === false) { $nextSpace = ($stackPtr - 1); } } if ($foundLines < $this->spacing) { $padding = str_repeat($phpcsFile->eolChar, ($this->spacing - $foundLines)); $phpcsFile->fixer->addContent($nextSpace, $padding); } else { $nextContent = $phpcsFile->findNext(T_WHITESPACE, ($nextSpace + 1), null, true); $phpcsFile->fixer->beginChangeset(); for ($i = $nextSpace; $i < ($nextContent - 1); $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->replaceToken($i, str_repeat($phpcsFile->eolChar, $this->spacing)); $phpcsFile->fixer->endChangeset(); } }//end if }//end if }//end process() }//end class ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.ph0000644000076700000240000000652512647543456033320 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_WhiteSpace_LanguageConstructSpacingSniff. * * Ensures all language constructs (without brackets) contain a * single space between themselves and their content. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_WhiteSpace_LanguageConstructSpacingSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_ECHO, T_PRINT, T_RETURN, T_INCLUDE, T_INCLUDE_ONCE, T_REQUIRE, T_REQUIRE_ONCE, T_NEW, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[($stackPtr + 1)]['code'] === T_SEMICOLON) { // No content for this language construct. return; } if ($tokens[($stackPtr + 1)]['code'] === T_WHITESPACE) { $content = $tokens[($stackPtr + 1)]['content']; $contentLength = strlen($content); if ($contentLength !== 1) { $error = 'Language constructs must be followed by a single space; expected 1 space but found %s'; $data = array($contentLength); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'IncorrectSingle', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' '); } } } else { $error = 'Language constructs must be followed by a single space; expected "%s" but found "%s"'; $data = array( $tokens[$stackPtr]['content'].' '.$tokens[($stackPtr + 1)]['content'], $tokens[$stackPtr]['content'].$tokens[($stackPtr + 1)]['content'], ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Incorrect', $data); if ($fix === true) { $phpcsFile->fixer->addContent($stackPtr, ' '); } }//end if }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/LogicalOperatorSpacingSniff.php0000644000076700000240000001022612647543456033127 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Sniffs_Squiz_WhiteSpace_OperatorSpacingSniff. * * Verifies that operators have valid spacing surrounding them. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_WhiteSpace_LogicalOperatorSpacingSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return PHP_CodeSniffer_Tokens::$booleanOperators; }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The current file being checked. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Check there is one space before the operator. if ($tokens[($stackPtr - 1)]['code'] !== T_WHITESPACE) { $error = 'Expected 1 space before logical operator; 0 found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBefore'); if ($fix === true) { $phpcsFile->fixer->addContentBefore($stackPtr, ' '); } } else { $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if ($tokens[$stackPtr]['line'] === $tokens[$prev]['line'] && strlen($tokens[($stackPtr - 1)]['content']) !== 1 ) { $found = strlen($tokens[($stackPtr - 1)]['content']); $error = 'Expected 1 space before logical operator; %s found'; $data = array($found); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'TooMuchSpaceBefore', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr - 1), ' '); } } } // Check there is one space after the operator. if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE) { $error = 'Expected 1 space after logical operator; 0 found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfter'); if ($fix === true) { $phpcsFile->fixer->addContent($stackPtr, ' '); } } else { $next = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$stackPtr]['line'] === $tokens[$next]['line'] && strlen($tokens[($stackPtr + 1)]['content']) !== 1 ) { $found = strlen($tokens[($stackPtr + 1)]['content']); $error = 'Expected 1 space after logical operator; %s found'; $data = array($found); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'TooMuchSpaceAfter', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' '); } } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/MemberVarSpacingSniff.php0000644000076700000240000001356712647543456031734 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractVariableSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractVariableSniff not found'); } /** * Verifies that class members are spaced correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_WhiteSpace_MemberVarSpacingSniff extends PHP_CodeSniffer_Standards_AbstractVariableSniff { /** * Processes the function tokens within the class. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the token was found. * * @return void */ protected function processMemberVar(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $ignore = PHP_CodeSniffer_Tokens::$methodPrefixes; $ignore[] = T_VAR; $ignore[] = T_WHITESPACE; $start = $stackPtr; $prev = $phpcsFile->findPrevious($ignore, ($stackPtr - 1), null, true); if (isset(PHP_CodeSniffer_Tokens::$commentTokens[$tokens[$prev]['code']]) === true) { // Assume the comment belongs to the member var if it is on a line by itself. $prevContent = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($prev - 1), null, true); if ($tokens[$prevContent]['line'] !== $tokens[$prev]['line']) { // Check the spacing, but then skip it. $foundLines = ($tokens[$stackPtr]['line'] - $tokens[$prev]['line'] - 1); if ($foundLines > 0) { $error = 'Expected 0 blank lines after member var comment; %s found'; $data = array($foundLines); $fix = $phpcsFile->addFixableError($error, $prev, 'AfterComment', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($prev + 1); $i <= $stackPtr; $i++) { if ($tokens[$i]['line'] === $tokens[$stackPtr]['line']) { break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->addNewline($prev); $phpcsFile->fixer->endChangeset(); } }//end if $start = $prev; }//end if }//end if // There needs to be 1 blank line before the var, not counting comments. if ($start === $stackPtr) { // No comment found. $first = $phpcsFile->findFirstOnLine(PHP_CodeSniffer_Tokens::$emptyTokens, $start, true); if ($first === false) { $first = $start; } } else if ($tokens[$start]['code'] === T_DOC_COMMENT_CLOSE_TAG) { $first = $tokens[$start]['comment_opener']; } else { $first = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($start - 1), null, true); $first = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$commentTokens, ($first + 1)); } $prev = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($first - 1), null, true); $foundLines = ($tokens[$first]['line'] - $tokens[$prev]['line'] - 1); if ($foundLines === 1) { return; } $error = 'Expected 1 blank line before member var; %s found'; $data = array($foundLines); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Incorrect', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($prev + 1); $i < $first; $i++) { if ($tokens[$i]['line'] === $tokens[$prev]['line']) { continue; } if ($tokens[$i]['line'] === $tokens[$first]['line']) { $phpcsFile->fixer->addNewline(($i - 1)); break; } $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); }//end if }//end processMemberVar() /** * Processes normal variables. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the token was found. * * @return void */ protected function processVariable(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { /* We don't care about normal variables. */ }//end processVariable() /** * Processes variables in double quoted strings. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position where the token was found. * * @return void */ protected function processVariableInString(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { /* We don't care about normal variables. */ }//end processVariableInString() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/ObjectOperatorSpacingSniff.php0000644000076700000240000000621612647543456032767 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_WhiteSpace_ObjectOperatorSpacingSniff. * * Ensure there is no whitespace before/after an object operator. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_WhiteSpace_ObjectOperatorSpacingSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OBJECT_OPERATOR); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[($stackPtr - 1)]['code'] !== T_WHITESPACE) { $before = 0; } else { if ($tokens[($stackPtr - 2)]['line'] !== $tokens[$stackPtr]['line']) { $before = 'newline'; } else { $before = $tokens[($stackPtr - 1)]['length']; } } if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE) { $after = 0; } else { if ($tokens[($stackPtr + 2)]['line'] !== $tokens[$stackPtr]['line']) { $after = 'newline'; } else { $after = $tokens[($stackPtr + 1)]['length']; } } $phpcsFile->recordMetric($stackPtr, 'Spacing before object operator', $before); $phpcsFile->recordMetric($stackPtr, 'Spacing after object operator', $after); if ($before !== 0) { $error = 'Space found before object operator'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Before'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr - 1), ''); } } if ($after !== 0) { $error = 'Space found after object operator'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'After'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ''); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/OperatorSpacingSniff.php0000644000076700000240000003103312647543456031633 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Sniffs_Squiz_WhiteSpace_OperatorSpacingSniff. * * Verifies that operators have valid spacing surrounding them. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_WhiteSpace_OperatorSpacingSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Allow newlines instead of spaces. * * @var boolean */ public $ignoreNewlines = false; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { $comparison = PHP_CodeSniffer_Tokens::$comparisonTokens; $operators = PHP_CodeSniffer_Tokens::$operators; $assignment = PHP_CodeSniffer_Tokens::$assignmentTokens; $inlineIf = array( T_INLINE_THEN, T_INLINE_ELSE, ); return array_unique( array_merge($comparison, $operators, $assignment, $inlineIf) ); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The current file being checked. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // Skip default values in function declarations. if ($tokens[$stackPtr]['code'] === T_EQUAL || $tokens[$stackPtr]['code'] === T_MINUS ) { if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) { $parenthesis = array_keys($tokens[$stackPtr]['nested_parenthesis']); $bracket = array_pop($parenthesis); if (isset($tokens[$bracket]['parenthesis_owner']) === true) { $function = $tokens[$bracket]['parenthesis_owner']; if ($tokens[$function]['code'] === T_FUNCTION || $tokens[$function]['code'] === T_CLOSURE ) { return; } } } } if ($tokens[$stackPtr]['code'] === T_EQUAL) { // Skip for '=&' case. if (isset($tokens[($stackPtr + 1)]) === true && $tokens[($stackPtr + 1)]['code'] === T_BITWISE_AND ) { return; } } // Skip short ternary such as: "$foo = $bar ?: true;". if (($tokens[$stackPtr]['code'] === T_INLINE_THEN && $tokens[($stackPtr + 1)]['code'] === T_INLINE_ELSE) || ($tokens[($stackPtr - 1)]['code'] === T_INLINE_THEN && $tokens[$stackPtr]['code'] === T_INLINE_ELSE) ) { return; } if ($tokens[$stackPtr]['code'] === T_BITWISE_AND) { // If it's not a reference, then we expect one space either side of the // bitwise operator. if ($phpcsFile->isReference($stackPtr) === true) { return; } // Check there is one space before the & operator. if ($tokens[($stackPtr - 1)]['code'] !== T_WHITESPACE) { $error = 'Expected 1 space before "&" operator; 0 found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBeforeAmp'); if ($fix === true) { $phpcsFile->fixer->addContentBefore($stackPtr, ' '); } $phpcsFile->recordMetric($stackPtr, 'Space before operator', 0); } else { if ($tokens[($stackPtr - 2)]['line'] !== $tokens[$stackPtr]['line']) { $found = 'newline'; } else { $found = $tokens[($stackPtr - 1)]['length']; } $phpcsFile->recordMetric($stackPtr, 'Space before operator', $found); if ($found !== 1 && ($found !== 'newline' || $this->ignoreNewlines === false) ) { $error = 'Expected 1 space before "&" operator; %s found'; $data = array($found); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBeforeAmp', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr - 1), ' '); } } }//end if // Check there is one space after the & operator. if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE) { $error = 'Expected 1 space after "&" operator; 0 found'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfterAmp'); if ($fix === true) { $phpcsFile->fixer->addContent($stackPtr, ' '); } $phpcsFile->recordMetric($stackPtr, 'Space after operator', 0); } else { if ($tokens[($stackPtr + 2)]['line'] !== $tokens[$stackPtr]['line']) { $found = 'newline'; } else { $found = $tokens[($stackPtr + 1)]['length']; } $phpcsFile->recordMetric($stackPtr, 'Space after operator', $found); if ($found !== 1 && ($found !== 'newline' || $this->ignoreNewlines === false) ) { $error = 'Expected 1 space after "&" operator; %s found'; $data = array($found); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfterAmp', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' '); } } }//end if return; }//end if if ($tokens[$stackPtr]['code'] === T_MINUS) { // Check minus spacing, but make sure we aren't just assigning // a minus value or returning one. $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); if ($tokens[$prev]['code'] === T_RETURN) { // Just returning a negative value; eg. (return -1). return; } if (isset(PHP_CodeSniffer_Tokens::$operators[$tokens[$prev]['code']]) === true) { // Just trying to operate on a negative value; eg. ($var * -1). return; } if (isset(PHP_CodeSniffer_Tokens::$comparisonTokens[$tokens[$prev]['code']]) === true) { // Just trying to compare a negative value; eg. ($var === -1). return; } if (isset(PHP_CodeSniffer_Tokens::$booleanOperators[$tokens[$prev]['code']]) === true) { // Just trying to compare a negative value; eg. ($var || -1 === $b). return; } if (isset(PHP_CodeSniffer_Tokens::$assignmentTokens[$tokens[$prev]['code']]) === true) { // Just trying to assign a negative value; eg. ($var = -1). return; } // A list of tokens that indicate that the token is not // part of an arithmetic operation. $invalidTokens = array( T_COMMA => true, T_OPEN_PARENTHESIS => true, T_OPEN_SQUARE_BRACKET => true, T_OPEN_SHORT_ARRAY => true, T_DOUBLE_ARROW => true, T_COLON => true, T_INLINE_THEN => true, T_INLINE_ELSE => true, T_CASE => true, ); if (isset($invalidTokens[$tokens[$prev]['code']]) === true) { // Just trying to use a negative value; eg. myFunction($var, -2). return; } }//end if $operator = $tokens[$stackPtr]['content']; if ($tokens[($stackPtr - 1)]['code'] !== T_WHITESPACE) { $error = "Expected 1 space before \"$operator\"; 0 found"; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBefore'); if ($fix === true) { $phpcsFile->fixer->addContentBefore($stackPtr, ' '); } $phpcsFile->recordMetric($stackPtr, 'Space before operator', 0); } else if (isset(PHP_CodeSniffer_Tokens::$assignmentTokens[$tokens[$stackPtr]['code']]) === false) { // Don't throw an error for assignments, because other standards allow // multiple spaces there to align multiple assignments. if ($tokens[($stackPtr - 2)]['line'] !== $tokens[$stackPtr]['line']) { $found = 'newline'; } else { $found = $tokens[($stackPtr - 1)]['length']; } $phpcsFile->recordMetric($stackPtr, 'Space before operator', $found); if ($found !== 1 && ($found !== 'newline' || $this->ignoreNewlines === false) ) { $error = 'Expected 1 space before "%s"; %s found'; $data = array( $operator, $found, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingBefore', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); if ($found === 'newline') { $i = ($stackPtr - 2); while ($tokens[$i]['code'] === T_WHITESPACE) { $phpcsFile->fixer->replaceToken($i, ''); $i--; } } $phpcsFile->fixer->replaceToken(($stackPtr - 1), ' '); $phpcsFile->fixer->endChangeset(); } }//end if }//end if if (isset($tokens[($stackPtr + 1)]) === false) { return; } if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE) { $error = "Expected 1 space after \"$operator\"; 0 found"; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfter'); if ($fix === true) { $phpcsFile->fixer->addContent($stackPtr, ' '); } $phpcsFile->recordMetric($stackPtr, 'Space after operator', 0); } else { if (isset($tokens[($stackPtr + 2)]) === true && $tokens[($stackPtr + 2)]['line'] !== $tokens[$stackPtr]['line'] ) { $found = 'newline'; } else { $found = $tokens[($stackPtr + 1)]['length']; } $phpcsFile->recordMetric($stackPtr, 'Space after operator', $found); if ($found !== 1 && ($found !== 'newline' || $this->ignoreNewlines === false) ) { $error = 'Expected 1 space after "%s"; %s found'; $data = array( $operator, $found, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SpacingAfter', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' '); } } }//end if }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/PropertyLabelSpacingSniff.php0000644000076700000240000000555512647543456032636 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_WhiteSpace_PropertyLabelSpacingSniff. * * Ensures that the colon in a property or label definition has a single * space after it and no space before it. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_WhiteSpace_PropertyLabelSpacingSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array('JS'); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_PROPERTY, T_LABEL, ); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $colon = $phpcsFile->findNext(T_COLON, ($stackPtr + 1)); if ($colon !== ($stackPtr + 1)) { $error = 'There must be no space before the colon in a property/label declaration'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Before'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ''); } } if ($tokens[($colon + 1)]['code'] !== T_WHITESPACE || $tokens[($colon + 1)]['content'] !== ' ') { $error = 'There must be a single space after the colon in a property/label declaration'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'After'); if ($fix === true) { if ($tokens[($colon + 1)]['code'] === T_WHITESPACE) { $phpcsFile->fixer->replaceToken(($colon + 1), ' '); } else { $phpcsFile->fixer->addContent($colon, ' '); } } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/ScopeClosingBraceSniff.php0000644000076700000240000001013012647543456032053 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_Whitespace_ScopeClosingBraceSniff. * * Checks that the closing braces of scopes are aligned correctly. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_WhiteSpace_ScopeClosingBraceSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return PHP_CodeSniffer_Tokens::$scopeOpeners; }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile All the tokens found in the document. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); // If this is an inline condition (ie. there is no scope opener), then // return, as this is not a new scope. if (isset($tokens[$stackPtr]['scope_closer']) === false) { return; } // We need to actually find the first piece of content on this line, // as if this is a method with tokens before it (public, static etc) // or an if with an else before it, then we need to start the scope // checking from there, rather than the current token. $lineStart = $phpcsFile->findFirstOnLine(T_WHITESPACE, $stackPtr, true); $startColumn = $tokens[$lineStart]['column']; $scopeStart = $tokens[$stackPtr]['scope_opener']; $scopeEnd = $tokens[$stackPtr]['scope_closer']; // Check that the closing brace is on it's own line. $lastContent = $phpcsFile->findPrevious(array(T_INLINE_HTML, T_WHITESPACE, T_OPEN_TAG), ($scopeEnd - 1), $scopeStart, true); if ($tokens[$lastContent]['line'] === $tokens[$scopeEnd]['line']) { $error = 'Closing brace must be on a line by itself'; $fix = $phpcsFile->addFixableError($error, $scopeEnd, 'ContentBefore'); if ($fix === true) { $phpcsFile->fixer->addNewlineBefore($scopeEnd); } return; } // Check now that the closing brace is lined up correctly. $lineStart = $phpcsFile->findFirstOnLine(T_WHITESPACE, $scopeEnd, true); $braceIndent = $tokens[$lineStart]['column']; if ($tokens[$stackPtr]['code'] !== T_DEFAULT && $tokens[$stackPtr]['code'] !== T_CASE && $braceIndent !== $startColumn ) { $error = 'Closing brace indented incorrectly; expected %s spaces, found %s'; $data = array( ($startColumn - 1), ($braceIndent - 1), ); $fix = $phpcsFile->addFixableError($error, $scopeEnd, 'Indent', $data); if ($fix === true) { $diff = ($startColumn - $braceIndent); if ($diff > 0) { $phpcsFile->fixer->addContentBefore($scopeEnd, str_repeat(' ', $diff)); } else { $phpcsFile->fixer->substrToken(($scopeEnd - 1), 0, $diff); } } }//end if }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/ScopeKeywordSpacingSniff.php0000644000076700000240000000567712647543456032475 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_WhiteSpace_ScopeKeywordSpacingSniff. * * Ensure there is a single space after scope keywords. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_WhiteSpace_ScopeKeywordSpacingSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { $register = PHP_CodeSniffer_Tokens::$scopeModifiers; $register[] = T_STATIC; return $register; }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $prevToken = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); $nextToken = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); if ($tokens[$stackPtr]['code'] === T_STATIC && ($tokens[$nextToken]['code'] === T_DOUBLE_COLON || $tokens[$prevToken]['code'] === T_NEW) ) { // Late static binding, e.g., static:: OR new static() usage. return; } if ($tokens[$prevToken]['code'] === T_AS) { // Trait visibilty change, e.g., "use HelloWorld { sayHello as private; }". return; } $nextToken = $tokens[($stackPtr + 1)]; if (strlen($nextToken['content']) !== 1 || $nextToken['content'] === $phpcsFile->eolChar ) { $error = 'Scope keyword "%s" must be followed by a single space'; $data = array($tokens[$stackPtr]['content']); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Incorrect', $data); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr + 1), ' '); } } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/SemicolonSpacingSniff.php0000644000076700000240000000603112647543456031770 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_WhiteSpace_SemicolonSpacingSniff. * * Ensure there is no whitespace before a semicolon. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_WhiteSpace_SemicolonSpacingSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', ); /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_SEMICOLON); }//end register() /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token * in the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $prevType = $tokens[($stackPtr - 1)]['code']; if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$prevType]) === false) { return; } $nonSpace = $phpcsFile->findPrevious(PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 2), null, true); if ($tokens[$nonSpace]['code'] === T_SEMICOLON) { // Empty statement. return; } $expected = $tokens[$nonSpace]['content'].';'; $found = $phpcsFile->getTokensAsString($nonSpace, ($stackPtr - $nonSpace)).';'; $error = 'Space found before semicolon; expected "%s" but found "%s"'; $data = array( $expected, $found, ); $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Incorrect', $data); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($stackPtr - 1); $i > $nonSpace; $i--) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Sniffs/WhiteSpace/SuperfluousWhitespaceSniff.php0000644000076700000240000002416412647543456033113 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Squiz_Sniffs_WhiteSpace_SuperfluousWhitespaceSniff. * * Checks that no whitespace proceeds the first content of the file, exists * after the last content of the file, resides after content on any line, or * are two empty lines in functions. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Sniffs_WhiteSpace_SuperfluousWhitespaceSniff implements PHP_CodeSniffer_Sniff { /** * A list of tokenizers this sniff supports. * * @var array */ public $supportedTokenizers = array( 'PHP', 'JS', 'CSS', ); /** * If TRUE, whitespace rules are not checked for blank lines. * * Blank lines are those that contain only whitespace. * * @var boolean */ public $ignoreBlankLines = false; /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array( T_OPEN_TAG, T_CLOSE_TAG, T_WHITESPACE, T_COMMENT, T_DOC_COMMENT_WHITESPACE, T_CLOSURE, ); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); if ($tokens[$stackPtr]['code'] === T_OPEN_TAG) { /* Check for start of file whitespace. */ if ($phpcsFile->tokenizerType !== 'PHP') { // The first token is always the open tag inserted when tokenizsed // and the second token is always the first piece of content in // the file. If the second token is whitespace, there was // whitespace at the start of the file. if ($tokens[($stackPtr + 1)]['code'] !== T_WHITESPACE) { return; } if ($phpcsFile->fixer->enabled === true) { $stackPtr = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), null, true); } } else { // If it's the first token, then there is no space. if ($stackPtr === 0) { return; } for ($i = ($stackPtr - 1); $i >= 0; $i--) { // If we find something that isn't inline html then there is something previous in the file. if ($tokens[$i]['type'] !== 'T_INLINE_HTML') { return; } // If we have ended up with inline html make sure it isn't just whitespace. $tokenContent = trim($tokens[$i]['content']); if ($tokenContent !== '') { return; } } }//end if $fix = $phpcsFile->addFixableError('Additional whitespace found at start of file', $stackPtr, 'StartFile'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = 0; $i < $stackPtr; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } } else if ($tokens[$stackPtr]['code'] === T_CLOSE_TAG) { /* Check for end of file whitespace. */ if ($phpcsFile->tokenizerType === 'PHP') { if (isset($tokens[($stackPtr + 1)]) === false) { // The close PHP token is the last in the file. return; } for ($i = ($stackPtr + 1); $i < $phpcsFile->numTokens; $i++) { // If we find something that isn't inline HTML then there // is more to the file. if ($tokens[$i]['type'] !== 'T_INLINE_HTML') { return; } // If we have ended up with inline html make sure it // isn't just whitespace. $tokenContent = trim($tokens[$i]['content']); if (empty($tokenContent) === false) { return; } } } else { // The last token is always the close tag inserted when tokenized // and the second last token is always the last piece of content in // the file. If the second last token is whitespace, there was // whitespace at the end of the file. $stackPtr--; // The pointer is now looking at the last content in the file and // not the fake PHP end tag the tokenizer inserted. if ($tokens[$stackPtr]['code'] !== T_WHITESPACE) { return; } // Allow a single newline at the end of the last line in the file. if ($tokens[($stackPtr - 1)]['code'] !== T_WHITESPACE && $tokens[$stackPtr]['content'] === $phpcsFile->eolChar ) { return; } if ($phpcsFile->fixer->enabled === true) { $prev = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true); $stackPtr = ($prev + 1); } }//end if $fix = $phpcsFile->addFixableError('Additional whitespace found at end of file', $stackPtr, 'EndFile'); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); for ($i = ($stackPtr + 1); $i < $phpcsFile->numTokens; $i++) { $phpcsFile->fixer->replaceToken($i, ''); } $phpcsFile->fixer->endChangeset(); } } else { /* Check for end of line whitespace. */ // Ignore whitespace that is not at the end of a line. if (isset($tokens[($stackPtr + 1)]['line']) === true && $tokens[($stackPtr + 1)]['line'] === $tokens[$stackPtr]['line'] ) { return; } // Ignore blank lines if required. if ($this->ignoreBlankLines === true && $tokens[($stackPtr - 1)]['line'] !== $tokens[$stackPtr]['line'] ) { return; } $tokenContent = rtrim($tokens[$stackPtr]['content'], $phpcsFile->eolChar); if (empty($tokenContent) === false) { if ($tokenContent !== rtrim($tokenContent)) { $fix = $phpcsFile->addFixableError('Whitespace found at end of line', $stackPtr, 'EndLine'); if ($fix === true) { $phpcsFile->fixer->replaceToken($stackPtr, rtrim($tokenContent).$phpcsFile->eolChar); } } } else if ($tokens[($stackPtr - 1)]['content'] !== rtrim($tokens[($stackPtr - 1)]['content']) && $tokens[($stackPtr - 1)]['line'] === $tokens[$stackPtr]['line'] ) { $fix = $phpcsFile->addFixableError('Whitespace found at end of line', ($stackPtr - 1), 'EndLine'); if ($fix === true) { $phpcsFile->fixer->replaceToken(($stackPtr - 1), rtrim($tokens[($stackPtr - 1)]['content'])); } } /* Check for multiple blank lines in a function. */ if (($phpcsFile->hasCondition($stackPtr, T_FUNCTION) === true || $phpcsFile->hasCondition($stackPtr, T_CLOSURE) === true) && $tokens[($stackPtr - 1)]['line'] < $tokens[$stackPtr]['line'] && $tokens[($stackPtr - 2)]['line'] === $tokens[($stackPtr - 1)]['line'] ) { // This is an empty line and the line before this one is not // empty, so this could be the start of a multiple empty // line block. $next = $phpcsFile->findNext(T_WHITESPACE, $stackPtr, null, true); $lines = ($tokens[$next]['line'] - $tokens[$stackPtr]['line']); if ($lines > 1) { $error = 'Functions must not contain multiple empty lines in a row; found %s empty lines'; $fix = $phpcsFile->addFixableError($error, $stackPtr, 'EmptyLines', array($lines)); if ($fix === true) { $phpcsFile->fixer->beginChangeset(); $i = $stackPtr; while ($tokens[$i]['line'] !== $tokens[$next]['line']) { $phpcsFile->fixer->replaceToken($i, ''); $i++; } $phpcsFile->fixer->addNewlineBefore($i); $phpcsFile->fixer->endChangeset(); } } }//end if }//end if }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Arrays/ArrayBracketSpacingUnitTest.inc0000644000076700000240000000052612647543456032170 0ustar gsherwoodstaff 'bar', 'bar' => 'foo', ]; $array = []; ?>PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Arrays/ArrayBracketSpacingUnitTest.php0000644000076700000240000000372212647543456032207 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ArrayBracketSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Arrays_ArrayBracketSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 4 => 2, 5 => 3, 7 => 3, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.1.inc0000644000076700000240000001355012647543456031675 0ustar gsherwoodstaff 1, ); } class TestClass { public $good = array( 'width' => '', 'height' => '', ); private $_bad = Array( 'width' => '', 'height' => '' ); public function test() { $truck = array( 'width' => '', 'height' => '', ); $plane = Array( 'width' => '', 'height' => '', ); $car = array( 'width' => '', 'height' => '', ); $bus = array( 'width' => '', 'height' => '' ); $train = array ( TRUE, FALSE, 'aaa' ); $inline = array('aaa', 'bbb', 'ccc'); $inline = array('aaa'); $inline = Array('aaa'); $bigone = array( 'name' => 'bigone', 'children' => Array( '1a' => 'child', '11b' => 'child', '111c' => 'child', 'children' => Array( 'child' => 'aaa', ), ), 'short_name' => 'big' ); } }//end class $value = array ( ); $value = array( ); $value = array('1'=>$one, '2' => $two, '3'=> $three, '4' =>$four); $value = array('1'=>$one); if (in_array('1', array('1','2','3')) === TRUE) { $value = in_array('1', array('1' , '2', '3','4')); } $value = array( '1'=> TRUE, FALSE, '3' => 'aaa',); $value = array( '1'=> TRUE, FALSE, ); $value = array( TRUE, '1' => FALSE, ); $value = array(1, 2 , 3 , ); $value = array(1 => $one, 2 => $two , 3 => $three , ); $value = array( 'tag' => $tag, 'space' => $this->_getIndentation($tag, $tagElement), ); $expected = array( array( '1' => 1, '1' => 2, ), ); $expected = array( array( '1' => 1, '1' => 2 ) ); // Space in second arg. $args = array( '"'.$this->id.'"', (int) $hasSessions, ); // No errors. $paths = array( Init::ROOT_DIR.'/Systems' => 'Systems', Init::ROOT_DIR.'/Installer' => 'Systems', ); $x = array( ); $x = array('test' ); $x = array('test', ); $x = array('name' => 'test', ); $x = array( $x, ); $func = array( $x, 'get'.$x.'Replacement' ); $array = array( 'input_one' => 'one', 'inputTwo' => 'two', 'input_3' => 3, ); $array = array( 'input_one', 'inputTwo', 'input_3', ); // Malformed $foo = array(1 , 2); $listItems[$aliasPath] = array('itemContent' => implode('
    ', $aliases)); $listItems[$aliasPath] = array( 'itemContent' => implode('
    ', $aliases) ); $x = array ( $x, $y, ); $x = array ( $x, $y, ); $x = array( $x, $y, ); $test = array( 'test' => TestFunction::blah( $value1, $value2 ), ); $c = array('a' => 1,); function b() { $a = array( 'a' => a('a'), ); } $foo = Array('[',']',':',"\n","\r"); $bar = Array('[',']',':',' ',' '); function foo() { return array($a, $b->screen); } $array = array( 'name' => 'contactSubject', 'required' => TRUE, 'validators' => array( new \Zend\Validator\InArray(array('haystack' => array_keys($aSubjects))), ), ); $var = array( 'ViewHelper', array('Foo'), 'Errors', ); $data = array( 'first', 'second', 'third', // Add more here ); $data = array( 'first', 'second', //'third', ); $data = array( 'first', 'second' //'third', ); $foo = array( $this->getViewName() . '.id' => 'value', $this->getViewName() . '.title' => 'value', ); $foo = array( $this->getViewName() . '.id', $this->getViewName() . '.title', ); $weightings = array( T_CLOSURE => 100, /* Conditions. */ T_WHILE => 50, /* Operators and arithmetic. */ T_BITWISE_AND => 8, T_BOOLEAN_AND => 5, /* Equality. */ T_IS_GREATER_OR_EQUAL => 5, ); foreach (array( 'foo' => 'bar', 'foobaz' => 'bazzy', ) as $key => $value) { } $ids = array( '1', // Foo. '13', // Bar. ); array( 'key1' => function($bar) { return $bar; }, 'key2' => function($foo) { return $foo; }, 'key3' => function($bar) { return $bar; } ); array( 'key1' => array( '1', '2', ) ); $var = array( 'tab_template' => '
  • %s
  • ', 'panel_template' => '
    %s
    ', ); function test() : array { return []; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.1.inc.fixed0000644000076700000240000001404312647543456032771 0ustar gsherwoodstaff 1); } class TestClass { public $good = array( 'width' => '', 'height' => '', ); private $_bad = array( 'width' => '', 'height' => '', ); public function test() { $truck = array( 'width' => '', 'height' => '', ); $plane = array( 'width' => '', 'height' => '', ); $car = array( 'width' => '', 'height' => '', ); $bus = array( 'width' => '', 'height' => '', ); $train = array( TRUE, FALSE, 'aaa', ); $inline = array( 'aaa', 'bbb', 'ccc', ); $inline = array('aaa'); $inline = array('aaa'); $bigone = array( 'name' => 'bigone', 'children' => array( '1a' => 'child', '11b' => 'child', '111c' => 'child', 'children' => array('child' => 'aaa'), ), 'short_name' => 'big', ); } }//end class $value = array(); $value = array(); $value = array( '1' => $one, '2' => $two, '3' => $three, '4' => $four, ); $value = array('1' => $one); if (in_array('1', array('1', '2', '3')) === TRUE) { $value = in_array('1', array('1', '2', '3', '4')); } $value = array( '1'=> TRUE, FALSE, '3' => 'aaa', ); $value = array( '1'=> TRUE, FALSE, ); $value = array( TRUE, '1' => FALSE, ); $value = array( 1, 2, 3, ); $value = array( 1 => $one, 2 => $two, 3 => $three, ); $value = array( 'tag' => $tag, 'space' => $this->_getIndentation($tag, $tagElement), ); $expected = array( array( '1' => 1, '1' => 2, ), ); $expected = array( array( '1' => 1, '1' => 2, ), ); // Space in second arg. $args = array( '"'.$this->id.'"', (int) $hasSessions, ); // No errors. $paths = array( Init::ROOT_DIR.'/Systems' => 'Systems', Init::ROOT_DIR.'/Installer' => 'Systems', ); $x = array(); $x = array('test'); $x = array('test'); $x = array('name' => 'test'); $x = array($x); $func = array( $x, 'get'.$x.'Replacement', ); $array = array( 'input_one' => 'one', 'inputTwo' => 'two', 'input_3' => 3, ); $array = array( 'input_one', 'inputTwo', 'input_3', ); // Malformed $foo = array( 1, 2, ); $listItems[$aliasPath] = array('itemContent' => implode('
    ', $aliases)); $listItems[$aliasPath] = array( 'itemContent' => implode('
    ', $aliases), ); $x = array( $x, $y, ); $x = array( $x, $y, ); $x = array( $x, $y, ); $test = array( 'test' => TestFunction::blah( $value1, $value2 ), ); $c = array('a' => 1); function b() { $a = array( 'a' => a('a'), ); } $foo = array( '[', ']', ':', "\n", "\r", ); $bar = array( '[', ']', ':', ' ', ' ', ); function foo() { return array( $a, $b->screen, ); } $array = array( 'name' => 'contactSubject', 'required' => TRUE, 'validators' => array( new \Zend\Validator\InArray(array('haystack' => array_keys($aSubjects))), ), ); $var = array( 'ViewHelper', array('Foo'), 'Errors', ); $data = array( 'first', 'second', 'third', // Add more here ); $data = array( 'first', 'second', //'third', ); $data = array( 'first', 'second', //'third', ); $foo = array( $this->getViewName() . '.id' => 'value', $this->getViewName() . '.title' => 'value', ); $foo = array( $this->getViewName() . '.id', $this->getViewName() . '.title', ); $weightings = array( T_CLOSURE => 100, /* Conditions. */ T_WHILE => 50, /* Operators and arithmetic. */ T_BITWISE_AND => 8, T_BOOLEAN_AND => 5, /* Equality. */ T_IS_GREATER_OR_EQUAL => 5, ); foreach (array( 'foo' => 'bar', 'foobaz' => 'bazzy', ) as $key => $value) { } $ids = array( '1', // Foo. '13', // Bar. ); array( 'key1' => function($bar) { return $bar; }, 'key2' => function($foo) { return $foo; }, 'key3' => function($bar) { return $bar; }, ); array( 'key1' => array( '1', '2', ), ); $var = array( 'tab_template' => '
  • %s
  • ', 'panel_template' => '
    %s
    ', ); function test() : array { return []; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.2.inc0000644000076700000240000001272312647543456031677 0ustar gsherwoodstaff 1, ]; } class TestClass { public $good = [ 'width' => '', 'height' => '', ]; private $_bad = [ 'width' => '', 'height' => '' ]; public function test() { $truck = [ 'width' => '', 'height' => '', ]; $plane = [ 'width' => '', 'height' => '', ]; $car = [ 'width' => '', 'height' => '', ]; $bus = [ 'width' => '', 'height' => '' ]; $train = [ TRUE, FALSE, 'aaa' ]; $inline = ['aaa', 'bbb', 'ccc']; $inline = ['aaa']; $inline = ['aaa']; $bigone = [ 'name' => 'bigone', 'children' => [ '1a' => 'child', '11b' => 'child', '111c' => 'child', 'children' => [ 'child' => 'aaa', ], ], 'short_name' => 'big' ]; } }//end class $value = [ ]; $value = [ ]; $value = ['1'=>$one, '2' => $two, '3'=> $three, '4' =>$four]; $value = ['1'=>$one]; if (in_array('1', ['1','2','3']) === TRUE) { $value = in_array('1', ['1' , '2', '3','4']); } $value = [ '1'=> TRUE, FALSE, '3' => 'aaa',]; $value = [ '1'=> TRUE, FALSE, ]; $value = [ TRUE, '1' => FALSE, ]; $value = [1, 2 , 3 , ]; $value = [1 => $one, 2 => $two , 3 => $three , ]; $value = [ 'tag' => $tag, 'space' => $this->_getIndentation($tag, $tagElement), ]; $expected = [ [ '1' => 1, '1' => 2, ], ]; $expected = [ [ '1' => 1, '1' => 2 ] ]; // Space in second arg. $args = [ '"'.$this->id.'"', (int) $hasSessions, ]; // No errors. $paths = [ Init::ROOT_DIR.'/Systems' => 'Systems', Init::ROOT_DIR.'/Installer' => 'Systems', ]; $x = [ ]; $x = ['test' ]; $x = ['test', ]; $x = ['name' => 'test', ]; $x = [ $x, ]; $func = [ $x, 'get'.$x.'Replacement' ]; $array = [ 'input_one' => 'one', 'inputTwo' => 'two', 'input_3' => 3, ]; $array = [ 'input_one', 'inputTwo', 'input_3', ]; // Malformed $foo = [1 , 2]; $listItems[$aliasPath] = ['itemContent' => implode('
    ', $aliases)]; $listItems[$aliasPath] = [ 'itemContent' => implode('
    ', $aliases) ]; $x = [ $x, $y, ]; $x = [ $x, $y, ]; $x = [ $x, $y, ]; $test = [ 'test' => TestFunction::blah( $value1, $value2 ), ]; $c = ['a' => 1,]; $c->{$var}[ ] = 2; $foo = ['[',']',':',"\n","\r"]; $bar = ['[',']',':',' ',' ']; function foo() { return [$a, $b->screen]; } $array = [ 'name' => 'contactSubject', 'required' => TRUE, 'validators' => [ new \Zend\Validator\InArray(['haystack' => array_keys($aSubjects)]), ], ]; $var = [ 'ViewHelper', ['Foo'], 'Errors', ]; $data = [ 'first', 'second', 'third', // Add more here ]; $data = [ 'first', 'second', //'third', ]; $data = [ 'first', 'second' //'third', ]; $foo = [ $this->getViewName() . '.id' => 'value', $this->getViewName() . '.title' => 'value', ]; $foo = [ $this->getViewName() . '.id', $this->getViewName() . '.title', ]; $weightings = [ T_CLOSURE => 100, /* Conditions. */ T_WHILE => 50, /* Operators and arithmetic. */ T_BITWISE_AND => 8, T_BOOLEAN_AND => 5, /* Equality. */ T_IS_GREATER_OR_EQUAL => 5, ]; foreach ([ 'foo' => 'bar', 'foobaz' => 'bazzy', ] as $key => $value) { } $ids = [ '1', // Foo. '13', // Bar. ]; [ 'key1' => function($bar) { return $bar; }, 'key2' => function($foo) { return $foo; }, 'key3' => function($bar) { return $bar; } ]; [ 'key1' => [ '1', '2', ] ]; $var = [ 'tab_template' => '
  • %s
  • ', 'panel_template' => '
    %s
    ', ]; function test() : array { return []; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.2.inc.fixed0000644000076700000240000001320612647543456032772 0ustar gsherwoodstaff 1]; } class TestClass { public $good = [ 'width' => '', 'height' => '', ]; private $_bad = [ 'width' => '', 'height' => '', ]; public function test() { $truck = [ 'width' => '', 'height' => '', ]; $plane = [ 'width' => '', 'height' => '', ]; $car = [ 'width' => '', 'height' => '', ]; $bus = [ 'width' => '', 'height' => '', ]; $train = [ TRUE, FALSE, 'aaa', ]; $inline = [ 'aaa', 'bbb', 'ccc', ]; $inline = ['aaa']; $inline = ['aaa']; $bigone = [ 'name' => 'bigone', 'children' => [ '1a' => 'child', '11b' => 'child', '111c' => 'child', 'children' => ['child' => 'aaa'], ], 'short_name' => 'big', ]; } }//end class $value = []; $value = []; $value = [ '1' => $one, '2' => $two, '3' => $three, '4' => $four, ]; $value = ['1' => $one]; if (in_array('1', ['1', '2', '3']) === TRUE) { $value = in_array('1', ['1', '2', '3', '4']); } $value = [ '1'=> TRUE, FALSE, '3' => 'aaa', ]; $value = [ '1'=> TRUE, FALSE, ]; $value = [ TRUE, '1' => FALSE, ]; $value = [ 1, 2, 3, ]; $value = [ 1 => $one, 2 => $two, 3 => $three, ]; $value = [ 'tag' => $tag, 'space' => $this->_getIndentation($tag, $tagElement), ]; $expected = [ [ '1' => 1, '1' => 2, ], ]; $expected = [ [ '1' => 1, '1' => 2, ], ]; // Space in second arg. $args = [ '"'.$this->id.'"', (int) $hasSessions, ]; // No errors. $paths = [ Init::ROOT_DIR.'/Systems' => 'Systems', Init::ROOT_DIR.'/Installer' => 'Systems', ]; $x = []; $x = ['test']; $x = ['test']; $x = ['name' => 'test']; $x = [$x]; $func = [ $x, 'get'.$x.'Replacement', ]; $array = [ 'input_one' => 'one', 'inputTwo' => 'two', 'input_3' => 3, ]; $array = [ 'input_one', 'inputTwo', 'input_3', ]; // Malformed $foo = [ 1, 2, ]; $listItems[$aliasPath] = ['itemContent' => implode('
    ', $aliases)]; $listItems[$aliasPath] = [ 'itemContent' => implode('
    ', $aliases), ]; $x = [ $x, $y, ]; $x = [ $x, $y, ]; $x = [ $x, $y, ]; $test = [ 'test' => TestFunction::blah( $value1, $value2 ), ]; $c = ['a' => 1]; $c->{$var}[ ] = 2; $foo = [ '[', ']', ':', "\n", "\r", ]; $bar = [ '[', ']', ':', ' ', ' ', ]; function foo() { return [ $a, $b->screen, ]; } $array = [ 'name' => 'contactSubject', 'required' => TRUE, 'validators' => [ new \Zend\Validator\InArray(['haystack' => array_keys($aSubjects)]), ], ]; $var = [ 'ViewHelper', ['Foo'], 'Errors', ]; $data = [ 'first', 'second', 'third', // Add more here ]; $data = [ 'first', 'second', //'third', ]; $data = [ 'first', 'second', //'third', ]; $foo = [ $this->getViewName() . '.id' => 'value', $this->getViewName() . '.title' => 'value', ]; $foo = [ $this->getViewName() . '.id', $this->getViewName() . '.title', ]; $weightings = [ T_CLOSURE => 100, /* Conditions. */ T_WHILE => 50, /* Operators and arithmetic. */ T_BITWISE_AND => 8, T_BOOLEAN_AND => 5, /* Equality. */ T_IS_GREATER_OR_EQUAL => 5, ]; foreach ([ 'foo' => 'bar', 'foobaz' => 'bazzy', ] as $key => $value) { } $ids = [ '1', // Foo. '13', // Bar. ]; [ 'key1' => function($bar) { return $bar; }, 'key2' => function($foo) { return $foo; }, 'key3' => function($bar) { return $bar; }, ]; [ 'key1' => [ '1', '2', ], ]; $var = [ 'tab_template' => '
  • %s
  • ', 'panel_template' => '
    %s
    ', ]; function test() : array { return []; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Arrays/ArrayDeclarationUnitTest.php0000644000076700000240000001333512647543456031555 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ArrayDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Arrays_ArrayDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='') { switch ($testFile) { case 'ArrayDeclarationUnitTest.1.inc': return array( 7 => 2, 9 => 2, 22 => 1, 23 => 1, 24 => 1, 25 => 1, 31 => 1, 35 => 1, 36 => 1, 41 => 1, 46 => 1, 47 => 1, 50 => 1, 51 => 1, 53 => 1, 56 => 1, 58 => 1, 61 => 1, 62 => 1, 63 => 1, 64 => 1, 65 => 1, 66 => 3, 70 => 1, 76 => 2, 77 => 1, 78 => 7, 79 => 2, 81 => 2, 82 => 4, 87 => 1, 88 => 1, 92 => 1, 97 => 1, 100 => 1, 101 => 1, 102 => 1, 105 => 1, 106 => 1, 107 => 1, 125 => 1, 126 => 1, 141 => 1, 144 => 1, 146 => 1, 148 => 1, 151 => 1, 157 => 1, 174 => 3, 179 => 1, 182 => 1, 188 => 1, 207 => 1, 212 => 1, 214 => 1, 218 => 2, 219 => 2, 223 => 1, 255 => 1, 294 => 1, 295 => 1, 296 => 1, 311 => 1, 317 => 1, ); case 'ArrayDeclarationUnitTest.2.inc': return array( 9 => 1, 23 => 1, 24 => 1, 25 => 1, 31 => 1, 36 => 1, 41 => 1, 46 => 1, 47 => 1, 51 => 1, 53 => 1, 56 => 1, 61 => 1, 63 => 1, 64 => 1, 65 => 1, 66 => 2, 70 => 1, 76 => 1, 77 => 1, 78 => 7, 79 => 2, 81 => 2, 82 => 4, 87 => 1, 88 => 1, 92 => 1, 97 => 1, 100 => 1, 101 => 1, 102 => 1, 105 => 1, 106 => 1, 107 => 1, 125 => 1, 126 => 1, 141 => 1, 144 => 1, 146 => 1, 148 => 1, 151 => 1, 157 => 1, 174 => 3, 179 => 1, 190 => 1, 191 => 1, 192 => 1, 207 => 1, 210 => 1, 211 => 1, 215 => 1, 247 => 1, 286 => 1, 287 => 1, 288 => 1, 303 => 1, 309 => 1, ); default: return array(); }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Classes/ClassDeclarationUnitTest.inc0000644000076700000240000000313012647543456031652 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ClassDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Classes_ClassDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 5 => 1, 10 => 1, 15 => 2, 18 => 1, 22 => 4, 23 => 4, 24 => 4, 27 => 2, 28 => 1, 30 => 2, 34 => 1, 35 => 1, 39 => 1, 42 => 1, 45 => 1, 48 => 1, 50 => 2, 55 => 1, 59 => 4, 63 => 1, 65 => 1, 69 => 3, 74 => 2, 77 => 1, 80 => 1, 85 => 3, 89 => 1, 92 => 1, 97 => 1, 103 => 1, 105 => 1, 107 => 1, 110 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Classes/ClassFileNameUnitTest.inc0000644000076700000240000000065112647543456031112 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Classes/ClassFileNameUnitTest.php0000644000076700000240000000402012647543456031122 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ClassFileName sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Classes_ClassFileNameUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 9 => 1, 10 => 1, 11 => 1, 15 => 1, 16 => 1, 17 => 1, 18 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Classes/DuplicatePropertyUnitTest.js0000644000076700000240000000140412647543456031763 0ustar gsherwoodstaffvar x = { abc: 1, zyz: 2, abc: 5, mno: { abc: 4 }, abc: 5 this.request({ action: 'getSubmissions' }); this.request({ action: 'deleteSubmission' }); } LinkingEditScreenWidgetType.prototype = { _addDeleteButtonEvent: function(parentid) { var params = { screen: 'LinkingEditScreenWidget', assetid: self.assetid, parentid: parentid, assetid: parentid, op: 'deleteLink' }; }, saveDesignEdit: function() { var params = { screen: [this.id, 'Widget'].join(''), assetid: this.assetid, changes: dfx.jsonEncode(this.currnetLinksWdgt.getChanges()), op: 'saveLinkEdit' }; } };PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Classes/DuplicatePropertyUnitTest.php0000644000076700000240000000352412647543456032143 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DuplicateProperty sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Classes_DuplicatePropertyUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 4 => 1, 8 => 1, 28 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Classes/LowercaseClassKeywordsUnitTest.inc0000644000076700000240000000031712647543456033105 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Classes/LowercaseClassKeywordsUnitTest.php0000644000076700000240000000410312647543456033120 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the LowercaseClassKeywords sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Classes_LowercaseClassKeywordsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { $errors = array( 2 => 3, 3 => 3, 4 => 1, 5 => 1, 9 => 1, 10 => 1, ); return $errors; }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Classes/SelfMemberReferenceUnitTest.inc0000644000076700000240000000436412647543456032311 0ustar gsherwoodstafftestResults; // Correct call to self. $testResults[] = self::selfMemberReferenceUnitTestFunction(); $testResults[] = parent::selfMemberReferenceUnitTestFunction(); // Incorrect case. $testResults[] = Self::selfMemberReferenceUnitTestFunction(); $testResults[] = SELF::selfMemberReferenceUnitTestFunction(); $testResults[] = SelfMemberReferenceUnitTestExample::selfMemberReferenceUnitTestFunction(); // Incorrect spacing. $testResults[] = self ::selfMemberReferenceUnitTestFunction(); $testResults[] = self:: selfMemberReferenceUnitTestFunction(); $testResults[] = self :: selfMemberReferenceUnitTestFunction(); } function selfMemberReferenceUnitTestFunction() { $this->testCount = $this->testCount + 1; return $this->testCount; } } class MyClass { public static function test($value) { echo "$value\n"; } public static function walk() { $callback = function($value, $key) { // This is valid because you cant use self:: in a closure MyClass::test($value); }; $array = array(1,2,3); array_walk($array, $callback); } } MyClass::walk(); class Controller { public function Action() { Doctrine\Common\Util\Debug::dump(); } } namespace TYPO3\CMS\Reports; class Status { const NOTICE = -2; const INFO = -1; const OK = 0; const WARNING = 1; const ERROR = 2; } namespace TYPO3\CMS\Reports\Report\Status; class Status implements \TYPO3\CMS\Reports\ReportInterface { public function getHighestSeverity(array $statusCollection) { $highestSeverity = \TYPO3\CMS\Reports\Status::NOTICE; } } namespace Foo; class Bar { function myFunction() { \Foo\Whatever::something(); \Foo\Bar::something(); } } namespace Foo\Bar; class Baz { function myFunction() { \Foo\Bar\Whatever::something(); \Foo\Bar\Baz::something(); } } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Classes/SelfMemberReferenceUnitTest.php0000644000076700000240000000410312647543456032316 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the SelfMemberReference sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Classes_SelfMemberReferenceUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 24 => 1, 25 => 1, 26 => 1, 30 => 1, 31 => 1, 32 => 2, 100 => 1, 111 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Classes/ValidClassNameUnitTest.inc0000644000076700000240000000162012647543456031267 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ValidClassName sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Classes_ValidClassNameUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 9 => 1, 10 => 1, 14 => 1, 15 => 1, 20 => 1, 30 => 1, 32 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/BlockCommentUnitTest.inc0000644000076700000240000000516112647543456031525 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the BlockComment sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Commenting_BlockCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { $errors = array( 8 => 1, 20 => 1, 24 => 1, 30 => 1, 31 => 1, 34 => 1, 40 => 1, 45 => 1, 49 => 1, 51 => 1, 53 => 1, 57 => 1, 60 => 1, 61 => 1, 63 => 1, 65 => 1, 68 => 1, 70 => 1, 72 => 1, 75 => 1, 84 => 1, 87 => 1, 89 => 1, 92 => 1, 111 => 1, 159 => 1, 181 => 1, 188 => 1, ); return $errors; }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/ClassCommentUnitTest.inc0000644000076700000240000000245012647543456031536 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for ClassCommentSniff. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Commenting_ClassCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 4 => 1, 15 => 1, 31 => 1, 39 => 1, 54 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 29 => 1, 30 => 1, 50 => 1, 66 => 1, 67 => 1, ); }//end getWarningList() }//end class ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest0000644000076700000240000000202312647543456033461 0ustar gsherwoodstaff././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest0000644000076700000240000000417112647543456033467 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ClosingDeclarationComment sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Commenting_ClosingDeclarationCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 13 => 1, 17 => 1, 31 => 1, 41 => 1, 59 => 1, 63 => 1, 67 => 1, 79 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 71 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/DocCommentAlignmentUnitTest.inc0000644000076700000240000000215612647543456033040 0ustar gsherwoodstaff line numbers for each token. * * Long description with some points: * - one * - two * - three * * @param array &$tokens The array of tokens to process. * @param object $tokenizer The tokenizer being used to * process this file. * @param string $eolChar The EOL character to use for splitting strings. * * @return void */ function myFunction() {}././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/DocCommentAlignmentUnitTest.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/DocCommentAlignmentUnitTest.inc.f0000644000076700000240000000215112647543456033257 0ustar gsherwoodstaff line numbers for each token. * * Long description with some points: * - one * - two * - three * * @param array &$tokens The array of tokens to process. * @param object $tokenizer The tokenizer being used to * process this file. * @param string $eolChar The EOL character to use for splitting strings. * * @return void */ function myFunction() {}PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/DocCommentAlignmentUnitTest.js0000644000076700000240000000234312647543456032701 0ustar gsherwoodstaff /** * Some info about the class here * */ foo.prototype = { /** * Some info about the function here. * *@return void */ bar: function() {} } /** * Some info about the class here * */ foo.prototype = { /** *Some info about the function here. * * @return void */ bar: function() {} } /** * Some info about the class here * */ foo.prototype = { /** * Some info about the function here. * * @return void */ bar: function() {} } /** @var Database $mockedDatabase */ /** @var Container $mockedContainer */ function myFunction() { console.info('hi'); /** Comment here. */ } /** * Creates a map of tokens => line numbers for each token. * * Long description with some points: * - one * - two * - three * * @param array &$tokens The array of tokens to process. * @param object $tokenizer The tokenizer being used to * process this file. * @param string $eolChar The EOL character to use for splitting strings. * * @return void */ function myFunction() {} $.extend(Datepicker.prototype, { _widgetDatepicker: function() { }, /* Action for selecting a new month/year. */ }); ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/DocCommentAlignmentUnitTest.js.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/DocCommentAlignmentUnitTest.js.fi0000644000076700000240000000233612647543456033300 0ustar gsherwoodstaff /** * Some info about the class here * */ foo.prototype = { /** * Some info about the function here. * * @return void */ bar: function() {} } /** * Some info about the class here * */ foo.prototype = { /** * Some info about the function here. * * @return void */ bar: function() {} } /** * Some info about the class here * */ foo.prototype = { /** * Some info about the function here. * * @return void */ bar: function() {} } /** @var Database $mockedDatabase */ /** @var Container $mockedContainer */ function myFunction() { console.info('hi'); /** Comment here. */ } /** * Creates a map of tokens => line numbers for each token. * * Long description with some points: * - one * - two * - three * * @param array &$tokens The array of tokens to process. * @param object $tokenizer The tokenizer being used to * process this file. * @param string $eolChar The EOL character to use for splitting strings. * * @return void */ function myFunction() {} $.extend(Datepicker.prototype, { _widgetDatepicker: function() { }, /* Action for selecting a new month/year. */ }); PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/DocCommentAlignmentUnitTest.php0000644000076700000240000000427312647543456033060 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DocCommentAlignment sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Commenting_DocCommentAlignmentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 11 => 1, 17 => 1, 18 => 1, 19 => 1, 23 => 2, 24 => 1, 25 => 2, 26 => 1, 32 => 1, 33 => 1, 38 => 1, 39 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/EmptyCatchCommentUnitTest.inc0000644000076700000240000000154112647543456032532 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/EmptyCatchCommentUnitTest.php0000644000076700000240000000400612647543456032547 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the EmptyCatchComment sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Commenting_EmptyCatchCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 13 => 1, 33 => 1, 49 => 1, 50 => 1, 51 => 1, 52 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/FileCommentUnitTest.inc0000644000076700000240000000172612647543456031355 0ustar gsherwoodstaff * @author * @copyright 1997~1994 The PHP Group * @copyright 1994-1997 The PHP Group * @copyright The PHP Group * @license http://www.php.net/license/3_0.txt * @summary An unknown summary tag * */ ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/FileCommentUnitTest.1.inc0000644000076700000240000000031412647543456031504 0ustar gsherwoodstaff * @copyright 2010-2014 Squiz Pty Ltd (ABN 77 084 670 600) */ echo 'hi';PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/FileCommentUnitTest.js0000644000076700000240000000171212647543456031213 0ustar gsherwoodstaff /** * * 0Multi-line short description without full stop * * * asdasd * long description for file (if any) * asdasdadada * * PHP versio * * LICENSE: This source file is subject to version 3.0 of the PHP license * that is available through the world-wide-web at the following URI: * http://www.php.net/license/3_0.txt. If you did not receive a copy of * the PHP License and are unable to obtain it through the web, please * send a note to license@php.net so we can mail you a copy immediately. * @package SquizCMS * @package ADDITIONAL PACKAGE TAG * @subpkg not_camelcased * @author Antônio Carlos Venâncio Júnior * @author * @copyright 1997~1994 The PHP Group * @copyright 1994-1997 The PHP Group * @copyright The PHP Group * @license http://www.php.net/license/3_0.txt * @summary An unknown summary tag * */ /** * This bit here is not qualified as file comment * * as it is not the first comment in the file * */ PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/FileCommentUnitTest.1.js0000644000076700000240000000030712647543456031351 0ustar gsherwoodstaff/** * File comment. * * @package Package * @subpackage Subpackage * @author Squiz Pty Ltd * @copyright 2010-2014 Squiz Pty Ltd (ABN 77 084 670 600) */ print 'hi';PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/FileCommentUnitTest.php0000644000076700000240000000522312647543456031367 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for FileCommentSniff. * * Verifies that : *
      *
    • A doc comment exists.
    • *
    • Short description must start with a capital letter and end with a period.
    • *
    • There must be one blank newline after the short description.
    • *
    • A PHP version is specified.
    • *
    • Check the order of the tags.
    • *
    • Check the indentation of each tag.
    • *
    • Check required and optional tags and the format of their content.
    • *
    * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Commenting_FileCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='FileCommentUnitTest.inc') { switch ($testFile) { case 'FileCommentUnitTest.inc': case 'FileCommentUnitTest.js': return array( 1 => 1, 22 => 2, 23 => 1, 24 => 2, 25 => 2, 26 => 1, 27 => 2, 28 => 2, 32 => 2, ); default: return array(); } }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/FunctionCommentThrowTagUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/FunctionCommentThrowTagUnitTest.i0000644000076700000240000001232712647543456033421 0ustar gsherwoodstaffcallSomeFunction(); }//end okFunction() /** * Comment inside function. * * @throws Exception */ function okFunction() { /** * @var FooClass */ $foo = FooFactory::factory(); throw new Exception; }//end okFunction }//end class class NamespacedException { /** * @throws \Exception */ public function foo() { throw new \Exception(); } /** * @throws \Foo\Bar\FooBarException */ public function fooBar2() { throw new \Foo\Bar\FooBarException(); } /** * @throws FooBarException */ public function fooBar2() { throw new \Foo\Bar\FooBarException(); } } class Foo { /** * Comment */ public function foo() { }//end foo() public function bar() { throw new Exception(); } /** * Returns information for a test. * * This info includes parameters, their valid values. * * @param integer $projectid Id of the project. * * @return array * @throws ChannelException If the project is invalid. */ public static function getTestInfo($projectid=NULL) { try { DAL::beginTransaction(); DAL::commit(); } catch (DALException $e) { DAL::rollBack(); throw new ChannelException($e); } } } class Test { /** * Folder name. * * @var string */ protected $folderName; protected function setUp() { parent::setUp(); if ( !strlen($this->folderName) ) { throw new \RuntimeException('The $this->folderName must be specified before proceeding.'); } } } ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/FunctionCommentThrowTagUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/FunctionCommentThrowTagUnitTest.p0000644000076700000240000000425012647543456033424 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for FunctionCommentThrowTagSniff. * * Verifies that : *
      *
    • A @throws tag exists for a function that throws exceptions.
    • *
    • The number of @throws tags and the number of throw tokens matches.
    • *
    • The exception type in comment matches the token.
    • *
    * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Commenting_FunctionCommentThrowTagUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 9 => 1, 21 => 1, 35 => 1, 47 => 1, 61 => 2, 106 => 1, 123 => 1, 215 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc0000644000076700000240000002736512647543456032272 0ustar gsherwoodstaffMyClass) */ public function caseSensitive($a1, $a2, $a3, arRay $a4, $a5, $a6, myclas $a7) { }//end caseSensitive() /** * More type hint check for custom type and array. * * @param array $a1 Comment here. * @param array $a2 Comment here. * @param MyClass $a3 Comment here. * @param MyClass $a4 Comment here. * * @return array(int => MyClass) */ public function typeHint(MyClass $a1, $a2, myclass $a3, $a4) { return (3 => 'myclass obj'); }//end typeHint() /** * Mixed variable type separated by a '|'. * * @param array|string $a1 Comment here. * @param mixed $a2 Comment here. * @param string|array $a3 Comment here. * @param MyClass|int $a4 Comment here. * * @return bool */ public function mixedType($a1, $a2, $a3, $a4) { return true; }//end mixedType() /** * Array type. * * @param array(MyClass) $a1 OK. * @param array() $a2 Invalid type. * @param array( $a3 Typo. * @param array(int) $a4 Use 'array(integer)' instead. * @param array(int => integer) $a5 Use 'array(integer => integer)' instead. * @param array(integer => bool) $a6 Use 'array(integer => boolean)' instead. * @param aRRay $a7 Use 'array' instead. * @param string $a8 String with unknown type hint. * * @return int */ public function mixedArrayType($a1, $a2, array $a3, $a4, $a5, $a6, $a7, unknownTypeHint $a8) { return 1; }//end mixedArrayType() /** */ function empty1() { }//end empty1() /** * */ function empty2() { }//end empty2() /** * * * */ function empty3() { }//end empty3 /** * @return boolean */ public function missingShortDescriptionInFunctionComment() { return true; }//end missingShortDescriptionInFunctionComment() class Another_Class { /** * Destructor should not include a return tag. * * @return void */ function __destruct() { return; } /** * Constructor should not include a return tag. * * @return void */ function __construct() { return; } }//end class /** * Comment param alignment test. * * @param string $varrr1 Comment1.. * @param string $vr2 Comment2. * @param string $var3 Comment3.. * * @return void */ public static function paramAlign($varrr1, $vr2, $var3) { }//end paramAlign() /** * Comment. * * @param string $id Comment. * @param array $design Comment. * * @return void */ public static function paint($id, array $design) { }//end paint() /** * Adds specified class name to class attribute of this widget. * * @since 4.0.0 * @return string */ public function myFunction() { if ($condition === FALSE) { echo 'hi'; } }//end myFunction() /** * Adds specified class name to class attribute of this widget. * * @return string */ public function myFunction() { if ($condition === FALSE) { echo 'hi'; return; } return 'blah'; }//end myFunction() /** * Adds specified class name to class attribute of this widget. * * @return string */ public function myFunction() { if ($condition === FALSE) { echo 'hi'; } return 'blah'; }//end myFunction() /** * Test function. * * @param string $arg1 An argument * * @access public * @return bool */ echo $blah; function myFunction($arg1) {} class MyClass() { /** * An abstract function. * * @return string[] */ abstract final protected function myFunction(); } /** * Comment. * * @param mixed $test An argument. * * @return mixed */ function test($test) { if ($test === TRUE) { return; } return $test; }//end test() /** Comment. * * @return mixed * */ function test() { }//end test() /** * Comment. * * @param \other\ns\item $test An argument. * * @return mixed */ function test(\other\ns\item $test) { return $test; }//end test() /** * Comment. * * @param item $test An argument. * * @return mixed */ function test(\other\ns\item $test) { return $test; }//end test() /** * Comment. * * @param \first\ns\item $test An argument. * * @return mixed */ function test(\first\ns\item $test = \second\ns::CONSTANT) { return $test; }//end test() /** * Comment. * * @param \first\item $test An argument. * * @return mixed */ function test(\first\ns\item $test = \second\ns::CONSTANT) { return $test; }//end test() // Closures should be ignored. preg_replace_callback( '~-([a-z])~', function ($match) { return strtoupper($match[1]); }, 'hello-world' ); $callback = function ($bar) use ($foo) { $bar += $foo; }; /** * Comment should end with '*', not '**' before the slash. **/ function test123() { } /** * Cant use resource for type hint. * * @param resource $test An argument. * * @return mixed */ function test($test) { return $test; }//end test() /** * Variable number of args. * * @param string $a1 Comment here. * @param string $a2 Comment here. * @param string $a2,... Comment here. * * @return boolean */ public function variableArgs($a1, $a2) { return true; }//end variableArgs() /** * Contains closure. * * @return void */ public function containsClosure() { function ($e) { return new Event($e); }, }//end containsClosure() /** * 这是一条测试评论. * * @return void */ public function test() { }//end variableArgs() /** * Uses callable. * * @param callable $cb Test parameter. * * @return void */ public function usesCallable(callable $cb) { $cb(); }//end usesCallable() /** * Creates a map of tokens => line numbers for each token. * * @param array $tokens The array of tokens to process. * @param object $tokenizer The tokenizer being used to process this file. * @param string $eolChar The EOL character * to use for splitting strings. * * @return void * @throws Exception If something really bad * happens while doing foo. */ public function foo(array &$tokens, $tokenizer, $eolChar) { }//end foo() /** * Some description. * * @param \Vendor\Package\SomeClass $someclass Some class. * @param \OtherVendor\Package\SomeClass2 $someclass2 Some class. * @param \OtherVendor\Package\SomeClass2 $someclass3 Some class. * * @return void */ public function foo(SomeClass $someclass, \OtherVendor\Package\SomeClass2 $someclass2, SomeClass3 $someclass3) { } /** * Gettext. * * @return string */ public function _() { return $foo; } class Baz { /** * The PHP5 constructor * * No return tag */ public function __construct() { } } /** * Test * * @return void * @throws E */ function myFunction() {} /** * Yield test * * @return integer */ function yieldTest() { for ($i = 0; $i < 5; $i++) { yield $i; } } /** * Yield test * * @return void */ function yieldTest() { for ($i = 0; $i < 5; $i++) { yield $i; } } /** * Using "array" as a type hint should satisfy a specified array parameter type. * * @param MyClass[] $values An array of MyClass objects. * * @return void */ public function specifiedArray(array $values) { }// end specifiedArray() /** * Using "callable" as a type hint should satisfy a "callback" parameter type. * * @param callback $cb A callback. * * @return void */ public function callableCallback(callable $cb) { }// end callableCallback() /** * PHP7 type hints. * * @param string $name1 Comment. * @param integer $name2 Comment. * @param float $name3 Comment. * @param boolean $name4 Comment. * * @return void */ public function myFunction (string $name1, int $name2, float $name3, bool $name4) { } /** * Variadic function. * * @param string $name1 Comment. * @param string ...$name2 Comment. * * @return void */ public function myFunction(string $name1, string ...$name2) { } /** * Variadic function. * * @param string $name1 Comment. * @param string $name2 Comment. * * @return void */ public function myFunction(string $name1, string ...$name2) { } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.php0000644000076700000240000001073312647543456032277 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for FunctionCommentSniff. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Commenting_FunctionCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { $errors = array( 5 => 1, 10 => 3, 12 => 2, 13 => 2, 14 => 1, 15 => 1, 28 => 1, 43 => 1, 76 => 1, 87 => 1, 103 => 1, 109 => 1, 112 => 1, 122 => 1, 123 => 3, 124 => 2, 125 => 1, 126 => 1, 137 => 4, 138 => 4, 139 => 4, 143 => 2, 152 => 1, 155 => 2, 159 => 1, 166 => 1, 173 => 1, 183 => 1, 190 => 2, 193 => 2, 196 => 1, 199 => 2, 210 => 1, 211 => 1, 222 => 1, 223 => 1, 224 => 1, 225 => 1, 226 => 1, 227 => 1, 230 => 2, 232 => 1, 246 => 1, 248 => 4, 261 => 1, 263 => 1, 276 => 1, 277 => 1, 278 => 1, 279 => 1, 280 => 1, 281 => 1, 284 => 1, 286 => 2, 294 => 1, 302 => 1, 312 => 1, 358 => 1, 359 => 2, 372 => 1, 373 => 1, 387 => 1, 407 => 1, 441 => 1, 500 => 1, 526 => 1, 548 => 1, 641 => 1, 669 => 1, 744 => 1, 748 => 1, ); // The yield tests will only work in PHP versions where yield exists and // will throw errors in earlier versions. if (version_compare(PHP_VERSION, '5.5.0') < 0) { $errors[676] = 1; } else { $errors[688] = 1; } // Scalar type hints only work from PHP 7 onwards. if (version_compare(PHP_VERSION, '7.0.0') >= 0) { $errors[17] = 1; $errors[143] = 3; $errors[161] = 2; $errors[201] = 1; $errors[363] = 3; $errors[377] = 1; $errors[575] = 2; $errors[627] = 1; } else { $errors[729] = 4; $errors[740] = 2; $errors[752] = 2; } return $errors; }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/InlineCommentUnitTest.inc0000644000076700000240000000303312647543456031705 0ustar gsherwoodstaff One // -> One.One // -> Two /* Here is some inline example code: -> One -> One.One -> Two */ /** * Comment should be ignored in PHP 5.4. * */ trait MyTrait { } $foo = 'foo'; // Var set to foo. echo $foo; // Comment here. echo $foo; PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/InlineCommentUnitTest.inc.fixed0000644000076700000240000000300512647543456033002 0ustar gsherwoodstaff One // -> One.One // -> Two /* Here is some inline example code: -> One -> One.One -> Two */ /** * Comment should be ignored in PHP 5.4. * */ trait MyTrait { } $foo = 'foo'; // Var set to foo. echo $foo; // Comment here. echo $foo; PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/InlineCommentUnitTest.js0000644000076700000240000000340712647543456031555 0ustar gsherwoodstaff// Some content here. var code = 'hello'; // This comment contains # multiple // hash signs (#). code = 'hello'; /** * This is the first line of a function comment. * This is the second line. */ function testFunction() { // Callback methods which are added by external objects. this.callbacks = {}; }//end testFunction() /** * This is the first line of a class comment. * This is the second line. */ myClass.prototype = { /** * This is the first line of a method comment. * This is the second line. */ load: function(url, callback) { // Some code here. } }; // some code goes here! /* A longer comment goes here. It spans multiple lines!! Or does it? */ // 0This is a simple multi-line // comment! code = 'hello'; //This is not valid. code = 'hello'; // Neither is this! code = 'hello'; // code = 'hello'; /** Neither is this! **/ code = 'hello'; /** * This is the first line of a function comment. * This is the second line. */ var myFunction = function() { } /** * This is the first line of a function comment. * This is the second line. */ myFunction = function() { } /** * This is the first line of a function comment. * This is the second line. */ myClass.myFunction = function() { } dfx.getIframeDocument = function(iframe) { return doc; };//end dfx.getIframeDocument() mig.Gallery.prototype = { init: function(cb) { },//end init() imageClicked: function(id) { }//end imageClicked() }; // Here is some inline example code: // -> One // -> One.One // -> Two /* Here is some inline example code: -> One -> One.One -> Two */ var foo = 'foo'; // Var set to foo. console.info(foo); // Comment here. console.info(foo);PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/InlineCommentUnitTest.php0000644000076700000240000000572612647543456031736 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the InlineComment sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Commenting_InlineCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='InlineCommentUnitTest.inc') { switch ($testFile) { case 'InlineCommentUnitTest.inc': $errors = array( 17 => 1, 27 => 1, 28 => 1, 32 => 2, 36 => 1, 44 => 2, 58 => 1, 61 => 1, 64 => 1, 67 => 1, 95 => 1, 96 => 1, 97 => 3, 118 => 1, ); return $errors; case 'InlineCommentUnitTest.js': return array( 31 => 1, 36 => 2, 48 => 1, 51 => 1, 54 => 1, 57 => 1, 102 => 1, 103 => 1, 104 => 3, 118 => 1, ); default: return array(); }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/LongConditionClosingCommentUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/LongConditionClosingCommentUnitTe0000644000076700000240000003121112647543456033434 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the LongConditionClosingComment sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Commenting_LongConditionClosingCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='LongConditionClosingCommentUnitTest.inc') { switch ($testFile) { case 'LongConditionClosingCommentUnitTest.inc': return array( 49 => 1, 99 => 1, 146 => 1, 192 => 1, 215 => 1, 238 => 1, 261 => 1, 286 => 1, 309 => 1, 332 => 1, 355 => 1, 378 => 1, 493 => 1, 531 => 1, 536 => 1, 540 => 1, 562 => 1, 601 => 1, 629 => 1, 663 => 1, 765 => 1, ); break; case 'LongConditionClosingCommentUnitTest.js': return array( 47 => 1, 97 => 1, 144 => 1, 190 => 1, 213 => 1, 238 => 1, 261 => 1, 284 => 1, 307 => 1, 401 => 1, 439 => 1, 444 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/PostStatementCommentUnitTest.inc0000644000076700000240000000037012647543456033302 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/PostStatementCommentUnitTest.js0000644000076700000240000000063312647543456033147 0ustar gsherwoodstafffunction test(id, buttons) // cool function { alert('hello'); alert('hello again'); // And again. // Valid comment. }//end test() var good = true; // Indeed. mig.Gallery.prototype = { init: function(cb) { },//end init() imageClicked: function(id) { }//end imageClicked() }; dfx.getIframeDocument = function(iframe) { return doc; };//end dfx.getIframeDocument()PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/PostStatementCommentUnitTest.php0000644000076700000240000000471312647543456033325 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the PostStatementComment sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Commenting_PostStatementCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='PostStatementCommentUnitTest.inc') { switch ($testFile) { case 'PostStatementCommentUnitTest.inc': return array( 6 => 1, 10 => 1, 18 => 1, ); break; case 'PostStatementCommentUnitTest.js': return array( 1 => 1, 4 => 1, 9 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/VariableCommentUnitTest.inc0000644000076700000240000000640512647543456032222 0ustar gsherwoodstaff $content) { echo $content; } return $var1; }//end checkVariable() /** * * */ $emptyVarDoc = ''; /** * Var type checking (int v.s. integer). * * @var int */ private $_varSimpleTypeCheck; /** * Var type checking (array(int => string) v.s. array(int => string)). * * @var array(int => string) */ private $_varArrayTypeCheck; /** * Var type checking (STRING v.s. string). * * @var STRING */ private $_varCaseTypeCheck; /** * @var integer */ private $_varWithNoShortComment; protected $noComment2 = ''; }//end class /** * VariableCommentUnitTest2. * * Long description goes here. * */ class VariableCommentUnitTest2 { public $hello; /** Comment starts here. * * @var string * */ private $_varCaseTypeCheck; /** * 这是一条测试评论. * * @var string */ public $foo; }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Commenting/VariableCommentUnitTest.php0000644000076700000240000000400112647543456032226 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for VariableCommentSniff. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Commenting_VariableCommentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 21 => 1, 24 => 1, 56 => 1, 64 => 1, 73 => 1, 84 => 1, 131 => 1, 137 => 1, 145 => 1, 153 => 1, 163 => 1, 178 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(93 => 1); }//end getWarningList() }//end class ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ControlSignatureUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ControlSignatureUnitTest.i0000644000076700000240000000440212647543456033552 0ustar gsherwoodstaff 0); do { echo $i; } while ($i > 0); do { echo $i; } while ($i > 0); do { echo $i; } while ($i > 0); do{ echo $i; }while($i > 0); while ($i < 1) { echo $i; } while($i < 1){ echo $i; } while ($i < 1) { echo $i; } for ($i = 1; $i < 1; $i++) { echo $i; } for($i = 1; $i < 1; $i++){ echo $i; } for ($i = 1; $i < 1; $i++) { echo $i; } if ($i == 0) { $i = 1; } if($i == 0){ $i = 1; } if ($i == 0) { $i = 1; } if ($i == 0) { $i = 1; } else { $i = 0; } if ($i == 0) { $i = 1; }else{ $i = 0; } if ($i == 0) { $i = 1; } else { $i = 0; } if ($i == 0) { $i = 1; } else if ($i == 2) { $i = 0; } if ($i == 0) { $i = 1; }else if($i == 2){ $i = 0; } if ($i == 0) { $i = 1; } else if ($i == 2) { $i = 0; } if ($i == 0) { // comments are allowed $i = 1; } if ($i == 0) {// comments are allowed $i = 1; } if ($i == 0) { /* comments are allowed*/ $i = 1; } if ($i == 0) { // this is ok $i = 1; } if ($i == 0) /* this is ok */ { } try { $code = 'this'; } catch (Exception $e) { // Caught! } try { $code = 'this'; } catch (Exception $e) { // Caught! } do { echo $i; } while ($i > 0); if ($i === 0) { $i = 1 } if ($a) { } elseif ($b) { } foreach ($items as $item) { echo $item; } foreach($items as $item){ echo $item; } if ($a && $b) // && $c) { } if ($a == 5) : echo "a equals 5"; echo "..."; elseif ($a == 6) : echo "a equals 6"; echo "!!!"; else : echo "a is neither 5 nor 6"; endif; try { // try body } catch (FirstExceptionType $e) { // catch body } catch (OtherExceptionType $e) { // catch body } switch($foo) { case 'bar': break; } if ($foo) : endif; ?> getRow()): ?>

    hello hello ././@LongLink000 154 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ControlSignatureUnitTest.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ControlSignatureUnitTest.i0000644000076700000240000000443212647543456033555 0ustar gsherwoodstaff 0); do { echo $i; } while ($i > 0); do { echo $i; } while ($i > 0); do { echo $i; } while ($i > 0); do { echo $i; } while ($i > 0); while ($i < 1) { echo $i; } while ($i < 1) { echo $i; } while ($i < 1) { echo $i; } for ($i = 1; $i < 1; $i++) { echo $i; } for ($i = 1; $i < 1; $i++) { echo $i; } for ($i = 1; $i < 1; $i++) { echo $i; } if ($i == 0) { $i = 1; } if ($i == 0) { $i = 1; } if ($i == 0) { $i = 1; } if ($i == 0) { $i = 1; } else { $i = 0; } if ($i == 0) { $i = 1; } else { $i = 0; } if ($i == 0) { $i = 1; } else { $i = 0; } if ($i == 0) { $i = 1; } else if ($i == 2) { $i = 0; } if ($i == 0) { $i = 1; } else if ($i == 2) { $i = 0; } if ($i == 0) { $i = 1; } else if ($i == 2) { $i = 0; } if ($i == 0) { // comments are allowed $i = 1; } if ($i == 0) {// comments are allowed $i = 1; } if ($i == 0) { /* comments are allowed*/ $i = 1; } if ($i == 0) { // this is ok $i = 1; } if ($i == 0) { /* this is ok */ } try { $code = 'this'; } catch (Exception $e) { // Caught! } try { $code = 'this'; } catch (Exception $e) { // Caught! } do { echo $i; } while ($i > 0); if ($i === 0) { $i = 1 } if ($a) { } elseif ($b) { } foreach ($items as $item) { echo $item; } foreach ($items as $item) { echo $item; } if ($a && $b) { // && $c) } if ($a == 5) : echo "a equals 5"; echo "..."; elseif ($a == 6) : echo "a equals 6"; echo "!!!"; else : echo "a is neither 5 nor 6"; endif; try { // try body } catch (FirstExceptionType $e) { // catch body } catch (OtherExceptionType $e) { // catch body } switch ($foo) { case 'bar': break; } if ($foo) : endif; ?> getRow()) : ?>

    hello hello ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ControlSignatureUnitTest.jsPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ControlSignatureUnitTest.j0000644000076700000240000000253612647543456033561 0ustar gsherwoodstaff i = 0; do { i = 0; } while (i > 0); do { i = 0; } while (i > 0); do { i = 0; } while (i > 0); do { i = 0; } while (i > 0); do{ i = 0; }while(i > 0); while (i < 1) { i = 0; } while(i < 1){ i = 0; } while (i < 1) { i = 0; } for (i = 1; i < 1; i++) { i = 0; } for(i = 1; i < 1; i++){ i = 0; } for (i = 1; i < 1; i++) { i = 0; } if (i == 0) { i = 1; } if(i == 0){ i = 1; } if (i == 0) { i = 1; } if (i == 0) { i = 1; } else { i = 0; } if (i == 0) { i = 1; }else{ i = 0; } if (i == 0) { i = 1; } else { i = 0; } if (i == 0) { i = 1; } else if (i == 2) { i = 0; } if (i == 0) { i = 1; }else if(i == 2){ i = 0; } if (i == 0) { i = 1; } else if (i == 2) { i = 0; } if (i == 0) { // comments are allowed i = 1; } if (i == 0) {// comments are allowed i = 1; } if (i == 0) { /* comments are allowed*/ i = 1; } if (i == 0) { // this is ok i = 1; } if (i == 0) /* this is ok */ { } try { code = 'this'; } catch (e) { // Caught! } try { code = 'this'; } catch (e) { // Caught! } do { i = 0; } while (i > 0); if (i === 0) { i = 1 } if (window.jQuery)(function($) { $.fn.reset = function() { return this.each(function() { try { this.reset(); } catch (e) { } }); }; })(jQuery); ././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ControlSignatureUnitTest.js.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ControlSignatureUnitTest.j0000644000076700000240000000255412647543456033561 0ustar gsherwoodstaff i = 0; do { i = 0; } while (i > 0); do { i = 0; } while (i > 0); do { i = 0; } while (i > 0); do { i = 0; } while (i > 0); do { i = 0; } while (i > 0); while (i < 1) { i = 0; } while (i < 1) { i = 0; } while (i < 1) { i = 0; } for (i = 1; i < 1; i++) { i = 0; } for (i = 1; i < 1; i++) { i = 0; } for (i = 1; i < 1; i++) { i = 0; } if (i == 0) { i = 1; } if (i == 0) { i = 1; } if (i == 0) { i = 1; } if (i == 0) { i = 1; } else { i = 0; } if (i == 0) { i = 1; } else { i = 0; } if (i == 0) { i = 1; } else { i = 0; } if (i == 0) { i = 1; } else if (i == 2) { i = 0; } if (i == 0) { i = 1; } else if (i == 2) { i = 0; } if (i == 0) { i = 1; } else if (i == 2) { i = 0; } if (i == 0) { // comments are allowed i = 1; } if (i == 0) {// comments are allowed i = 1; } if (i == 0) { /* comments are allowed*/ i = 1; } if (i == 0) { // this is ok i = 1; } if (i == 0) { /* this is ok */ } try { code = 'this'; } catch (e) { // Caught! } try { code = 'this'; } catch (e) { // Caught! } do { i = 0; } while (i > 0); if (i === 0) { i = 1 } if (window.jQuery)(function($) { $.fn.reset = function() { return this.each(function() { try { this.reset(); } catch (e) { } }); }; })(jQuery); ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ControlSignatureUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ControlSignatureUnitTest.p0000644000076700000240000000572512647543456033572 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ControlSignature sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_ControlStructures_ControlSignatureUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='ControlSignatureUnitTest.inc') { $errors = array( 7 => 1, 12 => 1, 15 => 1, 18 => 1, 20 => 1, 22 => 2, 28 => 2, 32 => 1, 38 => 2, 42 => 1, 48 => 2, 52 => 1, 62 => 2, 66 => 2, 76 => 4, 80 => 2, 94 => 1, 99 => 1, 108 => 1, 112 => 1, ); if ($testFile === 'ControlSignatureUnitTest.inc') { $errors[122] = 1; $errors[130] = 2; $errors[134] = 1; $errors[150] = 1; $errors[153] = 1; $errors[158] = 1; $errors[165] = 1; $errors[170] = 2; $errors[186] = 2; $errors[187] = 2; $errors[191] = 1; } return $errors; }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ElseIfDeclarationUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ElseIfDeclarationUnitTest.0000644000076700000240000000026412647543456033416 0ustar gsherwoodstaff././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ElseIfDeclarationUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ElseIfDeclarationUnitTest.0000644000076700000240000000365112647543456033421 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ElseIfDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_ControlStructures_ElseIfDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 8 => 1, 13 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 154 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ForEachLoopDeclarationUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ForEachLoopDeclarationUnit0000644000076700000240000000174112647543456033473 0ustar gsherwoodstaff $that) { } // Invalid. foreach ( $something as $blah => $that ) { } foreach ($something as $blah => $that) { } foreach ($something as $blah => $that) { } foreach (${something}AS$blah=>$that) { } // The works. foreach ( $something aS $blah => $that ) { } // @codingStandardsChangeSetting Squiz.ControlStructures.ForEachLoopDeclaration requiredSpacesAfterOpen 1 // @codingStandardsChangeSetting Squiz.ControlStructures.ForEachLoopDeclaration requiredSpacesBeforeClose 1 foreach ($something as $blah => $that) {} foreach ( $something as $blah => $that ) {} foreach ( $something as $blah => $that ) {} // @codingStandardsChangeSetting Squiz.ControlStructures.ForEachLoopDeclaration requiredSpacesAfterOpen 0 // @codingStandardsChangeSetting Squiz.ControlStructures.ForEachLoopDeclaration requiredSpacesBeforeClose 0 foreach ([ 'foo' => 'bar', 'foobaz' => 'bazzy', ] as $key => $value) { }././@LongLink000 162 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ForEachLoopDeclarationUnitTest.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ForEachLoopDeclarationUnit0000644000076700000240000000171612647543456033475 0ustar gsherwoodstaff $that) { } // Invalid. foreach ($something as $blah => $that) { } foreach ($something as $blah => $that) { } foreach ($something as $blah => $that) { } foreach (${something} as $blah => $that) { } // The works. foreach ($something as $blah => $that) { } // @codingStandardsChangeSetting Squiz.ControlStructures.ForEachLoopDeclaration requiredSpacesAfterOpen 1 // @codingStandardsChangeSetting Squiz.ControlStructures.ForEachLoopDeclaration requiredSpacesBeforeClose 1 foreach ( $something as $blah => $that ) {} foreach ( $something as $blah => $that ) {} foreach ( $something as $blah => $that ) {} // @codingStandardsChangeSetting Squiz.ControlStructures.ForEachLoopDeclaration requiredSpacesAfterOpen 0 // @codingStandardsChangeSetting Squiz.ControlStructures.ForEachLoopDeclaration requiredSpacesBeforeClose 0 foreach ([ 'foo' => 'bar', 'foobaz' => 'bazzy', ] as $key => $value) { }././@LongLink000 154 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ForEachLoopDeclarationUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ForEachLoopDeclarationUnit0000644000076700000240000000406512647543456033475 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ForEachLoopDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_ControlStructures_ForEachLoopDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 8 => 2, 11 => 2, 14 => 2, 17 => 5, 21 => 7, 26 => 2, 28 => 2, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ForLoopDeclarationUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/ForLoopDeclarationUnitTest0000644000076700000240000000154512647543456033554 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ForEachLoopDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_ControlStructures_ForLoopDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='ForLoopDeclarationUnitTest.inc') { switch ($testFile) { case 'ForLoopDeclarationUnitTest.inc': return array( 8 => 2, 11 => 2, 14 => 2, 17 => 2, 21 => 6, 27 => 1, 30 => 1, 37 => 2, 39 => 2, ); break; case 'ForLoopDeclarationUnitTest.js': return array( 6 => 2, 9 => 2, 12 => 2, 15 => 2, 19 => 6, 33 => 1, 36 => 1, 43 => 2, 45 => 2, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 151 0003733 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/InlineIfDeclarationUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/InlineIfDeclarationUnitTes0000644000076700000240000000242112647543456033477 0ustar gsherwoodstaffid.'"', '"'.$this->stepInfo['title'].'"', '"'.((isset($this->stepInfo['description']) === TRUE) ? $this->stepInfo['description'] : '').'"', '"'.(isset($this->stepInfo['description']) === TRUE ? $this->stepInfo['description'] : '').'"', '"'.$this->stepInfo['title'].'"', ); echo (TRUE)?'Hello':'Bye'; $array = array( 'one' => ($test == 1) ? true : false, 'two' => (($test == 1) ? true : false), 'three' => (($test == 1) ? true : false) ); $var = ($test == 1) ? true : false; $var = (myFunc(1,2,3) == 1) ? true : false; set('config', function() { $foo = ($bar === "on") ? "1" : "2"; }); $config = function() { $foo = ($bar === "on") ? "1" : "2"; }; ././@LongLink000 151 0003733 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/InlineIfDeclarationUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/InlineIfDeclarationUnitTes0000644000076700000240000000416712647543456033510 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the InlineIfDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_ControlStructures_InlineIfDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 4 => 1, 5 => 1, 6 => 1, 7 => 1, 8 => 1, 9 => 1, 10 => 1, 13 => 1, 20 => 1, 24 => 4, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/LowercaseDeclarationUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/LowercaseDeclarationUnitTe0000644000076700000240000000037712647543456033553 0ustar gsherwoodstaff././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/LowercaseDeclarationUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/LowercaseDeclarationUnitTe0000644000076700000240000000422312647543456033545 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the LowercaseDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_ControlStructures_LowercaseDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 5 => 1, 7 => 1, 9 => 1, 10 => 1, 12 => 1, 14 => 1, 15 => 1, 16 => 1, 20 => 1, 21 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/SwitchDeclarationUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/ControlStructures/SwitchDeclarationUnitTest.0000644000076700000240000000774212647543456033520 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the SwitchDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_ControlStructures_SwitchDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='SwitchDeclarationUnitTest.inc') { return array( 27 => 1, 29 => 1, 34 => 1, 36 => 1, 44 => 1, 48 => 1, 52 => 1, 54 => 1, 55 => 1, 56 => 1, 58 => 1, 59 => 1, 61 => 1, 62 => 1, 79 => 1, 85 => 2, 88 => 2, 89 => 2, 92 => 1, 95 => 3, 99 => 1, 116 => 1, 122 => 1, 127 => 2, 134 => 2, 135 => 1, 138 => 1, 143 => 1, 144 => 1, 147 => 1, 165 => 1, 172 => 1, 176 => 2, 180 => 1, 192 => 2, 196 => 1, 223 => 1, 266 => 1, 282 => 1, 284 => 2, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getWarningList($testFile='SwitchDeclarationUnitTest.inc') { if ($testFile === 'SwitchDeclarationUnitTest.js') { return array(273 => 1); } return array(); }//end getWarningList() }//end class ?> ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ClassDefinitionClosingBraceSpaceUnitTest.cssPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ClassDefinitionClosingBraceSpaceUnitTest0000644000076700000240000000102512647543456033231 0ustar gsherwoodstaff.my-style { } .my-style { } /* Comment */ .my-style { } /* Comment */ .my-style { float: left; } .AssetLineageWidgetType-item { color: #CCC; } /*.AssetLineageWidgetType-item2 .selected, .AssetLineageWidgetType-item .selected { }*/ .AssetLineageWidgetType-item.selected { } @media screen and (max-device-width: 769px) { header #logo img { max-width: 100%; } } @media screen and (max-device-width: 769px) { header #logo img { max-width: 100%; } } .GUITextBox.container:after {} ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ClassDefinitionClosingBraceSpaceUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ClassDefinitionClosingBraceSpaceUnitTest0000644000076700000240000000362612647543456033242 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ClassDefinitionClosingBraceSpace sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_ClassDefinitionClosingBraceSpaceUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 11 => 1, 44 => 1, 47 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ClassDefinitionNameSpacingUnitTest.css0000644000076700000240000000257412647543456032710 0ustar gsherwoodstaff.AssetListingEditWidgetType-BottomPanel select, #EditEditingModeWidgetType-assetEditor-filters-assetTypes-addNew { float: left; } .AssetListingEditWidgetType-BottomPanel select, #EditEditingModeWidgetType-assetEditor-filters-assetTypes-addNew { float: left; } .AssetListingEditWidgetType-BottomPanel select, /*.AssetListingEditWidgetType-BottomPanel ul,*/ #EditEditingModeWidgetType-assetEditor-filters-assetTypes-addNew { float: left; } .AssetListingEditWidgetType-BottomPanel select, .AssetListingEditWidgetType-BottomPanel ul, #EditEditingModeWidgetType-assetEditor-filters-assetTypes-addNew { float: left; } #SuperUsersSystemConfigScreen-table { display: block; left: 50%; margin-left: -500px; margin-top: 180px; position: relative; width: 1000px; } /** * More styles below here. */ td.TableWidgetType-header.TableWidgetType-header-lastLogin, td.TableWidgetType-header.TableWidgetType-header-remove, td.TableWidgetType-header.TableWidgetType-header-email, td.TableWidgetType-header.TableWidgetType-header-userName { background: url(images/ScreenImages/table_header_bg.png) repeat-x; border-top: 1px solid #D4D4D4; color: #787878; height: 33px; padding-left: 12px; width: 150px; } @media screen and (max-device-width: 769px) { header #logo img { max-width: 100%; padding: 20px; margin: 40px; } } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ClassDefinitionNameSpacingUnitTest.php0000644000076700000240000000352212647543456032701 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ClassDefinitionNameSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_ClassDefinitionNameSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 7 => 1, 19 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ClassDefinitionOpeningBraceSpaceUnitTest.cssPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ClassDefinitionOpeningBraceSpaceUnitTest0000644000076700000240000000114112647543456033231 0ustar gsherwoodstaff.HelpWidgetType-new-bug-title { float: left; } .HelpWidgetType-new-bug-title { float: left; } .HelpWidgetType-new-bug-title { float: left; } .HelpWidgetType-new-bug-title{ float: left; } .HelpWidgetType-new-bug-title { float: left; } @media screen and (max-device-width: 769px) { header #logo img { max-width: 100%; } } @media screen and (max-device-width: 769px) { header #logo img { max-width: 100%; } } @media screen and (max-device-width: 769px) { header #logo img { max-width: 100%; } } .GUITextBox.container:after {} ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ClassDefinitionOpeningBraceSpaceUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ClassDefinitionOpeningBraceSpaceUnitTest0000644000076700000240000000371012647543456033235 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ClassDefinitionOpeningBraceSpace sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_ClassDefinitionOpeningBraceSpaceUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 4 => 1, 7 => 1, 10 => 1, 26 => 1, 33 => 1, 43 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ColonSpacingUnitTest.css0000644000076700000240000000164012647543456030074 0ustar gsherwoodstaffbody { font-family: Arial, Helvetica, sans-serif; margin : 40px 0 0 0; padding : 0; background: #8FB7DB url(diag_lines_bg.gif) top left; margin-top: 10px; margin-bottom: 0px; } .TableWidgetType .recover:hover { background-color: #FFF; } #clearCache-settings:rootNodes-list_0 { border-top: none; } .LookupEditScreenWidgetType-urls a, .LookupEditScreenWidgetType-urls a:visited { text-decoration: none; color: #444; } /* checking embedded PHP */ li { background:url(/images//bullet.gif) left px no-repeat; margin:0px; padding-left:10px; margin-bottom:px; margin-top: px; line-height:13px; filter: progid:DXImageTransform.Microsoft.gradient(GradientType=0, startColorstr=#2e62a8, endColorstr=#123363); } /* empty style def */ .p { margin:; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ColonSpacingUnitTest.php0000644000076700000240000000375712647543456030106 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ColonSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_ColonSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 4 => 2, 5 => 1, 6 => 1, 8 => 1, 27 => 1, 28 => 1, 29 => 1, 30 => 1, 32 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ColourDefinitionUnitTest.css0000644000076700000240000000035012647543456030766 0ustar gsherwoodstaff#title-bar-bottom-right { background-color: #333333; padding: 10px; border-bottom: 1px dotted #F0F0F0; border-top: 1px dotted #FF00FF; background: #08f7db url(diag_lines_bg.gif) top left; } #add-new-comment { } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ColourDefinitionUnitTest.php0000644000076700000240000000351112647543456030767 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ColourDefinition sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_ColourDefinitionUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 5 => 1, 6 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/DisallowMultipleStyleDefinitionsUnitTest.cssPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/DisallowMultipleStyleDefinitionsUnitTest0000644000076700000240000000110412647543456033430 0ustar gsherwoodstaff.SettingsTabPaneWidgetType-tab-mid { background: transparent url(tab_inact_mid.png) repeat-x; height: 100%;float: left; line-height: -25px; cursor: pointer; margin: 10px; float: right; } /* testing embedded PHP */ li { background:url(/images//bullet.gif) left px no-repeat; margin:0px; padding-left:10px; margin-bottom:px; line-height:13px; filter: progid:DXImageTransform.Microsoft.gradient(GradientType=0, startColorstr=#2e62a8, endColorstr=#123363); } ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/DisallowMultipleStyleDefinitionsUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/DisallowMultipleStyleDefinitionsUnitTest0000644000076700000240000000357412647543456033445 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowMultipleStyleDefinitions sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_DisallowMultipleStyleDefinitionsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 5 => 2, 10 => 4, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/DuplicateClassDefinitionUnitTest.css0000644000076700000240000000064012647543456032425 0ustar gsherwoodstaff.AssetLineageWidgetType-item { color: #FFF; } .AssetLineageWidgetType-title { color: #CCC; } .AssetLineageWidgetType-item { color: #CCC; } .AssetLineageWidgetType-item .selected { } .AssetLineageWidgetType-item.selected { } #Blah .AssetLineageWidgetType-item { } #X.selected, .AssetLineageWidgetType-item { } .MyClass, .YourClass { } .YourClass, .MyClass { } .YourClass, .MyClass, .OurClass { } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/DuplicateClassDefinitionUnitTest.php0000644000076700000240000000351412647543456032427 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DuplicateClassDefinition sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_DuplicateClassDefinitionUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 9 => 1, 29 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/DuplicateStyleDefinitionUnitTest.css0000644000076700000240000000110412647543456032454 0ustar gsherwoodstaff.ViperSubToolbar-wrapper { height: 34px; left: 0; position: fixed; top: 60px; z-index: 997; left: 50%; } .expandable { -moz-transition-property: margin-left, margin-right; -moz-transition-duration: 0.2s; -moz-transition-timing-function: ease; -webkit-transition-property: margin-left, margin-right; -webkit-transition-duration: 0.2s; -webkit-transition-timing-function: ease; z-index: 2; } @media only screen and (max-width: 480px) { header nav.meta a { display: none; } header nav.meta a.search { display: block; } } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/DuplicateStyleDefinitionUnitTest.php0000644000076700000240000000346212647543456032464 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DuplicateStyleDefinition sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_DuplicateStyleDefinitionUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 7 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/EmptyClassDefinitionUnitTest.css0000644000076700000240000000040012647543456031603 0ustar gsherwoodstaff.HelpWidgetType-new-bug-title {} .HelpWidgetType-new-bug-title { } .HelpWidgetType-new-bug-title { } .HelpWidgetType-new-bug-title { } .HelpWidgetType-new-bug-title { /* Nothing to see here */ } .HelpWidgetType-new-bug-title { float: left; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/EmptyClassDefinitionUnitTest.php0000644000076700000240000000361212647543456031612 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the EmptyClassDefinition sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_EmptyClassDefinitionUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 1 => 1, 2 => 1, 4 => 1, 7 => 1, 10 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/EmptyStyleDefinitionUnitTest.css0000644000076700000240000000014212647543456031641 0ustar gsherwoodstaff#MetadataAdminScreen-addField-fieldType { margin-left: 10px; margin-right: float: ; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/EmptyStyleDefinitionUnitTest.php0000644000076700000240000000347512647543456031654 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the EmptyStyleDefinition sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_EmptyStyleDefinitionUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 4 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ForbiddenStylesUnitTest.css0000644000076700000240000000074012647543456030615 0ustar gsherwoodstaff#add-new-comment { -moz-border-radius: 1px; -webkit-border-radius: 1px; border-radius: 1px; -moz-border-radius-topleft: 1px; -moz-border-radius-topright: 1px; -moz-border-radius-bottomright: 1px; -moz-border-radius-bottomleft: 1px; border-top-left-radius: 1px; border-top-right-radius: 1px; border-bottom-right-radius: 1px; border-bottom-left-radius: 1px; -moz-box-shadow: 1px; -webkit-box-shadow: 1px; box-shadow: 1px; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ForbiddenStylesUnitTest.php0000644000076700000240000000370612647543456030621 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ForbiddenStyles sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_ForbiddenStylesUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 3 => 1, 6 => 1, 7 => 1, 8 => 1, 9 => 1, 15 => 1, 16 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/IndentationUnitTest.css0000644000076700000240000000222112647543456027765 0ustar gsherwoodstaffbody { font-family: Arial, Helvetica, sans-serif; margin: 40px 0 0 0; padding: 0; background: #8FB7DB url(diag_lines_bg.gif) top left; } td { margin: 40px; padding: 20px; } /* #AdminScreenModeWidgetType-tab_pane-containers .TabPaneWidgetType-tab-selected-left { background: transparent url(images/ScreenImages/tab_on_left.png) no-repeat; } #AdminScreenModeWidgetType-tab_pane-containers .TabPaneWidgetType-tab-selected-right { background: transparent url(images/ScreenImages/tab_on_right.png) no-repeat; } */ .GUITextBox.container:after {} @media screen and (max-device-width: 769px) { header #logo img { max-width: 100%; padding: 20px; margin: 40px; } } @media screen and (max-device-width: 769px) { header #logo img { max-width: 100%; } header #logo img { min-width: 100%; } } td { margin: 40px; padding: 20px; } .GUIFileUpload { /* opacity: 0.25; */ } .mortgage-calculator h2 { background: #072237; color: #fff; font-weight: normal; height: 50px; line-height: 50px; padding: 0 0 0 30px; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/IndentationUnitTest.css.fixed0000644000076700000240000000216012647543456031065 0ustar gsherwoodstaffbody { font-family: Arial, Helvetica, sans-serif; margin: 40px 0 0 0; padding: 0; background: #8FB7DB url(diag_lines_bg.gif) top left; } td { margin: 40px; padding: 20px; } /* #AdminScreenModeWidgetType-tab_pane-containers .TabPaneWidgetType-tab-selected-left { background: transparent url(images/ScreenImages/tab_on_left.png) no-repeat; } #AdminScreenModeWidgetType-tab_pane-containers .TabPaneWidgetType-tab-selected-right { background: transparent url(images/ScreenImages/tab_on_right.png) no-repeat; } */ .GUITextBox.container:after {} @media screen and (max-device-width: 769px) { header #logo img { max-width: 100%; padding: 20px; margin: 40px; } } @media screen and (max-device-width: 769px) { header #logo img { max-width: 100%; } header #logo img { min-width: 100%; } } td { margin: 40px; padding: 20px; } .GUIFileUpload { /* opacity: 0.25; */ } .mortgage-calculator h2 { background: #072237; color: #fff; font-weight: normal; height: 50px; line-height: 50px; padding: 0 0 0 30px; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/IndentationUnitTest.php0000644000076700000240000000426412647543456027775 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the Indentation sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_IndentationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 3 => 1, 5 => 1, 6 => 1, 7 => 1, 12 => 1, 30 => 1, 32 => 1, 50 => 1, 52 => 1, 53 => 1, 61 => 1, 62 => 1, 63 => 1, 64 => 1, 65 => 1, 66 => 1, 67 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/LowercaseStyleDefinitionUnitTest.css0000644000076700000240000000063112647543456032472 0ustar gsherwoodstaff.SettingsTabPaneWidgetType-tab-mid { font-family: Arial; Font-Family: arial; background-color: #DA9393; BACKGROUND-IMAGE: URL(Warning_Close.png); } @media screen and (max-device-width: 769px) { .SettingsTabPaneWidgetType-tab-mid { Font-Family: arial; filter: progid:DXImageTransform.Microsoft.gradient(GradientType=0, startColorstr=#2e62a8, endColorstr=#123363); } } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/LowercaseStyleDefinitionUnitTest.php0000644000076700000240000000357512647543456032503 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the LowercaseStyleDefinition sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_LowercaseStyleDefinitionUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 3 => 1, 5 => 2, 11 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/MissingColonUnitTest.css0000644000076700000240000000044212647543456030120 0ustar gsherwoodstaff.my-style { margin-right 15px; float: left; margin-left 15px; margin-top: 15px; margin-bottom 15px; } @media screen and (max-device-width: 769px) { header #logo img { max-width: 100%; margin-bottom 15px; } } #foo { background-color: #FF0000; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/MissingColonUnitTest.php0000644000076700000240000000353112647543456030121 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the MissingColon sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_MissingColonUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 4 => 1, 6 => 1, 12 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/NamedColoursUnitTest.css0000644000076700000240000000033512647543456030110 0ustar gsherwoodstaff#red { background-color: red; } .red { border-bottom: 1px dotted black; border-top: 1px dotted gray; } #red.yellow { background: yellow url(diag_lines_bg.gif) top left; text-shadow: 0 1px 0 white; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/NamedColoursUnitTest.php0000644000076700000240000000356212647543456030114 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the NamedColours sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_NamedColoursUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 6 => 1, 7 => 1, 11 => 1, 12 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/OpacityUnitTest.css0000644000076700000240000000117012647543456027123 0ustar gsherwoodstaff.my-style { opacity: 0; opacity: 0.0; opacity: 1; opacity: 1.0; opacity: 1.5; opacity: .5; opacity: 0.5; opacity: 2; opacity: -1; opacity: 0.55; } div { font-size: 1.2em; background: linear-gradient(to bottom, #00F, #0F0) repeat scroll 50% 50% #EEE; min-width: 250px; max-width: 100%; padding-bottom: 50px; box-shadow: 2px -3px 3px rgba(100, 100, 100, 0.33); border-left: 1px solid #000; border-right: 1px solid #000; border-top: 1px solid #000; border-bottom: 1px dotted #000; background: url(../1/2/3/4-5-6_7_100x100.png) repeat scroll 50% 50% #EEE; opacity: -1; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/OpacityUnitTest.php0000644000076700000240000000365612647543456027135 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the Opacity sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_OpacityUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 5 => 1, 6 => 1, 7 => 1, 9 => 1, 10 => 1, 11 => 1, 26 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/SemicolonSpacingUnitTest.css0000644000076700000240000000072112647543456030751 0ustar gsherwoodstaff.HelpWidgetType-new-bug-title { width: 308px float: left; } #MetadataAdminScreen-addField-add { float: left ; } .TableWidgetType .recover:hover { background-color: #FFF; } #clearCache-settings:rootNodes-list_0 { border-top: none; } .HelpWidgetType-list { list-style-image: url(); } @media (min-width: 320px) and (max-width: 961px) { .tooltipsrt:hover span.tltp, .tooltipstp:hover span.tltp { visibility: hidden; } } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/SemicolonSpacingUnitTest.php0000644000076700000240000000346112647543456030754 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the SemicolonSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_SemicolonSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 7 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ShorthandSizeUnitTest.css0000644000076700000240000000141112647543456030276 0ustar gsherwoodstaff#add-new-comment { background-color: #333333; padding: 10px; border-bottom: 1px dotted #F0F0F0; border-top: 1px dotted #FF00FF; background: #8fb7db url(diag_lines_bg.gif) top left; page-break-inside: 1; margin: 8px 8px 8px 8px; margin: 8px 8px; margin: 0 0 0 0; margin: 0 8px 0 8px; margin: 8px 4px 8px 4px; margin: 8px 4% 8px 4%; margin: 6px 2px 9px 2px; margin: 6px 2px 9px; border-radius: 2px 2px 2px 2px !important; border-width: 2px 2px 2px 2px; border-width: 1px 2px 2px 4px; margin: 97px auto 0 auto; text-shadow: 0 1px 0 #fff; /* These are black-listed style names. */ background-position: 0 0; box-shadow: 2px 2px 2px 2px; transform-origin: 0 110% 0; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/CSS/ShorthandSizeUnitTest.php0000644000076700000240000000373112647543456030304 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ShorthandSize sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_CSS_ShorthandSizeUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 8 => 1, 9 => 1, 10 => 1, 11 => 1, 12 => 1, 13 => 1, 15 => 1, 16 => 1, 17 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Debug/JavaScriptLintUnitTest.js0000644000076700000240000000003112647543456030625 0ustar gsherwoodstaffalert('hi') alert('hi'); PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Debug/JavaScriptLintUnitTest.php0000644000076700000240000000404512647543456031011 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the JavaScriptLint sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Debug_JavaScriptLintUnitTest extends AbstractSniffUnitTest { /** * Should this test be skipped for some reason. * * @return void */ protected function shouldSkipTest() { $jslPath = PHP_CodeSniffer::getConfigData('jsl_path'); return (is_null($jslPath)); }//end shouldSkipTest() /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 2 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Debug/JSLintUnitTest.js0000644000076700000240000000003112647543456027073 0ustar gsherwoodstaffalert('hi') alert('hi'); PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Debug/JSLintUnitTest.php0000644000076700000240000000405012647543456027253 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the JSLint sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Debug_JSLintUnitTest extends AbstractSniffUnitTest { /** * Should this test be skipped for some reason. * * @return void */ protected function shouldSkipTest() { $jslPath = PHP_CodeSniffer::getConfigData('jslint_path'); return (is_null($jslPath)); }//end shouldSkipTest() /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 1 => 2, 2 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Files/FileExtensionUnitTest.1.inc0000644000076700000240000000004212647543456031016 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Files/FileExtensionUnitTest.2.inc0000644000076700000240000000003212647543456031016 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Files/FileExtensionUnitTest.3.inc0000644000076700000240000000004212647543456031020 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Files/FileExtensionUnitTest.4.inc0000644000076700000240000000003212647543456031020 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Files/FileExtensionUnitTest.php0000644000076700000240000000413012647543456030677 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the FileExtension sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Files_FileExtensionUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='') { switch ($testFile) { case 'FileExtensionUnitTest.1.inc': return array( 1 => 1, ); default: return array(); } }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Formatting/OperatorBracketUnitTest.inc0000644000076700000240000000632212647543456032251 0ustar gsherwoodstaffwords[$wordPos-1]) || $this->words[$wordPos-1] !== ' ') { } else if ($this->tokens[$pos + 1] === "\n") { } if ($pos === count($this->tokens) - 1) { $file = '...'.substr($file, (($padding * -1) + 3)); } if (substr($basename, -5) !== 'Sniff') { $i = ($this->_tokens[$i]['parenthesis_closer'] + 1); } $pos = $this->_getShortCommentEndPos(); if ($pos === -1) { $stackPtr = ($tokens[$next][$to] - 1); $stackPtr = ($tokens[$next][$pattern[$i]['to']] + 1); $var = (($var1 + $var2) + $var3 + $var4) } $commentStart = ($phpcsFile->findPrevious(T_DOC_COMMENT, ($commentEnd - 1), null, true) + 1); $commentEnd = ($this->_phpcsFile->findNext(T_DOC_COMMENT, ($commentStart + 1), null, true) - 1); $expected .= '...'.substr($tokens[($stackPtr - 2)]['content'], -5).$tokens[$stackPtr]['content']; if (($tokens[$nextToken - 1]['code']) !== T_WHITESPACE) { $errorPos = ($params[(count($params) - 1)]->getLine() + $commentStart); } while (($nextSpace = $phpcsFile->findNext(T_WHITESPACE, $nextSpace + 1, $nextBreak)) !== false) { } foreach ($attributes as $id => &$attribute) { } class MyClass { public function &myFunction(array &$one, array &$two) { }//end myFunction() }//end class if ($index < -1) $index = 0; if ($index < - 1) $index = 0; $three = ceil($one / $two); $three = ceil(($one / $two) / $four); $three = ceil($one / ($two / $four)); $four = -0.25; $three = ceil($one[1] / $two); switch ($number % 10) { case -1: $suffix = 'st'; break; } $expectedPermission = array( 'granted' => 4, 'denied' => 1, 'cascade' => TRUE, 'blockergranted' => 2, 'blockerdenied' => - 3, 'effective' => TRUE, ); $value = (int) isset($blah) + 2; $value = (int) isset($blah) + (int) isset($foo) + (int) isset($bar); doSomething(getValue($var, 2)) - $y; $codeFiles = array($global => $codeFiles[$global]) + $codeFiles; $var = array(-1); $var = [-1]; $var = [0, -1, -2]; $cntPages = ceil(count($items) / self::ON_PAGE); PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Formatting/OperatorBracketUnitTest.js0000644000076700000240000000365312647543456032120 0ustar gsherwoodstaffvalue = (one + two); value = one + two; value = (one - two); value = one - two; value = (one * two); value = one * two; value = (one / two); value = one / two; value = (one % two); value = one % two; value = (one + two + three); value = one + two + three; value = (one + (two + three)); value = one + (two + three); value++; value--; value = -1; value = - 1; value = (1 + 2); value = 1 + 2; value = (1 - 2); value = 1 - 2; value = (1 * 2); value = 1 * 2; value = (1 / 2); value = 1 / 2; value = (1 % 2); value = 1 % 2; value = (1 + 2 + 3); value = 1 + 2 + 3; value = (1 + (2 + 3)); value = 1 + (2 + 3); value = one + 2 + 3 - (four * five * (6 + 7)) + nine + 2; value = myFunction(tokens[stackPtr - 1]); for (i = 1 + 2; i < 4 + 5; i++) { } function myFunction() { value = (one + 1) + (two + 2) + (myFunction() + 2); value = myFunction() + 2; value = (myFunction(mvar) + myFunction2(mvar)); return -1; } params['mode'] = id.replace(/WidgetType/, ''); if (index < -1) index = 0; if (index < - 1) index = 0; var classN = prvId.replace(/\./g, '-'); three = myFunction(one / two); three = myFunction((one / two) / four); three = myFunction(one / (two / four)); four = -0.25; id = id.replace(/row\/:/gi, ''); return /MSIE/.test(navigator.userAgent); var re = new RegExp(/<\/?(\w+)((\s+\w+(\s*=\s*(?:".*?"|'.*?'|[^'">\s]+))?)+\s*|\s*)\/?>/gim); var options = { minVal: -1, maxVal: -1 }; stepWidth = Math.round(this.width / 5); date.setMonth(d[2] - 1); switch (number % 10) { case -1: suffix = 'st'; break; } var pathSplit = ipt.value.split(/\/|\\/); if (pairs[i].search(/=/) !== -1) { } if (urlValue.search(/[a-zA-z]+:\/\//) !== 0) { } if (urlValue.search(/[a-zA-z]+:\/\/*/) !== 0) { } if (!value || /^\s*$/.test(value)) { return true; } parseInt(dfx.attr(selectors[idx], 'elemOffsetTop'), 10) - scrollCoords.y + 'px' if (something === true ^ somethingElse === true ) { return false; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Formatting/OperatorBracketUnitTest.php0000644000076700000240000000705312647543456032271 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the OperatorBracket sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Formatting_OperatorBracketUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='OperatorBracketUnitTest.inc') { switch ($testFile) { case 'OperatorBracketUnitTest.inc': return array( 3 => 1, 6 => 1, 9 => 1, 12 => 1, 15 => 1, 18 => 2, 20 => 1, 25 => 1, 28 => 1, 31 => 1, 34 => 1, 37 => 1, 40 => 1, 43 => 2, 45 => 1, 47 => 5, 48 => 1, 50 => 2, 55 => 2, 56 => 1, 63 => 2, 64 => 1, 67 => 1, 86 => 1, 90 => 1, 109 => 1, 130 => 1, 134 => 1, 135 => 2, 137 => 1, 139 => 1, ); break; case 'OperatorBracketUnitTest.js': return array( 5 => 1, 8 => 1, 11 => 1, 14 => 1, 24 => 1, 30 => 1, 33 => 1, 36 => 1, 39 => 1, 46 => 1, 47 => 1, 63 => 1, 108 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 160 0003733 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Functions/FunctionDeclarationArgumentSpacingUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Functions/FunctionDeclarationArgumentSpacing0000644000076700000240000000442012647543456033510 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the FunctionDeclarationArgumentSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Functions_FunctionDeclarationArgumentSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 5 => 2, 7 => 2, 8 => 2, 9 => 2, 11 => 2, 13 => 7, 14 => 2, 15 => 2, 16 => 4, 18 => 2, 35 => 2, 36 => 3, 44 => 2, 45 => 1, 46 => 1, 51 => 2, 53 => 2, 55 => 1, 56 => 1, 58 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Functions/FunctionDeclarationUnitTest.inc0000644000076700000240000000121312647543456032745 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the FunctionDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Functions_FunctionDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 55 => 1, 68 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Functions/FunctionDuplicateArgumentUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Functions/FunctionDuplicateArgumentUnitTest.0000644000076700000240000000022712647543456033447 0ustar gsherwoodstaff ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Functions/FunctionDuplicateArgumentUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Functions/FunctionDuplicateArgumentUnitTest.0000644000076700000240000000371712647543456033456 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the FunctionDuplicateArgument sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Functions_FunctionDuplicateArgumentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 4 => 2, 5 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Functions/GlobalFunctionUnitTest.inc0000644000076700000240000000041212647543456031720 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Functions/GlobalFunctionUnitTest.php0000644000076700000240000000357612647543456031754 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the GlobalFunction sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Functions_GlobalFunctionUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 2 => 1, ); }//end getWarningList() }//end class ?> ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Functions/LowercaseFunctionKeywordsUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Functions/LowercaseFunctionKeywordsUnitTest.0000644000076700000240000000024612647543456033507 0ustar gsherwoodstaff ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Functions/LowercaseFunctionKeywordsUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Functions/LowercaseFunctionKeywordsUnitTest.0000644000076700000240000000377712647543456033523 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the LowercaseFunctionKeywords sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Functions_LowercaseFunctionKeywordsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 3 => 1, 4 => 1, 5 => 1, 6 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Functions/MultiLineFunctionDeclarationUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Functions/MultiLineFunctionDeclarationUnitTe0000644000076700000240000000401712647543456033456 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the MultiLineFunctionDeclaration sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Functions_MultiLineFunctionDeclarationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='MultiLineFunctionDeclarationUnitTest.inc') { if ($testFile === 'MultiLineFunctionDeclarationUnitTest.inc') { $errors = array( 2 => 1, 3 => 1, 4 => 2, 5 => 1, 7 => 1, 11 => 1, 12 => 1, 13 => 1, 16 => 1, 36 => 1, 43 => 2, 48 => 1, 81 => 1, 82 => 2, 88 => 1, 102 => 2, ); } else { $errors = array( 2 => 1, 3 => 1, 4 => 2, 5 => 1, 7 => 1, 11 => 1, 12 => 1, 13 => 1, 16 => 1, 26 => 1, 36 => 1, 43 => 2, 48 => 1, ); }//end if return $errors; }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/NamingConventions/ValidFunctionNameUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/NamingConventions/ValidFunctionNameUnitTest.0000644000076700000240000000117212647543456033361 0ustar gsherwoodstaff ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/NamingConventions/ValidFunctionNameUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/NamingConventions/ValidFunctionNameUnitTest.0000644000076700000240000000416112647543456033362 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ValidFunctionName sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_NamingConventions_ValidFunctionNameUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 4 => 1, 5 => 1, 6 => 1, 7 => 1, 8 => 1, 9 => 1, 11 => 1, 12 => 1, 13 => 1, 14 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/NamingConventions/ValidVariableNameUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/NamingConventions/ValidVariableNameUnitTest.0000644000076700000240000000413312647543456033321 0ustar gsherwoodstaffvarName2; echo $this->var_name2; echo $this->varname2; echo $this->_varName2; echo $object->varName2; echo $object->var_name2; echo $object_name->varname2; echo $object_name->_varName2; echo $this->myFunction($one, $two); echo $object->myFunction($one_two); $error = "format is \$GLOBALS['$varName']"; echo $_SESSION['var_name']; echo $_FILES['var_name']; echo $_ENV['var_name']; echo $_COOKIE['var_name']; $XML = 'hello'; $myXML = 'hello'; $XMLParser = 'hello'; $xmlParser = 'hello'; echo "{$_SERVER['HOSTNAME']} $var_name"; // Need to be the last thing in this test file. $obj->$classVar = $prefix.'-'.$type; class foo { const bar = << * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ValidVariableName sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_NamingConventions_ValidVariableNameUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { $errors = array( 3 => 1, 5 => 1, 10 => 1, 12 => 1, 15 => 1, 17 => 1, 20 => 1, 22 => 1, 25 => 1, 27 => 1, 31 => 1, 33 => 1, 36 => 1, 37 => 1, 39 => 1, 42 => 1, 44 => 1, 53 => 1, 58 => 1, 62 => 1, 63 => 1, 64 => 1, 67 => 1, 81 => 1, 106 => 1, 107 => 1, 108 => 1, 117 => 1, ); return $errors; }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Objects/DisallowObjectStringIndexUnitTest.jsPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Objects/DisallowObjectStringIndexUnitTest.js0000644000076700000240000000142212647543456033364 0ustar gsherwoodstafffunction test(id) { this.id = id; } /**/ test.prototype = { init: function() { var x = {}; x.name = 'test'; x['phone'] = 123124324; var t = ['test', 'this'].join(''); var y = ['test'].join(''); var a = x[0]; var z = x[x['name']]; var p = x[x.name]; } }; function test() { this.errors['step_' + step] = errors; this.errors['test'] = x; this.errors['test' + 10] = x; this.errors['test' + y] = x; this.errors['test' + 'blah'] = x; this.errors[y] = x; this.errors[y + z] = x; this.permissions['workflow.cancel'] = x; } if (child.prototype) { above.prototype['constructor'] = parent; child.prototype['super'] = new above(); } ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Objects/DisallowObjectStringIndexUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Objects/DisallowObjectStringIndexUnitTest.ph0000644000076700000240000000415212647543456033362 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowObjectStringIndex sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Sertan Danis * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Objects_DisallowObjectStringIndexUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='DisallowObjectStringIndexUnitTest.js') { if ($testFile !== 'DisallowObjectStringIndexUnitTest.js') { return array(); } return array( 13 => 1, 17 => 1, 25 => 1, 35 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Objects/ObjectInstantiationUnitTest.inc0000644000076700000240000000044412647543456032413 0ustar gsherwoodstaff new MyClass()); $object->myFunction(new MyClass()); throw new MyException($msg); function foo() { return new MyClass(); } $doodad = $x ? new Foo : new Bar; function new ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Objects/ObjectInstantiationUnitTest.php0000644000076700000240000000364312647543456032435 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ObjectInstantiation sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Objects_ObjectInstantiationUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 5 => 1, 8 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Objects/ObjectMemberCommaUnitTest.js0000644000076700000240000000135212647543456031615 0ustar gsherwoodstaffthis.request({ action: 'getTypeFormatContents', }); addTypeFormatButton.addClickEvent(function() { self.addNewTypeFormat(); }); var x = {}; var y = { VarOne : 'If you ask me, thats if you ask', VarTwo : ['Alonzo played you', 'for a fool', 'esse'], VarThree: function(arg) { console.info(1); } }; var z = { VarOne : 'If you ask me, thats if you ask', VarTwo : ['Alonzo played you', 'for a fool', 'esse'], VarThree: function(arg) { console.info(1); }, }; var x = function() { console.info(2); }; AssetListingEditWidgetType.prototype = { init: function(data, assetid, editables) { } }; AssetListingEditWidgetType.prototype = { init: function(data, assetid, editables) { }, }; PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Objects/ObjectMemberCommaUnitTest.php0000644000076700000240000000405012647543456031766 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ObjectMemberComma sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Objects_ObjectMemberCommaUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='ObjectMemberCommaUnitTest.js') { if ($testFile !== 'ObjectMemberCommaUnitTest.js') { return array(); } return array( 1 => 1, 22 => 1, 38 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Operators/ComparisonOperatorUsageUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Operators/ComparisonOperatorUsageUnitTest.in0000644000076700000240000000333312647543456033475 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ComparisonOperatorUsage sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Operators_ComparisonOperatorUsageUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='ComparisonOperatorUsageUnitTest.inc') { switch ($testFile) { case 'ComparisonOperatorUsageUnitTest.inc': return array( 6 => 1, 7 => 1, 10 => 1, 11 => 1, 18 => 1, 19 => 1, 22 => 1, 23 => 1, 29 => 2, 32 => 2, 38 => 4, 47 => 2, 69 => 1, 72 => 1, 75 => 1, 78 => 1, 80 => 1, 82 => 1, 83 => 1, 89 => 1, 92 => 1, 100 => 1, 106 => 1, 112 => 1, ); break; case 'ComparisonOperatorUsageUnitTest.js': return array( 5 => 1, 6 => 1, 17 => 1, 18 => 1, 28 => 2, 40 => 1, 47 => 1, 52 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Operators/IncrementDecrementUsageUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Operators/IncrementDecrementUsageUnitTest.in0000644000076700000240000000133112647543456033416 0ustar gsherwoodstaff ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Operators/IncrementDecrementUsageUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Operators/IncrementDecrementUsageUnitTest.ph0000644000076700000240000000414212647543456033422 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the IncrementDecrementUsage sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Operators_IncrementDecrementUsageUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 6 => 1, 12 => 1, 16 => 1, 25 => 1, 26 => 1, 27 => 1, 29 => 1, 31 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Operators/ValidLogicalOperatorsUnitTest.inc0000644000076700000240000000057012647543456033256 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Operators/ValidLogicalOperatorsUnitTest.php0000644000076700000240000000370612647543456033300 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ValidLogicalOperators sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Operators_ValidLogicalOperatorsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 5 => 1, 11 => 1, 17 => 2, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/CommentedOutCodeUnitTest.css0000644000076700000240000000075112647543456030714 0ustar gsherwoodstaff/* CSS Document */ body { font-family: Arial, Helvetica, sans-serif; margin : 40px 0 0 0; padding : 0; /*background: #8FB7DB url(login_glow_bg.jpg) no-repeat 30% 0;*/ background: #8FB7DB url(diag_lines_bg.gif) top left; } #login-container { margin-left: -225px; margin-top: -161px; position:absolute; top :50%; /*left :50%;*/ width:450px; } #cacheConfig-dayLabel, #cacheConfig-hourLabel, #cacheConfig-minuteLabel { float: left; padding-right: 8px; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/CommentedOutCodeUnitTest.inc0000644000076700000240000000260212647543456030672 0ustar gsherwoodstaff * * Title * Contents * * ... * * * * * @return void */ /* [^\'"] */ // http://www.google.com // Base config function. PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/CommentedOutCodeUnitTest.php0000644000076700000240000000454712647543456030722 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the CommentedOutCode sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_CommentedOutCodeUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList($testFile='CommentedOutCodeUnitTest.inc') { switch ($testFile) { case 'CommentedOutCodeUnitTest.inc': return array( 6 => 1, 8 => 1, 15 => 1, 19 => 1, ); break; case 'CommentedOutCodeUnitTest.css': return array( 7 => 1, 16 => 1, ); break; default: return array(); break; }//end switch }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowBooleanStatementUnitTest.inc0000644000076700000240000000054112647543456032437 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowBooleanStatementUnitTest.php0000644000076700000240000000357612647543456032470 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowBooleanStatement sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_DisallowBooleanStatementUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 8 => 1, 13 => 1, 15 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowComparisonAssignmentUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowComparisonAssignmentUnitTest.inc0000644000076700000240000000175012647543456033341 0ustar gsherwoodstaffnextSibling; $node; $node = $node->nextSibling) { if ($node->nodeType !== XML_ELEMENT_NODE) { continue; } for ($node = $fields->nextSibling; $node; $node = $node->nextSibling) { if ($node->nodeType !== XML_ELEMENT_NODE) { continue; } } } $a = $b ? $c : $d; $a = $b === true ? $c : $d; ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowComparisonAssignmentUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowComparisonAssignmentUnitTest.php0000644000076700000240000000412212647543456033353 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowComparisonAssignment sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_DisallowComparisonAssignmentUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 5 => 1, 6 => 1, 7 => 1, 8 => 1, 10 => 1, 52 => 1, 53 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowInlineIfUnitTest.inc0000644000076700000240000000013712647543456030671 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowInlineIfUnitTest.js0000644000076700000240000000005612647543456030534 0ustar gsherwoodstaffx = (x?a:x); id = id.replace(/row\/:/gi, ''); PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowInlineIfUnitTest.php0000644000076700000240000000436212647543456030713 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowInlineIf sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_DisallowInlineIfUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList($testFile='DisallowInlineIfUnitTest.inc') { switch ($testFile) { case 'DisallowInlineIfUnitTest.inc': return array( 8 => 1, ); break; case 'DisallowInlineIfUnitTest.js': return array( 1 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowMultipleAssignmentsUnitTest.inc0000644000076700000240000000161212647543456033202 0ustar gsherwoodstafffetch(PDO::FETCH_NUM)) { $result[$row[0]] = array() $result[$row[0]][] = $current; self::$_inTransaction = TRUE; $$varName = $varValue; } }//end getVar() class myClass { private static $_dbh = NULL; public $dbh = NULL; protected $dbh = NULL; } $var = $var2; list ($a, $b) = explode(',', $c); $var1 ? $var2 = 0 : $var2 = 1; $obj->$classVar = $prefix.'-'.$type; $closureWithDefaultParamter = function(array $testArray=array()) {}; ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowMultipleAssignmentsUnitTest.php0000644000076700000240000000403512647543456033222 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowMultipleAssignments sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_DisallowMultipleAssignmentsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 4 => 1, 5 => 2, 7 => 1, 9 => 1, 12 => 1, 14 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowObEndFlushUnitTest.inc0000644000076700000240000000021112647543456031156 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowObEndFlushUnitTest.php0000644000076700000240000000360412647543456031205 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowObEndFlush sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_DisallowObEndFlushUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 9 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowSizeFunctionsInLoopsUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowSizeFunctionsInLoopsUnitTest.inc0000644000076700000240000000134012647543456033300 0ustar gsherwoodstaffchildren); $i++) { } for ($i = 0; $i < sizeof($array); $i++) { } $num = sizeof($array); while ($i < sizeof($array)) { } do { } while ($i < sizeof($array)); for ($i = 0; $i < sizeof($this->children); $i++) { } for ($i = 0; $i < strlen($string); $i++) { } $num = strlen($string); while ($i < strlen($string)) { } do { } while ($i < strlen($string)); for ($i = 0; $i < strlen($this->string); $i++) { } for ($i = sizeof($array); $i > 0; $i--) { } do { echo $a->count; $a->count--; } while($a->count); for ($i = 0; $i < $a->count; $i++) {} ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowSizeFunctionsInLoopsUnitTest.js0000644000076700000240000000037512647543456033152 0ustar gsherwoodstafffor (var i = 0; i < permissions.length; i++) { // Code here. } var permLen = permissions.length; for (var length = 0; i < permLen; i++) { // Code here. } var myArray = [1, 2, 3, 4]; for (var i = myArray.length; i >= 0; i--) { var x = i; } ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowSizeFunctionsInLoopsUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DisallowSizeFunctionsInLoopsUnitTest.php0000644000076700000240000000530112647543456033317 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DisallowSizeFunctionsInLoops sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_DisallowSizeFunctionsInLoopsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='DisallowSizeFunctionsInLoopsUnitTest.inc') { switch ($testFile) { case 'DisallowSizeFunctionsInLoopsUnitTest.inc': return array( 2 => 1, 7 => 1, 11 => 1, 13 => 1, 18 => 1, 23 => 1, 27 => 1, 29 => 1, 35 => 1, 40 => 1, 44 => 1, 46 => 1, ); break; case 'DisallowSizeFunctionsInLoopsUnitTest.js': return array( 1 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DiscouragedFunctionsUnitTest.inc0000644000076700000240000000007712647543456031622 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/DiscouragedFunctionsUnitTest.php0000644000076700000240000000352612647543456031642 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DiscouragedFunctions sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_DiscouragedFunctionsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 2 => 1, 3 => 1, 4 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/EmbeddedPhpUnitTest.inc0000644000076700000240000000304412647543456027636 0ustar gsherwoodstaff <?php echo $title ?> hello section as $section) { ?> section as $section) { ?>
    ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/EmbeddedPhpUnitTest.inc.fixed0000644000076700000240000000310412647543456030731 0ustar gsherwoodstaff <?php echo $title; ?> hello section as $section) { ?>
    section as $section) { ?>
    ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/EmbeddedPhpUnitTest.php0000644000076700000240000000473512647543456027664 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the EmbeddedPhp sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_EmbeddedPhpUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 7 => 1, 12 => 1, 18 => 1, 19 => 2, 20 => 1, 21 => 1, 22 => 3, 24 => 1, 26 => 1, 29 => 1, 30 => 1, 31 => 1, 34 => 1, 36 => 1, 40 => 1, 41 => 1, 44 => 1, 45 => 1, 49 => 1, 59 => 1, 63 => 1, 93 => 1, 94 => 2, 100 => 1, 102 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/EvalUnitTest.inc0000644000076700000240000000010212647543456026354 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/EvalUnitTest.php0000644000076700000240000000356212647543456026407 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the Eval sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_EvalUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 2 => 1, 4 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/ForbiddenFunctionsUnitTest.inc0000644000076700000240000000030412647543456031256 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/ForbiddenFunctionsUnitTest.php0000644000076700000240000000371412647543456031304 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ForbiddenFunctions sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_ForbiddenFunctionsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 3 => 1, 4 => 1, 5 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/GlobalKeywordUnitTest.inc0000644000076700000240000000025512647543456030243 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/GlobalKeywordUnitTest.php0000644000076700000240000000361512647543456030264 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the GlobalKeyword sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_GlobalKeywordUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 8 => 1, 9 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/HeredocUnitTest.inc0000644000076700000240000000036412647543456027050 0ustar gsherwoodstafffoo. Now, I am printing some {$foo->bar[1]}. This should not print a capital 'A': \x41 EOT; ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/HeredocUnitTest.php0000644000076700000240000000357312647543456027073 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the Heredoc sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_HeredocUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 8 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/InnerFunctionsUnitTest.inc0000644000076700000240000000042412647543456030440 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/InnerFunctionsUnitTest.php0000644000076700000240000000357012647543456030463 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the InnerFunctions sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_InnerFunctionsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 5 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/LowercasePHPFunctionsUnitTest.inc0000644000076700000240000000061012647543456031656 0ustar gsherwoodstaffCount(); $count = $object::Count(); $count = $object->count(); $count = $object::count(); class MyClass { public function Count() {} } function &Sort() { } $connection = new Db\Adapter\Pdo\Mysql($config); PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/LowercasePHPFunctionsUnitTest.php0000644000076700000240000000364512647543456031707 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the LowercasePHPFunctions sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_LowercasePHPFunctionsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 4 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/NonExecutableCodeUnitTest.inc0000644000076700000240000000721712647543456031032 0ustar gsherwoodstaff{$action . 'JsonAction'}(); } exit(); // Errors are thrown from here down from the exit() above. foreach ($vars as $var) { if ($something === TRUE) { break; break; } } exit(); function test() { echo 'no error'; } class myClass { function myFunc() { echo 'no error'; } } function bar() { return function() { echo "1"; }; } class HttpStatus { const CONTINUE = 100; const SWITCHING_PROTOCOLS = 101; } ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/PHP/NonExecutableCodeUnitTest.php0000644000076700000240000000510112647543456031036 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the NonExecutableCode sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_PHP_NonExecutableCodeUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 5 => 1, 11 => 1, 17 => 1, 18 => 1, 19 => 2, 28 => 1, 32 => 1, 33 => 2, 34 => 2, 42 => 1, 45 => 1, 54 => 1, 58 => 1, 73 => 1, 83 => 1, 95 => 1, 105 => 1, 123 => 1, 146 => 1, 149 => 1, 152 => 1, 165 => 1, 179 => 1, 221 => 1, 222 => 1, 223 => 1, 224 => 2, 228 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Scope/MemberVarScopeUnitTest.inc0000644000076700000240000000025212647543456030767 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Scope/MemberVarScopeUnitTest.php0000644000076700000240000000357212647543456031015 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the MemberVarScope sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Scope_MemberVarScopeUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 7 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Scope/MethodScopeUnitTest.inc0000644000076700000240000000067012647543456030333 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the MethodScope sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Scope_MethodScopeUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 6 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Scope/StaticThisUsageUnitTest.inc0000644000076700000240000000113712647543456031164 0ustar gsherwoodstafffunc2()); $result = $this->getValue($value); return $this->setValue($result); } public function func1() { $value = 'hello'; $newValue = array($this->func2()); $result = $this->getValue($value); return $this->setValue($result); } function func1() { $value = 'hello'; $newValue = array($this->func2()); $result = $this->getValue($value); return $this->setValue($result); } } ?>PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Scope/StaticThisUsageUnitTest.php0000644000076700000240000000365512647543456031211 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the StaticThisUsage sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Scope_StaticThisUsageUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 7 => 1, 8 => 1, 9 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Strings/ConcatenationSpacingUnitTest.inc0000644000076700000240000000137412647543456032575 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ConcatenationSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Strings_ConcatenationSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 5, 5 => 1, 6 => 1, 9 => 1, 10 => 1, 14 => 5, 16 => 1, 17 => 1, 18 => 1, 34 => 2, 36 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Strings/DoubleQuoteUsageUnitTest.inc0000644000076700000240000000114012647543456031707 0ustar gsherwoodstaff"; $string = "Value: $var[test]"; $string = "\0"; $x = "bar = '$z', baz = '" . $a . "'...$x"; $string = "Hello there"; $string = 'Hello there'; $string = "\123 \234"."\u123"."\e"; echo "window.location = \"".$url."\";\n"; echo "" PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Strings/DoubleQuoteUsageUnitTest.inc.fixed0000644000076700000240000000113712647543456033013 0ustar gsherwoodstaff"; $string = "Value: $var[test]"; $string = "\0"; $x = "bar = '$z', baz = '" . $a . "'...$x"; $string = 'Hello there'; $string = 'Hello there'; $string = "\123 \234"."\u123"."\e"; echo 'window.location = "'.$url."\";\n"; echo '' PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Strings/DoubleQuoteUsageUnitTest.php0000644000076700000240000000417112647543456031734 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the DoubleQuoteUsage sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Strings_DoubleQuoteUsageUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 4 => 1, 5 => 1, 6 => 1, 8 => 2, 14 => 1, 15 => 1, 18 => 1, 19 => 1, 21 => 1, 28 => 1, 29 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Strings/EchoedStringsUnitTest.inc0000644000076700000240000000044012647543456031235 0ustar gsherwoodstaffreturndate == 0) ? 'Not returned' : date('d/m/Y', $loan_device->returndate); ?>

    PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/Strings/EchoedStringsUnitTest.php0000644000076700000240000000373612647543456031266 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the EchoedStrings sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_Strings_EchoedStringsUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 5 => 1, 6 => 1, 7 => 1, 8 => 1, 12 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/CastSpacingUnitTest.inc0000644000076700000240000000016212647543456031277 0ustar gsherwoodstaffPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/CastSpacingUnitTest.php0000644000076700000240000000367612647543456031332 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the CastSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_WhiteSpace_CastSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 4 => 1, 5 => 1, 6 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/ControlStructureSpacingUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/ControlStructureSpacingUnitTest.i0000644000076700000240000000525412647543456033434 0ustar gsherwoodstaff
    children as $child) { // There should be no error after this // foreach, because it is followed by a // close PHP tag. } ?>
    children as $child) { echo $child; } if ($defaultPageDesign === 0 && $defaultCascade === TRUE && $defaultChildDesign === 0 ) { $settingsUpdated = FALSE; } foreach ( $blah as $var ) { if ( $blah ) { } } if ( $defaultPageDesign === 0 && $defaultCascade === TRUE && $defaultChildDesign === 0 ) { $settingsUpdated = FALSE; } $moo = 'blar'; switch ($moo) { case 'blar': if ($moo === 'blar2') { $moo = 'blar' } return $moo; default: $moo = 'moo'; break; } do { } while (true); try { // Something } catch (Exception $e) { // Something } try { // Something } catch (Exception $e) { // Something } if ($one) { } elseif ($two) { } // else if something else if ($three) { } // else do something else { } if ($one) { } do { echo 'hi'; } while ( $blah ); if ($one) { } // No blank line here. if ($two) { } switch ($moo) { case 'blar': if ($moo === 'blar2') { $moo = 'blar' } return $moo; } try { // Something } catch (Exception $e) { // Something } if ($foo) { /** * Comment */ function foo() { // Code here } /** * Comment */ class bar() { }//end class } ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/ControlStructureSpacingUnitTest.jsPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/ControlStructureSpacingUnitTest.j0000644000076700000240000000211612647543456033427 0ustar gsherwoodstaff if (something) { } for (i = 0; i < 10; i++) { } while (true) { for (i = 0; i < 10; i++) { } if (something) { } do { } while (true); } if (one) { } else (two) { } else if (three) { } if (one) { } else (two) { } else if (three) { } switch (blah) { case 'one': if (blah) { // There are no spaces before break. } break; default: if (blah) { // There are no spaces before break. } break; } switch (blah) { case 'one': if (blah) { // There are no spaces before break. } break; default: if (blah) { // Code here. } } for (i = 0; i < 10; i++) { if (blah) { } break; } while (true) { for (i = 0; i < 10; i++) { if (something) { } } do { alert(i); } while (true); } for ( i = 0; i < 10; i++ ) { if ( blah ) { } } var x = { a: function () { if (blah) { } }, }; if (one) { } // else if something else if (two) { } // else do something else { }././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/ControlStructureSpacingUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/ControlStructureSpacingUnitTest.p0000644000076700000240000000640112647543456033436 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ControlStructureSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_WhiteSpace_ControlStructureSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='ControlStructureSpacingUnitTest.inc') { switch ($testFile) { case 'ControlStructureSpacingUnitTest.inc': return array( 3 => 1, 5 => 1, 8 => 1, 15 => 1, 23 => 1, 74 => 1, 79 => 1, 82 => 1, 83 => 1, 87 => 1, 103 => 1, 113 => 2, 114 => 2, 118 => 1, 150 => 1, 153 => 1, 154 => 1, 157 => 1, 170 => 1, 176 => 2, 179 => 1, 189 => 1, ); break; case 'ControlStructureSpacingUnitTest.js': return array( 3 => 1, 9 => 1, 15 => 1, 21 => 1, 56 => 1, 61 => 1, 64 => 1, 65 => 1, 68 => 1, 74 => 2, 75 => 2, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/FunctionClosingBraceSpaceUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/FunctionClosingBraceSpaceUnitTest0000644000076700000240000000072212647543456033347 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the FunctionClosingBraceSpace sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_WhiteSpace_FunctionClosingBraceSpaceUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='FunctionClosingBraceSpaceUnitTest.inc') { switch ($testFile) { case 'FunctionClosingBraceSpaceUnitTest.inc': return array( 10 => 1, 21 => 1, 28 => 1, 29 => 1, 31 => 1, 39 => 1, ); break; case 'FunctionClosingBraceSpaceUnitTest.js': return array( 13 => 1, 25 => 1, 32 => 1, 53 => 1, 59 => 1, 67 => 1, 84 => 1, 128 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/FunctionOpeningBraceSpaceUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/FunctionOpeningBraceSpaceUnitTest0000644000076700000240000000073012647543456033347 0ustar gsherwoodstaff ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/FunctionOpeningBraceSpaceUnitTest.jsPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/FunctionOpeningBraceSpaceUnitTest0000644000076700000240000000256512647543456033357 0ustar gsherwoodstafffunction FuncOne() { // Code here. }//end AdjustModalDialogWidgetType Testing.prototype = { doSomething: function() { // Code here. }, doSomethingElse: function() { // Code here. }, start: function() { this.toolbarPlugin.addButton('Image', 'imageEditor', 'Insert/Edit Image', function () { self.editImage() }); }, }; function FuncFour() { // Code here. } AbstractAttributeEditorWidgetType.prototype = { isActive: function() { return this.active; }, activate: function(data) { var x = { test: function () { alert('This is ok'); } }; this.active = true; } }; function test() { var x = 1; var y = function() { alert(1); } return x; } var myFunc = function() { var x = 1; blah(x, y, function() { alert(2); }, z); blah(function() { alert(2); }); return x; } HelpWidgetType.prototype = { init: function() { var x = 1; var y = { test: function() { alert(3); } } return x; } } CustomFormEditWidgetType.prototype = { addQuestion: function() { var settings = { default: '' }; }, addQuestionRulesEvent: function() { var self = this; } }; ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/FunctionOpeningBraceSpaceUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/FunctionOpeningBraceSpaceUnitTest0000644000076700000240000000476512647543456033363 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the FunctionOpeningBraceSpace sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_WhiteSpace_FunctionOpeningBraceSpaceUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='FunctionOpeningBraceSpaceUnitTest.inc') { switch ($testFile) { case 'FunctionOpeningBraceSpaceUnitTest.inc': return array( 10 => 1, 25 => 1, ); break; case 'FunctionOpeningBraceSpaceUnitTest.js': return array( 11 => 1, 31 => 1, 38 => 1, 88 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/FunctionSpacingUnitTest.inc0000644000076700000240000000613012647543456032173 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the FunctionSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_WhiteSpace_FunctionSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 20 => 1, 29 => 1, 38 => 1, 45 => 1, 49 => 1, 55 => 1, 58 => 1, 60 => 1, 75 => 1, 94 => 1, 105 => 1, 107 => 1, 113 => 2, 135 => 1, 154 => 1, 167 => 2, 184 => 1, 218 => 1, 233 => 1, 252 => 1, 275 => 1, 276 => 1, 289 => 1, 291 => 1, 297 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ././@LongLink000 147 0003740 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/LanguageConstructSpacingUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/LanguageConstructSpacingUnitTest.0000644000076700000240000000065312647543456033350 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the LanguageConstructSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_WhiteSpace_LanguageConstructSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 4 => 1, 7 => 1, 8 => 1, 11 => 1, 12 => 1, 15 => 1, 16 => 1, 19 => 1, 20 => 1, 23 => 1, 24 => 1, 27 => 1, 31 => 1, 32 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/LogicalOperatorSpacingUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/LogicalOperatorSpacingUnitTest.in0000644000076700000240000000040712647543456033332 0ustar gsherwoodstaff ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/LogicalOperatorSpacingUnitTest.jsPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/LogicalOperatorSpacingUnitTest.js0000644000076700000240000000035512647543456033342 0ustar gsherwoodstaff if (foo || bar) {} if (foo||bar && baz) {} if (foo|| bar&&baz) {} if (foo || bar && baz) {} // Spacing after || below is ignored as it is EOL whitespace. if (foo || bar && baz ) { } if (foo|| bar &&baz ) { } ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/LogicalOperatorSpacingUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/LogicalOperatorSpacingUnitTest.ph0000644000076700000240000000401712647543456033334 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the LogicalOperatorSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_WhiteSpace_LogicalOperatorSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='LogicalOperatorSpacingUnitTest.inc') { return array( 4 => 2, 5 => 3, 6 => 3, 15 => 1, 17 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/MemberVarSpacingUnitTest.inc0000644000076700000240000000342312647543456032270 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the MemberVarSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_WhiteSpace_MemberVarSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 4 => 1, 7 => 1, 20 => 1, 30 => 1, 35 => 1, 44 => 1, 50 => 1, 73 => 1, 86 => 1, 106 => 1, 115 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/ObjectOperatorSpacingUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/ObjectOperatorSpacingUnitTest.inc0000644000076700000240000000030112647543456033322 0ustar gsherwoodstafftestThis(); $this-> testThis(); $this -> testThis(); $this->/* comment here */testThis(); $this/* comment here */ -> testThis(); $this ->testThis(); $this-> testThis();././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/ObjectOperatorSpacingUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/ObjectOperatorSpacingUnitTest.php0000644000076700000240000000376412647543456033360 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ObjectOperatorSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_WhiteSpace_ObjectOperatorSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 4 => 2, 6 => 2, 8 => 1, 9 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.inc0000644000076700000240000000533412647543456032206 0ustar gsherwoodstaff $j && $k< $l && $m>= $n && $o<= $p && $q<> $r; $a ==$b && $c !=$d && $e ===$f && $g !==$h; $i >$j && $k <$l && $m >=$n && $o <=$p && $q <>$r; function myFunction($variable=0, $var2='string') {} if (index > -1) { } array_walk_recursive($array, function(&$item) use (&$something) { }); $var = saveFile(&$model, &$foo); // This is all valid. $boo = -$foo; function foo($boo = -1) {} $foo = array('boo' => -1); $x = $test ? -1 : 1; $y = $test ? 1 : -1; $z = $test ?: false; $closureWithDefaultParameter = function (array $testArray=array()) {}; switch ($foo) { case -1: break; } $y = 1 * -1; $y = -1 * 1; $y = -1 * $var; $y = 10 / -2; $y = -10 / 2; $y = (-10 / 2); $y = (-10 / $var); $y = 10 + -2; $y = -10 + 2; $a = $x?$y:$z; $a = $x ? $y : $z; $y = 1 + 2 - 3; $y = 1 + 2 - 3; $y = 1 + 2 - 3; // @codingStandardsChangeSetting Squiz.WhiteSpace.OperatorSpacing ignoreNewlines true $y = 1 + 2 - 3; $y = 1 + 2 - 3; $y = 1 + 2 - 3; // @codingStandardsChangeSetting Squiz.WhiteSpace.OperatorSpacing ignoreNewlines false if (true || -1 == $b) { } $var = array(-1); $var = [-1]; $var = [0, -1, -2]; $y = array(&$x); $y = [&$x]; $y = array(&$a, &$b, &$c); $y = [&$a, &$b, &$c]; $y = array(&$a => 1, 2 => &$b, &$c); $y = [&$a => 1, 2 => &$b, &$c]; if ($a <=> $b) { } if ($a <=>$b) { } ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.inc.fixed0000644000076700000240000000537312647543456033307 0ustar gsherwoodstaff $j && $k < $l && $m >= $n && $o <= $p && $q <> $r; $a == $b && $c != $d && $e === $f && $g !== $h; $i > $j && $k < $l && $m >= $n && $o <= $p && $q <> $r; function myFunction($variable=0, $var2='string') {} if (index > -1) { } array_walk_recursive($array, function(&$item) use (&$something) { }); $var = saveFile(&$model, &$foo); // This is all valid. $boo = -$foo; function foo($boo = -1) {} $foo = array('boo' => -1); $x = $test ? -1 : 1; $y = $test ? 1 : -1; $z = $test ?: false; $closureWithDefaultParameter = function (array $testArray=array()) {}; switch ($foo) { case -1: break; } $y = 1 * -1; $y = -1 * 1; $y = -1 * $var; $y = 10 / -2; $y = -10 / 2; $y = (-10 / 2); $y = (-10 / $var); $y = 10 + -2; $y = -10 + 2; $a = $x ? $y : $z; $a = $x ? $y : $z; $y = 1 + 2 - 3; $y = 1 + 2 - 3; $y = 1 + 2 - 3; // @codingStandardsChangeSetting Squiz.WhiteSpace.OperatorSpacing ignoreNewlines true $y = 1 + 2 - 3; $y = 1 + 2 - 3; $y = 1 + 2 - 3; // @codingStandardsChangeSetting Squiz.WhiteSpace.OperatorSpacing ignoreNewlines false if (true || -1 == $b) { } $var = array(-1); $var = [-1]; $var = [0, -1, -2]; $y = array(&$x); $y = [&$x]; $y = array(&$a, &$b, &$c); $y = [&$a, &$b, &$c]; $y = array(&$a => 1, 2 => &$b, &$c); $y = [&$a => 1, 2 => &$b, &$c]; if ($a <=> $b) { } if ($a <=> $b) { } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.js0000644000076700000240000000213212647543456032042 0ustar gsherwoodstaff result = 1 + 2; result = 1 + 2; result = 1 + 2; result = 1 +2; result = 1+ 2; result = 1+2; result = 1 - 2; result = 1 - 2; result = 1 - 2; result = 1 -2; result = 1- 2; result = 1-2; result = 1 * 2; result = 1 * 2; result = 1 * 2; result = 1 *2; result = 1* 2; result = 1*2; result = 1 / 2; result = 1 / 2; result = 1 / 2; result = 1 /2; result = 1/ 2; result = 1/2; result = 1 % 2; result = 1 % 2; result = 1 % 2; result = 1 %2; result = 1% 2; result = 1%2; result = '100%'; result += 4; result+=4; result -= 4; result-=4; result /= 4; result/=4; result *=4; result*=4; $.localScroll({offset: {top: -32}}); switch (result) { case -1: break; } result = x?y:z; result = x ? y : z; if (something === true ^ somethingElse === true ) { return false; } y = 1 + 2 - 3; y = 1 + 2 - 3; y = 1 + 2 - 3; // @codingStandardsChangeSetting Squiz.WhiteSpace.OperatorSpacing ignoreNewlines true y = 1 + 2 - 3; y = 1 + 2 - 3; y = 1 + 2 - 3; // @codingStandardsChangeSetting Squiz.WhiteSpace.OperatorSpacing ignoreNewlines false if (true || -1 == b) { } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.js.fixed0000644000076700000240000000212712647543456033144 0ustar gsherwoodstaff result = 1 + 2; result = 1 + 2; result = 1 + 2; result = 1 + 2; result = 1 + 2; result = 1 + 2; result = 1 - 2; result = 1 - 2; result = 1 - 2; result = 1 - 2; result = 1 - 2; result = 1 - 2; result = 1 * 2; result = 1 * 2; result = 1 * 2; result = 1 * 2; result = 1 * 2; result = 1 * 2; result = 1 / 2; result = 1 / 2; result = 1 / 2; result = 1 / 2; result = 1 / 2; result = 1 / 2; result = 1 % 2; result = 1 % 2; result = 1 % 2; result = 1 % 2; result = 1 % 2; result = 1 % 2; result = '100%'; result += 4; result += 4; result -= 4; result -= 4; result /= 4; result /= 4; result *= 4; result *= 4; $.localScroll({offset: {top: -32}}); switch (result) { case -1: break; } result = x ? y : z; result = x ? y : z; if (something === true ^ somethingElse === true ) { return false; } y = 1 + 2 - 3; y = 1 + 2 - 3; y = 1 + 2 - 3; // @codingStandardsChangeSetting Squiz.WhiteSpace.OperatorSpacing ignoreNewlines true y = 1 + 2 - 3; y = 1 + 2 - 3; y = 1 + 2 - 3; // @codingStandardsChangeSetting Squiz.WhiteSpace.OperatorSpacing ignoreNewlines false if (true || -1 == b) { } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.php0000644000076700000240000001154612647543456032226 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the OperatorSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_WhiteSpace_OperatorSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='OperatorSpacingUnitTest.inc') { switch ($testFile) { case 'OperatorSpacingUnitTest.inc': return array( 4 => 1, 5 => 2, 6 => 1, 7 => 1, 8 => 2, 11 => 1, 12 => 2, 13 => 1, 14 => 1, 15 => 2, 18 => 1, 19 => 2, 20 => 1, 21 => 1, 22 => 2, 25 => 1, 26 => 2, 27 => 1, 28 => 1, 29 => 2, 32 => 1, 33 => 2, 34 => 1, 35 => 1, 36 => 2, 40 => 2, 42 => 2, 44 => 2, 45 => 1, 46 => 2, 53 => 4, 54 => 3, 59 => 10, 64 => 1, 77 => 4, 78 => 1, 79 => 1, 80 => 2, 81 => 1, 84 => 6, 85 => 6, 87 => 4, 88 => 5, 90 => 4, 91 => 5, 128 => 4, 132 => 1, 133 => 1, 135 => 1, 136 => 1, 140 => 1, 141 => 1, 174 => 1, ); break; case 'OperatorSpacingUnitTest.js': return array( 4 => 1, 5 => 2, 6 => 1, 7 => 1, 8 => 2, 11 => 1, 12 => 2, 13 => 1, 14 => 1, 15 => 2, 18 => 1, 19 => 2, 20 => 1, 21 => 1, 22 => 2, 25 => 1, 26 => 2, 27 => 1, 28 => 1, 29 => 2, 32 => 1, 33 => 2, 34 => 1, 35 => 1, 36 => 2, 40 => 2, 42 => 2, 44 => 2, 45 => 1, 46 => 2, 55 => 4, 65 => 1, 66 => 1, 68 => 1, 69 => 1, 73 => 1, 74 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/PropertyLabelSpacingUnitTest.js0000644000076700000240000000111212647543456033030 0ustar gsherwoodstaffvar x = { b: 'x', xasd: x, abc:x, a: function () { alert('thats right'); x = (x?a:x); }, casdasd : 123123, omgwtfbbq: { a: 1, b: 2 } }; id = id.replace(/row\/:/gi, ''); outer_loop: for (i=0; i<3; i++) { for (j=0; j<5; j++) { if (j==x) break outer_loop; } } alert('hi'); even_number: if ((i % 2) == 0) { if (i == 12) break even_number; } switch (blah) { case dfx.DOM_VK_LEFT: this.caretLeft(shiftKey); break; default: if (blah) { } break; } ././@LongLink000 150 0003732 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/PropertyLabelSpacingUnitTest.js.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/PropertyLabelSpacingUnitTest.js.f0000644000076700000240000000110512647543456033256 0ustar gsherwoodstaffvar x = { b: 'x', xasd: x, abc: x, a: function () { alert('thats right'); x = (x?a:x); }, casdasd: 123123, omgwtfbbq: { a: 1, b: 2 } }; id = id.replace(/row\/:/gi, ''); outer_loop: for (i=0; i<3; i++) { for (j=0; j<5; j++) { if (j==x) break outer_loop; } } alert('hi'); even_number: if ((i % 2) == 0) { if (i == 12) break even_number; } switch (blah) { case dfx.DOM_VK_LEFT: this.caretLeft(shiftKey); break; default: if (blah) { } break; } PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/PropertyLabelSpacingUnitTest.php0000644000076700000240000000377512647543456033224 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the PropertyLabel sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_WhiteSpace_PropertyLabelSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 2 => 1, 4 => 1, 9 => 2, 10 => 1, 12 => 1, 18 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/ScopeClosingBraceUnitTest.inc0000644000076700000240000000203612647543456032427 0ustar gsherwoodstaff{$property} =& new $class_name($this->db_index); $this->modules[$module] =& $this->{$property}; } foreach ($elements as $element) { if ($something) { // Do IF. } else if ($somethingElse) { // Do ELSE. } } if ($token['code'] === T_COMMENT && $multiLineComment === false && (substr($token['content'], 0, 2) === '//' || $token['content']{0} === '#') ) { } switch ($blah) { case 'one': echo 'one'; break; default: echo 'another'; } ?> getRow()): ?>

    o hai!

    PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/ScopeClosingBraceUnitTest.php0000644000076700000240000000367312647543456032455 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ScopeClosingBrace sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_WhiteSpace_ScopeClosingBraceUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 11 => 1, 13 => 1, 24 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/ScopeKeywordSpacingUnitTest.inc0000644000076700000240000000133412647543456033025 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ScopeKeywordSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_WhiteSpace_ScopeKeywordSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 7 => 2, 8 => 1, 13 => 1, 14 => 1, 15 => 1, 17 => 2, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SemicolonSpacingUnitTest.inc0000644000076700000240000000041712647543456032340 0ustar gsherwoodstafftestThis(); $test = $this->testThis() ; $test = $this->testThis() ; for ($var = 1 ; $var < 10 ; $var++) { echo $var ; } $test = $this->testThis() /* comment here */; $test = $this->testThis() /* comment here */ ; $hello ='foo'; ;PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SemicolonSpacingUnitTest.js0000644000076700000240000000035612647543456032205 0ustar gsherwoodstaffvar x = { a: function () { alert('thats right') ; x = (x?a:x) ; }, } ; id = id.replace(/row\/:;/gi, ''); for (i=0 ; i<3 ; i++) { for (j=0; j<5 ; j++) { if (j==x) break ; } } alert('hi'); ;PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SemicolonSpacingUnitTest.php0000644000076700000240000000513612647543456032361 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the SemicolonSpacing sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_WhiteSpace_SemicolonSpacingUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='SemicolonSpacingUnitTest.inc') { switch ($testFile) { case 'SemicolonSpacingUnitTest.inc': return array( 3 => 1, 4 => 1, 5 => 2, 6 => 1, 8 => 1, 9 => 1, ); break; case 'SemicolonSpacingUnitTest.js': return array( 3 => 1, 4 => 1, 6 => 1, 10 => 2, 11 => 1, 13 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.1.cssPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.1.c0000644000076700000240000000100712647543456033260 0ustar gsherwoodstaff .HelpWidgetType-new-bug-title { float: left; } .HelpWidgetType-new-bug-title { float: left; } .HelpWidgetType-new-bug-title { float: left; } .HelpWidgetType-new-bug-title{ float: left; } /* @codingStandardsChangeSetting Squiz.WhiteSpace.SuperfluousWhitespace ignoreBlankLines true */ .HelpWidgetType-new-bug-title{ float: left; } .HelpWidgetType-new-bug-title{ float: left; } /* @codingStandardsChangeSetting Squiz.WhiteSpace.SuperfluousWhitespace ignoreBlankLines false */ ././@LongLink000 154 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.1.css.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.1.c0000644000076700000240000000077312647543456033271 0ustar gsherwoodstaff.HelpWidgetType-new-bug-title { float: left; } .HelpWidgetType-new-bug-title { float: left; } .HelpWidgetType-new-bug-title { float: left; } .HelpWidgetType-new-bug-title{ float: left; } /* @codingStandardsChangeSetting Squiz.WhiteSpace.SuperfluousWhitespace ignoreBlankLines true */ .HelpWidgetType-new-bug-title{ float: left; } .HelpWidgetType-new-bug-title{ float: left; } /* @codingStandardsChangeSetting Squiz.WhiteSpace.SuperfluousWhitespace ignoreBlankLines false */ ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.1.jsPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.1.j0000644000076700000240000000116012647543456033267 0ustar gsherwoodstaff alert('hi'); alert('hello'); if (something) { } function myFunction() { alert('code here'); alert('code here'); // Hello. /* HI */ } function myFunction2() { alert('code here'); alert('code here'); } MyFunction = function() { alert('code here'); alert('code here'); }; // @codingStandardsChangeSetting Squiz.WhiteSpace.SuperfluousWhitespace ignoreBlankLines true function myFunction2() { alert('code here'); alert('code here'); } // @codingStandardsChangeSetting Squiz.WhiteSpace.SuperfluousWhitespace ignoreBlankLines false ././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.1.js.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.1.j0000644000076700000240000000113512647543456033271 0ustar gsherwoodstaffalert('hi'); alert('hello'); if (something) { } function myFunction() { alert('code here'); alert('code here'); // Hello. /* HI */ } function myFunction2() { alert('code here'); alert('code here'); } MyFunction = function() { alert('code here'); alert('code here'); }; // @codingStandardsChangeSetting Squiz.WhiteSpace.SuperfluousWhitespace ignoreBlankLines true function myFunction2() { alert('code here'); alert('code here'); } // @codingStandardsChangeSetting Squiz.WhiteSpace.SuperfluousWhitespace ignoreBlankLines false ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.2.cssPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.2.c0000644000076700000240000000006212647543456033261 0ustar gsherwoodstaff.HelpWidgetType-new-bug-title { float: left; }././@LongLink000 154 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.2.css.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.2.c0000644000076700000240000000006212647543456033261 0ustar gsherwoodstaff.HelpWidgetType-new-bug-title { float: left; }././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.2.jsPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.2.j0000644000076700000240000000001412647543456033265 0ustar gsherwoodstaffalert('hi');././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.2.js.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.2.j0000644000076700000240000000001412647543456033265 0ustar gsherwoodstaffalert('hi');././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.3.cssPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.3.c0000644000076700000240000000006312647543456033263 0ustar gsherwoodstaff.HelpWidgetType-new-bug-title { float: left; } ././@LongLink000 154 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.3.css.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.3.c0000644000076700000240000000006212647543456033262 0ustar gsherwoodstaff.HelpWidgetType-new-bug-title { float: left; }././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.3.jsPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.3.j0000644000076700000240000000001512647543456033267 0ustar gsherwoodstaffalert('hi'); ././@LongLink000 153 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.3.js.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.3.j0000644000076700000240000000001512647543456033267 0ustar gsherwoodstaffalert('hi'); ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.inc0000644000076700000240000000130312647543456033447 0ustar gsherwoodstaff ././@LongLink000 152 0003734 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.inc.fixedPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.inc0000644000076700000240000000126012647543456033451 0ustar gsherwoodstaff ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.php0000644000076700000240000000616412647543456033477 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the SuperfluousWhitespace sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Squiz_Tests_WhiteSpace_SuperfluousWhitespaceUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='SuperfluousWhitespaceUnitTest.inc') { switch ($testFile) { case 'SuperfluousWhitespaceUnitTest.inc': return array( 2 => 1, 4 => 1, 5 => 1, 6 => 1, 7 => 1, 16 => 1, 23 => 1, 28 => 1, 33 => 1, 53 => 1, ); break; case 'SuperfluousWhitespaceUnitTest.1.js': return array( 1 => 1, 3 => 1, 4 => 1, 5 => 1, 6 => 1, 15 => 1, 22 => 1, 29 => 1, 38 => 1, 56 => 1, ); break; case 'SuperfluousWhitespaceUnitTest.1.css': return array( 1 => 1, 8 => 1, 9 => 1, 11 => 1, 25 => 1, ); break; default: return array(); break; }//end switch }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Squiz/ruleset.xml0000644000076700000240000000515612647543456023764 0ustar gsherwoodstaff The Squiz coding standard. 0 %2$s PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Docs/Debug/CodeAnalyzerStandard.xml0000644000076700000240000000103112647543456030031 0ustar gsherwoodstaff $bar + $baz; } ]]> $bar + 2; } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Docs/Files/ClosingTagStandard.xml0000644000076700000240000000075312647543456027531 0ustar gsherwoodstaff ?> ]]> ././@LongLink000 145 0003736 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Docs/NamingConventions/ValidVariableNameStandard.xmlPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Docs/NamingConventions/ValidVariableNameStandard.xm0000644000076700000240000000175112647543456033225 0ustar gsherwoodstaff $testNumber = 1; ]]> $Test_Number = 1; ]]> _bar; } ]]> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Sniffs/Debug/CodeAnalyzerSniff.php0000644000076700000240000000725312647543456027701 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Zend_Sniffs_Debug_CodeAnalyzerSniff. * * Runs the Zend Code Analyzer (from Zend Studio) on the file. * * @category PHP * @package PHP_CodeSniffer * @author Holger Kral * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Zend_Sniffs_Debug_CodeAnalyzerSniff implements PHP_CodeSniffer_Sniff { /** * Returns the token types that this sniff is interested in. * * @return int[] */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes the tokens that this sniff is interested in. * * @param PHP_CodeSniffer_File $phpcsFile The file where the token was found. * @param int $stackPtr The position in the stack where * the token was found. * * @return int */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $fileName = $phpcsFile->getFilename(); $analyzerPath = PHP_CodeSniffer::getConfigData('zend_ca_path'); if (is_null($analyzerPath) === true) { return; } // In the command, 2>&1 is important because the code analyzer sends its // findings to stderr. $output normally contains only stdout, so using 2>&1 // will pipe even stderr to stdout. $cmd = $analyzerPath.' '.$fileName.' 2>&1'; // There is the possibility to pass "--ide" as an option to the analyzer. // This would result in an output format which would be easier to parse. // The problem here is that no cleartext error messages are returnwd; only // error-code-labels. So for a start we go for cleartext output. $exitCode = exec($cmd, $output, $retval); // Variable $exitCode is the last line of $output if no error occures, on // error it is numeric. Try to handle various error conditions and // provide useful error reporting. if (is_numeric($exitCode) === true && $exitCode > 0) { if (is_array($output) === true) { $msg = join('\n', $output); } throw new PHP_CodeSniffer_Exception("Failed invoking ZendCodeAnalyzer, exitcode was [$exitCode], retval was [$retval], output was [$msg]"); } if (is_array($output) === true) { foreach ($output as $finding) { // The first two lines of analyzer output contain // something like this: // > Zend Code Analyzer 1.2.2 // > Analyzing ... // So skip these... $res = preg_match("/^.+\(line ([0-9]+)\):(.+)$/", $finding, $regs); if (empty($regs) === true || $res === false) { continue; } $phpcsFile->addWarningOnLine(trim($regs[2]), $regs[1], 'ExternalTool'); } } // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Sniffs/Files/ClosingTagSniff.php0000644000076700000240000000475212647543456027370 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Zend_Sniffs_Files_LineEndingsSniff. * * Checks that the file does not end with a closing tag. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Zend_Sniffs_Files_ClosingTagSniff implements PHP_CodeSniffer_Sniff { /** * Returns an array of tokens this test wants to listen for. * * @return array */ public function register() { return array(T_OPEN_TAG); }//end register() /** * Processes this sniff, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in * the stack passed in $tokens. * * @return void */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { // Find the last non-empty token. $tokens = $phpcsFile->getTokens(); for ($last = ($phpcsFile->numTokens - 1); $last > 0; $last--) { if (trim($tokens[$last]['content']) !== '') { break; } } if ($tokens[$last]['code'] === T_CLOSE_TAG) { $error = 'A closing tag is not permitted at the end of a PHP file'; $fix = $phpcsFile->addFixableError($error, $last, 'NotAllowed'); if ($fix === true) { $phpcsFile->fixer->replaceToken($last, ''); } $phpcsFile->recordMetric($stackPtr, 'PHP closing tag at EOF', 'yes'); } else { $phpcsFile->recordMetric($stackPtr, 'PHP closing tag at EOF', 'no'); } // Ignore the rest of the file. return ($phpcsFile->numTokens + 1); }//end process() }//end class ././@LongLink000 144 0003735 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Sniffs/NamingConventions/ValidVariableNameSniff.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Sniffs/NamingConventions/ValidVariableNameSniff.php0000644000076700000240000002406012647543456033233 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractVariableSniff', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Standards_AbstractVariableSniff not found'); } /** * Squiz_Sniffs_NamingConventions_ValidVariableNameSniff. * * Checks the naming of variables and member variables. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Zend_Sniffs_NamingConventions_ValidVariableNameSniff extends PHP_CodeSniffer_Standards_AbstractVariableSniff { /** * Tokens to ignore so that we can find a DOUBLE_COLON. * * @var array */ private $_ignore = array( T_WHITESPACE, T_COMMENT, ); /** * Processes this test, when one of its tokens is encountered. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ protected function processVariable(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $varName = ltrim($tokens[$stackPtr]['content'], '$'); $phpReservedVars = array( '_SERVER', '_GET', '_POST', '_REQUEST', '_SESSION', '_ENV', '_COOKIE', '_FILES', 'GLOBALS', 'http_response_header', 'HTTP_RAW_POST_DATA', 'php_errormsg', ); // If it's a php reserved var, then its ok. if (in_array($varName, $phpReservedVars) === true) { return; } $objOperator = $phpcsFile->findNext(array(T_WHITESPACE), ($stackPtr + 1), null, true); if ($tokens[$objOperator]['code'] === T_OBJECT_OPERATOR) { // Check to see if we are using a variable from an object. $var = $phpcsFile->findNext(array(T_WHITESPACE), ($objOperator + 1), null, true); if ($tokens[$var]['code'] === T_STRING) { // Either a var name or a function call, so check for bracket. $bracket = $phpcsFile->findNext(array(T_WHITESPACE), ($var + 1), null, true); if ($tokens[$bracket]['code'] !== T_OPEN_PARENTHESIS) { $objVarName = $tokens[$var]['content']; // There is no way for us to know if the var is public or private, // so we have to ignore a leading underscore if there is one and just // check the main part of the variable name. $originalVarName = $objVarName; if (substr($objVarName, 0, 1) === '_') { $objVarName = substr($objVarName, 1); } if (PHP_CodeSniffer::isCamelCaps($objVarName, false, true, false) === false) { $error = 'Variable "%s" is not in valid camel caps format'; $data = array($originalVarName); $phpcsFile->addError($error, $var, 'NotCamelCaps', $data); } else if (preg_match('|\d|', $objVarName) === 1) { $warning = 'Variable "%s" contains numbers but this is discouraged'; $data = array($originalVarName); $phpcsFile->addWarning($warning, $stackPtr, 'ContainsNumbers', $data); } }//end if }//end if }//end if // There is no way for us to know if the var is public or private, // so we have to ignore a leading underscore if there is one and just // check the main part of the variable name. $originalVarName = $varName; if (substr($varName, 0, 1) === '_') { $objOperator = $phpcsFile->findPrevious(array(T_WHITESPACE), ($stackPtr - 1), null, true); if ($tokens[$objOperator]['code'] === T_DOUBLE_COLON) { // The variable lives within a class, and is referenced like // this: MyClass::$_variable, so we don't know its scope. $inClass = true; } else { $inClass = $phpcsFile->hasCondition($stackPtr, array(T_CLASS, T_INTERFACE, T_TRAIT)); } if ($inClass === true) { $varName = substr($varName, 1); } } if (PHP_CodeSniffer::isCamelCaps($varName, false, true, false) === false) { $error = 'Variable "%s" is not in valid camel caps format'; $data = array($originalVarName); $phpcsFile->addError($error, $stackPtr, 'NotCamelCaps', $data); } else if (preg_match('|\d|', $varName) === 1) { $warning = 'Variable "%s" contains numbers but this is discouraged'; $data = array($originalVarName); $phpcsFile->addWarning($warning, $stackPtr, 'ContainsNumbers', $data); } }//end processVariable() /** * Processes class member variables. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the current token in the * stack passed in $tokens. * * @return void */ protected function processMemberVar(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $varName = ltrim($tokens[$stackPtr]['content'], '$'); $memberProps = $phpcsFile->getMemberProperties($stackPtr); $public = ($memberProps['scope'] === 'public'); if ($public === true) { if (substr($varName, 0, 1) === '_') { $error = 'Public member variable "%s" must not contain a leading underscore'; $data = array($varName); $phpcsFile->addError($error, $stackPtr, 'PublicHasUnderscore', $data); return; } } else { if (substr($varName, 0, 1) !== '_') { $scope = ucfirst($memberProps['scope']); $error = '%s member variable "%s" must contain a leading underscore'; $data = array( $scope, $varName, ); $phpcsFile->addError($error, $stackPtr, 'PrivateNoUnderscore', $data); return; } } if (PHP_CodeSniffer::isCamelCaps($varName, false, $public, false) === false) { $error = 'Member variable "%s" is not in valid camel caps format'; $data = array($varName); $phpcsFile->addError($error, $stackPtr, 'MemberVarNotCamelCaps', $data); } else if (preg_match('|\d|', $varName) === 1) { $warning = 'Member variable "%s" contains numbers but this is discouraged'; $data = array($varName); $phpcsFile->addWarning($warning, $stackPtr, 'MemberVarContainsNumbers', $data); } }//end processMemberVar() /** * Processes the variable found within a double quoted string. * * @param PHP_CodeSniffer_File $phpcsFile The file being scanned. * @param int $stackPtr The position of the double quoted * string. * * @return void */ protected function processVariableInString(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $phpReservedVars = array( '_SERVER', '_GET', '_POST', '_REQUEST', '_SESSION', '_ENV', '_COOKIE', '_FILES', 'GLOBALS', 'http_response_header', 'HTTP_RAW_POST_DATA', 'php_errormsg', ); if (preg_match_all('|[^\\\]\$([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)|', $tokens[$stackPtr]['content'], $matches) !== 0) { foreach ($matches[1] as $varName) { // If it's a php reserved var, then its ok. if (in_array($varName, $phpReservedVars) === true) { continue; } if (PHP_CodeSniffer::isCamelCaps($varName, false, true, false) === false) { $error = 'Variable "%s" is not in valid camel caps format'; $data = array($varName); $phpcsFile->addError($error, $stackPtr, 'StringVarNotCamelCaps', $data); } else if (preg_match('|\d|', $varName) === 1) { $warning = 'Variable "%s" contains numbers but this is discouraged'; $data = array($varName); $phpcsFile->addWarning($warning, $stackPtr, 'StringVarContainsNumbers', $data); } }//end foreach }//end if }//end processVariableInString() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Tests/Debug/CodeAnalyzerUnitTest.inc0000644000076700000240000000012712647543456030240 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Tests/Debug/CodeAnalyzerUnitTest.php0000644000076700000240000000422012647543456030254 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the CodeAnalyzer sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Zend_Tests_Debug_CodeAnalyzerUnitTest extends AbstractSniffUnitTest { /** * Should this test be skipped for some reason. * * @return void */ protected function shouldSkipTest() { $analyzerPath = PHP_CodeSniffer::getConfigData('zend_ca_path'); return (is_null($analyzerPath)); }//end shouldSkipTest() /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array(); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 2 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Tests/Files/ClosingTagUnitTest.1.inc0000644000076700000240000000005712647543456030067 0ustar gsherwoodstaff PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Tests/Files/ClosingTagUnitTest.2.inc0000644000076700000240000000010112647543456030056 0ustar gsherwoodstaff
    PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Tests/Files/ClosingTagUnitTest.php0000644000076700000240000000404212647543456027744 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ClosingTag sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Zend_Tests_Files_ClosingTagUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @param string $testFile The name of the file being tested. * * @return array */ public function getErrorList($testFile='') { if ($testFile !== 'ClosingTagUnitTest.1.inc') { return array(); } return array( 11 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array(); }//end getWarningList() }//end class ?> ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Tests/NamingConventions/ValidVariableNameUnitTest.incPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Tests/NamingConventions/ValidVariableNameUnitTest.i0000644000076700000240000000431412647543456033260 0ustar gsherwoodstaffvarName; echo $this->var_name; echo $this->varname; echo $this->_varName; echo $this->varName2; echo $object->varName; echo $object->var_name; echo $object->varName2; echo $object_name->varname; echo $object_name->_varName; echo $object_name->varName2; echo $this->myFunction($one, $two); echo $object->myFunction($one_two, $var2); $error = "format is \$GLOBALS['$varName']"; $error = "format is \$GLOBALS['$varName2']"; echo $_SESSION['var_name']; echo $_FILES['var_name']; echo $_ENV['var_name']; echo $_COOKIE['var_name']; echo $_COOKIE['var_name2']; $XML = 'hello'; $myXML = 'hello'; $XMLParser = 'hello'; $xmlParser = 'hello'; $xmlParser2 = 'hello'; echo "{$_SERVER['HOSTNAME']} $var_name"; $someObject->{$name}; $someObject->my_function($var_name); var_dump($http_response_header); var_dump($HTTP_RAW_POST_DATA); var_dump($php_errormsg); ././@LongLink000 146 0003737 LPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Tests/NamingConventions/ValidVariableNameUnitTest.phpPHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/Tests/NamingConventions/ValidVariableNameUnitTest.p0000644000076700000240000000555612647543456033300 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Unit test class for the ValidVariableName sniff. * * A sniff unit test checks a .inc file for expected violations of a single * coding standard. Expected errors and warnings are stored in this class. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class Zend_Tests_NamingConventions_ValidVariableNameUnitTest extends AbstractSniffUnitTest { /** * Returns the lines where errors should occur. * * The key of the array should represent the line number and the value * should represent the number of errors that should occur on that line. * * @return array */ public function getErrorList() { return array( 3 => 1, 5 => 1, 11 => 1, 13 => 1, 17 => 1, 19 => 1, 23 => 1, 25 => 1, 29 => 1, 31 => 1, 36 => 1, 38 => 1, 42 => 1, 44 => 1, 48 => 1, 50 => 1, 61 => 1, 67 => 1, 72 => 1, 74 => 1, 75 => 1, 76 => 1, 79 => 1, 96 => 1, 99 => 1, ); }//end getErrorList() /** * Returns the lines where warnings should occur. * * The key of the array should represent the line number and the value * should represent the number of warnings that should occur on that line. * * @return array */ public function getWarningList() { return array( 6 => 1, 14 => 1, 20 => 1, 26 => 1, 32 => 1, 39 => 1, 45 => 1, 51 => 1, 64 => 1, 70 => 1, 73 => 1, 76 => 1, 79 => 1, 82 => 1, 94 => 1, ); }//end getWarningList() }//end class ?> PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/Zend/ruleset.xml0000644000076700000240000000220412647543456023540 0ustar gsherwoodstaff A coding standard based on an early Zend Framework coding standard. Note that this standard is out of date. PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/AbstractPatternSniff.php0000644000076700000240000010701412647543456025240 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_IncorrectPatternException', true) === false) { $error = 'Class PHP_CodeSniffer_Standards_IncorrectPatternException not found'; throw new PHP_CodeSniffer_Exception($error); } /** * Processes pattern strings and checks that the code conforms to the pattern. * * This test essentially checks that code is correctly formatted with whitespace. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ abstract class PHP_CodeSniffer_Standards_AbstractPatternSniff implements PHP_CodeSniffer_Sniff { /** * If true, comments will be ignored if they are found in the code. * * @var boolean */ public $ignoreComments = false; /** * The current file being checked. * * @var string */ protected $currFile = ''; /** * The parsed patterns array. * * @var array */ private $_parsedPatterns = array(); /** * Tokens that this sniff wishes to process outside of the patterns. * * @var array(int) * @see registerSupplementary() * @see processSupplementary() */ private $_supplementaryTokens = array(); /** * Positions in the stack where errors have occurred. * * @var array() */ private $_errorPos = array(); /** * Constructs a PHP_CodeSniffer_Standards_AbstractPatternSniff. * * @param boolean $ignoreComments If true, comments will be ignored. */ public function __construct($ignoreComments=null) { // This is here for backwards compatibility. if ($ignoreComments !== null) { $this->ignoreComments = $ignoreComments; } $this->_supplementaryTokens = $this->registerSupplementary(); }//end __construct() /** * Registers the tokens to listen to. * * Classes extending AbstractPatternTest should implement the * getPatterns() method to register the patterns they wish to test. * * @return int[] * @see process() */ public final function register() { $listenTypes = array(); $patterns = $this->getPatterns(); foreach ($patterns as $pattern) { $parsedPattern = $this->_parse($pattern); // Find a token position in the pattern that we can use // for a listener token. $pos = $this->_getListenerTokenPos($parsedPattern); $tokenType = $parsedPattern[$pos]['token']; $listenTypes[] = $tokenType; $patternArray = array( 'listen_pos' => $pos, 'pattern' => $parsedPattern, 'pattern_code' => $pattern, ); if (isset($this->_parsedPatterns[$tokenType]) === false) { $this->_parsedPatterns[$tokenType] = array(); } $this->_parsedPatterns[$tokenType][] = $patternArray; }//end foreach return array_unique(array_merge($listenTypes, $this->_supplementaryTokens)); }//end register() /** * Returns the token types that the specified pattern is checking for. * * Returned array is in the format: * * array( * T_WHITESPACE => 0, // 0 is the position where the T_WHITESPACE token * // should occur in the pattern. * ); * * * @param array $pattern The parsed pattern to find the acquire the token * types from. * * @return array */ private function _getPatternTokenTypes($pattern) { $tokenTypes = array(); foreach ($pattern as $pos => $patternInfo) { if ($patternInfo['type'] === 'token') { if (isset($tokenTypes[$patternInfo['token']]) === false) { $tokenTypes[$patternInfo['token']] = $pos; } } } return $tokenTypes; }//end _getPatternTokenTypes() /** * Returns the position in the pattern that this test should register as * a listener for the pattern. * * @param array $pattern The pattern to acquire the listener for. * * @return int The position in the pattern that this test should register * as the listener. * @throws PHP_CodeSniffer_Exception If we could not determine a token * to listen for. */ private function _getListenerTokenPos($pattern) { $tokenTypes = $this->_getPatternTokenTypes($pattern); $tokenCodes = array_keys($tokenTypes); $token = PHP_CodeSniffer_Tokens::getHighestWeightedToken($tokenCodes); // If we could not get a token. if ($token === false) { $error = 'Could not determine a token to listen for'; throw new PHP_CodeSniffer_Exception($error); } return $tokenTypes[$token]; }//end _getListenerTokenPos() /** * Processes the test. * * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where the * token occurred. * @param int $stackPtr The position in the tokens stack * where the listening token type was * found. * * @return void * @see register() */ public final function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $file = $phpcsFile->getFilename(); if ($this->currFile !== $file) { // We have changed files, so clean up. $this->_errorPos = array(); $this->currFile = $file; } $tokens = $phpcsFile->getTokens(); if (in_array($tokens[$stackPtr]['code'], $this->_supplementaryTokens) === true) { $this->processSupplementary($phpcsFile, $stackPtr); } $type = $tokens[$stackPtr]['code']; // If the type is not set, then it must have been a token registered // with registerSupplementary(). if (isset($this->_parsedPatterns[$type]) === false) { return; } $allErrors = array(); // Loop over each pattern that is listening to the current token type // that we are processing. foreach ($this->_parsedPatterns[$type] as $patternInfo) { // If processPattern returns false, then the pattern that we are // checking the code with must not be designed to check that code. $errors = $this->processPattern($patternInfo, $phpcsFile, $stackPtr); if ($errors === false) { // The pattern didn't match. continue; } else if (empty($errors) === true) { // The pattern matched, but there were no errors. break; } foreach ($errors as $stackPtr => $error) { if (isset($this->_errorPos[$stackPtr]) === false) { $this->_errorPos[$stackPtr] = true; $allErrors[$stackPtr] = $error; } } } foreach ($allErrors as $stackPtr => $error) { $phpcsFile->addError($error, $stackPtr); } }//end process() /** * Processes the pattern and verifies the code at $stackPtr. * * @param array $patternInfo Information about the pattern used * for checking, which includes are * parsed token representation of the * pattern. * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where the * token occurred. * @param int $stackPtr The position in the tokens stack where * the listening token type was found. * * @return array */ protected function processPattern( $patternInfo, PHP_CodeSniffer_File $phpcsFile, $stackPtr ) { $tokens = $phpcsFile->getTokens(); $pattern = $patternInfo['pattern']; $patternCode = $patternInfo['pattern_code']; $errors = array(); $found = ''; $ignoreTokens = array(T_WHITESPACE); if ($this->ignoreComments === true) { $ignoreTokens = array_merge($ignoreTokens, PHP_CodeSniffer_Tokens::$commentTokens); } $origStackPtr = $stackPtr; $hasError = false; if ($patternInfo['listen_pos'] > 0) { $stackPtr--; for ($i = ($patternInfo['listen_pos'] - 1); $i >= 0; $i--) { if ($pattern[$i]['type'] === 'token') { if ($pattern[$i]['token'] === T_WHITESPACE) { if ($tokens[$stackPtr]['code'] === T_WHITESPACE) { $found = $tokens[$stackPtr]['content'].$found; } // Only check the size of the whitespace if this is not // the first token. We don't care about the size of // leading whitespace, just that there is some. if ($i !== 0) { if ($tokens[$stackPtr]['content'] !== $pattern[$i]['value']) { $hasError = true; } } } else { // Check to see if this important token is the same as the // previous important token in the pattern. If it is not, // then the pattern cannot be for this piece of code. $prev = $phpcsFile->findPrevious( $ignoreTokens, $stackPtr, null, true ); if ($prev === false || $tokens[$prev]['code'] !== $pattern[$i]['token'] ) { return false; } // If we skipped past some whitespace tokens, then add them // to the found string. $tokenContent = $phpcsFile->getTokensAsString( ($prev + 1), ($stackPtr - $prev - 1) ); $found = $tokens[$prev]['content'].$tokenContent.$found; if (isset($pattern[($i - 1)]) === true && $pattern[($i - 1)]['type'] === 'skip' ) { $stackPtr = $prev; } else { $stackPtr = ($prev - 1); } }//end if } else if ($pattern[$i]['type'] === 'skip') { // Skip to next piece of relevant code. if ($pattern[$i]['to'] === 'parenthesis_closer') { $to = 'parenthesis_opener'; } else { $to = 'scope_opener'; } // Find the previous opener. $next = $phpcsFile->findPrevious( $ignoreTokens, $stackPtr, null, true ); if ($next === false || isset($tokens[$next][$to]) === false) { // If there was not opener, then we must be // using the wrong pattern. return false; } if ($to === 'parenthesis_opener') { $found = '{'.$found; } else { $found = '('.$found; } $found = '...'.$found; // Skip to the opening token. $stackPtr = ($tokens[$next][$to] - 1); } else if ($pattern[$i]['type'] === 'string') { $found = 'abc'; } else if ($pattern[$i]['type'] === 'newline') { if ($this->ignoreComments === true && isset(PHP_CodeSniffer_Tokens::$commentTokens[$tokens[$stackPtr]['code']]) === true ) { $startComment = $phpcsFile->findPrevious( PHP_CodeSniffer_Tokens::$commentTokens, ($stackPtr - 1), null, true ); if ($tokens[$startComment]['line'] !== $tokens[($startComment + 1)]['line']) { $startComment++; } $tokenContent = $phpcsFile->getTokensAsString( $startComment, ($stackPtr - $startComment + 1) ); $found = $tokenContent.$found; $stackPtr = ($startComment - 1); } if ($tokens[$stackPtr]['code'] === T_WHITESPACE) { if ($tokens[$stackPtr]['content'] !== $phpcsFile->eolChar) { $found = $tokens[$stackPtr]['content'].$found; // This may just be an indent that comes after a newline // so check the token before to make sure. If it is a newline, we // can ignore the error here. if (($tokens[($stackPtr - 1)]['content'] !== $phpcsFile->eolChar) && ($this->ignoreComments === true && isset(PHP_CodeSniffer_Tokens::$commentTokens[$tokens[($stackPtr - 1)]['code']]) === false) ) { $hasError = true; } else { $stackPtr--; } } else { $found = 'EOL'.$found; } } else { $found = $tokens[$stackPtr]['content'].$found; $hasError = true; }//end if if ($hasError === false && $pattern[($i - 1)]['type'] !== 'newline') { // Make sure they only have 1 newline. $prev = $phpcsFile->findPrevious($ignoreTokens, ($stackPtr - 1), null, true); if ($prev !== false && $tokens[$prev]['line'] !== $tokens[$stackPtr]['line']) { $hasError = true; } } }//end if }//end for }//end if $stackPtr = $origStackPtr; $lastAddedStackPtr = null; $patternLen = count($pattern); for ($i = $patternInfo['listen_pos']; $i < $patternLen; $i++) { if (isset($tokens[$stackPtr]) === false) { break; } if ($pattern[$i]['type'] === 'token') { if ($pattern[$i]['token'] === T_WHITESPACE) { if ($this->ignoreComments === true) { // If we are ignoring comments, check to see if this current // token is a comment. If so skip it. if (isset(PHP_CodeSniffer_Tokens::$commentTokens[$tokens[$stackPtr]['code']]) === true) { continue; } // If the next token is a comment, the we need to skip the // current token as we should allow a space before a // comment for readability. if (isset($tokens[($stackPtr + 1)]) === true && isset(PHP_CodeSniffer_Tokens::$commentTokens[$tokens[($stackPtr + 1)]['code']]) === true ) { continue; } } $tokenContent = ''; if ($tokens[$stackPtr]['code'] === T_WHITESPACE) { if (isset($pattern[($i + 1)]) === false) { // This is the last token in the pattern, so just compare // the next token of content. $tokenContent = $tokens[$stackPtr]['content']; } else { // Get all the whitespace to the next token. $next = $phpcsFile->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, $stackPtr, null, true ); $tokenContent = $phpcsFile->getTokensAsString( $stackPtr, ($next - $stackPtr) ); $lastAddedStackPtr = $stackPtr; $stackPtr = $next; }//end if if ($stackPtr !== $lastAddedStackPtr) { $found .= $tokenContent; } } else { if ($stackPtr !== $lastAddedStackPtr) { $found .= $tokens[$stackPtr]['content']; $lastAddedStackPtr = $stackPtr; } }//end if if (isset($pattern[($i + 1)]) === true && $pattern[($i + 1)]['type'] === 'skip' ) { // The next token is a skip token, so we just need to make // sure the whitespace we found has *at least* the // whitespace required. if (strpos($tokenContent, $pattern[$i]['value']) !== 0) { $hasError = true; } } else { if ($tokenContent !== $pattern[$i]['value']) { $hasError = true; } } } else { // Check to see if this important token is the same as the // next important token in the pattern. If it is not, then // the pattern cannot be for this piece of code. $next = $phpcsFile->findNext( $ignoreTokens, $stackPtr, null, true ); if ($next === false || $tokens[$next]['code'] !== $pattern[$i]['token'] ) { // The next important token did not match the pattern. return false; } if ($lastAddedStackPtr !== null) { if (($tokens[$next]['code'] === T_OPEN_CURLY_BRACKET || $tokens[$next]['code'] === T_CLOSE_CURLY_BRACKET) && isset($tokens[$next]['scope_condition']) === true && $tokens[$next]['scope_condition'] > $lastAddedStackPtr ) { // This is a brace, but the owner of it is after the current // token, which means it does not belong to any token in // our pattern. This means the pattern is not for us. return false; } if (($tokens[$next]['code'] === T_OPEN_PARENTHESIS || $tokens[$next]['code'] === T_CLOSE_PARENTHESIS) && isset($tokens[$next]['parenthesis_owner']) === true && $tokens[$next]['parenthesis_owner'] > $lastAddedStackPtr ) { // This is a bracket, but the owner of it is after the current // token, which means it does not belong to any token in // our pattern. This means the pattern is not for us. return false; } }//end if // If we skipped past some whitespace tokens, then add them // to the found string. if (($next - $stackPtr) > 0) { $hasComment = false; for ($j = $stackPtr; $j < $next; $j++) { $found .= $tokens[$j]['content']; if (isset(PHP_CodeSniffer_Tokens::$commentTokens[$tokens[$j]['code']]) === true) { $hasComment = true; } } // If we are not ignoring comments, this additional // whitespace or comment is not allowed. If we are // ignoring comments, there needs to be at least one // comment for this to be allowed. if ($this->ignoreComments === false || ($this->ignoreComments === true && $hasComment === false) ) { $hasError = true; } // Even when ignoring comments, we are not allowed to include // newlines without the pattern specifying them, so // everything should be on the same line. if ($tokens[$next]['line'] !== $tokens[$stackPtr]['line']) { $hasError = true; } }//end if if ($next !== $lastAddedStackPtr) { $found .= $tokens[$next]['content']; $lastAddedStackPtr = $next; } if (isset($pattern[($i + 1)]) === true && $pattern[($i + 1)]['type'] === 'skip' ) { $stackPtr = $next; } else { $stackPtr = ($next + 1); } }//end if } else if ($pattern[$i]['type'] === 'skip') { if ($pattern[$i]['to'] === 'unknown') { $next = $phpcsFile->findNext( $pattern[($i + 1)]['token'], $stackPtr ); if ($next === false) { // Couldn't find the next token, so we must // be using the wrong pattern. return false; } $found .= '...'; $stackPtr = $next; } else { // Find the previous opener. $next = $phpcsFile->findPrevious( PHP_CodeSniffer_Tokens::$blockOpeners, $stackPtr ); if ($next === false || isset($tokens[$next][$pattern[$i]['to']]) === false ) { // If there was not opener, then we must // be using the wrong pattern. return false; } $found .= '...'; if ($pattern[$i]['to'] === 'parenthesis_closer') { $found .= ')'; } else { $found .= '}'; } // Skip to the closing token. $stackPtr = ($tokens[$next][$pattern[$i]['to']] + 1); }//end if } else if ($pattern[$i]['type'] === 'string') { if ($tokens[$stackPtr]['code'] !== T_STRING) { $hasError = true; } if ($stackPtr !== $lastAddedStackPtr) { $found .= 'abc'; $lastAddedStackPtr = $stackPtr; } $stackPtr++; } else if ($pattern[$i]['type'] === 'newline') { // Find the next token that contains a newline character. $newline = 0; for ($j = $stackPtr; $j < $phpcsFile->numTokens; $j++) { if (strpos($tokens[$j]['content'], $phpcsFile->eolChar) !== false) { $newline = $j; break; } } if ($newline === 0) { // We didn't find a newline character in the rest of the file. $next = ($phpcsFile->numTokens - 1); $hasError = true; } else { if ($this->ignoreComments === false) { // The newline character cannot be part of a comment. if (isset(PHP_CodeSniffer_Tokens::$commentTokens[$tokens[$newline]['code']]) === true) { $hasError = true; } } if ($newline === $stackPtr) { $next = ($stackPtr + 1); } else { // Check that there were no significant tokens that we // skipped over to find our newline character. $next = $phpcsFile->findNext( $ignoreTokens, $stackPtr, null, true ); if ($next < $newline) { // We skipped a non-ignored token. $hasError = true; } else { $next = ($newline + 1); } } }//end if if ($stackPtr !== $lastAddedStackPtr) { $found .= $phpcsFile->getTokensAsString( $stackPtr, ($next - $stackPtr) ); $diff = ($next - $stackPtr); $lastAddedStackPtr = ($next - 1); } $stackPtr = $next; }//end if }//end for if ($hasError === true) { $error = $this->prepareError($found, $patternCode); $errors[$origStackPtr] = $error; } return $errors; }//end processPattern() /** * Prepares an error for the specified patternCode. * * @param string $found The actual found string in the code. * @param string $patternCode The expected pattern code. * * @return string The error message. */ protected function prepareError($found, $patternCode) { $found = str_replace("\r\n", '\n', $found); $found = str_replace("\n", '\n', $found); $found = str_replace("\r", '\n', $found); $found = str_replace("\t", '\t', $found); $found = str_replace('EOL', '\n', $found); $expected = str_replace('EOL', '\n', $patternCode); $error = "Expected \"$expected\"; found \"$found\""; return $error; }//end prepareError() /** * Returns the patterns that should be checked. * * @return string[] */ protected abstract function getPatterns(); /** * Registers any supplementary tokens that this test might wish to process. * * A sniff may wish to register supplementary tests when it wishes to group * an arbitrary validation that cannot be performed using a pattern, with * other pattern tests. * * @return int[] * @see processSupplementary() */ protected function registerSupplementary() { return array(); }//end registerSupplementary() /** * Processes any tokens registered with registerSupplementary(). * * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where to * process the skip. * @param int $stackPtr The position in the tokens stack to * process. * * @return void * @see registerSupplementary() */ protected function processSupplementary( PHP_CodeSniffer_File $phpcsFile, $stackPtr ) { }//end processSupplementary() /** * Parses a pattern string into an array of pattern steps. * * @param string $pattern The pattern to parse. * * @return array The parsed pattern array. * @see _createSkipPattern() * @see _createTokenPattern() */ private function _parse($pattern) { $patterns = array(); $length = strlen($pattern); $lastToken = 0; $firstToken = 0; for ($i = 0; $i < $length; $i++) { $specialPattern = false; $isLastChar = ($i === ($length - 1)); $oldFirstToken = $firstToken; if (substr($pattern, $i, 3) === '...') { // It's a skip pattern. The skip pattern requires the // content of the token in the "from" position and the token // to skip to. $specialPattern = $this->_createSkipPattern($pattern, ($i - 1)); $lastToken = ($i - $firstToken); $firstToken = ($i + 3); $i = ($i + 2); if ($specialPattern['to'] !== 'unknown') { $firstToken++; } } else if (substr($pattern, $i, 3) === 'abc') { $specialPattern = array('type' => 'string'); $lastToken = ($i - $firstToken); $firstToken = ($i + 3); $i = ($i + 2); } else if (substr($pattern, $i, 3) === 'EOL') { $specialPattern = array('type' => 'newline'); $lastToken = ($i - $firstToken); $firstToken = ($i + 3); $i = ($i + 2); }//end if if ($specialPattern !== false || $isLastChar === true) { // If we are at the end of the string, don't worry about a limit. if ($isLastChar === true) { // Get the string from the end of the last skip pattern, if any, // to the end of the pattern string. $str = substr($pattern, $oldFirstToken); } else { // Get the string from the end of the last special pattern, // if any, to the start of this special pattern. if ($lastToken === 0) { // Note that if the last special token was zero characters ago, // there will be nothing to process so we can skip this bit. // This happens if you have something like: EOL... in your pattern. $str = ''; } else { $str = substr($pattern, $oldFirstToken, $lastToken); } } if ($str !== '') { $tokenPatterns = $this->_createTokenPattern($str); foreach ($tokenPatterns as $tokenPattern) { $patterns[] = $tokenPattern; } } // Make sure we don't skip the last token. if ($isLastChar === false && $i === ($length - 1)) { $i--; } }//end if // Add the skip pattern *after* we have processed // all the tokens from the end of the last skip pattern // to the start of this skip pattern. if ($specialPattern !== false) { $patterns[] = $specialPattern; } }//end for return $patterns; }//end _parse() /** * Creates a skip pattern. * * @param string $pattern The pattern being parsed. * @param string $from The token content that the skip pattern starts from. * * @return array The pattern step. * @see _createTokenPattern() * @see _parse() */ private function _createSkipPattern($pattern, $from) { $skip = array('type' => 'skip'); $nestedParenthesis = 0; $nestedBraces = 0; for ($start = $from; $start >= 0; $start--) { switch ($pattern[$start]) { case '(': if ($nestedParenthesis === 0) { $skip['to'] = 'parenthesis_closer'; } $nestedParenthesis--; break; case '{': if ($nestedBraces === 0) { $skip['to'] = 'scope_closer'; } $nestedBraces--; break; case '}': $nestedBraces++; break; case ')': $nestedParenthesis++; break; }//end switch if (isset($skip['to']) === true) { break; } }//end for if (isset($skip['to']) === false) { $skip['to'] = 'unknown'; } return $skip; }//end _createSkipPattern() /** * Creates a token pattern. * * @param string $str The tokens string that the pattern should match. * * @return array The pattern step. * @see _createSkipPattern() * @see _parse() */ private function _createTokenPattern($str) { // Don't add a space after the closing php tag as it will add a new // whitespace token. $tokenizer = new PHP_CodeSniffer_Tokenizers_PHP(); $tokens = $tokenizer->tokenizeString(''); // Remove the 'token', 'token' => $patternInfo['code'], 'value' => $patternInfo['content'], ); } return $patterns; }//end _createTokenPattern() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/AbstractScopeSniff.php0000644000076700000240000001453412647543456024700 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * An AbstractScopeTest allows for tests that extend from this class to * listen for tokens within a particular scope. * * Below is a test that listens to methods that exist only within classes: * * class ClassScopeTest extends PHP_CodeSniffer_Standards_AbstractScopeSniff * { * public function __construct() * { * parent::__construct(array(T_CLASS), array(T_FUNCTION)); * } * * protected function processTokenWithinScope(PHP_CodeSniffer_File $phpcsFile, $) * { * $className = $phpcsFile->getDeclarationName($currScope); * echo 'encountered a method within class '.$className; * } * } * * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ abstract class PHP_CodeSniffer_Standards_AbstractScopeSniff implements PHP_CodeSniffer_Sniff { /** * The token types that this test wishes to listen to within the scope. * * @var array */ private $_tokens = array(); /** * The type of scope opener tokens that this test wishes to listen to. * * @var string */ private $_scopeTokens = array(); /** * True if this test should fire on tokens outside of the scope. * * @var boolean */ private $_listenOutside = false; /** * Constructs a new AbstractScopeTest. * * @param array $scopeTokens The type of scope the test wishes to listen to. * @param array $tokens The tokens that the test wishes to listen to * within the scope. * @param boolean $listenOutside If true this test will also alert the * extending class when a token is found outside * the scope, by calling the * processTokenOutsideScope method. * * @see PHP_CodeSniffer.getValidScopeTokeners() * @throws PHP_CodeSniffer_Exception If the specified tokens array is empty. */ public function __construct( array $scopeTokens, array $tokens, $listenOutside=false ) { if (empty($scopeTokens) === true) { $error = 'The scope tokens list cannot be empty'; throw new PHP_CodeSniffer_Exception($error); } if (empty($tokens) === true) { $error = 'The tokens list cannot be empty'; throw new PHP_CodeSniffer_Exception($error); } $invalidScopeTokens = array_intersect($scopeTokens, $tokens); if (empty($invalidScopeTokens) === false) { $invalid = implode(', ', $invalidScopeTokens); $error = "Scope tokens [$invalid] cant be in the tokens array"; throw new PHP_CodeSniffer_Exception($error); } $this->_listenOutside = $listenOutside; $this->_scopeTokens = array_flip($scopeTokens); $this->_tokens = $tokens; }//end __construct() /** * The method that is called to register the tokens this test wishes to * listen to. * * DO NOT OVERRIDE THIS METHOD. Use the constructor of this class to register * for the desired tokens and scope. * * @return int[] * @see __constructor() */ public final function register() { return $this->_tokens; }//end register() /** * Processes the tokens that this test is listening for. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position in the stack where this * token was found. * * @return void * @see processTokenWithinScope() */ public final function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr) { $tokens = $phpcsFile->getTokens(); $foundScope = false; foreach ($tokens[$stackPtr]['conditions'] as $scope => $code) { if (isset($this->_scopeTokens[$code]) === true) { $this->processTokenWithinScope($phpcsFile, $stackPtr, $scope); $foundScope = true; } } if ($this->_listenOutside === true && $foundScope === false) { $this->processTokenOutsideScope($phpcsFile, $stackPtr); } }//end process() /** * Processes a token that is found within the scope that this test is * listening to. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position in the stack where this * token was found. * @param int $currScope The position in the tokens array that * opened the scope that this test is * listening for. * * @return void */ protected abstract function processTokenWithinScope( PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope ); /** * Processes a token that is found within the scope that this test is * listening to. * * @param PHP_CodeSniffer_File $phpcsFile The file where this token was found. * @param int $stackPtr The position in the stack where this * token was found. * * @return void */ protected function processTokenOutsideScope( PHP_CodeSniffer_File $phpcsFile, $stackPtr ) { }//end processTokenOutsideScope() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/AbstractVariableSniff.php0000644000076700000240000001754512647543456025361 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Standards_AbstractScopeSniff', true) === false) { $error = 'Class PHP_CodeSniffer_Standards_AbstractScopeSniff not found'; throw new PHP_CodeSniffer_Exception($error); } /** * A class to find T_VARIABLE tokens. * * This class can distinguish between normal T_VARIABLE tokens, and those tokens * that represent class members. If a class member is encountered, then then * processMemberVar method is called so the extending class can process it. If * the token is found to be a normal T_VARIABLE token, then processVariable is * called. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ abstract class PHP_CodeSniffer_Standards_AbstractVariableSniff extends PHP_CodeSniffer_Standards_AbstractScopeSniff { /** * The end token of the current function that we are in. * * @var int */ private $_endFunction = -1; /** * TRUE if a function is currently open. * * @var boolean */ private $_functionOpen = false; /** * The current PHP_CodeSniffer file that we are processing. * * @var PHP_CodeSniffer_File */ protected $currentFile = null; /** * Constructs an AbstractVariableTest. */ public function __construct() { $scopes = array( T_CLASS, T_TRAIT, T_INTERFACE, ); $listen = array( T_FUNCTION, T_VARIABLE, T_DOUBLE_QUOTED_STRING, T_HEREDOC, ); parent::__construct($scopes, $listen, true); }//end __construct() /** * Processes the token in the specified PHP_CodeSniffer_File. * * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this * token was found. * @param int $stackPtr The position where the token was found. * @param array $currScope The current scope opener token. * * @return void */ protected final function processTokenWithinScope( PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope ) { if ($this->currentFile !== $phpcsFile) { $this->currentFile = $phpcsFile; $this->_functionOpen = false; $this->_endFunction = -1; } $tokens = $phpcsFile->getTokens(); if ($stackPtr > $this->_endFunction) { $this->_functionOpen = false; } if ($tokens[$stackPtr]['code'] === T_FUNCTION && $this->_functionOpen === false ) { $this->_functionOpen = true; $methodProps = $phpcsFile->getMethodProperties($stackPtr); // If the function is abstract, or is in an interface, // then set the end of the function to it's closing semicolon. if ($methodProps['is_abstract'] === true || $tokens[$currScope]['code'] === T_INTERFACE ) { $this->_endFunction = $phpcsFile->findNext(array(T_SEMICOLON), $stackPtr); } else { if (isset($tokens[$stackPtr]['scope_closer']) === false) { $error = 'Possible parse error: non-abstract method defined as abstract'; $phpcsFile->addWarning($error, $stackPtr); return; } $this->_endFunction = $tokens[$stackPtr]['scope_closer']; } }//end if if ($tokens[$stackPtr]['code'] === T_DOUBLE_QUOTED_STRING || $tokens[$stackPtr]['code'] === T_HEREDOC ) { // Check to see if this string has a variable in it. $pattern = '|(?processVariableInString($phpcsFile, $stackPtr); } return; } if ($this->_functionOpen === true) { if ($tokens[$stackPtr]['code'] === T_VARIABLE) { $this->processVariable($phpcsFile, $stackPtr); } } else { // What if we assign a member variable to another? // ie. private $_count = $this->_otherCount + 1;. $this->processMemberVar($phpcsFile, $stackPtr); } }//end processTokenWithinScope() /** * Processes the token outside the scope in the file. * * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this * token was found. * @param int $stackPtr The position where the token was found. * * @return void */ protected final function processTokenOutsideScope( PHP_CodeSniffer_File $phpcsFile, $stackPtr ) { $tokens = $phpcsFile->getTokens(); // These variables are not member vars. if ($tokens[$stackPtr]['code'] === T_VARIABLE) { $this->processVariable($phpcsFile, $stackPtr); } else if ($tokens[$stackPtr]['code'] === T_DOUBLE_QUOTED_STRING || $tokens[$stackPtr]['code'] === T_HEREDOC ) { // Check to see if this string has a variable in it. $pattern = '|(?processVariableInString($phpcsFile, $stackPtr); } } }//end processTokenOutsideScope() /** * Called to process class member vars. * * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this * token was found. * @param int $stackPtr The position where the token was found. * * @return void */ abstract protected function processMemberVar( PHP_CodeSniffer_File $phpcsFile, $stackPtr ); /** * Called to process normal member vars. * * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this * token was found. * @param int $stackPtr The position where the token was found. * * @return void */ abstract protected function processVariable( PHP_CodeSniffer_File $phpcsFile, $stackPtr ); /** * Called to process variables found in double quoted strings or heredocs. * * Note that there may be more than one variable in the string, which will * result only in one call for the string or one call per line for heredocs. * * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where this * token was found. * @param int $stackPtr The position where the double quoted * string was found. * * @return void */ abstract protected function processVariableInString( PHP_CodeSniffer_File $phpcsFile, $stackPtr ); }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Standards/IncorrectPatternException.php0000644000076700000240000000213212647543456026311 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * An exception thrown if the pattern being processed is not supposed to be * validating the code in question. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Standards_IncorrectPatternException extends Exception { }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Tokenizers/Comment.php0000644000076700000240000002252712647543456022772 0ustar gsherwoodstaff * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Tokenizes doc block comments. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Tokenizers_Comment { /** * Creates an array of tokens when given some PHP code. * * Starts by using token_get_all() but does a lot of extra processing * to insert information about the context of the token. * * @param string $string The string to tokenize. * @param string $eolChar The EOL character to use for splitting strings. * @param int $stackPtr The position of the first token in the file. * * @return array */ public function tokenizeString($string, $eolChar, $stackPtr) { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t*** START COMMENT TOKENIZING ***".PHP_EOL; } $tokens = array(); $numChars = strlen($string); /* Doc block comments start with /*, but typically contain an extra star when they are used for function and class comments. */ $char = ($numChars - strlen(ltrim($string, '/*'))); $openTag = substr($string, 0, $char); $string = ltrim($string, '/*'); $tokens[$stackPtr] = array( 'content' => $openTag, 'code' => T_DOC_COMMENT_OPEN_TAG, 'type' => 'T_DOC_COMMENT_OPEN_TAG', 'comment_tags' => array(), ); $openPtr = $stackPtr; $stackPtr++; if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($openTag); echo "\t\tCreate comment token: T_DOC_COMMENT_OPEN_TAG => $content".PHP_EOL; } /* Strip off the close tag so it doesn't interfere with any of our comment line processing. The token will be added to the stack just before we return it. */ $closeTag = array( 'content' => substr($string, strlen(rtrim($string, '/*'))), 'code' => T_DOC_COMMENT_CLOSE_TAG, 'type' => 'T_DOC_COMMENT_CLOSE_TAG', 'comment_opener' => $openPtr, ); $string = rtrim($string, '/*'); /* Process each line of the comment. */ $lines = explode($eolChar, $string); $numLines = count($lines); foreach ($lines as $lineNum => $string) { if ($lineNum !== ($numLines - 1)) { $string .= $eolChar; } $char = 0; $numChars = strlen($string); // We've started a new line, so process the indent. $space = $this->_collectWhitespace($string, $char, $numChars); if ($space !== null) { $tokens[$stackPtr] = $space; $stackPtr++; if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($space['content']); $type = $lineToken['type']; echo "\t\tCreate comment token: T_DOC_COMMENT_WHITESPACE => $content".PHP_EOL; } $char += strlen($space['content']); if ($char === $numChars) { break; } } if ($string === '') { continue; } if ($string[$char] === '*') { // This is a function or class doc block line. $char++; $tokens[$stackPtr] = array( 'content' => '*', 'code' => T_DOC_COMMENT_STAR, 'type' => 'T_DOC_COMMENT_STAR', ); $stackPtr++; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\tCreate comment token: T_DOC_COMMENT_STAR => *".PHP_EOL; } } // Now we are ready to process the actual content of the line. $lineTokens = $this->_processLine($string, $eolChar, $char, $numChars); foreach ($lineTokens as $lineToken) { $tokens[$stackPtr] = $lineToken; if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($lineToken['content']); $type = $lineToken['type']; echo "\t\tCreate comment token: $type => $content".PHP_EOL; } if ($lineToken['code'] === T_DOC_COMMENT_TAG) { $tokens[$openPtr]['comment_tags'][] = $stackPtr; } $stackPtr++; } }//end foreach $tokens[$stackPtr] = $closeTag; $tokens[$openPtr]['comment_closer'] = $stackPtr; if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($closeTag['content']); echo "\t\tCreate comment token: T_DOC_COMMENT_CLOSE_TAG => $content".PHP_EOL; } if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t*** END COMMENT TOKENIZING ***".PHP_EOL; } return $tokens; }//end tokenizeString() /** * Process a single line of a comment. * * @param string $string The comment string being tokenized. * @param string $eolChar The EOL character to use for splitting strings. * @param int $start The position in the string to start processing. * @param int $end The position in the string to end processing. * * @return array */ private function _processLine($string, $eolChar, $start, $end) { $tokens = array(); // Collect content padding. $space = $this->_collectWhitespace($string, $start, $end); if ($space !== null) { $tokens[] = $space; $start += strlen($space['content']); } if (isset($string[$start]) === false) { return $tokens; } if ($string[$start] === '@') { // The content up until the first whitespace is the tag name. $matches = array(); preg_match('/@[^\s]+/', $string, $matches, 0, $start); if (isset($matches[0]) === true) { $tagName = $matches[0]; $start += strlen($tagName); $tokens[] = array( 'content' => $tagName, 'code' => T_DOC_COMMENT_TAG, 'type' => 'T_DOC_COMMENT_TAG', ); // Then there will be some whitespace. $space = $this->_collectWhitespace($string, $start, $end); if ($space !== null) { $tokens[] = $space; $start += strlen($space['content']); } } }//end if // Process the rest of the line. $eol = strpos($string, $eolChar, $start); if ($eol === false) { $eol = $end; } if ($eol > $start) { $tokens[] = array( 'content' => substr($string, $start, ($eol - $start)), 'code' => T_DOC_COMMENT_STRING, 'type' => 'T_DOC_COMMENT_STRING', ); } if ($eol !== $end) { $tokens[] = array( 'content' => substr($string, $eol, strlen($eolChar)), 'code' => T_DOC_COMMENT_WHITESPACE, 'type' => 'T_DOC_COMMENT_WHITESPACE', ); } return $tokens; }//end _processLine() /** * Collect consecutive whitespace into a single token. * * @param string $string The comment string being tokenized. * @param int $start The position in the string to start processing. * @param int $end The position in the string to end processing. * * @return array|null */ private function _collectWhitespace($string, $start, $end) { $space = ''; for ($start; $start < $end; $start++) { if ($string[$start] !== ' ' && $string[$start] !== "\t") { break; } $space .= $string[$start]; } if ($space === '') { return null; } $token = array( 'content' => $space, 'code' => T_DOC_COMMENT_WHITESPACE, 'type' => 'T_DOC_COMMENT_WHITESPACE', ); return $token; }//end _collectWhitespace() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Tokenizers/CSS.php0000644000076700000240000005157412647543456022024 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ if (class_exists('PHP_CodeSniffer_Tokenizers_PHP', true) === false) { throw new Exception('Class PHP_CodeSniffer_Tokenizers_PHP not found'); } /** * Tokenizes CSS code. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Tokenizers_CSS extends PHP_CodeSniffer_Tokenizers_PHP { /** * Creates an array of tokens when given some CSS code. * * Uses the PHP tokenizer to do all the tricky work * * @param string $string The string to tokenize. * @param string $eolChar The EOL character to use for splitting strings. * * @return array */ public function tokenizeString($string, $eolChar='\n') { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** START CSS TOKENIZING 1ST PASS ***".PHP_EOL; } // If the content doesn't have an EOL char on the end, add one so // the open and close tags we add are parsed correctly. $eolAdded = false; if (substr($string, (strlen($eolChar) * -1)) !== $eolChar) { $string .= $eolChar; $eolAdded = true; } $string = str_replace('', '^PHPCS_CSS_T_CLOSE_TAG^', $string); $tokens = parent::tokenizeString('', $eolChar); $finalTokens = array(); $finalTokens[0] = array( 'code' => T_OPEN_TAG, 'type' => 'T_OPEN_TAG', 'content' => '', ); $newStackPtr = 1; $numTokens = count($tokens); $multiLineComment = false; for ($stackPtr = 1; $stackPtr < $numTokens; $stackPtr++) { $token = $tokens[$stackPtr]; // CSS files don't have lists, breaks etc, so convert these to // standard strings early so they can be converted into T_STYLE // tokens and joined with other strings if needed. if ($token['code'] === T_BREAK || $token['code'] === T_LIST || $token['code'] === T_DEFAULT || $token['code'] === T_SWITCH || $token['code'] === T_FOR || $token['code'] === T_FOREACH || $token['code'] === T_WHILE ) { $token['type'] = 'T_STRING'; $token['code'] = T_STRING; } if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $token['type']; $content = PHP_CodeSniffer::prepareForOutput($token['content']); echo "\tProcess token $stackPtr: $type => $content".PHP_EOL; } if ($token['code'] === T_BITWISE_XOR && $tokens[($stackPtr + 1)]['content'] === 'PHPCS_CSS_T_OPEN_TAG' ) { $content = ''; $stackPtr += 2; break; } else { $content .= $tokens[$stackPtr]['content']; } } if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t=> Found embedded PHP code: "; $cleanContent = PHP_CodeSniffer::prepareForOutput($content); echo $cleanContent.PHP_EOL; } $finalTokens[$newStackPtr] = array( 'type' => 'T_EMBEDDED_PHP', 'code' => T_EMBEDDED_PHP, 'content' => $content, ); $newStackPtr++; continue; }//end if if ($token['code'] === T_GOTO_LABEL) { // Convert these back to T_STRING followed by T_COLON so we can // more easily process style definitions. $finalTokens[$newStackPtr] = array( 'type' => 'T_STRING', 'code' => T_STRING, 'content' => substr($token['content'], 0, -1), ); $newStackPtr++; $finalTokens[$newStackPtr] = array( 'type' => 'T_COLON', 'code' => T_COLON, 'content' => ':', ); $newStackPtr++; continue; } if ($token['code'] === T_FUNCTION) { // There are no functions in CSS, so convert this to a string. $finalTokens[$newStackPtr] = array( 'type' => 'T_STRING', 'code' => T_STRING, 'content' => $token['content'], ); $newStackPtr++; continue; } if ($token['code'] === T_COMMENT && substr($token['content'], 0, 2) === '/*' ) { // Multi-line comment. Record it so we can ignore other // comment tags until we get out of this one. $multiLineComment = true; } if ($token['code'] === T_COMMENT && $multiLineComment === false && (substr($token['content'], 0, 2) === '//' || $token['content']{0} === '#') ) { $content = ltrim($token['content'], '#/'); // Guard against PHP7+ syntax errors by stripping // leading zeros so the content doesn't look like an invalid int. $leadingZero = false; if ($content{0} === '0') { $content = '1'.$content; $leadingZero = true; } $commentTokens = parent::tokenizeString('', $eolChar); // The first and last tokens are the open/close tags. array_shift($commentTokens); array_pop($commentTokens); if ($leadingZero === true) { $commentTokens[0]['content'] = substr($commentTokens[0]['content'], 1); $content = substr($content, 1); } if ($token['content']{0} === '#') { // The # character is not a comment in CSS files, so // determine what it means in this context. $firstContent = $commentTokens[0]['content']; // If the first content is just a number, it is probably a // colour like 8FB7DB, which PHP splits into 8 and FB7DB. if (($commentTokens[0]['code'] === T_LNUMBER || $commentTokens[0]['code'] === T_DNUMBER) && $commentTokens[1]['code'] === T_STRING ) { $firstContent .= $commentTokens[1]['content']; array_shift($commentTokens); } // If the first content looks like a colour and not a class // definition, join the tokens together. if (preg_match('/^[ABCDEF0-9]+$/i', $firstContent) === 1 && $commentTokens[1]['content'] !== '-' ) { array_shift($commentTokens); // Work out what we trimmed off above and remember to re-add it. $trimmed = substr($token['content'], 0, (strlen($token['content']) - strlen($content))); $finalTokens[$newStackPtr] = array( 'type' => 'T_COLOUR', 'code' => T_COLOUR, 'content' => $trimmed.$firstContent, ); } else { $finalTokens[$newStackPtr] = array( 'type' => 'T_HASH', 'code' => T_HASH, 'content' => '#', ); } } else { $finalTokens[$newStackPtr] = array( 'type' => 'T_STRING', 'code' => T_STRING, 'content' => '//', ); }//end if $newStackPtr++; array_splice($tokens, $stackPtr, 1, $commentTokens); $numTokens = count($tokens); $stackPtr--; continue; }//end if if ($token['code'] === T_COMMENT && substr($token['content'], -2) === '*/' ) { // Multi-line comment is done. $multiLineComment = false; } $finalTokens[$newStackPtr] = $token; $newStackPtr++; }//end for if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** END CSS TOKENIZING 1ST PASS ***".PHP_EOL; echo "\t*** START CSS TOKENIZING 2ND PASS ***".PHP_EOL; } // A flag to indicate if we are inside a style definition, // which is defined using curly braces. $inStyleDef = false; // A flag to indicate if an At-rule like "@media" is used, which will result // in nested curly brackets. $asperandStart = false; $numTokens = count($finalTokens); for ($stackPtr = 0; $stackPtr < $numTokens; $stackPtr++) { $token = $finalTokens[$stackPtr]; if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $token['type']; $content = PHP_CodeSniffer::prepareForOutput($token['content']); echo "\tProcess token $stackPtr: $type => $content".PHP_EOL; } switch ($token['code']) { case T_OPEN_CURLY_BRACKET: // Opening curly brackets for an At-rule do not start a style // definition. We also reset the asperand flag here because the next // opening curly bracket could be indeed the start of a style // definition. if ($asperandStart === true) { if (PHP_CODESNIFFER_VERBOSITY > 1) { if ($inStyleDef === true) { echo "\t\t* style definition closed *".PHP_EOL; } if ($asperandStart === true) { echo "\t\t* at-rule definition closed *".PHP_EOL; } } $inStyleDef = false; $asperandStart = false; } else { $inStyleDef = true; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* style definition opened *".PHP_EOL; } } break; case T_CLOSE_CURLY_BRACKET: if (PHP_CODESNIFFER_VERBOSITY > 1) { if ($inStyleDef === true) { echo "\t\t* style definition closed *".PHP_EOL; } if ($asperandStart === true) { echo "\t\t* at-rule definition closed *".PHP_EOL; } } $inStyleDef = false; $asperandStart = false; break; case T_MINUS: // Minus signs are often used instead of spaces inside // class names, IDs and styles. if ($finalTokens[($stackPtr + 1)]['code'] === T_STRING) { if ($finalTokens[($stackPtr - 1)]['code'] === T_STRING) { $newContent = $finalTokens[($stackPtr - 1)]['content'].'-'.$finalTokens[($stackPtr + 1)]['content']; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* token is a string joiner; ignoring this and previous token".PHP_EOL; $old = PHP_CodeSniffer::prepareForOutput($finalTokens[($stackPtr + 1)]['content']); $new = PHP_CodeSniffer::prepareForOutput($newContent); echo "\t\t=> token ".($stackPtr + 1)." content changed from \"$old\" to \"$new\"".PHP_EOL; } $finalTokens[($stackPtr + 1)]['content'] = $newContent; unset($finalTokens[$stackPtr]); unset($finalTokens[($stackPtr - 1)]); } else { $newContent = '-'.$finalTokens[($stackPtr + 1)]['content']; $finalTokens[($stackPtr + 1)]['content'] = $newContent; unset($finalTokens[$stackPtr]); } } else if ($finalTokens[($stackPtr + 1)]['code'] === T_LNUMBER) { // They can also be used to provide negative numbers. if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* token is part of a negative number; adding content to next token and ignoring *".PHP_EOL; $content = PHP_CodeSniffer::prepareForOutput($finalTokens[($stackPtr + 1)]['content']); echo "\t\t=> token ".($stackPtr + 1)." content changed from \"$content\" to \"-$content\"".PHP_EOL; } $finalTokens[($stackPtr + 1)]['content'] = '-'.$finalTokens[($stackPtr + 1)]['content']; unset($finalTokens[$stackPtr]); }//end if break; case T_COLON: // Only interested in colons that are defining styles. if ($inStyleDef === false) { break; } for ($x = ($stackPtr - 1); $x >= 0; $x--) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$finalTokens[$x]['code']]) === false) { break; } } if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $finalTokens[$x]['type']; echo "\t\t=> token $x changed from $type to T_STYLE".PHP_EOL; } $finalTokens[$x]['type'] = 'T_STYLE'; $finalTokens[$x]['code'] = T_STYLE; break; case T_STRING: if (strtolower($token['content']) === 'url') { // Find the next content. for ($x = ($stackPtr + 1); $x < $numTokens; $x++) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$finalTokens[$x]['code']]) === false) { break; } } // Needs to be in the format "url(" for it to be a URL. if ($finalTokens[$x]['code'] !== T_OPEN_PARENTHESIS) { continue; } // Make sure the content isn't empty. for ($y = ($x + 1); $y < $numTokens; $y++) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$finalTokens[$y]['code']]) === false) { break; } } if ($finalTokens[$y]['code'] === T_CLOSE_PARENTHESIS) { continue; } if (PHP_CODESNIFFER_VERBOSITY > 1) { for ($i = ($stackPtr + 1); $i <= $y; $i++) { $type = $finalTokens[$i]['type']; $content = PHP_CodeSniffer::prepareForOutput($finalTokens[$i]['content']); echo "\tProcess token $i: $type => $content".PHP_EOL; } echo "\t\t* token starts a URL *".PHP_EOL; } // Join all the content together inside the url() statement. $newContent = ''; for ($i = ($x + 2); $i < $numTokens; $i++) { if ($finalTokens[$i]['code'] === T_CLOSE_PARENTHESIS) { break; } $newContent .= $finalTokens[$i]['content']; if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($finalTokens[$i]['content']); echo "\t\t=> token $i added to URL string and ignored: $content".PHP_EOL; } unset($finalTokens[$i]); } $stackPtr = $i; // If the content inside the "url()" is in double quotes // there will only be one token and so we don't have to do // anything except change its type. If it is not empty, // we need to do some token merging. $finalTokens[($x + 1)]['type'] = 'T_URL'; $finalTokens[($x + 1)]['code'] = T_URL; if ($newContent !== '') { $finalTokens[($x + 1)]['content'] .= $newContent; if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($finalTokens[($x + 1)]['content']); echo "\t\t=> token content changed to: $content".PHP_EOL; } } }//end if break; case T_ASPERAND: $asperandStart = true; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* at-rule definition opened *".PHP_EOL; } break; default: // Nothing special to be done with this token. break; }//end switch }//end for // Reset the array keys to avoid gaps. $finalTokens = array_values($finalTokens); $numTokens = count($finalTokens); // Blank out the content of the end tag. $finalTokens[($numTokens - 1)]['content'] = ''; if ($eolAdded === true) { // Strip off the extra EOL char we added for tokenizing. $finalTokens[($numTokens - 2)]['content'] = substr( $finalTokens[($numTokens - 2)]['content'], 0, (strlen($eolChar) * -1) ); if ($finalTokens[($numTokens - 2)]['content'] === '') { unset($finalTokens[($numTokens - 2)]); $finalTokens = array_values($finalTokens); $numTokens = count($finalTokens); } } if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** END CSS TOKENIZING 2ND PASS ***".PHP_EOL; } return $finalTokens; }//end tokenizeString() /** * Performs additional processing after main tokenizing. * * @param array $tokens The array of tokens to process. * @param string $eolChar The EOL character to use for splitting strings. * * @return void */ public function processAdditional(&$tokens, $eolChar) { /* We override this method because we don't want the PHP version to run during CSS processing because it is wasted processing time. */ }//end processAdditional() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Tokenizers/JS.php0000644000076700000240000014251212647543456021701 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Tokenizes JS code. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Tokenizers_JS { /** * A list of tokens that are allowed to open a scope. * * This array also contains information about what kind of token the scope * opener uses to open and close the scope, if the token strictly requires * an opener, if the token can share a scope closer, and who it can be shared * with. An example of a token that shares a scope closer is a CASE scope. * * @var array */ public $scopeOpeners = array( T_IF => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => false, 'shared' => false, 'with' => array(), ), T_TRY => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => true, 'shared' => false, 'with' => array(), ), T_CATCH => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => true, 'shared' => false, 'with' => array(), ), T_ELSE => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => false, 'shared' => false, 'with' => array(), ), T_FOR => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => false, 'shared' => false, 'with' => array(), ), T_FUNCTION => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => false, 'shared' => false, 'with' => array(), ), T_WHILE => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => false, 'shared' => false, 'with' => array(), ), T_DO => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => true, 'shared' => false, 'with' => array(), ), T_SWITCH => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => true, 'shared' => false, 'with' => array(), ), T_CASE => array( 'start' => array(T_COLON => T_COLON), 'end' => array( T_BREAK => T_BREAK, T_RETURN => T_RETURN, T_CONTINUE => T_CONTINUE, T_THROW => T_THROW, ), 'strict' => true, 'shared' => true, 'with' => array( T_DEFAULT => T_DEFAULT, T_CASE => T_CASE, T_SWITCH => T_SWITCH, ), ), T_DEFAULT => array( 'start' => array(T_COLON => T_COLON), 'end' => array( T_BREAK => T_BREAK, T_RETURN => T_RETURN, T_CONTINUE => T_CONTINUE, T_THROW => T_THROW, ), 'strict' => true, 'shared' => true, 'with' => array( T_CASE => T_CASE, T_SWITCH => T_SWITCH, ), ), ); /** * A list of tokens that end the scope. * * This array is just a unique collection of the end tokens * from the _scopeOpeners array. The data is duplicated here to * save time during parsing of the file. * * @var array */ public $endScopeTokens = array( T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET, T_BREAK => T_BREAK, ); /** * A list of special JS tokens and their types. * * @var array */ protected $tokenValues = array( 'function' => 'T_FUNCTION', 'prototype' => 'T_PROTOTYPE', 'try' => 'T_TRY', 'catch' => 'T_CATCH', 'return' => 'T_RETURN', 'throw' => 'T_THROW', 'break' => 'T_BREAK', 'switch' => 'T_SWITCH', 'continue' => 'T_CONTINUE', 'if' => 'T_IF', 'else' => 'T_ELSE', 'do' => 'T_DO', 'while' => 'T_WHILE', 'for' => 'T_FOR', 'var' => 'T_VAR', 'case' => 'T_CASE', 'default' => 'T_DEFAULT', 'true' => 'T_TRUE', 'false' => 'T_FALSE', 'null' => 'T_NULL', 'this' => 'T_THIS', 'typeof' => 'T_TYPEOF', '(' => 'T_OPEN_PARENTHESIS', ')' => 'T_CLOSE_PARENTHESIS', '{' => 'T_OPEN_CURLY_BRACKET', '}' => 'T_CLOSE_CURLY_BRACKET', '[' => 'T_OPEN_SQUARE_BRACKET', ']' => 'T_CLOSE_SQUARE_BRACKET', '?' => 'T_INLINE_THEN', '.' => 'T_OBJECT_OPERATOR', '+' => 'T_PLUS', '-' => 'T_MINUS', '*' => 'T_MULTIPLY', '%' => 'T_MODULUS', '/' => 'T_DIVIDE', '^' => 'T_LOGICAL_XOR', ',' => 'T_COMMA', ';' => 'T_SEMICOLON', ':' => 'T_COLON', '<' => 'T_LESS_THAN', '>' => 'T_GREATER_THAN', '<=' => 'T_IS_SMALLER_OR_EQUAL', '>=' => 'T_IS_GREATER_OR_EQUAL', '!' => 'T_BOOLEAN_NOT', '||' => 'T_BOOLEAN_OR', '&&' => 'T_BOOLEAN_AND', '|' => 'T_BITWISE_OR', '&' => 'T_BITWISE_AND', '!=' => 'T_IS_NOT_EQUAL', '!==' => 'T_IS_NOT_IDENTICAL', '=' => 'T_EQUAL', '==' => 'T_IS_EQUAL', '===' => 'T_IS_IDENTICAL', '-=' => 'T_MINUS_EQUAL', '+=' => 'T_PLUS_EQUAL', '*=' => 'T_MUL_EQUAL', '/=' => 'T_DIV_EQUAL', '%=' => 'T_MOD_EQUAL', '++' => 'T_INC', '--' => 'T_DEC', '//' => 'T_COMMENT', '/*' => 'T_COMMENT', '/**' => 'T_DOC_COMMENT', '*/' => 'T_COMMENT', ); /** * A list string delimiters. * * @var array */ protected $stringTokens = array( '\'' => '\'', '"' => '"', ); /** * A list tokens that start and end comments. * * @var array */ protected $commentTokens = array( '//' => null, '/*' => '*/', '/**' => '*/', ); /** * Creates an array of tokens when given some PHP code. * * Starts by using token_get_all() but does a lot of extra processing * to insert information about the context of the token. * * @param string $string The string to tokenize. * @param string $eolChar The EOL character to use for splitting strings. * * @return array */ public function tokenizeString($string, $eolChar='\n') { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** START JS TOKENIZING ***".PHP_EOL; } $maxTokenLength = 0; foreach ($this->tokenValues as $token => $values) { if (strlen($token) > $maxTokenLength) { $maxTokenLength = strlen($token); } } $tokens = array(); $inString = ''; $stringChar = null; $inComment = ''; $buffer = ''; $preStringBuffer = ''; $cleanBuffer = false; $commentTokenizer = new PHP_CodeSniffer_Tokenizers_Comment(); $tokens[] = array( 'code' => T_OPEN_TAG, 'type' => 'T_OPEN_TAG', 'content' => '', ); // Convert newlines to single characters for ease of // processing. We will change them back later. $string = str_replace($eolChar, "\n", $string); $chars = str_split($string); $numChars = count($chars); for ($i = 0; $i < $numChars; $i++) { $char = $chars[$i]; if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($char); $bufferContent = PHP_CodeSniffer::prepareForOutput($buffer); if ($inString !== '') { echo "\t"; } if ($inComment !== '') { echo "\t"; } echo "\tProcess char $i => $content (buffer: $bufferContent)".PHP_EOL; }//end if if ($inString === '' && $inComment === '' && $buffer !== '') { // If the buffer only has whitespace and we are about to // add a character, store the whitespace first. if (trim($char) !== '' && trim($buffer) === '') { $tokens[] = array( 'code' => T_WHITESPACE, 'type' => 'T_WHITESPACE', 'content' => str_replace("\n", $eolChar, $buffer), ); if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($buffer); echo "\t=> Added token T_WHITESPACE ($content)".PHP_EOL; } $buffer = ''; } // If the buffer is not whitespace and we are about to // add a whitespace character, store the content first. if ($inString === '' && $inComment === '' && trim($char) === '' && trim($buffer) !== '' ) { $tokens[] = array( 'code' => T_STRING, 'type' => 'T_STRING', 'content' => str_replace("\n", $eolChar, $buffer), ); if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($buffer); echo "\t=> Added token T_STRING ($content)".PHP_EOL; } $buffer = ''; } }//end if // Process strings. if ($inComment === '' && isset($this->stringTokens[$char]) === true) { if ($inString === $char) { // This could be the end of the string, but make sure it // is not escaped first. $escapes = 0; for ($x = ($i - 1); $x >= 0; $x--) { if ($chars[$x] !== '\\') { break; } $escapes++; } if ($escapes === 0 || ($escapes % 2) === 0) { // There is an even number escape chars, // so this is not escaped, it is the end of the string. $tokens[] = array( 'code' => T_CONSTANT_ENCAPSED_STRING, 'type' => 'T_CONSTANT_ENCAPSED_STRING', 'content' => str_replace("\n", $eolChar, $buffer).$char, ); if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* found end of string *".PHP_EOL; $content = PHP_CodeSniffer::prepareForOutput($buffer.$char); echo "\t=> Added token T_CONSTANT_ENCAPSED_STRING ($content)".PHP_EOL; } $buffer = ''; $preStringBuffer = ''; $inString = ''; $stringChar = null; continue; }//end if } else if ($inString === '') { $inString = $char; $stringChar = $i; $preStringBuffer = $buffer; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* looking for string closer *".PHP_EOL; } }//end if }//end if if ($inString !== '' && $char === "\n") { // Unless this newline character is escaped, the string did not // end before the end of the line, which means it probably // wasn't a string at all (maybe a regex). if ($chars[($i - 1)] !== '\\') { $i = $stringChar; $buffer = $preStringBuffer; $preStringBuffer = ''; $inString = ''; $stringChar = null; $char = $chars[$i]; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* found newline before end of string, bailing *".PHP_EOL; } } } $buffer .= $char; // We don't look for special tokens inside strings, // so if we are in a string, we can continue here now // that the current char is in the buffer. if ($inString !== '') { continue; } // Special case for T_DIVIDE which can actually be // the start of a regular expression. if ($buffer === $char && $char === '/' && $chars[($i + 1)] !== '*') { $regex = $this->getRegexToken( $i, $string, $chars, $tokens, $eolChar ); if ($regex !== null) { $tokens[] = array( 'code' => T_REGULAR_EXPRESSION, 'type' => 'T_REGULAR_EXPRESSION', 'content' => $regex['content'], ); if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($regex['content']); echo "\t=> Added token T_REGULAR_EXPRESSION ($content)".PHP_EOL; } $i = $regex['end']; $buffer = ''; $cleanBuffer = false; continue; }//end if }//end if // Check for known tokens, but ignore tokens found that are not at // the end of a string, like FOR and this.FORmat. if (isset($this->tokenValues[strtolower($buffer)]) === true && (preg_match('|[a-zA-z0-9_]|', $char) === 0 || isset($chars[($i + 1)]) === false || preg_match('|[a-zA-z0-9_]|', $chars[($i + 1)]) === 0) ) { $matchedToken = false; $lookAheadLength = ($maxTokenLength - strlen($buffer)); if ($lookAheadLength > 0) { // The buffer contains a token type, but we need // to look ahead at the next chars to see if this is // actually part of a larger token. For example, // FOR and FOREACH. if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* buffer possibly contains token, looking ahead $lookAheadLength chars *".PHP_EOL; } $charBuffer = $buffer; for ($x = 1; $x <= $lookAheadLength; $x++) { if (isset($chars[($i + $x)]) === false) { break; } $charBuffer .= $chars[($i + $x)]; if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($charBuffer); echo "\t\t=> Looking ahead $x chars => $content".PHP_EOL; } if (isset($this->tokenValues[strtolower($charBuffer)]) === true) { // We've found something larger that matches // so we can ignore this char. Except for 1 very specific // case where a comment like /**/ needs to tokenize as // T_COMMENT and not T_DOC_COMMENT. $oldType = $this->tokenValues[strtolower($buffer)]; $newType = $this->tokenValues[strtolower($charBuffer)]; if ($oldType === 'T_COMMENT' && $newType === 'T_DOC_COMMENT' && $chars[($i + $x + 1)] === '/' ) { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* look ahead ignored T_DOC_COMMENT, continuing *".PHP_EOL; } } else { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* look ahead found more specific token ($newType), ignoring $i *".PHP_EOL; } $matchedToken = true; break; } }//end if }//end for }//end if if ($matchedToken === false) { if (PHP_CODESNIFFER_VERBOSITY > 1 && $lookAheadLength > 0) { echo "\t\t* look ahead found nothing *".PHP_EOL; } $value = $this->tokenValues[strtolower($buffer)]; $tokens[] = array( 'code' => constant($value), 'type' => $value, 'content' => $buffer, ); if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($buffer); echo "\t=> Added token $value ($content)".PHP_EOL; } $cleanBuffer = true; }//end if } else if (isset($this->tokenValues[strtolower($char)]) === true) { // No matter what token we end up using, we don't // need the content in the buffer any more because we have // found a valid token. $newContent = substr(str_replace("\n", $eolChar, $buffer), 0, -1); if ($newContent !== '') { $tokens[] = array( 'code' => T_STRING, 'type' => 'T_STRING', 'content' => $newContent, ); if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput(substr($buffer, 0, -1)); echo "\t=> Added token T_STRING ($content)".PHP_EOL; } } if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* char is token, looking ahead ".($maxTokenLength - 1).' chars *'.PHP_EOL; } // The char is a token type, but we need to look ahead at the // next chars to see if this is actually part of a larger token. // For example, = and ===. $charBuffer = $char; $matchedToken = false; for ($x = 1; $x <= $maxTokenLength; $x++) { if (isset($chars[($i + $x)]) === false) { break; } $charBuffer .= $chars[($i + $x)]; if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($charBuffer); echo "\t\t=> Looking ahead $x chars => $content".PHP_EOL; } if (isset($this->tokenValues[strtolower($charBuffer)]) === true) { // We've found something larger that matches // so we can ignore this char. if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $this->tokenValues[strtolower($charBuffer)]; echo "\t\t* look ahead found more specific token ($type), ignoring $i *".PHP_EOL; } $matchedToken = true; break; } }//end for if ($matchedToken === false) { $value = $this->tokenValues[strtolower($char)]; $tokens[] = array( 'code' => constant($value), 'type' => $value, 'content' => $char, ); if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* look ahead found nothing *".PHP_EOL; $content = PHP_CodeSniffer::prepareForOutput($char); echo "\t=> Added token $value ($content)".PHP_EOL; } $cleanBuffer = true; } else { $buffer = $char; }//end if }//end if // Keep track of content inside comments. if ($inComment === '' && array_key_exists($buffer, $this->commentTokens) === true ) { // This is not really a comment if the content // looks like \// (i.e., it is escaped). if (isset($chars[($i - 2)]) === true && $chars[($i - 2)] === '\\') { $lastToken = array_pop($tokens); $lastContent = $lastToken['content']; if (PHP_CODESNIFFER_VERBOSITY > 1) { $value = $this->tokenValues[strtolower($lastContent)]; $content = PHP_CodeSniffer::prepareForOutput($lastContent); echo "\t=> Removed token $value ($content)".PHP_EOL; } $lastChars = str_split($lastContent); $lastNumChars = count($lastChars); for ($x = 0; $x < $lastNumChars; $x++) { $lastChar = $lastChars[$x]; $value = $this->tokenValues[strtolower($lastChar)]; $tokens[] = array( 'code' => constant($value), 'type' => $value, 'content' => $lastChar, ); if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($lastChar); echo "\t=> Added token $value ($content)".PHP_EOL; } } } else { // We have started a comment. $inComment = $buffer; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* looking for end of comment *".PHP_EOL; } }//end if } else if ($inComment !== '') { if ($this->commentTokens[$inComment] === null) { // Comment ends at the next newline. if (strpos($buffer, "\n") !== false) { $inComment = ''; } } else { if ($this->commentTokens[$inComment] === $buffer) { $inComment = ''; } } if (PHP_CODESNIFFER_VERBOSITY > 1) { if ($inComment === '') { echo "\t\t* found end of comment *".PHP_EOL; } } if ($inComment === '' && $cleanBuffer === false) { $tokens[] = array( 'code' => T_STRING, 'type' => 'T_STRING', 'content' => str_replace("\n", $eolChar, $buffer), ); if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($buffer); echo "\t=> Added token T_STRING ($content)".PHP_EOL; } $buffer = ''; } }//end if if ($cleanBuffer === true) { $buffer = ''; $cleanBuffer = false; } }//end for if (empty($buffer) === false) { // Buffer contains whitespace from the end of the file. $tokens[] = array( 'code' => T_WHITESPACE, 'type' => 'T_WHITESPACE', 'content' => str_replace("\n", $eolChar, $buffer), ); if (PHP_CODESNIFFER_VERBOSITY > 1) { $content = PHP_CodeSniffer::prepareForOutput($buffer); echo "\t=> Added token T_WHITESPACE ($content)".PHP_EOL; } } $tokens[] = array( 'code' => T_CLOSE_TAG, 'type' => 'T_CLOSE_TAG', 'content' => '', ); /* Now that we have done some basic tokenizing, we need to modify the tokens to join some together and split some apart so they match what the PHP tokenizer does. */ $finalTokens = array(); $newStackPtr = 0; $numTokens = count($tokens); for ($stackPtr = 0; $stackPtr < $numTokens; $stackPtr++) { $token = $tokens[$stackPtr]; /* Look for comments and join the tokens together. */ if ($token['code'] === T_COMMENT || $token['code'] === T_DOC_COMMENT) { $newContent = ''; $tokenContent = $token['content']; $endContent = $this->commentTokens[$tokenContent]; while ($tokenContent !== $endContent) { if ($endContent === null && strpos($tokenContent, $eolChar) !== false ) { // A null end token means the comment ends at the end of // the line so we look for newlines and split the token. $tokens[$stackPtr]['content'] = substr( $tokenContent, (strpos($tokenContent, $eolChar) + strlen($eolChar)) ); $tokenContent = substr( $tokenContent, 0, (strpos($tokenContent, $eolChar) + strlen($eolChar)) ); // If the substr failed, skip the token as the content // will now be blank. if ($tokens[$stackPtr]['content'] !== false && $tokens[$stackPtr]['content'] !== '' ) { $stackPtr--; } break; }//end if $stackPtr++; $newContent .= $tokenContent; if (isset($tokens[$stackPtr]) === false) { break; } $tokenContent = $tokens[$stackPtr]['content']; }//end while if ($token['code'] === T_DOC_COMMENT) { $commentTokens = $commentTokenizer->tokenizeString($newContent.$tokenContent, $eolChar, $newStackPtr); foreach ($commentTokens as $commentToken) { $finalTokens[$newStackPtr] = $commentToken; $newStackPtr++; } continue; } else { // Save the new content in the current token so // the code below can chop it up on newlines. $token['content'] = $newContent.$tokenContent; } }//end if /* If this token has newlines in its content, split each line up and create a new token for each line. We do this so it's easier to ascertain where errors occur on a line. Note that $token[1] is the token's content. */ if (strpos($token['content'], $eolChar) !== false) { $tokenLines = explode($eolChar, $token['content']); $numLines = count($tokenLines); for ($i = 0; $i < $numLines; $i++) { $newToken['content'] = $tokenLines[$i]; if ($i === ($numLines - 1)) { if ($tokenLines[$i] === '') { break; } } else { $newToken['content'] .= $eolChar; } $newToken['type'] = $token['type']; $newToken['code'] = $token['code']; $finalTokens[$newStackPtr] = $newToken; $newStackPtr++; } } else { $finalTokens[$newStackPtr] = $token; $newStackPtr++; }//end if // Convert numbers, including decimals. if ($token['code'] === T_STRING || $token['code'] === T_OBJECT_OPERATOR ) { $newContent = ''; $oldStackPtr = $stackPtr; while (preg_match('|^[0-9\.]+$|', $tokens[$stackPtr]['content']) !== 0) { $newContent .= $tokens[$stackPtr]['content']; $stackPtr++; } if ($newContent !== '' && $newContent !== '.') { $finalTokens[($newStackPtr - 1)]['content'] = $newContent; if (ctype_digit($newContent) === true) { $finalTokens[($newStackPtr - 1)]['code'] = constant('T_LNUMBER'); $finalTokens[($newStackPtr - 1)]['type'] = 'T_LNUMBER'; } else { $finalTokens[($newStackPtr - 1)]['code'] = constant('T_DNUMBER'); $finalTokens[($newStackPtr - 1)]['type'] = 'T_DNUMBER'; } $stackPtr--; } else { $stackPtr = $oldStackPtr; } }//end if // Convert the token after an object operator into a string, in most cases. if ($token['code'] === T_OBJECT_OPERATOR) { for ($i = ($stackPtr + 1); $i < $numTokens; $i++) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$i]['code']]) === true) { continue; } if ($tokens[$i]['code'] !== T_PROTOTYPE && $tokens[$i]['code'] !== T_LNUMBER && $tokens[$i]['code'] !== T_DNUMBER ) { $tokens[$i]['code'] = T_STRING; $tokens[$i]['type'] = 'T_STRING'; } break; } } }//end for if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** END TOKENIZING ***".PHP_EOL; } return $finalTokens; }//end tokenizeString() /** * Tokenizes a regular expression if one is found. * * If a regular expression is not found, NULL is returned. * * @param string $char The index of the possible regex start character. * @param string $string The complete content of the string being tokenized. * @param string $chars An array of characters being tokenized. * @param string $tokens The current array of tokens found in the string. * @param string $eolChar The EOL character to use for splitting strings. * * @return void */ public function getRegexToken($char, $string, $chars, $tokens, $eolChar) { $beforeTokens = array( T_EQUAL => true, T_OPEN_PARENTHESIS => true, T_OPEN_SQUARE_BRACKET => true, T_RETURN => true, T_BOOLEAN_OR => true, T_BOOLEAN_AND => true, T_BITWISE_OR => true, T_BITWISE_AND => true, T_COMMA => true, T_COLON => true, T_TYPEOF => true, ); $afterTokens = array( ',' => true, ')' => true, ']' => true, ';' => true, ' ' => true, '.' => true, $eolChar => true, ); // Find the last non-whitespace token that was added // to the tokens array. $numTokens = count($tokens); for ($prev = ($numTokens - 1); $prev >= 0; $prev--) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$prev]['code']]) === false) { break; } } if (isset($beforeTokens[$tokens[$prev]['code']]) === false) { return null; } // This is probably a regular expression, so look for the end of it. if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t* token possibly starts a regular expression *".PHP_EOL; } $numChars = count($chars); for ($next = ($char + 1); $next < $numChars; $next++) { if ($chars[$next] === '/') { // Just make sure this is not escaped first. if ($chars[($next - 1)] !== '\\') { // In the simple form: /.../ so we found the end. break; } else if ($chars[($next - 2)] === '\\') { // In the form: /...\\/ so we found the end. break; } } else { $possibleEolChar = substr($string, $next, strlen($eolChar)); if ($possibleEolChar === $eolChar) { // This is the last token on the line and regular // expressions need to be defined on a single line, // so this is not a regular expression. break; } } } if ($chars[$next] !== '/') { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t* could not find end of regular expression *".PHP_EOL; } return null; } while (preg_match('|[a-zA-Z]|', $chars[($next + 1)]) !== 0) { // The token directly after the end of the regex can // be modifiers like global and case insensitive // (.e.g, /pattern/gi). $next++; } $regexEnd = $next; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t* found end of regular expression at token $regexEnd *".PHP_EOL; } for ($next = ($next + 1); $next < $numChars; $next++) { if ($chars[$next] !== ' ') { break; } else { $possibleEolChar = substr($string, $next, strlen($eolChar)); if ($possibleEolChar === $eolChar) { // This is the last token on the line. break; } } } if (isset($afterTokens[$chars[$next]]) === false) { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t* tokens after regular expression do not look correct *".PHP_EOL; } return null; } // This is a regular expression, so join all the tokens together. $content = ''; for ($x = $char; $x <= $regexEnd; $x++) { $content .= $chars[$x]; } $token = array( 'start' => $char, 'end' => $regexEnd, 'content' => $content, ); return $token; }//end getRegexToken() /** * Performs additional processing after main tokenizing. * * This additional processing looks for properties, closures, labels and objects. * * @param array $tokens The array of tokens to process. * @param string $eolChar The EOL character to use for splitting strings. * * @return void */ public function processAdditional(&$tokens, $eolChar) { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** START ADDITIONAL JS PROCESSING ***".PHP_EOL; } $numTokens = count($tokens); $classStack = array(); for ($i = 0; $i < $numTokens; $i++) { if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$i]['type']; $content = PHP_CodeSniffer::prepareForOutput($tokens[$i]['content']); echo str_repeat("\t", count($classStack)); echo "\tProcess token $i: $type => $content".PHP_EOL; } // Looking for functions that are actually closures. if ($tokens[$i]['code'] === T_FUNCTION && isset($tokens[$i]['scope_opener']) === true) { for ($x = ($i + 1); $x < $numTokens; $x++) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$x]['code']]) === false) { break; } } if ($tokens[$x]['code'] === T_OPEN_PARENTHESIS) { $tokens[$i]['code'] = T_CLOSURE; $tokens[$i]['type'] = 'T_CLOSURE'; if (PHP_CODESNIFFER_VERBOSITY > 1) { $line = $tokens[$i]['line']; echo str_repeat("\t", count($classStack)); echo "\t* token $i on line $line changed from T_FUNCTION to T_CLOSURE".PHP_EOL; } for ($x = ($tokens[$i]['scope_opener'] + 1); $x < $tokens[$i]['scope_closer']; $x++) { if (isset($tokens[$x]['conditions'][$i]) === false) { continue; } $tokens[$x]['conditions'][$i] = T_CLOSURE; if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$x]['type']; echo str_repeat("\t", count($classStack)); echo "\t\t* cleaned $x ($type) *".PHP_EOL; } } }//end if continue; } else if ($tokens[$i]['code'] === T_OPEN_CURLY_BRACKET && isset($tokens[$i]['scope_condition']) === false ) { $classStack[] = $i; $closer = $tokens[$i]['bracket_closer']; $tokens[$i]['code'] = T_OBJECT; $tokens[$i]['type'] = 'T_OBJECT'; $tokens[$closer]['code'] = T_CLOSE_OBJECT; $tokens[$closer]['type'] = 'T_CLOSE_OBJECT'; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", count($classStack)); echo "\t* token $i converted from T_OPEN_CURLY_BRACKET to T_OBJECT *".PHP_EOL; echo str_repeat("\t", count($classStack)); echo "\t* token $closer converted from T_CLOSE_CURLY_BRACKET to T_CLOSE_OBJECT *".PHP_EOL; } for ($x = ($i + 1); $x < $closer; $x++) { $tokens[$x]['conditions'][$i] = T_OBJECT; ksort($tokens[$x]['conditions'], SORT_NUMERIC); if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$x]['type']; echo str_repeat("\t", count($classStack)); echo "\t\t* added T_OBJECT condition to $x ($type) *".PHP_EOL; } } } else if ($tokens[$i]['code'] === T_CLOSE_OBJECT) { $opener = array_pop($classStack); } else if ($tokens[$i]['code'] === T_COLON) { // If it is a scope opener, it belongs to a // DEFAULT or CASE statement. if (isset($tokens[$i]['scope_condition']) === true) { continue; } // Make sure this is not part of an inline IF statement. for ($x = ($i - 1); $x >= 0; $x--) { if ($tokens[$x]['code'] === T_INLINE_THEN) { $tokens[$i]['code'] = T_INLINE_ELSE; $tokens[$i]['type'] = 'T_INLINE_ELSE'; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", count($classStack)); echo "\t* token $i converted from T_COLON to T_INLINE_THEN *".PHP_EOL; } continue(2); } else if ($tokens[$x]['line'] < $tokens[$i]['line']) { break; } } // The string to the left of the colon is either a property or label. for ($label = ($i - 1); $label >= 0; $label--) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$label]['code']]) === false) { break; } } if ($tokens[$label]['code'] !== T_STRING && $tokens[$label]['code'] !== T_CONSTANT_ENCAPSED_STRING ) { continue; } if (empty($classStack) === false) { $tokens[$label]['code'] = T_PROPERTY; $tokens[$label]['type'] = 'T_PROPERTY'; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", count($classStack)); echo "\t* token $label converted from T_STRING to T_PROPERTY *".PHP_EOL; } } else { $tokens[$label]['code'] = T_LABEL; $tokens[$label]['type'] = 'T_LABEL'; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", count($classStack)); echo "\t* token $label converted from T_STRING to T_LABEL *".PHP_EOL; } }//end if }//end if }//end for if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** END ADDITIONAL JS PROCESSING ***".PHP_EOL; } }//end processAdditional() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Tokenizers/PHP.php0000644000076700000240000020643212647543456022016 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Tokenizes PHP code. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Tokenizers_PHP { /** * A list of tokens that are allowed to open a scope. * * This array also contains information about what kind of token the scope * opener uses to open and close the scope, if the token strictly requires * an opener, if the token can share a scope closer, and who it can be shared * with. An example of a token that shares a scope closer is a CASE scope. * * @var array */ public $scopeOpeners = array( T_IF => array( 'start' => array( T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET, T_COLON => T_COLON, ), 'end' => array( T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET, T_ENDIF => T_ENDIF, T_ELSE => T_ELSE, T_ELSEIF => T_ELSEIF, ), 'strict' => false, 'shared' => false, 'with' => array( T_ELSE => T_ELSE, T_ELSEIF => T_ELSEIF, ), ), T_TRY => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => true, 'shared' => false, 'with' => array(), ), T_CATCH => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => true, 'shared' => false, 'with' => array(), ), T_FINALLY => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => true, 'shared' => false, 'with' => array(), ), T_ELSE => array( 'start' => array( T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET, T_COLON => T_COLON, ), 'end' => array( T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET, T_ENDIF => T_ENDIF, ), 'strict' => false, 'shared' => false, 'with' => array( T_IF => T_IF, T_ELSEIF => T_ELSEIF, ), ), T_ELSEIF => array( 'start' => array( T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET, T_COLON => T_COLON, ), 'end' => array( T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET, T_ENDIF => T_ENDIF, T_ELSE => T_ELSE, T_ELSEIF => T_ELSEIF, ), 'strict' => false, 'shared' => false, 'with' => array( T_IF => T_IF, T_ELSE => T_ELSE, ), ), T_FOR => array( 'start' => array( T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET, T_COLON => T_COLON, ), 'end' => array( T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET, T_ENDFOR => T_ENDFOR, ), 'strict' => false, 'shared' => false, 'with' => array(), ), T_FOREACH => array( 'start' => array( T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET, T_COLON => T_COLON, ), 'end' => array( T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET, T_ENDFOREACH => T_ENDFOREACH, ), 'strict' => false, 'shared' => false, 'with' => array(), ), T_INTERFACE => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => true, 'shared' => false, 'with' => array(), ), T_FUNCTION => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => true, 'shared' => false, 'with' => array(), ), T_CLASS => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => true, 'shared' => false, 'with' => array(), ), T_TRAIT => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => true, 'shared' => false, 'with' => array(), ), T_USE => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => false, 'shared' => false, 'with' => array(), ), T_DECLARE => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => false, 'shared' => false, 'with' => array(), ), T_NAMESPACE => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => false, 'shared' => false, 'with' => array(), ), T_WHILE => array( 'start' => array( T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET, T_COLON => T_COLON, ), 'end' => array( T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET, T_ENDWHILE => T_ENDWHILE, ), 'strict' => false, 'shared' => false, 'with' => array(), ), T_DO => array( 'start' => array(T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET), 'end' => array(T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET), 'strict' => true, 'shared' => false, 'with' => array(), ), T_SWITCH => array( 'start' => array( T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET, T_COLON => T_COLON, ), 'end' => array( T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET, T_ENDSWITCH => T_ENDSWITCH, ), 'strict' => true, 'shared' => false, 'with' => array(), ), T_CASE => array( 'start' => array( T_COLON => T_COLON, T_SEMICOLON => T_SEMICOLON, ), 'end' => array( T_BREAK => T_BREAK, T_RETURN => T_RETURN, T_CONTINUE => T_CONTINUE, T_THROW => T_THROW, T_EXIT => T_EXIT, ), 'strict' => true, 'shared' => true, 'with' => array( T_DEFAULT => T_DEFAULT, T_CASE => T_CASE, T_SWITCH => T_SWITCH, ), ), T_DEFAULT => array( 'start' => array( T_COLON => T_COLON, T_SEMICOLON => T_SEMICOLON, ), 'end' => array( T_BREAK => T_BREAK, T_RETURN => T_RETURN, T_CONTINUE => T_CONTINUE, T_THROW => T_THROW, T_EXIT => T_EXIT, ), 'strict' => true, 'shared' => true, 'with' => array( T_CASE => T_CASE, T_SWITCH => T_SWITCH, ), ), T_START_HEREDOC => array( 'start' => array(T_START_HEREDOC => T_START_HEREDOC), 'end' => array(T_END_HEREDOC => T_END_HEREDOC), 'strict' => true, 'shared' => false, 'with' => array(), ), ); /** * A list of tokens that end the scope. * * This array is just a unique collection of the end tokens * from the _scopeOpeners array. The data is duplicated here to * save time during parsing of the file. * * @var array */ public $endScopeTokens = array( T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET, T_ENDIF => T_ENDIF, T_ENDFOR => T_ENDFOR, T_ENDFOREACH => T_ENDFOREACH, T_ENDWHILE => T_ENDWHILE, T_ENDSWITCH => T_ENDSWITCH, T_BREAK => T_BREAK, T_END_HEREDOC => T_END_HEREDOC, ); /** * A cache of different token types, resolved into arrays. * * @var array() * @see standardiseToken() */ private static $_resolveTokenCache = array(); /** * Creates an array of tokens when given some PHP code. * * Starts by using token_get_all() but does a lot of extra processing * to insert information about the context of the token. * * @param string $string The string to tokenize. * @param string $eolChar The EOL character to use for splitting strings. * * @return array */ public function tokenizeString($string, $eolChar='\n') { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** START PHP TOKENIZING ***".PHP_EOL; $isWin = false; if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') { $isWin = true; } } $tokens = @token_get_all($string); $finalTokens = array(); $newStackPtr = 0; $numTokens = count($tokens); $lastNotEmptyToken = 0; $insideInlineIf = array(); $commentTokenizer = new PHP_CodeSniffer_Tokenizers_Comment(); for ($stackPtr = 0; $stackPtr < $numTokens; $stackPtr++) { $token = (array) $tokens[$stackPtr]; $tokenIsArray = isset($token[1]); if (PHP_CODESNIFFER_VERBOSITY > 1) { if ($tokenIsArray === true) { $type = token_name($token[0]); $content = PHP_CodeSniffer::prepareForOutput($token[1]); } else { $newToken = self::resolveSimpleToken($token[0]); $type = $newToken['type']; $content = PHP_CodeSniffer::prepareForOutput($token[0]); } echo "\tProcess token "; if ($tokenIsArray === true) { echo "[$stackPtr]"; } else { echo " $stackPtr "; } echo ": $type => $content"; }//end if if ($newStackPtr > 0 && $finalTokens[($newStackPtr - 1)]['code'] !== T_WHITESPACE) { $lastNotEmptyToken = ($newStackPtr - 1); } /* If we are using \r\n newline characters, the \r and \n are sometimes split over two tokens. This normally occurs after comments. We need to merge these two characters together so that our line endings are consistent for all lines. */ if ($tokenIsArray === true && substr($token[1], -1) === "\r") { if (isset($tokens[($stackPtr + 1)]) === true && is_array($tokens[($stackPtr + 1)]) === true && $tokens[($stackPtr + 1)][1][0] === "\n" ) { $token[1] .= "\n"; if (PHP_CODESNIFFER_VERBOSITY > 1) { if ($isWin === true) { echo '\n'; } else { echo "\033[30;1m\\n\033[0m"; } } if ($tokens[($stackPtr + 1)][1] === "\n") { // This token's content has been merged into the previous, // so we can skip it. $tokens[($stackPtr + 1)] = ''; } else { $tokens[($stackPtr + 1)][1] = substr($tokens[($stackPtr + 1)][1], 1); } } }//end if if (PHP_CODESNIFFER_VERBOSITY > 1) { echo PHP_EOL; } /* Parse doc blocks into something that can be easily iterated over. */ if ($tokenIsArray === true && $token[0] === T_DOC_COMMENT) { $commentTokens = $commentTokenizer->tokenizeString($token[1], $eolChar, $newStackPtr); foreach ($commentTokens as $commentToken) { $finalTokens[$newStackPtr] = $commentToken; $newStackPtr++; } continue; } /* If this is a double quoted string, PHP will tokenize the whole thing which causes problems with the scope map when braces are within the string. So we need to merge the tokens together to provide a single string. */ if ($tokenIsArray === false && ($token[0] === '"' || $token[0] === 'b"')) { // Binary casts need a special token. if ($token[0] === 'b"') { $finalTokens[$newStackPtr] = array( 'code' => T_BINARY_CAST, 'type' => 'T_BINARY_CAST', 'content' => 'b', ); $newStackPtr++; } $tokenContent = '"'; $nestedVars = array(); for ($i = ($stackPtr + 1); $i < $numTokens; $i++) { $subToken = (array) $tokens[$i]; $subTokenIsArray = isset($subToken[1]); if ($subTokenIsArray === true) { $tokenContent .= $subToken[1]; if ($subToken[1] === '{' && $subToken[0] !== T_ENCAPSED_AND_WHITESPACE ) { $nestedVars[] = $i; } } else { $tokenContent .= $subToken[0]; if ($subToken[0] === '}') { array_pop($nestedVars); } } if ($subTokenIsArray === false && $subToken[0] === '"' && empty($nestedVars) === true ) { // We found the other end of the double quoted string. break; } }//end for $stackPtr = $i; // Convert each line within the double quoted string to a // new token, so it conforms with other multiple line tokens. $tokenLines = explode($eolChar, $tokenContent); $numLines = count($tokenLines); $newToken = array(); for ($j = 0; $j < $numLines; $j++) { $newToken['content'] = $tokenLines[$j]; if ($j === ($numLines - 1)) { if ($tokenLines[$j] === '') { break; } } else { $newToken['content'] .= $eolChar; } $newToken['code'] = T_DOUBLE_QUOTED_STRING; $newToken['type'] = 'T_DOUBLE_QUOTED_STRING'; $finalTokens[$newStackPtr] = $newToken; $newStackPtr++; } // Continue, as we're done with this token. continue; }//end if /* If this is a heredoc, PHP will tokenize the whole thing which causes problems when heredocs don't contain real PHP code, which is almost never. We want to leave the start and end heredoc tokens alone though. */ if ($tokenIsArray === true && $token[0] === T_START_HEREDOC) { // Add the start heredoc token to the final array. $finalTokens[$newStackPtr] = self::standardiseToken($token); // Check if this is actually a nowdoc and use a different token // to help the sniffs. $nowdoc = false; if ($token[1][3] === "'") { $finalTokens[$newStackPtr]['code'] = T_START_NOWDOC; $finalTokens[$newStackPtr]['type'] = 'T_START_NOWDOC'; $nowdoc = true; } $newStackPtr++; $tokenContent = ''; for ($i = ($stackPtr + 1); $i < $numTokens; $i++) { $subTokenIsArray = is_array($tokens[$i]); if ($subTokenIsArray === true && $tokens[$i][0] === T_END_HEREDOC ) { // We found the other end of the heredoc. break; } if ($subTokenIsArray === true) { $tokenContent .= $tokens[$i][1]; } else { $tokenContent .= $tokens[$i]; } } $stackPtr = $i; // Convert each line within the heredoc to a // new token, so it conforms with other multiple line tokens. $tokenLines = explode($eolChar, $tokenContent); $numLines = count($tokenLines); $newToken = array(); for ($j = 0; $j < $numLines; $j++) { $newToken['content'] = $tokenLines[$j]; if ($j === ($numLines - 1)) { if ($tokenLines[$j] === '') { break; } } else { $newToken['content'] .= $eolChar; } if ($nowdoc === true) { $newToken['code'] = T_NOWDOC; $newToken['type'] = 'T_NOWDOC'; } else { $newToken['code'] = T_HEREDOC; $newToken['type'] = 'T_HEREDOC'; } $finalTokens[$newStackPtr] = $newToken; $newStackPtr++; }//end for // Add the end heredoc token to the final array. $finalTokens[$newStackPtr] = self::standardiseToken($tokens[$stackPtr]); if ($nowdoc === true) { $finalTokens[$newStackPtr]['code'] = T_END_NOWDOC; $finalTokens[$newStackPtr]['type'] = 'T_END_NOWDOC'; $nowdoc = true; } $newStackPtr++; // Continue, as we're done with this token. continue; }//end if /* Before PHP 5.6, the ... operator was tokenized as three T_STRING_CONCAT tokens in a row. So look for and combine these tokens in earlier versions. */ if ($tokenIsArray === false && $token[0] === '.' && isset($tokens[($stackPtr + 1)]) === true && isset($tokens[($stackPtr + 2)]) === true && $tokens[($stackPtr + 1)] === '.' && $tokens[($stackPtr + 2)] === '.' ) { $newToken = array(); $newToken['code'] = T_ELLIPSIS; $newToken['type'] = 'T_ELLIPSIS'; $newToken['content'] = '...'; $finalTokens[$newStackPtr] = $newToken; $newStackPtr++; $stackPtr += 2; continue; } /* Before PHP 5.6, the ** operator was tokenized as two T_MULTIPLY tokens in a row. So look for and combine these tokens in earlier versions. */ if ($tokenIsArray === false && $token[0] === '*' && isset($tokens[($stackPtr + 1)]) === true && $tokens[($stackPtr + 1)] === '*' ) { $newToken = array(); $newToken['code'] = T_POW; $newToken['type'] = 'T_POW'; $newToken['content'] = '**'; $finalTokens[$newStackPtr] = $newToken; $newStackPtr++; $stackPtr++; continue; } /* Before PHP 7, the <=> operator was tokenized as T_IS_SMALLER_OR_EQUAL followed by T_GREATER_THAN. So look for and combine these tokens in earlier versions. */ if ($tokenIsArray === true && $token[0] === T_IS_SMALLER_OR_EQUAL && isset($tokens[($stackPtr + 1)]) === true && $tokens[($stackPtr + 1)][0] === '>' ) { $newToken = array(); $newToken['code'] = T_SPACESHIP; $newToken['type'] = 'T_SPACESHIP'; $newToken['content'] = '<=>'; $finalTokens[$newStackPtr] = $newToken; $newStackPtr++; $stackPtr++; continue; } /* Emulate traits in PHP versions less than 5.4. */ if ($tokenIsArray === true && $token[0] === T_STRING && strtolower($token[1]) === 'trait' && $tokens[($stackPtr - 1)][0] !== T_OBJECT_OPERATOR ) { $finalTokens[$newStackPtr] = array( 'content' => $token[1], 'code' => T_TRAIT, 'type' => 'T_TRAIT', ); if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* token $stackPtr changed from T_STRING to T_TRAIT".PHP_EOL; } $newStackPtr++; continue; } /* PHP doesn't assign a token to goto labels, so we have to. These are just string tokens with a single colon after them. Double colons are already tokenized and so don't interfere with this check. But we do have to account for CASE statements, that look just like goto labels. */ if ($tokenIsArray === true && $token[0] === T_STRING && $tokens[($stackPtr + 1)] === ':' && $tokens[($stackPtr - 1)][0] !== T_PAAMAYIM_NEKUDOTAYIM ) { $stopTokens = array( T_CASE => true, T_SEMICOLON => true, T_OPEN_CURLY_BRACKET => true, T_INLINE_THEN => true, ); for ($x = ($newStackPtr - 1); $x > 0; $x--) { if (isset($stopTokens[$finalTokens[$x]['code']]) === true) { break; } } if ($finalTokens[$x]['code'] !== T_CASE && $finalTokens[$x]['code'] !== T_INLINE_THEN ) { $finalTokens[$newStackPtr] = array( 'content' => $token[1].':', 'code' => T_GOTO_LABEL, 'type' => 'T_GOTO_LABEL', ); if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* token $stackPtr changed from T_STRING to T_GOTO_LABEL".PHP_EOL; echo "\t\t* skipping T_COLON token ".($stackPtr + 1).PHP_EOL; } $newStackPtr++; $stackPtr++; continue; } }//end if /* HHVM 3.5 tokenizes "else[\s]+if" as a T_ELSEIF token while PHP proper only tokenizes "elseif" as a T_ELSEIF token. So split up the HHVM token to make it looks like proper PHP. */ if ($tokenIsArray === true && $token[0] === T_ELSEIF && strtolower($token[1]) !== 'elseif' ) { $finalTokens[$newStackPtr] = array( 'content' => substr($token[1], 0, 4), 'code' => T_ELSE, 'type' => 'T_ELSE', ); $newStackPtr++; $finalTokens[$newStackPtr] = array( 'content' => substr($token[1], 4, -2), 'code' => T_WHITESPACE, 'type' => 'T_WHITESPACE', ); $newStackPtr++; $finalTokens[$newStackPtr] = array( 'content' => substr($token[1], -2), 'code' => T_IF, 'type' => 'T_IF', ); if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* token $stackPtr changed from T_ELSEIF to T_ELSE/T_WHITESPACE/T_IF".PHP_EOL; } $newStackPtr++; continue; }//end if /* HHVM 3.5 and 3.6 tokenizes a hashbang line such as #!/usr/bin/php as T_HASHANG while PHP proper uses T_INLINE_HTML. */ if ($tokenIsArray === true && token_name($token[0]) === 'T_HASHBANG') { $finalTokens[$newStackPtr] = array( 'content' => $token[1], 'code' => T_INLINE_HTML, 'type' => 'T_INLINE_HTML', ); if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t\t* token $stackPtr changed from T_HASHBANG to T_INLINE_HTML".PHP_EOL; } $newStackPtr++; continue; }//end if /* If this token has newlines in its content, split each line up and create a new token for each line. We do this so it's easier to ascertain where errors occur on a line. Note that $token[1] is the token's content. */ if ($tokenIsArray === true && strpos($token[1], $eolChar) !== false) { $tokenLines = explode($eolChar, $token[1]); $numLines = count($tokenLines); $newToken = array( 'type' => token_name($token[0]), 'code' => $token[0], 'content' => '', ); for ($i = 0; $i < $numLines; $i++) { $newToken['content'] = $tokenLines[$i]; if ($i === ($numLines - 1)) { if ($tokenLines[$i] === '') { break; } } else { $newToken['content'] .= $eolChar; } $finalTokens[$newStackPtr] = $newToken; $newStackPtr++; } } else { if ($tokenIsArray === true && $token[0] === T_STRING) { // Some T_STRING tokens should remain that way // due to their context. $context = array( T_OBJECT_OPERATOR => true, T_FUNCTION => true, T_CLASS => true, T_EXTENDS => true, T_IMPLEMENTS => true, T_NEW => true, T_CONST => true, T_NS_SEPARATOR => true, T_USE => true, T_NAMESPACE => true, T_PAAMAYIM_NEKUDOTAYIM => true, ); if (isset($context[$finalTokens[$lastNotEmptyToken]['code']]) === true) { $finalTokens[$newStackPtr] = array( 'content' => $token[1], 'code' => T_STRING, 'type' => 'T_STRING', ); $newStackPtr++; continue; } }//end if $newToken = null; if ($tokenIsArray === false) { if (isset(self::$_resolveTokenCache[$token[0]]) === true) { $newToken = self::$_resolveTokenCache[$token[0]]; } } else { $cacheKey = null; if ($token[0] === T_STRING) { $cacheKey = strtolower($token[1]); } else if ($token[0] !== T_CURLY_OPEN) { $cacheKey = $token[0]; } if ($cacheKey !== null && isset(self::$_resolveTokenCache[$cacheKey]) === true) { $newToken = self::$_resolveTokenCache[$cacheKey]; $newToken['content'] = $token[1]; } } if ($newToken === null) { $newToken = self::standardiseToken($token); } // Convert colons that are actually the ELSE component of an // inline IF statement. if ($newToken['code'] === T_INLINE_THEN) { $insideInlineIf[] = $stackPtr; } else if (empty($insideInlineIf) === false && $newToken['code'] === T_COLON) { array_pop($insideInlineIf); $newToken['code'] = T_INLINE_ELSE; $newToken['type'] = 'T_INLINE_ELSE'; } // This is a special condition for T_ARRAY tokens used for // type hinting function arguments as being arrays. We want to keep // the parenthesis map clean, so let's tag these tokens as // T_ARRAY_HINT. if ($newToken['code'] === T_ARRAY) { // Recalculate number of tokens. for ($i = $stackPtr; $i < $numTokens; $i++) { if ($tokens[$i] === '(') { break; } else if ($tokens[$i][0] === T_VARIABLE) { $newToken['code'] = T_ARRAY_HINT; $newToken['type'] = 'T_ARRAY_HINT'; break; } } } // This is a special case when checking PHP 5.5+ code in PHP < 5.5 // where "finally" should be T_FINALLY instead of T_STRING. if ($newToken['code'] === T_STRING && strtolower($newToken['content']) === 'finally' ) { $newToken['code'] = T_FINALLY; $newToken['type'] = 'T_FINALLY'; } // This is a special case for the PHP 5.5 classname::class syntax // where "class" should be T_STRING instead of T_CLASS. if ($newToken['code'] === T_CLASS && $finalTokens[($newStackPtr - 1)]['code'] === T_DOUBLE_COLON ) { $newToken['code'] = T_STRING; $newToken['type'] = 'T_STRING'; } // This is a special case for PHP 5.6 use function and use const // where "function" and "const" should be T_STRING instead of T_FUNCTION // and T_CONST. if (($newToken['code'] === T_FUNCTION || $newToken['code'] === T_CONST) && $finalTokens[$lastNotEmptyToken]['code'] === T_USE ) { $newToken['code'] = T_STRING; $newToken['type'] = 'T_STRING'; } $finalTokens[$newStackPtr] = $newToken; $newStackPtr++; }//end if }//end for if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** END PHP TOKENIZING ***".PHP_EOL; } return $finalTokens; }//end tokenizeString() /** * Performs additional processing after main tokenizing. * * This additional processing checks for CASE statements that are using curly * braces for scope openers and closers. It also turns some T_FUNCTION tokens * into T_CLOSURE when they are not standard function definitions. It also * detects short array syntax and converts those square brackets into new tokens. * It also corrects some usage of the static and class keywords. It also * assigns tokens to function return types. * * @param array $tokens The array of tokens to process. * @param string $eolChar The EOL character to use for splitting strings. * * @return void */ public function processAdditional(&$tokens, $eolChar) { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** START ADDITIONAL PHP PROCESSING ***".PHP_EOL; } $numTokens = count($tokens); for ($i = ($numTokens - 1); $i >= 0; $i--) { // Check for any unset scope conditions due to alternate IF/ENDIF syntax. if (isset($tokens[$i]['scope_opener']) === true && isset($tokens[$i]['scope_condition']) === false ) { $tokens[$i]['scope_condition'] = $tokens[$tokens[$i]['scope_opener']]['scope_condition']; } if ($tokens[$i]['code'] === T_FUNCTION) { // Context sensitive keywords support. for ($x = ($i + 1); $i < $numTokens; $x++) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$x]['code']]) === false) { // Non-whitespace content. break; } } if (in_array($tokens[$x]['code'], array(T_STRING, T_OPEN_PARENTHESIS, T_BITWISE_AND), true) === false) { if (PHP_CODESNIFFER_VERBOSITY > 1) { $line = $tokens[$x]['line']; $type = $tokens[$x]['type']; echo "\t* token $x on line $line changed from $type to T_STRING".PHP_EOL; } $tokens[$x]['code'] = T_STRING; $tokens[$x]['type'] = 'T_STRING'; } /* Detect functions that are actually closures and assign them a different token. */ if (isset($tokens[$i]['scope_opener']) === true) { for ($x = ($i + 1); $x < $numTokens; $x++) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$x]['code']]) === false && $tokens[$x]['code'] !== T_BITWISE_AND ) { break; } } if ($tokens[$x]['code'] === T_OPEN_PARENTHESIS) { $tokens[$i]['code'] = T_CLOSURE; $tokens[$i]['type'] = 'T_CLOSURE'; if (PHP_CODESNIFFER_VERBOSITY > 1) { $line = $tokens[$i]['line']; echo "\t* token $i on line $line changed from T_FUNCTION to T_CLOSURE".PHP_EOL; } for ($x = ($tokens[$i]['scope_opener'] + 1); $x < $tokens[$i]['scope_closer']; $x++) { if (isset($tokens[$x]['conditions'][$i]) === false) { continue; } $tokens[$x]['conditions'][$i] = T_CLOSURE; if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$x]['type']; echo "\t\t* cleaned $x ($type) *".PHP_EOL; } } } $tokenAfterReturnTypeHint = $tokens[$i]['scope_opener']; } else if (isset($tokens[$i]['parenthesis_closer']) === true) { for ($x = ($tokens[$i]['parenthesis_closer'] + 1); $i < $numTokens; $x++) { if ($tokens[$x]['code'] === T_SEMICOLON) { $tokenAfterReturnTypeHint = $x; break; } } } else { // Probably a syntax error. continue; }//end if /* Detect function return values and assign them a special token, because PHP doesn't. */ for ($x = ($tokenAfterReturnTypeHint - 1); $x > $i; $x--) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$x]['code']]) === false) { if ($tokens[$x]['code'] === T_STRING || $tokens[$x]['code'] === T_ARRAY) { if (PHP_CODESNIFFER_VERBOSITY > 1) { $line = $tokens[$x]['line']; $type = $tokens[$x]['type']; echo "\t* token $x on line $line changed from $type to T_RETURN_TYPE".PHP_EOL; } $tokens[$x]['code'] = T_RETURN_TYPE; $tokens[$x]['type'] = 'T_RETURN_TYPE'; } break; } } continue; } else if ($tokens[$i]['code'] === T_CLASS && isset($tokens[$i]['scope_opener']) === true) { /* Detect anonymous classes and assign them a different token. */ for ($x = ($i + 1); $x < $numTokens; $x++) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$x]['code']]) === false) { break; } } if ($tokens[$x]['code'] === T_OPEN_PARENTHESIS || $tokens[$x]['code'] === T_OPEN_CURLY_BRACKET ) { $tokens[$i]['code'] = T_ANON_CLASS; $tokens[$i]['type'] = 'T_ANON_CLASS'; if (PHP_CODESNIFFER_VERBOSITY > 1) { $line = $tokens[$i]['line']; echo "\t* token $i on line $line changed from T_CLASS to T_ANON_CLASS".PHP_EOL; } for ($x = ($tokens[$i]['scope_opener'] + 1); $x < $tokens[$i]['scope_closer']; $x++) { if (isset($tokens[$x]['conditions'][$i]) === false) { continue; } $tokens[$x]['conditions'][$i] = T_ANON_CLASS; if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$x]['type']; echo "\t\t* cleaned $x ($type) *".PHP_EOL; } } } continue; } else if ($tokens[$i]['code'] === T_OPEN_SQUARE_BRACKET) { // Unless there is a variable or a bracket before this token, // it is the start of an array being defined using the short syntax. for ($x = ($i - 1); $x > 0; $x--) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$x]['code']]) === false) { break; } } $allowed = array( T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET, T_CLOSE_SQUARE_BRACKET => T_CLOSE_SQUARE_BRACKET, T_CLOSE_PARENTHESIS => T_CLOSE_PARENTHESIS, T_VARIABLE => T_VARIABLE, T_STRING => T_STRING, ); if (isset($allowed[$tokens[$x]['code']]) === false && isset($tokens[$i]['bracket_closer']) === true ) { $tokens[$i]['code'] = T_OPEN_SHORT_ARRAY; $tokens[$i]['type'] = 'T_OPEN_SHORT_ARRAY'; $closer = $tokens[$i]['bracket_closer']; $tokens[$closer]['code'] = T_CLOSE_SHORT_ARRAY; $tokens[$closer]['type'] = 'T_CLOSE_SHORT_ARRAY'; if (PHP_CODESNIFFER_VERBOSITY > 1) { $line = $tokens[$i]['line']; echo "\t* token $i on line $line changed from T_OPEN_SQUARE_BRACKET to T_OPEN_SHORT_ARRAY".PHP_EOL; $line = $tokens[$closer]['line']; echo "\t* token $closer on line $line changed from T_CLOSE_SQUARE_BRACKET to T_CLOSE_SHORT_ARRAY".PHP_EOL; } } continue; } else if ($tokens[$i]['code'] === T_STATIC) { for ($x = ($i - 1); $x > 0; $x--) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$x]['code']]) === false) { break; } } if ($tokens[$x]['code'] === T_INSTANCEOF) { $tokens[$i]['code'] = T_STRING; $tokens[$i]['type'] = 'T_STRING'; if (PHP_CODESNIFFER_VERBOSITY > 1) { $line = $tokens[$i]['line']; echo "\t* token $i on line $line changed from T_STATIC to T_STRING".PHP_EOL; } } continue; } else if ($tokens[$i]['code'] === T_ECHO && $tokens[$i]['content'] === ' 1) { $line = $tokens[$i]['line']; echo "\t* token $i on line $line changed from T_ECHO to T_OPEN_TAG_WITH_ECHO".PHP_EOL; } } else if ($tokens[$i]['code'] === T_TRUE || $tokens[$i]['code'] === T_FALSE || $tokens[$i]['code'] === T_NULL ) { for ($x = ($i + 1); $i < $numTokens; $x++) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$x]['code']]) === false) { // Non-whitespace content. break; } } $context = array( T_OBJECT_OPERATOR => true, T_NS_SEPARATOR => true, T_PAAMAYIM_NEKUDOTAYIM => true, ); if (isset($context[$tokens[$x]['code']]) === true) { if (PHP_CODESNIFFER_VERBOSITY > 1) { $line = $tokens[$i]['line']; $type = $tokens[$i]['type']; echo "\t* token $i on line $line changed from $type to T_STRING".PHP_EOL; } $tokens[$i]['code'] = T_STRING; $tokens[$i]['type'] = 'T_STRING'; } } else if ($tokens[$i]['code'] === T_CONST) { // Context sensitive keywords support. for ($x = ($i + 1); $i < $numTokens; $x++) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$x]['code']]) === false) { // Non-whitespace content. break; } } if ($tokens[$x]['code'] !== T_STRING) { if (PHP_CODESNIFFER_VERBOSITY > 1) { $line = $tokens[$x]['line']; $type = $tokens[$x]['type']; echo "\t* token $x on line $line changed from $type to T_STRING".PHP_EOL; } $tokens[$x]['code'] = T_STRING; $tokens[$x]['type'] = 'T_STRING'; } } else if ($tokens[$i]['code'] === T_PAAMAYIM_NEKUDOTAYIM) { // Context sensitive keywords support. for ($x = ($i + 1); $i < $numTokens; $x++) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$x]['code']]) === false) { // Non-whitespace content. break; } } if (in_array($tokens[$x]['code'], array(T_STRING, T_VARIABLE, T_DOLLAR), true) === false) { if (PHP_CODESNIFFER_VERBOSITY > 1) { $line = $tokens[$x]['line']; $type = $tokens[$x]['type']; echo "\t* token $x on line $line changed from $type to T_STRING".PHP_EOL; } $tokens[$x]['code'] = T_STRING; $tokens[$x]['type'] = 'T_STRING'; } }//end if if (($tokens[$i]['code'] !== T_CASE && $tokens[$i]['code'] !== T_DEFAULT) || isset($tokens[$i]['scope_opener']) === false ) { // Only interested in CASE and DEFAULT statements from here on in. continue; } $scopeOpener = $tokens[$i]['scope_opener']; $scopeCloser = $tokens[$i]['scope_closer']; // If the first char after the opener is a curly brace // and that brace has been ignored, it is actually // opening this case statement and the opener and closer are // probably set incorrectly. for ($x = ($scopeOpener + 1); $x < $numTokens; $x++) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$x]['code']]) === false) { // Non-whitespace content. break; } } if ($tokens[$x]['code'] === T_CASE) { // Special case for multiple CASE statements that share the same // closer. Because we are going backwards through the file, this next // CASE statement is already fixed, so just use its closer and don't // worry about fixing anything. $newCloser = $tokens[$x]['scope_closer']; $tokens[$i]['scope_closer'] = $newCloser; if (PHP_CODESNIFFER_VERBOSITY > 1) { $oldType = $tokens[$scopeCloser]['type']; $newType = $tokens[$newCloser]['type']; $line = $tokens[$i]['line']; echo "\t* token $i (T_CASE) on line $line closer changed from $scopeCloser ($oldType) to $newCloser ($newType)".PHP_EOL; } continue; } if ($tokens[$x]['code'] !== T_OPEN_CURLY_BRACKET || isset($tokens[$x]['scope_condition']) === true ) { // Not a CASE with a curly brace opener. continue; } // The closer for this CASE/DEFAULT should be the closing curly brace and // not whatever it already is. The opener needs to be the opening curly // brace so everything matches up. $newCloser = $tokens[$x]['bracket_closer']; foreach (array($i, $x, $newCloser) as $index) { $tokens[$index]['scope_condition'] = $i; $tokens[$index]['scope_opener'] = $x; $tokens[$index]['scope_closer'] = $newCloser; } unset($tokens[$scopeOpener]['scope_condition']); unset($tokens[$scopeOpener]['scope_opener']); unset($tokens[$scopeOpener]['scope_closer']); unset($tokens[$scopeCloser]['scope_condition']); unset($tokens[$scopeCloser]['scope_opener']); unset($tokens[$scopeCloser]['scope_closer']); unset($tokens[$x]['bracket_opener']); unset($tokens[$x]['bracket_closer']); unset($tokens[$newCloser]['bracket_opener']); unset($tokens[$newCloser]['bracket_closer']); $tokens[$scopeCloser]['conditions'][] = $i; if (PHP_CODESNIFFER_VERBOSITY > 1) { $line = $tokens[$i]['line']; $tokenType = $tokens[$i]['type']; $oldType = $tokens[$scopeOpener]['type']; $newType = $tokens[$x]['type']; echo "\t* token $i ($tokenType) on line $line opener changed from $scopeOpener ($oldType) to $x ($newType)".PHP_EOL; $oldType = $tokens[$scopeCloser]['type']; $newType = $tokens[$newCloser]['type']; echo "\t* token $i ($tokenType) on line $line closer changed from $scopeCloser ($oldType) to $newCloser ($newType)".PHP_EOL; } // Now fix up all the tokens that think they are // inside the CASE/DEFAULT statement when they are really outside. for ($x = $newCloser; $x < $scopeCloser; $x++) { foreach ($tokens[$x]['conditions'] as $num => $oldCond) { if ($oldCond === $tokens[$i]['code']) { $oldConditions = $tokens[$x]['conditions']; unset($tokens[$x]['conditions'][$num]); if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$x]['type']; $oldConds = ''; foreach ($oldConditions as $condition) { $oldConds .= token_name($condition).','; } $oldConds = rtrim($oldConds, ','); $newConds = ''; foreach ($tokens[$x]['conditions'] as $condition) { $newConds .= token_name($condition).','; } $newConds = rtrim($newConds, ','); echo "\t\t* cleaned $x ($type) *".PHP_EOL; echo "\t\t\t=> conditions changed from $oldConds to $newConds".PHP_EOL; } break; }//end if }//end foreach }//end for }//end for if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** END ADDITIONAL PHP PROCESSING ***".PHP_EOL; } }//end processAdditional() /** * Takes a token produced from token_get_all() and produces a * more uniform token. * * @param string|array $token The token to convert. * * @return array The new token. */ public static function standardiseToken($token) { if (isset($token[1]) === false) { if (isset(self::$_resolveTokenCache[$token[0]]) === true) { return self::$_resolveTokenCache[$token[0]]; } } else { $cacheKey = null; if ($token[0] === T_STRING) { $cacheKey = strtolower($token[1]); } else if ($token[0] !== T_CURLY_OPEN) { $cacheKey = $token[0]; } if ($cacheKey !== null && isset(self::$_resolveTokenCache[$cacheKey]) === true) { $newToken = self::$_resolveTokenCache[$cacheKey]; $newToken['content'] = $token[1]; return $newToken; } } if (isset($token[1]) === false) { return self::resolveSimpleToken($token[0]); } if ($token[0] === T_STRING) { switch ($cacheKey) { case 'false': $newToken['type'] = 'T_FALSE'; break; case 'true': $newToken['type'] = 'T_TRUE'; break; case 'null': $newToken['type'] = 'T_NULL'; break; case 'self': $newToken['type'] = 'T_SELF'; break; case 'parent': $newToken['type'] = 'T_PARENT'; break; default: $newToken['type'] = 'T_STRING'; break; } $newToken['code'] = constant($newToken['type']); self::$_resolveTokenCache[$cacheKey] = $newToken; } else if ($token[0] === T_CURLY_OPEN) { $newToken = array( 'code' => T_OPEN_CURLY_BRACKET, 'type' => 'T_OPEN_CURLY_BRACKET', ); } else { $newToken = array( 'code' => $token[0], 'type' => token_name($token[0]), ); self::$_resolveTokenCache[$token[0]] = $newToken; }//end if $newToken['content'] = $token[1]; return $newToken; }//end standardiseToken() /** * Converts simple tokens into a format that conforms to complex tokens * produced by token_get_all(). * * Simple tokens are tokens that are not in array form when produced from * token_get_all(). * * @param string $token The simple token to convert. * * @return array The new token in array format. */ public static function resolveSimpleToken($token) { $newToken = array(); switch ($token) { case '{': $newToken['type'] = 'T_OPEN_CURLY_BRACKET'; break; case '}': $newToken['type'] = 'T_CLOSE_CURLY_BRACKET'; break; case '[': $newToken['type'] = 'T_OPEN_SQUARE_BRACKET'; break; case ']': $newToken['type'] = 'T_CLOSE_SQUARE_BRACKET'; break; case '(': $newToken['type'] = 'T_OPEN_PARENTHESIS'; break; case ')': $newToken['type'] = 'T_CLOSE_PARENTHESIS'; break; case ':': $newToken['type'] = 'T_COLON'; break; case '.': $newToken['type'] = 'T_STRING_CONCAT'; break; case '?': $newToken['type'] = 'T_INLINE_THEN'; break; case ';': $newToken['type'] = 'T_SEMICOLON'; break; case '=': $newToken['type'] = 'T_EQUAL'; break; case '*': $newToken['type'] = 'T_MULTIPLY'; break; case '/': $newToken['type'] = 'T_DIVIDE'; break; case '+': $newToken['type'] = 'T_PLUS'; break; case '-': $newToken['type'] = 'T_MINUS'; break; case '%': $newToken['type'] = 'T_MODULUS'; break; case '^': $newToken['type'] = 'T_BITWISE_XOR'; break; case '&': $newToken['type'] = 'T_BITWISE_AND'; break; case '|': $newToken['type'] = 'T_BITWISE_OR'; break; case '<': $newToken['type'] = 'T_LESS_THAN'; break; case '>': $newToken['type'] = 'T_GREATER_THAN'; break; case '!': $newToken['type'] = 'T_BOOLEAN_NOT'; break; case ',': $newToken['type'] = 'T_COMMA'; break; case '@': $newToken['type'] = 'T_ASPERAND'; break; case '$': $newToken['type'] = 'T_DOLLAR'; break; case '`': $newToken['type'] = 'T_BACKTICK'; break; default: $newToken['type'] = 'T_NONE'; break; }//end switch $newToken['code'] = constant($newToken['type']); $newToken['content'] = $token; self::$_resolveTokenCache[$token] = $newToken; return $newToken; }//end resolveSimpleToken() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/CLI.php0000644000076700000240000013576112647543456017647 0ustar gsherwoodstaff * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ error_reporting(E_ALL | E_STRICT); // Installations via Composer: make sure that we autoload all dependencies. if (file_exists($a = dirname(__FILE__).'/../../../autoload.php') === true) { include_once $a; } else if (file_exists($a = dirname(__FILE__).'/../vendor/autoload.php') === true) { include_once $a; } if (file_exists($a = dirname(__FILE__).'/../CodeSniffer.php') === true) { // Running from a git clone. include_once $a; } else { // PEAR installed. include_once 'PHP/CodeSniffer.php'; } /** * A class to process command line phpcs scripts. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_CLI { /** * An array of all values specified on the command line. * * @var array */ protected $values = array(); /** * The minimum severity level errors must have to be displayed. * * @var bool */ public $errorSeverity = 0; /** * The minimum severity level warnings must have to be displayed. * * @var bool */ public $warningSeverity = 0; /** * Whether or not to kill the process when an unknown command line arg is found. * * If FALSE, arguments that are not command line options or file/directory paths * will be ignored and execution will continue. * * @var bool */ public $dieOnUnknownArg = true; /** * An array of the current command line arguments we are processing. * * @var array */ private $_cliArgs = array(); /** * Run the PHPCS script. * * @return array */ public function runphpcs() { if (defined('PHP_CODESNIFFER_CBF') === false) { define('PHP_CODESNIFFER_CBF', false); } if (is_file(dirname(__FILE__).'/../CodeSniffer/Reporting.php') === true) { include_once dirname(__FILE__).'/../CodeSniffer/Reporting.php'; } else { include_once 'PHP/CodeSniffer/Reporting.php'; } PHP_CodeSniffer_Reporting::startTiming(); $this->checkRequirements(); $numErrors = $this->process(); if ($numErrors === 0) { exit(0); } else { exit(1); } }//end runphpcs() /** * Run the PHPCBF script. * * @return array */ public function runphpcbf() { if (defined('PHP_CODESNIFFER_CBF') === false) { define('PHP_CODESNIFFER_CBF', true); } if (is_file(dirname(__FILE__).'/../CodeSniffer/Reporting.php') === true) { include_once dirname(__FILE__).'/../CodeSniffer/Reporting.php'; } else { include_once 'PHP/CodeSniffer/Reporting.php'; } PHP_CodeSniffer_Reporting::startTiming(); $this->checkRequirements(); $this->dieOnUnknownArg = false; // Override some of the command line settings that might break the fixes. $cliValues = $this->getCommandLineValues(); $cliValues['verbosity'] = 0; $cliValues['showProgress'] = false; $cliValues['generator'] = ''; $cliValues['explain'] = false; $cliValues['interactive'] = false; $cliValues['showSources'] = false; $cliValues['reportFile'] = null; $cliValues['reports'] = array(); $suffix = ''; if (isset($cliValues['suffix']) === true) { $suffix = $cliValues['suffix']; } $allowPatch = true; if (isset($cliValues['no-patch']) === true || empty($cliValues['files']) === true) { // They either asked for this, // or they are using STDIN, which can't use diff. $allowPatch = false; } if ($suffix === '' && $allowPatch === true) { // Using the diff/patch tools. $diffFile = getcwd().'/phpcbf-fixed.diff'; $cliValues['reports'] = array('diff' => $diffFile); if (file_exists($diffFile) === true) { unlink($diffFile); } } else { // Replace the file without the patch command // or writing to a file with a new suffix. $cliValues['reports'] = array('cbf' => null); $cliValues['phpcbf-suffix'] = $suffix; } $numErrors = $this->process($cliValues); if ($suffix === '' && $allowPatch === true) { if (file_exists($diffFile) === false) { // Nothing to fix. if ($numErrors === 0) { // And no errors reported. $exit = 0; } else { // Errors we can't fix. $exit = 2; } } else { if (filesize($diffFile) < 10) { // Empty or bad diff file. if ($numErrors === 0) { // And no errors reported. $exit = 0; } else { // Errors we can't fix. $exit = 2; } } else { $cmd = "patch -p0 -ui \"$diffFile\""; $output = array(); $retVal = null; exec($cmd, $output, $retVal); if ($retVal === 0) { // Everything went well. $filesPatched = count($output); echo "Patched $filesPatched file"; if ($filesPatched > 1) { echo 's'; } echo PHP_EOL; $exit = 1; } else { print_r($output); echo "Returned: $retVal".PHP_EOL; $exit = 3; } }//end if unlink($diffFile); }//end if } else { // File are being patched manually, so we can't tell // how many errors were fixed. $exit = 1; }//end if if ($exit === 0) { echo 'No fixable errors were found'.PHP_EOL; } else if ($exit === 2) { echo 'PHPCBF could not fix all the errors found'.PHP_EOL; } PHP_CodeSniffer_Reporting::printRunTime(); exit($exit); }//end runphpcbf() /** * Exits if the minimum requirements of PHP_CodSniffer are not met. * * @return array */ public function checkRequirements() { // Check the PHP version. if (version_compare(PHP_VERSION, '5.1.2') === -1) { echo 'ERROR: PHP_CodeSniffer requires PHP version 5.1.2 or greater.'.PHP_EOL; exit(2); } if (extension_loaded('tokenizer') === false) { echo 'ERROR: PHP_CodeSniffer requires the tokenizer extension to be enabled.'.PHP_EOL; exit(2); } }//end checkRequirements() /** * Get a list of default values for all possible command line arguments. * * @return array */ public function getDefaults() { if (defined('PHP_CODESNIFFER_IN_TESTS') === true) { return array(); } // The default values for config settings. $defaults['files'] = array(); $defaults['standard'] = null; $defaults['verbosity'] = 0; $defaults['interactive'] = false; $defaults['colors'] = false; $defaults['explain'] = false; $defaults['local'] = false; $defaults['showSources'] = false; $defaults['extensions'] = array(); $defaults['sniffs'] = array(); $defaults['ignored'] = array(); $defaults['reportFile'] = null; $defaults['generator'] = ''; $defaults['reports'] = array(); $defaults['bootstrap'] = array(); $defaults['errorSeverity'] = null; $defaults['warningSeverity'] = null; $reportFormat = PHP_CodeSniffer::getConfigData('report_format'); if ($reportFormat !== null) { $defaults['reports'][$reportFormat] = null; } $tabWidth = PHP_CodeSniffer::getConfigData('tab_width'); if ($tabWidth === null) { $defaults['tabWidth'] = 0; } else { $defaults['tabWidth'] = (int) $tabWidth; } $encoding = PHP_CodeSniffer::getConfigData('encoding'); if ($encoding === null) { $defaults['encoding'] = 'iso-8859-1'; } else { $defaults['encoding'] = strtolower($encoding); } $severity = PHP_CodeSniffer::getConfigData('severity'); if ($severity !== null) { $defaults['errorSeverity'] = (int) $severity; $defaults['warningSeverity'] = (int) $severity; } $severity = PHP_CodeSniffer::getConfigData('error_severity'); if ($severity !== null) { $defaults['errorSeverity'] = (int) $severity; } $severity = PHP_CodeSniffer::getConfigData('warning_severity'); if ($severity !== null) { $defaults['warningSeverity'] = (int) $severity; } $showWarnings = PHP_CodeSniffer::getConfigData('show_warnings'); if ($showWarnings !== null) { $showWarnings = (bool) $showWarnings; if ($showWarnings === false) { $defaults['warningSeverity'] = 0; } } $reportWidth = PHP_CodeSniffer::getConfigData('report_width'); if ($reportWidth !== null) { $defaults['reportWidth'] = $this->_validateReportWidth($reportWidth); } else { // Use function defaults. $defaults['reportWidth'] = null; } $showProgress = PHP_CodeSniffer::getConfigData('show_progress'); if ($showProgress === null) { $defaults['showProgress'] = false; } else { $defaults['showProgress'] = (bool) $showProgress; } $colors = PHP_CodeSniffer::getConfigData('colors'); if ($colors === null) { $defaults['colors'] = false; } else { $defaults['colors'] = (bool) $colors; } if (PHP_CodeSniffer::isPharFile(dirname(dirname(__FILE__))) === true) { // If this is a phar file, check for the standard in the config. $standard = PHP_CodeSniffer::getConfigData('standard'); if ($standard !== null) { $defaults['standard'] = $standard; } } return $defaults; }//end getDefaults() /** * Gets the processed command line values. * * If the values have not yet been set, the values will be sourced * from the command line arguments. * * @return array */ public function getCommandLineValues() { if (empty($this->values) === false) { return $this->values; } $values = $this->getDefaults(); $args = $_SERVER['argv']; array_shift($args); $this->setCommandLineValues($args); return $this->values; }//end getCommandLineValues() /** * Set the command line values. * * @param array $args An array of command line arguments to process. * * @return void */ public function setCommandLineValues($args) { if (defined('PHP_CODESNIFFER_IN_TESTS') === true) { $this->values = array(); } else if (empty($this->values) === true) { $this->values = $this->getDefaults(); } $this->_cliArgs = $args; $numArgs = count($args); for ($i = 0; $i < $numArgs; $i++) { $arg = $this->_cliArgs[$i]; if ($arg === '') { continue; } if ($arg{0} === '-') { if ($arg === '-' || $arg === '--') { // Empty argument, ignore it. continue; } if ($arg{1} === '-') { $this->processLongArgument(substr($arg, 2), $i); } else { $switches = str_split($arg); foreach ($switches as $switch) { if ($switch === '-') { continue; } $this->processShortArgument($switch, $i); } } } else { $this->processUnknownArgument($arg, $i); }//end if }//end for }//end setCommandLineValues() /** * Processes a short (-e) command line argument. * * @param string $arg The command line argument. * @param int $pos The position of the argument on the command line. * * @return void */ public function processShortArgument($arg, $pos) { switch ($arg) { case 'h': case '?': $this->printUsage(); exit(0); break; case 'i' : $this->printInstalledStandards(); exit(0); break; case 'v' : if (isset($this->values['verbosity']) === false) { $this->values['verbosity'] = 1; } else { $this->values['verbosity']++; } break; case 'l' : $this->values['local'] = true; break; case 's' : $this->values['showSources'] = true; break; case 'a' : $this->values['interactive'] = true; break; case 'e': $this->values['explain'] = true; break; case 'p' : $this->values['showProgress'] = true; break; case 'd' : $ini = explode('=', $this->_cliArgs[($pos + 1)]); $this->_cliArgs[($pos + 1)] = ''; if (isset($ini[1]) === true) { ini_set($ini[0], $ini[1]); } else { ini_set($ini[0], true); } break; case 'n' : $this->values['warningSeverity'] = 0; break; case 'w' : $this->values['warningSeverity'] = null; break; default: if ($this->dieOnUnknownArg === false) { $this->values[$arg] = $arg; } else { $this->processUnknownArgument('-'.$arg, $pos); } }//end switch }//end processShortArgument() /** * Processes a long (--example) command line argument. * * @param string $arg The command line argument. * @param int $pos The position of the argument on the command line. * * @return void */ public function processLongArgument($arg, $pos) { switch ($arg) { case 'help': $this->printUsage(); exit(0); case 'version': echo 'PHP_CodeSniffer version '.PHP_CodeSniffer::VERSION.' ('.PHP_CodeSniffer::STABILITY.') '; echo 'by Squiz (http://www.squiz.net)'.PHP_EOL; exit(0); case 'colors': $this->values['colors'] = true; break; case 'no-colors': $this->values['colors'] = false; break; case 'config-set': if (isset($this->_cliArgs[($pos + 1)]) === false || isset($this->_cliArgs[($pos + 2)]) === false ) { echo 'ERROR: Setting a config option requires a name and value'.PHP_EOL.PHP_EOL; $this->printUsage(); exit(0); } $key = $this->_cliArgs[($pos + 1)]; $value = $this->_cliArgs[($pos + 2)]; $current = PHP_CodeSniffer::getConfigData($key); try { PHP_CodeSniffer::setConfigData($key, $value); } catch (Exception $e) { echo $e->getMessage().PHP_EOL; exit(2); } if ($current === null) { echo "Config value \"$key\" added successfully".PHP_EOL; } else { echo "Config value \"$key\" updated successfully; old value was \"$current\"".PHP_EOL; } exit(0); case 'config-delete': if (isset($this->_cliArgs[($pos + 1)]) === false) { echo 'ERROR: Deleting a config option requires the name of the option'.PHP_EOL.PHP_EOL; $this->printUsage(); exit(0); } $key = $this->_cliArgs[($pos + 1)]; $current = PHP_CodeSniffer::getConfigData($key); if ($current === null) { echo "Config value \"$key\" has not been set".PHP_EOL; } else { try { PHP_CodeSniffer::setConfigData($key, null); } catch (Exception $e) { echo $e->getMessage().PHP_EOL; exit(2); } echo "Config value \"$key\" removed successfully; old value was \"$current\"".PHP_EOL; } exit(0); case 'config-show': $data = PHP_CodeSniffer::getAllConfigData(); $this->printConfigData($data); exit(0); case 'runtime-set': if (isset($this->_cliArgs[($pos + 1)]) === false || isset($this->_cliArgs[($pos + 2)]) === false ) { echo 'ERROR: Setting a runtime config option requires a name and value'.PHP_EOL.PHP_EOL; $this->printUsage(); exit(0); } $key = $this->_cliArgs[($pos + 1)]; $value = $this->_cliArgs[($pos + 2)]; $this->_cliArgs[($pos + 1)] = ''; $this->_cliArgs[($pos + 2)] = ''; PHP_CodeSniffer::setConfigData($key, $value, true); break; default: if (substr($arg, 0, 7) === 'sniffs=') { $sniffs = explode(',', substr($arg, 7)); foreach ($sniffs as $sniff) { if (substr_count($sniff, '.') !== 2) { echo 'ERROR: The specified sniff code "'.$sniff.'" is invalid'.PHP_EOL.PHP_EOL; $this->printUsage(); exit(2); } } $this->values['sniffs'] = $sniffs; } else if (substr($arg, 0, 10) === 'bootstrap=') { $files = explode(',', substr($arg, 10)); foreach ($files as $file) { $path = PHP_CodeSniffer::realpath($file); if ($path === false) { echo 'ERROR: The specified bootstrap file "'.$file.'" does not exist'.PHP_EOL.PHP_EOL; $this->printUsage(); exit(2); } $this->values['bootstrap'][] = $path; } } else if (substr($arg, 0, 12) === 'report-file=') { $this->values['reportFile'] = PHP_CodeSniffer::realpath(substr($arg, 12)); // It may not exist and return false instead. if ($this->values['reportFile'] === false) { $this->values['reportFile'] = substr($arg, 12); $dir = dirname($this->values['reportFile']); if (is_dir($dir) === false) { echo 'ERROR: The specified report file path "'.$this->values['reportFile'].'" points to a non-existent directory'.PHP_EOL.PHP_EOL; $this->printUsage(); exit(2); } if ($dir === '.') { // Passed report file is a file in the current directory. $this->values['reportFile'] = getcwd().'/'.basename($this->values['reportFile']); } else { $dir = PHP_CodeSniffer::realpath(getcwd().'/'.$dir); if ($dir !== false) { // Report file path is relative. $this->values['reportFile'] = $dir.'/'.basename($this->values['reportFile']); } } }//end if if (is_dir($this->values['reportFile']) === true) { echo 'ERROR: The specified report file path "'.$this->values['reportFile'].'" is a directory'.PHP_EOL.PHP_EOL; $this->printUsage(); exit(2); } } else if (substr($arg, 0, 13) === 'report-width=') { $this->values['reportWidth'] = $this->_validateReportWidth(substr($arg, 13)); } else if (substr($arg, 0, 7) === 'report=' || substr($arg, 0, 7) === 'report-' ) { if ($arg[6] === '-') { // This is a report with file output. $split = strpos($arg, '='); if ($split === false) { $report = substr($arg, 7); $output = null; } else { $report = substr($arg, 7, ($split - 7)); $output = substr($arg, ($split + 1)); if ($output === false) { $output = null; } else { $dir = dirname($output); if ($dir === '.') { // Passed report file is a filename in the current directory. $output = getcwd().'/'.basename($output); } else { $dir = PHP_CodeSniffer::realpath(getcwd().'/'.$dir); if ($dir !== false) { // Report file path is relative. $output = $dir.'/'.basename($output); } } }//end if }//end if } else { // This is a single report. $report = substr($arg, 7); $output = null; }//end if $this->values['reports'][$report] = $output; } else if (substr($arg, 0, 9) === 'standard=') { $standards = trim(substr($arg, 9)); if ($standards !== '') { $this->values['standard'] = explode(',', $standards); } } else if (substr($arg, 0, 11) === 'extensions=') { $this->values['extensions'] = array_merge($this->values['extensions'], explode(',', substr($arg, 11))); } else if (substr($arg, 0, 9) === 'severity=') { $this->values['errorSeverity'] = (int) substr($arg, 9); $this->values['warningSeverity'] = $this->values['errorSeverity']; } else if (substr($arg, 0, 15) === 'error-severity=') { $this->values['errorSeverity'] = (int) substr($arg, 15); } else if (substr($arg, 0, 17) === 'warning-severity=') { $this->values['warningSeverity'] = (int) substr($arg, 17); } else if (substr($arg, 0, 7) === 'ignore=') { // Split the ignore string on commas, unless the comma is escaped // using 1 or 3 slashes (\, or \\\,). $ignored = preg_split( '/(?<=(?values['ignored'][$pattern] = 'absolute'; } } else if (substr($arg, 0, 10) === 'generator=') { $this->values['generator'] = substr($arg, 10); } else if (substr($arg, 0, 9) === 'encoding=') { $this->values['encoding'] = strtolower(substr($arg, 9)); } else if (substr($arg, 0, 10) === 'tab-width=') { $this->values['tabWidth'] = (int) substr($arg, 10); } else { if ($this->dieOnUnknownArg === false) { $eqPos = strpos($arg, '='); if ($eqPos === false) { $this->values[$arg] = $arg; } else { $value = substr($arg, ($eqPos + 1)); $arg = substr($arg, 0, $eqPos); $this->values[$arg] = $value; } } else { $this->processUnknownArgument('--'.$arg, $pos); } }//end if break; }//end switch }//end processLongArgument() /** * Processes an unknown command line argument. * * Assumes all unknown arguments are files and folders to check. * * @param string $arg The command line argument. * @param int $pos The position of the argument on the command line. * * @return void */ public function processUnknownArgument($arg, $pos) { // We don't know about any additional switches; just files. if ($arg{0} === '-') { if ($this->dieOnUnknownArg === false) { return; } echo 'ERROR: option "'.$arg.'" not known.'.PHP_EOL.PHP_EOL; $this->printUsage(); exit(2); } $file = PHP_CodeSniffer::realpath($arg); if (file_exists($file) === false) { if ($this->dieOnUnknownArg === false) { return; } echo 'ERROR: The file "'.$arg.'" does not exist.'.PHP_EOL.PHP_EOL; $this->printUsage(); exit(2); } else { $this->values['files'][] = $file; } }//end processUnknownArgument() /** * Runs PHP_CodeSniffer over files and directories. * * @param array $values An array of values determined from CLI args. * * @return int The number of error and warning messages shown. * @see getCommandLineValues() */ public function process($values=array()) { if (empty($values) === true) { $values = $this->getCommandLineValues(); } else { $values = array_merge($this->getDefaults(), $values); $this->values = $values; } if ($values['generator'] !== '') { $phpcs = new PHP_CodeSniffer($values['verbosity']); if ($values['standard'] === null) { $values['standard'] = $this->validateStandard(null); } foreach ($values['standard'] as $standard) { $phpcs->generateDocs( $standard, $values['sniffs'], $values['generator'] ); } exit(0); } // If no standard is supplied, get the default. $values['standard'] = $this->validateStandard($values['standard']); foreach ($values['standard'] as $standard) { if (PHP_CodeSniffer::isInstalledStandard($standard) === false) { // They didn't select a valid coding standard, so help them // out by letting them know which standards are installed. echo 'ERROR: the "'.$standard.'" coding standard is not installed. '; $this->printInstalledStandards(); exit(2); } } if ($values['explain'] === true) { foreach ($values['standard'] as $standard) { $this->explainStandard($standard); } exit(0); } $phpcs = new PHP_CodeSniffer($values['verbosity'], null, null, null); $phpcs->setCli($this); $phpcs->initStandard($values['standard'], $values['sniffs']); $values = $this->values; $phpcs->setTabWidth($values['tabWidth']); $phpcs->setEncoding($values['encoding']); $phpcs->setInteractive($values['interactive']); // Set file extensions if they were specified. Otherwise, // let PHP_CodeSniffer decide on the defaults. if (empty($values['extensions']) === false) { $phpcs->setAllowedFileExtensions($values['extensions']); } // Set ignore patterns if they were specified. if (empty($values['ignored']) === false) { $ignorePatterns = array_merge($phpcs->getIgnorePatterns(), $values['ignored']); $phpcs->setIgnorePatterns($ignorePatterns); } // Set some convenience member vars. if ($values['errorSeverity'] === null) { $this->errorSeverity = PHPCS_DEFAULT_ERROR_SEV; } else { $this->errorSeverity = $values['errorSeverity']; } if ($values['warningSeverity'] === null) { $this->warningSeverity = PHPCS_DEFAULT_WARN_SEV; } else { $this->warningSeverity = $values['warningSeverity']; } if (empty($values['reports']) === true) { $values['reports']['full'] = $values['reportFile']; $this->values['reports'] = $values['reports']; } // Include bootstrap files. foreach ($values['bootstrap'] as $bootstrap) { include $bootstrap; } $phpcs->processFiles($values['files'], $values['local']); if (empty($values['files']) === true) { // Check if they are passing in the file contents. $handle = fopen('php://stdin', 'r'); $fileContents = stream_get_contents($handle); fclose($handle); if ($fileContents === '') { // No files and no content passed in. echo 'ERROR: You must supply at least one file or directory to process.'.PHP_EOL.PHP_EOL; $this->printUsage(); exit(2); } else { if ($fileContents !== '') { $phpcs->processFile('STDIN', $fileContents); } } } // Interactive runs don't require a final report and it doesn't really // matter what the retun value is because we know it isn't being read // by a script. if ($values['interactive'] === true) { return 0; } return $this->printErrorReport( $phpcs, $values['reports'], $values['showSources'], $values['reportFile'], $values['reportWidth'] ); }//end process() /** * Prints the error report for the run. * * Note that this function may actually print multiple reports * as the user may have specified a number of output formats. * * @param PHP_CodeSniffer $phpcs The PHP_CodeSniffer object containing * the errors. * @param array $reports A list of reports to print. * @param bool $showSources TRUE if report should show error sources * (not used by all reports). * @param string $reportFile A default file to log report output to. * @param int $reportWidth How wide the screen reports should be. * * @return int The number of error and warning messages shown. */ public function printErrorReport( PHP_CodeSniffer $phpcs, $reports, $showSources, $reportFile, $reportWidth ) { if (empty($reports) === true) { $reports['full'] = $reportFile; } $errors = 0; $warnings = 0; $toScreen = false; foreach ($reports as $report => $output) { if ($output === null) { $output = $reportFile; } if ($reportFile === null) { $toScreen = true; } // We don't add errors here because the number of // errors reported by each report type will always be the // same, so we really just need 1 number. $result = $phpcs->reporting->printReport( $report, $showSources, $this->values, $output, $reportWidth ); $errors = $result['errors']; $warnings = $result['warnings']; }//end foreach // Only print timer output if no reports were // printed to the screen so we don't put additional output // in something like an XML report. If we are printing to screen, // the report types would have already worked out who should // print the timer info. if (PHP_CODESNIFFER_INTERACTIVE === false && ($toScreen === false || (($errors + $warnings) === 0 && $this->values['showProgress'] === true)) ) { PHP_CodeSniffer_Reporting::printRunTime(); } // They should all return the same value, so it // doesn't matter which return value we end up using. $ignoreWarnings = PHP_CodeSniffer::getConfigData('ignore_warnings_on_exit'); $ignoreErrors = PHP_CodeSniffer::getConfigData('ignore_errors_on_exit'); $return = ($errors + $warnings); if ($ignoreErrors !== null) { $ignoreErrors = (bool) $ignoreErrors; if ($ignoreErrors === true) { $return -= $errors; } } if ($ignoreWarnings !== null) { $ignoreWarnings = (bool) $ignoreWarnings; if ($ignoreWarnings === true) { $return -= $warnings; } } return $return; }//end printErrorReport() /** * Convert the passed standards into valid standards. * * Checks things like default values and case. * * @param array $standards The standards to validate. * * @return array */ public function validateStandard($standards) { if ($standards === null) { // They did not supply a standard to use. // Look for a default ruleset in the current directory or higher. $currentDir = getcwd(); do { $default = $currentDir.DIRECTORY_SEPARATOR.'phpcs.xml'; if (is_file($default) === true) { return array($default); } $default = $currentDir.DIRECTORY_SEPARATOR.'phpcs.xml.dist'; if (is_file($default) === true) { return array($default); } $lastDir = $currentDir; $currentDir = dirname($currentDir); } while ($currentDir !== '.' && $currentDir !== $lastDir); // Try to get the default from the config system. $standard = PHP_CodeSniffer::getConfigData('default_standard'); if ($standard === null) { // Product default standard. $standard = 'PEAR'; } return array($standard); }//end if $cleaned = array(); $standards = (array) $standards; // Check if the standard name is valid, or if the case is invalid. $installedStandards = PHP_CodeSniffer::getInstalledStandards(); foreach ($standards as $standard) { foreach ($installedStandards as $validStandard) { if (strtolower($standard) === strtolower($validStandard)) { $standard = $validStandard; break; } } $cleaned[] = $standard; } return $cleaned; }//end validateStandard() /** * Prints a report showing the sniffs contained in a standard. * * @param string $standard The standard to validate. * * @return void */ public function explainStandard($standard) { $phpcs = new PHP_CodeSniffer(); $phpcs->process(array(), $standard); $sniffs = $phpcs->getSniffs(); $sniffs = array_keys($sniffs); sort($sniffs); ob_start(); $lastStandard = ''; $lastCount = ''; $sniffCount = count($sniffs); $sniffs[] = '___'; echo PHP_EOL."The $standard standard contains $sniffCount sniffs".PHP_EOL; ob_start(); foreach ($sniffs as $sniff) { $parts = explode('_', str_replace('\\', '_', $sniff)); if ($lastStandard === '') { $lastStandard = $parts[0]; } if ($parts[0] !== $lastStandard) { $sniffList = ob_get_contents(); ob_end_clean(); echo PHP_EOL.$lastStandard.' ('.$lastCount.' sniffs)'.PHP_EOL; echo str_repeat('-', (strlen($lastStandard.$lastCount) + 10)); echo PHP_EOL; echo $sniffList; $lastStandard = $parts[0]; $lastCount = 0; ob_start(); } echo ' '.$parts[0].'.'.$parts[2].'.'.substr($parts[3], 0, -5).PHP_EOL; $lastCount++; }//end foreach ob_end_clean(); }//end explainStandard() /** * Prints out the gathered config data. * * @param array $data The config data to print. * * @return void */ public function printConfigData($data) { $max = 0; $keys = array_keys($data); foreach ($keys as $key) { $len = strlen($key); if (strlen($key) > $max) { $max = $len; } } if ($max === 0) { return; } $max += 2; ksort($data); foreach ($data as $name => $value) { echo str_pad($name.': ', $max).$value.PHP_EOL; } }//end printConfigData() /** * Prints out the usage information for this script. * * @return void */ public function printUsage() { if (PHP_CODESNIFFER_CBF === true) { $this->printPHPCBFUsage(); } else { $this->printPHPCSUsage(); } }//end printUsage() /** * Prints out the usage information for PHPCS. * * @return void */ public function printPHPCSUsage() { echo 'Usage: phpcs [-nwlsaepvi] [-d key[=value]] [--colors] [--no-colors]'.PHP_EOL; echo ' [--report=] [--report-file=] [--report-=] ...'.PHP_EOL; echo ' [--report-width=] [--generator=] [--tab-width=]'.PHP_EOL; echo ' [--severity=] [--error-severity=] [--warning-severity=]'.PHP_EOL; echo ' [--runtime-set key value] [--config-set key value] [--config-delete key] [--config-show]'.PHP_EOL; echo ' [--standard=] [--sniffs=] [--encoding=]'.PHP_EOL; echo ' [--extensions=] [--ignore=] [--bootstrap=] ...'.PHP_EOL; echo ' Set runtime value (see --config-set) '.PHP_EOL; echo ' -n Do not print warnings (shortcut for --warning-severity=0)'.PHP_EOL; echo ' -w Print both warnings and errors (this is the default)'.PHP_EOL; echo ' -l Local directory only, no recursion'.PHP_EOL; echo ' -s Show sniff codes in all reports'.PHP_EOL; echo ' -a Run interactively'.PHP_EOL; echo ' -e Explain a standard by showing the sniffs it includes'.PHP_EOL; echo ' -p Show progress of the run'.PHP_EOL; echo ' -v[v][v] Print verbose output'.PHP_EOL; echo ' -i Show a list of installed coding standards'.PHP_EOL; echo ' -d Set the [key] php.ini value to [value] or [true] if value is omitted'.PHP_EOL; echo ' --help Print this help message'.PHP_EOL; echo ' --version Print version information'.PHP_EOL; echo ' --colors Use colors in output'.PHP_EOL; echo ' --no-colors Do not use colors in output (this is the default)'.PHP_EOL; echo ' One or more files and/or directories to check'.PHP_EOL; echo ' A comma separated list of files to run before processing starts'.PHP_EOL; echo ' The encoding of the files being checked (default is iso-8859-1)'.PHP_EOL; echo ' A comma separated list of file extensions to check'.PHP_EOL; echo ' (extension filtering only valid when checking a directory)'.PHP_EOL; echo ' The type of the file can be specified using: ext/type'.PHP_EOL; echo ' e.g., module/php,es/js'.PHP_EOL; echo ' Uses either the "HMTL", "Markdown" or "Text" generator'.PHP_EOL; echo ' (forces documentation generation instead of checking)'.PHP_EOL; echo ' A comma separated list of patterns to ignore files and directories'.PHP_EOL; echo ' Print either the "full", "xml", "checkstyle", "csv"'.PHP_EOL; echo ' "json", "emacs", "source", "summary", "diff"'.PHP_EOL; echo ' "svnblame", "gitblame", "hgblame" or "notifysend" report'.PHP_EOL; echo ' (the "full" report is printed by default)'.PHP_EOL; echo ' Write the report to the specified file path'.PHP_EOL; echo ' How many columns wide screen reports should be printed'.PHP_EOL; echo ' or set to "auto" to use current screen width, where supported'.PHP_EOL; echo ' A comma separated list of sniff codes to limit the check to'.PHP_EOL; echo ' (all sniffs must be part of the specified standard)'.PHP_EOL; echo ' The minimum severity required to display an error or warning'.PHP_EOL; echo ' The name or path of the coding standard to use'.PHP_EOL; echo ' The number of spaces each tab represents'.PHP_EOL; }//end printPHPCSUsage() /** * Prints out the usage information for PHPCBF. * * @return void */ public function printPHPCBFUsage() { echo 'Usage: phpcbf [-nwli] [-d key[=value]]'.PHP_EOL; echo ' [--standard=] [--sniffs=] [--suffix=]'.PHP_EOL; echo ' [--severity=] [--error-severity=] [--warning-severity=]'.PHP_EOL; echo ' [--tab-width=] [--encoding=]'.PHP_EOL; echo ' [--extensions=] [--ignore=] [--bootstrap=] ...'.PHP_EOL; echo ' -n Do not fix warnings (shortcut for --warning-severity=0)'.PHP_EOL; echo ' -w Fix both warnings and errors (on by default)'.PHP_EOL; echo ' -l Local directory only, no recursion'.PHP_EOL; echo ' -i Show a list of installed coding standards'.PHP_EOL; echo ' -d Set the [key] php.ini value to [value] or [true] if value is omitted'.PHP_EOL; echo ' --help Print this help message'.PHP_EOL; echo ' --version Print version information'.PHP_EOL; echo ' --no-patch Do not make use of the "diff" or "patch" programs'.PHP_EOL; echo ' One or more files and/or directories to fix'.PHP_EOL; echo ' A comma separated list of files to run before processing starts'.PHP_EOL; echo ' The encoding of the files being fixed (default is iso-8859-1)'.PHP_EOL; echo ' A comma separated list of file extensions to fix'.PHP_EOL; echo ' (extension filtering only valid when checking a directory)'.PHP_EOL; echo ' The type of the file can be specified using: ext/type'.PHP_EOL; echo ' e.g., module/php,es/js'.PHP_EOL; echo ' A comma separated list of patterns to ignore files and directories'.PHP_EOL; echo ' A comma separated list of sniff codes to limit the fixes to'.PHP_EOL; echo ' (all sniffs must be part of the specified standard)'.PHP_EOL; echo ' The minimum severity required to fix an error or warning'.PHP_EOL; echo ' The name or path of the coding standard to use'.PHP_EOL; echo ' Write modified files to a filename using this suffix'.PHP_EOL; echo ' ("diff" and "patch" are not used in this mode)'.PHP_EOL; echo ' The number of spaces each tab represents'.PHP_EOL; }//end printPHPCBFUsage() /** * Prints out a list of installed coding standards. * * @return void */ public function printInstalledStandards() { $installedStandards = PHP_CodeSniffer::getInstalledStandards(); $numStandards = count($installedStandards); if ($numStandards === 0) { echo 'No coding standards are installed.'.PHP_EOL; } else { $lastStandard = array_pop($installedStandards); if ($numStandards === 1) { echo "The only coding standard installed is $lastStandard".PHP_EOL; } else { $standardList = implode(', ', $installedStandards); $standardList .= ' and '.$lastStandard; echo 'The installed coding standards are '.$standardList.PHP_EOL; } } }//end printInstalledStandards() /** * Set report width based on terminal width. * * @param int $width The width of the report. If "auto" then will * be replaced by the terminal width. * * @return void */ private function _validateReportWidth($width) { if ($width === 'auto' && preg_match('|\d+ (\d+)|', shell_exec('stty size 2>&1'), $matches) === 1 ) { return (int) $matches[1]; } return (int) $width; }//end _validateReportWidth() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Exception.php0000644000076700000240000000201212647543456021154 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * An exception thrown by PHP_CodeSniffer when it encounters an unrecoverable error. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Exception extends Exception { }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/File.php0000644000076700000240000041632312647543456020113 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * A PHP_CodeSniffer_File object represents a PHP source file and the tokens * associated with it. * * It provides a means for traversing the token stack, along with * other token related operations. If a PHP_CodeSniffer_Sniff finds and error or * warning within a PHP_CodeSniffer_File, you can raise an error using the * addError() or addWarning() methods. * * Token Information * * Each token within the stack contains information about itself: * * * array( * 'code' => 301, // the token type code (see token_get_all()) * 'content' => 'if', // the token content * 'type' => 'T_IF', // the token name * 'line' => 56, // the line number when the token is located * 'column' => 12, // the column in the line where this token * // starts (starts from 1) * 'level' => 2 // the depth a token is within the scopes open * 'conditions' => array( // a list of scope condition token * // positions => codes that * 2 => 50, // opened the scopes that this token exists * 9 => 353, // in (see conditional tokens section below) * ), * ); * * * Conditional Tokens * * In addition to the standard token fields, conditions contain information to * determine where their scope begins and ends: * * * array( * 'scope_condition' => 38, // the token position of the condition * 'scope_opener' => 41, // the token position that started the scope * 'scope_closer' => 70, // the token position that ended the scope * ); * * * The condition, the scope opener and the scope closer each contain this * information. * * Parenthesis Tokens * * Each parenthesis token (T_OPEN_PARENTHESIS and T_CLOSE_PARENTHESIS) has a * reference to their opening and closing parenthesis, one being itself, the * other being its opposite. * * * array( * 'parenthesis_opener' => 34, * 'parenthesis_closer' => 40, * ); * * * Some tokens can "own" a set of parenthesis. For example a T_FUNCTION token * has parenthesis around its argument list. These tokens also have the * parenthesis_opener and and parenthesis_closer indices. Not all parenthesis * have owners, for example parenthesis used for arithmetic operations and * function calls. The parenthesis tokens that have an owner have the following * auxiliary array indices. * * * array( * 'parenthesis_opener' => 34, * 'parenthesis_closer' => 40, * 'parenthesis_owner' => 33, * ); * * * Each token within a set of parenthesis also has an array index * 'nested_parenthesis' which is an array of the * left parenthesis => right parenthesis token positions. * * * 'nested_parenthesis' => array( * 12 => 15 * 11 => 14 * ); * * * Extended Tokens * * PHP_CodeSniffer extends and augments some of the tokens created by * token_get_all(). A full list of these tokens can be seen in the * Tokens.php file. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_File { /** * The absolute path to the file associated with this object. * * @var string */ private $_file = ''; /** * The EOL character this file uses. * * @var string */ public $eolChar = ''; /** * The PHP_CodeSniffer object controlling this run. * * @var PHP_CodeSniffer */ public $phpcs = null; /** * The Fixer object to control fixing errors. * * @var PHP_CodeSniffer_Fixer */ public $fixer = null; /** * The tokenizer being used for this file. * * @var object */ public $tokenizer = null; /** * The tokenizer being used for this file. * * @var string */ public $tokenizerType = 'PHP'; /** * The number of tokens in this file. * * Stored here to save calling count() everywhere. * * @var int */ public $numTokens = 0; /** * The tokens stack map. * * Note that the tokens in this array differ in format to the tokens * produced by token_get_all(). Tokens are initially produced with * token_get_all(), then augmented so that it's easier to process them. * * @var array() * @see Tokens.php */ private $_tokens = array(); /** * The errors raised from PHP_CodeSniffer_Sniffs. * * @var array() * @see getErrors() */ private $_errors = array(); /** * The warnings raised from PHP_CodeSniffer_Sniffs. * * @var array() * @see getWarnings() */ private $_warnings = array(); /** * The metrics recorded from PHP_CodeSniffer_Sniffs. * * @var array() * @see getMetrics() */ private $_metrics = array(); /** * Record the errors and warnings raised. * * @var bool */ private $_recordErrors = true; /** * An array of lines that are being ignored. * * @var array() */ private static $_ignoredLines = array(); /** * An array of sniffs that are being ignored. * * @var array() */ private $_ignoredListeners = array(); /** * An array of message codes that are being ignored. * * @var array() */ private $_ignoredCodes = array(); /** * The total number of errors raised. * * @var int */ private $_errorCount = 0; /** * The total number of warnings raised. * * @var int */ private $_warningCount = 0; /** * The total number of errors/warnings that can be fixed. * * @var int */ private $_fixableCount = 0; /** * An array of sniffs listening to this file's processing. * * @var array(PHP_CodeSniffer_Sniff) */ private $_listeners = array(); /** * The class name of the sniff currently processing the file. * * @var string */ private $_activeListener = ''; /** * An array of sniffs being processed and how long they took. * * @var array() */ private $_listenerTimes = array(); /** * An array of rules from the ruleset.xml file. * * This value gets set by PHP_CodeSniffer when the object is created. * It may be empty, indicating that the ruleset does not override * any of the default sniff settings. * * @var array */ protected $ruleset = array(); /** * Constructs a PHP_CodeSniffer_File. * * @param string $file The absolute path to the file to process. * @param array(string) $listeners The initial listeners listening to processing of this file. * to processing of this file. * @param array $ruleset An array of rules from the ruleset.xml file. * ruleset.xml file. * @param PHP_CodeSniffer $phpcs The PHP_CodeSniffer object controlling this run. * this run. * * @throws PHP_CodeSniffer_Exception If the register() method does * not return an array. */ public function __construct( $file, array $listeners, array $ruleset, PHP_CodeSniffer $phpcs ) { $this->_file = trim($file); $this->_listeners = $listeners; $this->ruleset = $ruleset; $this->phpcs = $phpcs; $this->fixer = new PHP_CodeSniffer_Fixer(); if (PHP_CODESNIFFER_INTERACTIVE === false) { $cliValues = $phpcs->cli->getCommandLineValues(); if (isset($cliValues['showSources']) === true && $cliValues['showSources'] !== true ) { $recordErrors = false; foreach ($cliValues['reports'] as $report => $output) { $reportClass = $phpcs->reporting->factory($report); if (property_exists($reportClass, 'recordErrors') === false || $reportClass->recordErrors === true ) { $recordErrors = true; break; } } $this->_recordErrors = $recordErrors; } } }//end __construct() /** * Sets the name of the currently active sniff. * * @param string $activeListener The class name of the current sniff. * * @return void */ public function setActiveListener($activeListener) { $this->_activeListener = $activeListener; }//end setActiveListener() /** * Adds a listener to the token stack that listens to the specific tokens. * * When PHP_CodeSniffer encounters on the the tokens specified in $tokens, * it invokes the process method of the sniff. * * @param PHP_CodeSniffer_Sniff $listener The listener to add to the * listener stack. * @param array(int) $tokens The token types the listener wishes to * listen to. * * @return void */ public function addTokenListener(PHP_CodeSniffer_Sniff $listener, array $tokens) { $class = get_class($listener); foreach ($tokens as $token) { if (isset($this->_listeners[$token]) === false) { $this->_listeners[$token] = array(); } if (isset($this->_listeners[$token][$class]) === false) { $this->_listeners[$token][$class] = $listener; } } }//end addTokenListener() /** * Removes a listener from listening from the specified tokens. * * @param PHP_CodeSniffer_Sniff $listener The listener to remove from the * listener stack. * @param array(int) $tokens The token types the listener wishes to * stop listen to. * * @return void */ public function removeTokenListener( PHP_CodeSniffer_Sniff $listener, array $tokens ) { $class = get_class($listener); foreach ($tokens as $token) { if (isset($this->_listeners[$token]) === false) { continue; } unset($this->_listeners[$token][$class]); } }//end removeTokenListener() /** * Rebuilds the list of listeners to ensure their state is cleared. * * @return void */ public function refreshTokenListeners() { $this->phpcs->populateTokenListeners(); $this->_listeners = $this->phpcs->getTokenSniffs(); }//end refreshTokenListeners() /** * Returns the token stack for this file. * * @return array */ public function getTokens() { return $this->_tokens; }//end getTokens() /** * Starts the stack traversal and tells listeners when tokens are found. * * @param string $contents The contents to parse. If NULL, the content * is taken from the file system. * * @return void */ public function start($contents=null) { $this->_errors = array(); $this->_warnings = array(); $this->_errorCount = 0; $this->_warningCount = 0; $this->_fixableCount = 0; // Reset the ignored lines because lines numbers may have changed // if we are fixing this file. self::$_ignoredLines = array(); try { $this->eolChar = self::detectLineEndings($this->_file, $contents); } catch (PHP_CodeSniffer_Exception $e) { $this->addWarning($e->getMessage(), null, 'Internal.DetectLineEndings'); return; } // If this is standard input, see if a filename was passed in as well. // This is done by including: phpcs_input_file: [file path] // as the first line of content. if ($this->_file === 'STDIN' && $contents !== null) { if (substr($contents, 0, 17) === 'phpcs_input_file:') { $eolPos = strpos($contents, $this->eolChar); $filename = trim(substr($contents, 17, ($eolPos - 17))); $contents = substr($contents, ($eolPos + strlen($this->eolChar))); $this->_file = $filename; } } $this->_parse($contents); $this->fixer->startFile($this); if (PHP_CODESNIFFER_VERBOSITY > 2) { echo "\t*** START TOKEN PROCESSING ***".PHP_EOL; } $foundCode = false; $listeners = $this->phpcs->getSniffs(); $listenerIgnoreTo = array(); $inTests = defined('PHP_CODESNIFFER_IN_TESTS'); // Foreach of the listeners that have registered to listen for this // token, get them to process it. foreach ($this->_tokens as $stackPtr => $token) { // Check for ignored lines. if ($token['code'] === T_COMMENT || $token['code'] === T_DOC_COMMENT_TAG || ($inTests === true && $token['code'] === T_INLINE_HTML) ) { if (strpos($token['content'], '@codingStandards') !== false) { if (strpos($token['content'], '@codingStandardsIgnoreFile') !== false) { // Ignoring the whole file, just a little late. $this->_errors = array(); $this->_warnings = array(); $this->_errorCount = 0; $this->_warningCount = 0; $this->_fixableCount = 0; return; } else if (strpos($token['content'], '@codingStandardsChangeSetting') !== false) { $start = strpos($token['content'], '@codingStandardsChangeSetting'); $comment = substr($token['content'], ($start + 30)); $parts = explode(' ', $comment); $sniffParts = explode('.', $parts[0]); $listenerClass = $sniffParts[0].'_Sniffs_'.$sniffParts[1].'_'.$sniffParts[2].'Sniff'; $this->phpcs->setSniffProperty($listenerClass, $parts[1], $parts[2]); }//end if }//end if }//end if if (PHP_CODESNIFFER_VERBOSITY > 2) { $type = $token['type']; $content = PHP_CodeSniffer::prepareForOutput($token['content']); echo "\t\tProcess token $stackPtr: $type => $content".PHP_EOL; } if ($token['code'] !== T_INLINE_HTML) { $foundCode = true; } if (isset($this->_listeners[$token['code']]) === false) { continue; } foreach ($this->_listeners[$token['code']] as $listenerData) { if (isset($this->_ignoredListeners[$listenerData['class']]) === true || (isset($listenerIgnoreTo[$listenerData['class']]) === true && $listenerIgnoreTo[$listenerData['class']] > $stackPtr) ) { // This sniff is ignoring past this token, or the whole file. continue; } // Make sure this sniff supports the tokenizer // we are currently using. $class = $listenerData['class']; if (isset($listenerData['tokenizers'][$this->tokenizerType]) === false) { continue; } // If the file path matches one of our ignore patterns, skip it. // While there is support for a type of each pattern // (absolute or relative) we don't actually support it here. foreach ($listenerData['ignore'] as $pattern) { // We assume a / directory separator, as do the exclude rules // most developers write, so we need a special case for any system // that is different. if (DIRECTORY_SEPARATOR === '\\') { $pattern = str_replace('/', '\\\\', $pattern); } $pattern = '`'.$pattern.'`i'; if (preg_match($pattern, $this->_file) === 1) { $this->_ignoredListeners[$class] = true; continue(2); } } $this->_activeListener = $class; if (PHP_CODESNIFFER_VERBOSITY > 2) { $startTime = microtime(true); echo "\t\t\tProcessing ".$this->_activeListener.'... '; } $ignoreTo = $listeners[$class]->process($this, $stackPtr); if ($ignoreTo !== null) { $listenerIgnoreTo[$this->_activeListener] = $ignoreTo; } if (PHP_CODESNIFFER_VERBOSITY > 2) { $timeTaken = (microtime(true) - $startTime); if (isset($this->_listenerTimes[$this->_activeListener]) === false) { $this->_listenerTimes[$this->_activeListener] = 0; } $this->_listenerTimes[$this->_activeListener] += $timeTaken; $timeTaken = round(($timeTaken), 4); echo "DONE in $timeTaken seconds".PHP_EOL; } $this->_activeListener = ''; }//end foreach }//end foreach if ($this->_recordErrors === false) { $this->_errors = array(); $this->_warnings = array(); } // If short open tags are off but the file being checked uses // short open tags, the whole content will be inline HTML // and nothing will be checked. So try and handle this case. if ($foundCode === false && $this->tokenizerType === 'PHP') { $shortTags = (bool) ini_get('short_open_tag'); if ($shortTags === false) { $error = 'No PHP code was found in this file and short open tags are not allowed by this install of PHP. This file may be using short open tags but PHP does not allow them.'; $this->addWarning($error, null, 'Internal.NoCodeFound'); } } if (PHP_CODESNIFFER_VERBOSITY > 2) { echo "\t*** END TOKEN PROCESSING ***".PHP_EOL; echo "\t*** START SNIFF PROCESSING REPORT ***".PHP_EOL; asort($this->_listenerTimes, SORT_NUMERIC); $this->_listenerTimes = array_reverse($this->_listenerTimes, true); foreach ($this->_listenerTimes as $listener => $timeTaken) { echo "\t$listener: ".round(($timeTaken), 4).' secs'.PHP_EOL; } echo "\t*** END SNIFF PROCESSING REPORT ***".PHP_EOL; } }//end start() /** * Remove vars stored in this file that are no longer required. * * @return void */ public function cleanUp() { $this->_tokens = null; $this->_listeners = null; }//end cleanUp() /** * Tokenizes the file and prepares it for the test run. * * @param string $contents The contents to parse. If NULL, the content * is taken from the file system. * * @return void */ private function _parse($contents=null) { if ($contents === null && empty($this->_tokens) === false) { // File has already been parsed. return; } $stdin = false; $cliValues = $this->phpcs->cli->getCommandLineValues(); if (empty($cliValues['files']) === true) { $stdin = true; } // Determine the tokenizer from the file extension. $fileParts = explode('.', $this->_file); $extension = array_pop($fileParts); if (isset($this->phpcs->allowedFileExtensions[$extension]) === true) { $tokenizerClass = 'PHP_CodeSniffer_Tokenizers_'.$this->phpcs->allowedFileExtensions[$extension]; $this->tokenizerType = $this->phpcs->allowedFileExtensions[$extension]; } else if (isset($this->phpcs->defaultFileExtensions[$extension]) === true) { $tokenizerClass = 'PHP_CodeSniffer_Tokenizers_'.$this->phpcs->defaultFileExtensions[$extension]; $this->tokenizerType = $this->phpcs->defaultFileExtensions[$extension]; } else { // Revert to default. $tokenizerClass = 'PHP_CodeSniffer_Tokenizers_'.$this->tokenizerType; } $tokenizer = new $tokenizerClass(); $this->tokenizer = $tokenizer; if ($contents === null) { $contents = file_get_contents($this->_file); } try { $tabWidth = null; $encoding = null; if (defined('PHP_CODESNIFFER_IN_TESTS') === true) { $cliValues = $this->phpcs->cli->getCommandLineValues(); if (isset($cliValues['tabWidth']) === true) { $tabWidth = $cliValues['tabWidth']; } if (isset($cliValues['encoding']) === true) { $encoding = $cliValues['encoding']; } } $this->_tokens = self::tokenizeString($contents, $tokenizer, $this->eolChar, $tabWidth, $encoding); } catch (PHP_CodeSniffer_Exception $e) { $this->addWarning($e->getMessage(), null, 'Internal.Tokenizer.Exception'); if (PHP_CODESNIFFER_VERBOSITY > 0 || (PHP_CODESNIFFER_CBF === true && $stdin === false)) { echo "[$this->tokenizerType => tokenizer error]... "; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo PHP_EOL; } } return; }//end try $this->numTokens = count($this->_tokens); // Check for mixed line endings as these can cause tokenizer errors and we // should let the user know that the results they get may be incorrect. // This is done by removing all backslashes, removing the newline char we // detected, then converting newlines chars into text. If any backslashes // are left at the end, we have additional newline chars in use. $contents = str_replace('\\', '', $contents); $contents = str_replace($this->eolChar, '', $contents); $contents = str_replace("\n", '\n', $contents); $contents = str_replace("\r", '\r', $contents); if (strpos($contents, '\\') !== false) { $error = 'File has mixed line endings; this may cause incorrect results'; $this->addWarning($error, 0, 'Internal.LineEndings.Mixed'); } if (PHP_CODESNIFFER_VERBOSITY > 0 || (PHP_CODESNIFFER_CBF === true && $stdin === false)) { if ($this->numTokens === 0) { $numLines = 0; } else { $numLines = $this->_tokens[($this->numTokens - 1)]['line']; } echo "[$this->tokenizerType => $this->numTokens tokens in $numLines lines]... "; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo PHP_EOL; } } }//end _parse() /** * Opens a file and detects the EOL character being used. * * @param string $file The full path to the file. * @param string $contents The contents to parse. If NULL, the content * is taken from the file system. * * @return string * @throws PHP_CodeSniffer_Exception If $file could not be opened. */ public static function detectLineEndings($file, $contents=null) { if ($contents === null) { // Determine the newline character being used in this file. // Will be either \r, \r\n or \n. if (is_readable($file) === false) { $error = 'Error opening file; file no longer exists or you do not have access to read the file'; throw new PHP_CodeSniffer_Exception($error); } else { $handle = fopen($file, 'r'); if ($handle === false) { $error = 'Error opening file; could not auto-detect line endings'; throw new PHP_CodeSniffer_Exception($error); } } $firstLine = fgets($handle); fclose($handle); $eolChar = substr($firstLine, -1); if ($eolChar === "\n") { $secondLastChar = substr($firstLine, -2, 1); if ($secondLastChar === "\r") { $eolChar = "\r\n"; } } else if ($eolChar !== "\r") { // Must not be an EOL char at the end of the line. // Probably a one-line file, so assume \n as it really // doesn't matter considering there are no newlines. $eolChar = "\n"; } } else { if (preg_match("/\r\n?|\n/", $contents, $matches) !== 1) { // Assuming there are no newlines. $eolChar = "\n"; } else { $eolChar = $matches[0]; } }//end if return $eolChar; }//end detectLineEndings() /** * Records an error against a specific token in the file. * * @param string $error The error message. * @param int $stackPtr The stack position where the error occurred. * @param string $code A violation code unique to the sniff message. * @param array $data Replacements for the error message. * @param int $severity The severity level for this error. A value of 0 * will be converted into the default severity level. * @param boolean $fixable Can the error be fixed by the sniff? * * @return boolean */ public function addError( $error, $stackPtr, $code='', $data=array(), $severity=0, $fixable=false ) { if ($stackPtr === null) { $line = 1; $column = 1; } else { $line = $this->_tokens[$stackPtr]['line']; $column = $this->_tokens[$stackPtr]['column']; } return $this->_addError($error, $line, $column, $code, $data, $severity, $fixable); }//end addError() /** * Records a warning against a specific token in the file. * * @param string $warning The error message. * @param int $stackPtr The stack position where the error occurred. * @param string $code A violation code unique to the sniff message. * @param array $data Replacements for the warning message. * @param int $severity The severity level for this warning. A value of 0 * will be converted into the default severity level. * @param boolean $fixable Can the warning be fixed by the sniff? * * @return boolean */ public function addWarning( $warning, $stackPtr, $code='', $data=array(), $severity=0, $fixable=false ) { if ($stackPtr === null) { $line = 1; $column = 1; } else { $line = $this->_tokens[$stackPtr]['line']; $column = $this->_tokens[$stackPtr]['column']; } return $this->_addWarning($warning, $line, $column, $code, $data, $severity, $fixable); }//end addWarning() /** * Records an error against a specific line in the file. * * @param string $error The error message. * @param int $line The line on which the error occurred. * @param string $code A violation code unique to the sniff message. * @param array $data Replacements for the error message. * @param int $severity The severity level for this error. A value of 0 will be converted into the default severity level. * will be converted into the default severity level. * * @return boolean */ public function addErrorOnLine( $error, $line, $code='', $data=array(), $severity=0 ) { return $this->_addError($error, $line, 1, $code, $data, $severity, false); }//end addErrorOnLine() /** * Records a warning against a specific token in the file. * * @param string $warning The error message. * @param int $line The line on which the warning occurred. * @param string $code A violation code unique to the sniff message. * @param array $data Replacements for the warning message. * @param int $severity The severity level for this warning. A value of 0 will be converted into the default severity level. * will be converted into the default severity level. * * @return boolean */ public function addWarningOnLine( $warning, $line, $code='', $data=array(), $severity=0 ) { return $this->_addWarning($warning, $line, 1, $code, $data, $severity, false); }//end addWarningOnLine() /** * Records a fixable error against a specific token in the file. * * Returns true if the error was recorded and should be fixed. * * @param string $error The error message. * @param int $stackPtr The stack position where the error occurred. * @param string $code A violation code unique to the sniff message. * @param array $data Replacements for the error message. * @param int $severity The severity level for this error. A value of 0 * will be converted into the default severity level. * * @return boolean */ public function addFixableError( $error, $stackPtr, $code='', $data=array(), $severity=0 ) { $recorded = $this->addError($error, $stackPtr, $code, $data, $severity, true); if ($recorded === true && $this->fixer->enabled === true) { return true; } return false; }//end addFixableError() /** * Records a fixable warning against a specific token in the file. * * Returns true if the warning was recorded and should be fixed. * * @param string $warning The error message. * @param int $stackPtr The stack position where the error occurred. * @param string $code A violation code unique to the sniff message. * @param array $data Replacements for the warning message. * @param int $severity The severity level for this warning. A value of 0 * will be converted into the default severity level. * * @return boolean */ public function addFixableWarning( $warning, $stackPtr, $code='', $data=array(), $severity=0 ) { $recorded = $this->addWarning($warning, $stackPtr, $code, $data, $severity, true); if ($recorded === true && $this->fixer->enabled === true) { return true; } return false; }//end addFixableWarning() /** * Adds an error to the error stack. * * @param string $error The error message. * @param int $line The line on which the error occurred. * @param int $column The column at which the error occurred. * @param string $code A violation code unique to the sniff message. * @param array $data Replacements for the error message. * @param int $severity The severity level for this error. A value of 0 * will be converted into the default severity level. * @param boolean $fixable Can the error be fixed by the sniff? * * @return boolean */ private function _addError($error, $line, $column, $code, $data, $severity, $fixable) { if (isset(self::$_ignoredLines[$line]) === true) { return false; } // Work out which sniff generated the error. if (substr($code, 0, 9) === 'Internal.') { // Any internal message. $sniff = $code; $sniffCode = $code; } else { $parts = explode('_', str_replace('\\', '_', $this->_activeListener)); if (isset($parts[3]) === true) { $sniff = $parts[0].'.'.$parts[2].'.'.$parts[3]; // Remove "Sniff" from the end. $sniff = substr($sniff, 0, -5); } else { $sniff = 'unknownSniff'; } $sniffCode = $sniff; if ($code !== '') { $sniffCode .= '.'.$code; } }//end if // If we know this sniff code is being ignored for this file, return early. if (isset($this->_ignoredCodes[$sniffCode]) === true) { return false; } // Make sure this message type has not been set to "warning". if (isset($this->ruleset[$sniffCode]['type']) === true && $this->ruleset[$sniffCode]['type'] === 'warning' ) { // Pass this off to the warning handler. return $this->_addWarning($error, $line, $column, $code, $data, $severity, $fixable); } else if ($this->phpcs->cli->errorSeverity === 0) { // Don't bother doing any processing as errors are just going to // be hidden in the reports anyway. return false; } // Make sure we are interested in this severity level. if (isset($this->ruleset[$sniffCode]['severity']) === true) { $severity = $this->ruleset[$sniffCode]['severity']; } else if ($severity === 0) { $severity = PHPCS_DEFAULT_ERROR_SEV; } if ($this->phpcs->cli->errorSeverity > $severity) { return false; } // Make sure we are not ignoring this file. $patterns = $this->phpcs->getIgnorePatterns($sniffCode); foreach ($patterns as $pattern => $type) { // While there is support for a type of each pattern // (absolute or relative) we don't actually support it here. $replacements = array( '\\,' => ',', '*' => '.*', ); // We assume a / directory separator, as do the exclude rules // most developers write, so we need a special case for any system // that is different. if (DIRECTORY_SEPARATOR === '\\') { $replacements['/'] = '\\\\'; } $pattern = '`'.strtr($pattern, $replacements).'`i'; if (preg_match($pattern, $this->_file) === 1) { $this->_ignoredCodes[$sniffCode] = true; return false; } }//end foreach $this->_errorCount++; if ($fixable === true) { $this->_fixableCount++; } if ($this->_recordErrors === false) { if (isset($this->_errors[$line]) === false) { $this->_errors[$line] = 0; } $this->_errors[$line]++; return true; } // Work out the error message. if (isset($this->ruleset[$sniffCode]['message']) === true) { $error = $this->ruleset[$sniffCode]['message']; } if (empty($data) === true) { $message = $error; } else { $message = vsprintf($error, $data); } if (isset($this->_errors[$line]) === false) { $this->_errors[$line] = array(); } if (isset($this->_errors[$line][$column]) === false) { $this->_errors[$line][$column] = array(); } $this->_errors[$line][$column][] = array( 'message' => $message, 'source' => $sniffCode, 'severity' => $severity, 'fixable' => $fixable, ); if (PHP_CODESNIFFER_VERBOSITY > 1 && $this->fixer->enabled === true && $fixable === true ) { @ob_end_clean(); echo "\tE: [Line $line] $message ($sniffCode)".PHP_EOL; ob_start(); } return true; }//end _addError() /** * Adds an warning to the warning stack. * * @param string $warning The error message. * @param int $line The line on which the warning occurred. * @param int $column The column at which the warning occurred. * @param string $code A violation code unique to the sniff message. * @param array $data Replacements for the warning message. * @param int $severity The severity level for this warning. A value of 0 * will be converted into the default severity level. * @param boolean $fixable Can the warning be fixed by the sniff? * * @return boolean */ private function _addWarning($warning, $line, $column, $code, $data, $severity, $fixable) { if (isset(self::$_ignoredLines[$line]) === true) { return false; } // Work out which sniff generated the warning. if (substr($code, 0, 9) === 'Internal.') { // Any internal message. $sniff = $code; $sniffCode = $code; } else { $parts = explode('_', str_replace('\\', '_', $this->_activeListener)); if (isset($parts[3]) === true) { $sniff = $parts[0].'.'.$parts[2].'.'.$parts[3]; // Remove "Sniff" from the end. $sniff = substr($sniff, 0, -5); } else { $sniff = 'unknownSniff'; } $sniffCode = $sniff; if ($code !== '') { $sniffCode .= '.'.$code; } }//end if // If we know this sniff code is being ignored for this file, return early. if (isset($this->_ignoredCodes[$sniffCode]) === true) { return false; } // Make sure this message type has not been set to "error". if (isset($this->ruleset[$sniffCode]['type']) === true && $this->ruleset[$sniffCode]['type'] === 'error' ) { // Pass this off to the error handler. return $this->_addError($warning, $line, $column, $code, $data, $severity, $fixable); } else if ($this->phpcs->cli->warningSeverity === 0) { // Don't bother doing any processing as warnings are just going to // be hidden in the reports anyway. return false; } // Make sure we are interested in this severity level. if (isset($this->ruleset[$sniffCode]['severity']) === true) { $severity = $this->ruleset[$sniffCode]['severity']; } else if ($severity === 0) { $severity = PHPCS_DEFAULT_WARN_SEV; } if ($this->phpcs->cli->warningSeverity > $severity) { return false; } // Make sure we are not ignoring this file. $patterns = $this->phpcs->getIgnorePatterns($sniffCode); foreach ($patterns as $pattern => $type) { // While there is support for a type of each pattern // (absolute or relative) we don't actually support it here. $replacements = array( '\\,' => ',', '*' => '.*', ); // We assume a / directory separator, as do the exclude rules // most developers write, so we need a special case for any system // that is different. if (DIRECTORY_SEPARATOR === '\\') { $replacements['/'] = '\\\\'; } $pattern = '`'.strtr($pattern, $replacements).'`i'; if (preg_match($pattern, $this->_file) === 1) { $this->_ignoredCodes[$sniffCode] = true; return false; } }//end foreach $this->_warningCount++; if ($fixable === true) { $this->_fixableCount++; } if ($this->_recordErrors === false) { if (isset($this->_warnings[$line]) === false) { $this->_warnings[$line] = 0; } $this->_warnings[$line]++; return true; } // Work out the warning message. if (isset($this->ruleset[$sniffCode]['message']) === true) { $warning = $this->ruleset[$sniffCode]['message']; } if (empty($data) === true) { $message = $warning; } else { $message = vsprintf($warning, $data); } if (isset($this->_warnings[$line]) === false) { $this->_warnings[$line] = array(); } if (isset($this->_warnings[$line][$column]) === false) { $this->_warnings[$line][$column] = array(); } $this->_warnings[$line][$column][] = array( 'message' => $message, 'source' => $sniffCode, 'severity' => $severity, 'fixable' => $fixable, ); if (PHP_CODESNIFFER_VERBOSITY > 1 && $this->fixer->enabled === true && $fixable === true ) { @ob_end_clean(); echo "\tW: $message ($sniffCode)".PHP_EOL; ob_start(); } return true; }//end _addWarning() /** * Adds an warning to the warning stack. * * @param int $stackPtr The stack position where the metric was recorded. * @param string $metric The name of the metric being recorded. * @param string $value The value of the metric being recorded. * * @return boolean */ public function recordMetric($stackPtr, $metric, $value) { if (isset($this->_metrics[$metric]) === false) { $this->_metrics[$metric] = array( 'values' => array( $value => array($stackPtr), ), ); } else { if (isset($this->_metrics[$metric]['values'][$value]) === false) { $this->_metrics[$metric]['values'][$value] = array($stackPtr); } else { $this->_metrics[$metric]['values'][$value][] = $stackPtr; } } return true; }//end recordMetric() /** * Returns the number of errors raised. * * @return int */ public function getErrorCount() { return $this->_errorCount; }//end getErrorCount() /** * Returns the number of warnings raised. * * @return int */ public function getWarningCount() { return $this->_warningCount; }//end getWarningCount() /** * Returns the number of successes recorded. * * @return int */ public function getSuccessCount() { return $this->_successCount; }//end getSuccessCount() /** * Returns the number of fixable errors/warnings raised. * * @return int */ public function getFixableCount() { return $this->_fixableCount; }//end getFixableCount() /** * Returns the list of ignored lines. * * @return array */ public function getIgnoredLines() { return self::$_ignoredLines; }//end getIgnoredLines() /** * Returns the errors raised from processing this file. * * @return array */ public function getErrors() { return $this->_errors; }//end getErrors() /** * Returns the warnings raised from processing this file. * * @return array */ public function getWarnings() { return $this->_warnings; }//end getWarnings() /** * Returns the metrics found while processing this file. * * @return array */ public function getMetrics() { return $this->_metrics; }//end getMetrics() /** * Returns the absolute filename of this file. * * @return string */ public function getFilename() { return $this->_file; }//end getFilename() /** * Creates an array of tokens when given some PHP code. * * Starts by using token_get_all() but does a lot of extra processing * to insert information about the context of the token. * * @param string $string The string to tokenize. * @param object $tokenizer A tokenizer class to use to tokenize the string. * @param string $eolChar The EOL character to use for splitting strings. * @param int $tabWidth The number of spaces each tab respresents. * @param string $encoding The charset of the sniffed file. * * @throws PHP_CodeSniffer_Exception If the file cannot be processed. * @return array */ public static function tokenizeString($string, $tokenizer, $eolChar='\n', $tabWidth=null, $encoding=null) { // Minified files often have a very large number of characters per line // and cause issues when tokenizing. if (get_class($tokenizer) !== 'PHP_CodeSniffer_Tokenizers_PHP') { $numChars = strlen($string); $numLines = (substr_count($string, $eolChar) + 1); $average = ($numChars / $numLines); if ($average > 100) { throw new PHP_CodeSniffer_Exception('File appears to be minified and cannot be processed'); } } $tokens = $tokenizer->tokenizeString($string, $eolChar); if ($tabWidth === null) { $tabWidth = PHP_CODESNIFFER_TAB_WIDTH; } if ($encoding === null) { $encoding = PHP_CODESNIFFER_ENCODING; } self::_createPositionMap($tokens, $tokenizer, $eolChar, $encoding, $tabWidth); self::_createTokenMap($tokens, $tokenizer, $eolChar); self::_createParenthesisNestingMap($tokens, $tokenizer, $eolChar); self::_createScopeMap($tokens, $tokenizer, $eolChar); self::_createLevelMap($tokens, $tokenizer, $eolChar); // Allow the tokenizer to do additional processing if required. $tokenizer->processAdditional($tokens, $eolChar); return $tokens; }//end tokenizeString() /** * Sets token position information. * * Can also convert tabs into spaces. Each tab can represent between * 1 and $width spaces, so this cannot be a straight string replace. * * @param array $tokens The array of tokens to process. * @param object $tokenizer The tokenizer being used to process this file. * @param string $eolChar The EOL character to use for splitting strings. * @param string $encoding The charset of the sniffed file. * @param int $tabWidth The number of spaces that each tab represents. * Set to 0 to disable tab replacement. * * @return void */ private static function _createPositionMap(&$tokens, $tokenizer, $eolChar, $encoding, $tabWidth) { $currColumn = 1; $lineNumber = 1; $eolLen = (strlen($eolChar) * -1); $tokenizerType = get_class($tokenizer); $ignoring = false; $inTests = defined('PHP_CODESNIFFER_IN_TESTS'); $checkEncoding = false; if ($encoding !== 'iso-8859-1' && function_exists('iconv_strlen') === true) { $checkEncoding = true; } $tokensWithTabs = array( T_WHITESPACE => true, T_COMMENT => true, T_DOC_COMMENT => true, T_DOC_COMMENT_WHITESPACE => true, T_DOC_COMMENT_STRING => true, T_CONSTANT_ENCAPSED_STRING => true, T_DOUBLE_QUOTED_STRING => true, T_HEREDOC => true, T_NOWDOC => true, T_INLINE_HTML => true, ); $numTokens = count($tokens); for ($i = 0; $i < $numTokens; $i++) { $tokens[$i]['line'] = $lineNumber; $tokens[$i]['column'] = $currColumn; if ($tokenizerType === 'PHP_CodeSniffer_Tokenizers_PHP' && isset(PHP_CodeSniffer_Tokens::$knownLengths[$tokens[$i]['code']]) === true ) { // There are no tabs in the tokens we know the length of. $length = PHP_CodeSniffer_Tokens::$knownLengths[$tokens[$i]['code']]; $currColumn += $length; } else if ($tabWidth === 0 || isset($tokensWithTabs[$tokens[$i]['code']]) === false || strpos($tokens[$i]['content'], "\t") === false ) { // There are no tabs in this content, or we aren't replacing them. if ($checkEncoding === true) { // Not using the default encoding, so take a bit more care. $length = @iconv_strlen($tokens[$i]['content'], $encoding); if ($length === false) { // String contained invalid characters, so revert to default. $length = strlen($tokens[$i]['content']); } } else { $length = strlen($tokens[$i]['content']); } $currColumn += $length; } else { if (str_replace("\t", '', $tokens[$i]['content']) === '') { // String only contains tabs, so we can shortcut the process. $numTabs = strlen($tokens[$i]['content']); $newContent = ''; $firstTabSize = ($tabWidth - ($currColumn % $tabWidth) + 1); $length = ($firstTabSize + ($tabWidth * ($numTabs - 1))); $currColumn += $length; $newContent = str_repeat(' ', $length); } else { // We need to determine the length of each tab. $tabs = explode("\t", $tokens[$i]['content']); $numTabs = (count($tabs) - 1); $tabNum = 0; $newContent = ''; $length = 0; foreach ($tabs as $content) { if ($content !== '') { $newContent .= $content; if ($checkEncoding === true) { // Not using the default encoding, so take a bit more care. $contentLength = @iconv_strlen($content, $encoding); if ($contentLength === false) { // String contained invalid characters, so revert to default. $contentLength = strlen($content); } } else { $contentLength = strlen($content); } $currColumn += $contentLength; $length += $contentLength; } // The last piece of content does not have a tab after it. if ($tabNum === $numTabs) { break; } // Process the tab that comes after the content. $lastCurrColumn = $currColumn; $tabNum++; // Move the pointer to the next tab stop. if (($currColumn % $tabWidth) === 0) { // This is the first tab, and we are already at a // tab stop, so this tab counts as a single space. $currColumn++; } else { $currColumn++; while (($currColumn % $tabWidth) !== 0) { $currColumn++; } $currColumn++; } $length += ($currColumn - $lastCurrColumn); $newContent .= str_repeat(' ', ($currColumn - $lastCurrColumn)); }//end foreach }//end if $tokens[$i]['orig_content'] = $tokens[$i]['content']; $tokens[$i]['content'] = $newContent; }//end if $tokens[$i]['length'] = $length; if (isset(PHP_CodeSniffer_Tokens::$knownLengths[$tokens[$i]['code']]) === false && strpos($tokens[$i]['content'], $eolChar) !== false ) { $lineNumber++; $currColumn = 1; // Newline chars are not counted in the token length. $tokens[$i]['length'] += $eolLen; } if ($tokens[$i]['code'] === T_COMMENT || $tokens[$i]['code'] === T_DOC_COMMENT_TAG || ($inTests === true && $tokens[$i]['code'] === T_INLINE_HTML) ) { if (strpos($tokens[$i]['content'], '@codingStandards') !== false) { if ($ignoring === false && strpos($tokens[$i]['content'], '@codingStandardsIgnoreStart') !== false ) { $ignoring = true; } else if ($ignoring === true && strpos($tokens[$i]['content'], '@codingStandardsIgnoreEnd') !== false ) { $ignoring = false; // Ignore this comment too. self::$_ignoredLines[$tokens[$i]['line']] = true; } else if ($ignoring === false && strpos($tokens[$i]['content'], '@codingStandardsIgnoreLine') !== false ) { self::$_ignoredLines[($tokens[$i]['line'] + 1)] = true; // Ignore this comment too. self::$_ignoredLines[$tokens[$i]['line']] = true; } } }//end if if ($ignoring === true) { self::$_ignoredLines[$tokens[$i]['line']] = true; } }//end for }//end _createPositionMap() /** * Creates a map of brackets positions. * * @param array $tokens The array of tokens to process. * @param object $tokenizer The tokenizer being used to process this file. * @param string $eolChar The EOL character to use for splitting strings. * * @return void */ private static function _createTokenMap(&$tokens, $tokenizer, $eolChar) { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** START TOKEN MAP ***".PHP_EOL; } $squareOpeners = array(); $curlyOpeners = array(); $numTokens = count($tokens); $openers = array(); $openOwner = null; for ($i = 0; $i < $numTokens; $i++) { /* Parenthesis mapping. */ if (isset(PHP_CodeSniffer_Tokens::$parenthesisOpeners[$tokens[$i]['code']]) === true) { $tokens[$i]['parenthesis_opener'] = null; $tokens[$i]['parenthesis_closer'] = null; $tokens[$i]['parenthesis_owner'] = $i; $openOwner = $i; } else if ($tokens[$i]['code'] === T_OPEN_PARENTHESIS) { $openers[] = $i; $tokens[$i]['parenthesis_opener'] = $i; if ($openOwner !== null) { $tokens[$openOwner]['parenthesis_opener'] = $i; $tokens[$i]['parenthesis_owner'] = $openOwner; $openOwner = null; } } else if ($tokens[$i]['code'] === T_CLOSE_PARENTHESIS) { // Did we set an owner for this set of parenthesis? $numOpeners = count($openers); if ($numOpeners !== 0) { $opener = array_pop($openers); if (isset($tokens[$opener]['parenthesis_owner']) === true) { $owner = $tokens[$opener]['parenthesis_owner']; $tokens[$owner]['parenthesis_closer'] = $i; $tokens[$i]['parenthesis_owner'] = $owner; } $tokens[$i]['parenthesis_opener'] = $opener; $tokens[$i]['parenthesis_closer'] = $i; $tokens[$opener]['parenthesis_closer'] = $i; } }//end if /* Bracket mapping. */ switch ($tokens[$i]['code']) { case T_OPEN_SQUARE_BRACKET: $squareOpeners[] = $i; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", count($squareOpeners)); echo str_repeat("\t", count($curlyOpeners)); echo "=> Found square bracket opener at $i".PHP_EOL; } break; case T_OPEN_CURLY_BRACKET: if (isset($tokens[$i]['scope_closer']) === false) { $curlyOpeners[] = $i; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", count($squareOpeners)); echo str_repeat("\t", count($curlyOpeners)); echo "=> Found curly bracket opener at $i".PHP_EOL; } } break; case T_CLOSE_SQUARE_BRACKET: if (empty($squareOpeners) === false) { $opener = array_pop($squareOpeners); $tokens[$i]['bracket_opener'] = $opener; $tokens[$i]['bracket_closer'] = $i; $tokens[$opener]['bracket_opener'] = $opener; $tokens[$opener]['bracket_closer'] = $i; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", count($squareOpeners)); echo str_repeat("\t", count($curlyOpeners)); echo "\t=> Found square bracket closer at $i for $opener".PHP_EOL; } } break; case T_CLOSE_CURLY_BRACKET: if (empty($curlyOpeners) === false && isset($tokens[$i]['scope_opener']) === false ) { $opener = array_pop($curlyOpeners); $tokens[$i]['bracket_opener'] = $opener; $tokens[$i]['bracket_closer'] = $i; $tokens[$opener]['bracket_opener'] = $opener; $tokens[$opener]['bracket_closer'] = $i; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", count($squareOpeners)); echo str_repeat("\t", count($curlyOpeners)); echo "\t=> Found curly bracket closer at $i for $opener".PHP_EOL; } } break; default: continue; }//end switch }//end for if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** END TOKEN MAP ***".PHP_EOL; } }//end _createTokenMap() /** * Creates a map for the parenthesis tokens that surround other tokens. * * @param array $tokens The array of tokens to process. * @param object $tokenizer The tokenizer being used to process this file. * @param string $eolChar The EOL character to use for splitting strings. * * @return void */ private static function _createParenthesisNestingMap( &$tokens, $tokenizer, $eolChar ) { $numTokens = count($tokens); $map = array(); for ($i = 0; $i < $numTokens; $i++) { if (isset($tokens[$i]['parenthesis_opener']) === true && $i === $tokens[$i]['parenthesis_opener'] ) { if (empty($map) === false) { $tokens[$i]['nested_parenthesis'] = $map; } if (isset($tokens[$i]['parenthesis_closer']) === true) { $map[$tokens[$i]['parenthesis_opener']] = $tokens[$i]['parenthesis_closer']; } } else if (isset($tokens[$i]['parenthesis_closer']) === true && $i === $tokens[$i]['parenthesis_closer'] ) { array_pop($map); if (empty($map) === false) { $tokens[$i]['nested_parenthesis'] = $map; } } else { if (empty($map) === false) { $tokens[$i]['nested_parenthesis'] = $map; } }//end if }//end for }//end _createParenthesisNestingMap() /** * Creates a scope map of tokens that open scopes. * * @param array $tokens The array of tokens to process. * @param object $tokenizer The tokenizer being used to process this file. * @param string $eolChar The EOL character to use for splitting strings. * * @return void * @see _recurseScopeMap() */ private static function _createScopeMap(&$tokens, $tokenizer, $eolChar) { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** START SCOPE MAP ***".PHP_EOL; $isWin = false; if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') { $isWin = true; } } $numTokens = count($tokens); for ($i = 0; $i < $numTokens; $i++) { // Check to see if the current token starts a new scope. if (isset($tokenizer->scopeOpeners[$tokens[$i]['code']]) === true) { if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$i]['type']; $content = PHP_CodeSniffer::prepareForOutput($tokens[$i]['content']); echo "\tStart scope map at $i:$type => $content".PHP_EOL; } if (isset($tokens[$i]['scope_condition']) === true) { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t* already processed, skipping *".PHP_EOL; } continue; } $i = self::_recurseScopeMap( $tokens, $numTokens, $tokenizer, $eolChar, $i ); }//end if }//end for if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** END SCOPE MAP ***".PHP_EOL; } }//end _createScopeMap() /** * Recurses though the scope openers to build a scope map. * * @param array $tokens The array of tokens to process. * @param int $numTokens The size of the tokens array. * @param object $tokenizer The tokenizer being used to process this file. * @param string $eolChar The EOL character to use for splitting strings. * @param int $stackPtr The position in the stack of the token that * opened the scope (eg. an IF token or FOR token). * @param int $depth How many scope levels down we are. * @param int $ignore How many curly braces we are ignoring. * * @return int The position in the stack that closed the scope. */ private static function _recurseScopeMap( &$tokens, $numTokens, $tokenizer, $eolChar, $stackPtr, $depth=1, &$ignore=0 ) { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "=> Begin scope map recursion at token $stackPtr with depth $depth".PHP_EOL; $isWin = false; if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') { $isWin = true; } } $opener = null; $currType = $tokens[$stackPtr]['code']; $startLine = $tokens[$stackPtr]['line']; // We will need this to restore the value if we end up // returning a token ID that causes our calling function to go back // over already ignored braces. $originalIgnore = $ignore; // If the start token for this scope opener is the same as // the scope token, we have already found our opener. if (isset($tokenizer->scopeOpeners[$currType]['start'][$currType]) === true) { $opener = $stackPtr; } for ($i = ($stackPtr + 1); $i < $numTokens; $i++) { $tokenType = $tokens[$i]['code']; if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$i]['type']; $line = $tokens[$i]['line']; $content = PHP_CodeSniffer::prepareForOutput($tokens[$i]['content']); echo str_repeat("\t", $depth); echo "Process token $i on line $line ["; if ($opener !== null) { echo "opener:$opener;"; } if ($ignore > 0) { echo "ignore=$ignore;"; } echo "]: $type => $content".PHP_EOL; }//end if // Very special case for IF statements in PHP that can be defined without // scope tokens. E.g., if (1) 1; 1 ? (1 ? 1 : 1) : 1; // If an IF statement below this one has an opener but no // keyword, the opener will be incorrectly assigned to this IF statement. if (($currType === T_IF || $currType === T_ELSE) && $opener === null && $tokens[$i]['code'] === T_SEMICOLON ) { if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$stackPtr]['type']; echo str_repeat("\t", $depth); echo "=> Found semicolon before scope opener for $stackPtr:$type, bailing".PHP_EOL; } return $i; } if ($opener !== null && (isset($tokens[$i]['scope_opener']) === false || $tokenizer->scopeOpeners[$tokens[$stackPtr]['code']]['shared'] === true) && isset($tokenizer->scopeOpeners[$currType]['end'][$tokenType]) === true ) { if ($ignore > 0 && $tokenType === T_CLOSE_CURLY_BRACKET) { // The last opening bracket must have been for a string // offset or alike, so let's ignore it. if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo '* finished ignoring curly brace *'.PHP_EOL; } $ignore--; continue; } else if ($tokens[$opener]['code'] === T_OPEN_CURLY_BRACKET && $tokenType !== T_CLOSE_CURLY_BRACKET ) { // The opener is a curly bracket so the closer must be a curly bracket as well. // We ignore this closer to handle cases such as T_ELSE or T_ELSEIF being considered // a closer of T_IF when it should not. if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$stackPtr]['type']; echo str_repeat("\t", $depth); echo "=> Ignoring non-curly scope closer for $stackPtr:$type".PHP_EOL; } } else { $scopeCloser = $i; $todo = array( $stackPtr, $opener, ); if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$stackPtr]['type']; $closerType = $tokens[$scopeCloser]['type']; echo str_repeat("\t", $depth); echo "=> Found scope closer ($scopeCloser:$closerType) for $stackPtr:$type".PHP_EOL; } $validCloser = true; if (($tokens[$stackPtr]['code'] === T_IF || $tokens[$stackPtr]['code'] === T_ELSEIF) && ($tokenType === T_ELSE || $tokenType === T_ELSEIF) ) { // To be a closer, this token must have an opener. if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "* closer needs to be tested *".PHP_EOL; } $i = self::_recurseScopeMap( $tokens, $numTokens, $tokenizer, $eolChar, $i, ($depth + 1), $ignore ); if (isset($tokens[$scopeCloser]['scope_opener']) === false) { $validCloser = false; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "* closer is not valid (no opener found) *".PHP_EOL; } } else if ($tokens[$tokens[$scopeCloser]['scope_opener']]['code'] !== $tokens[$opener]['code']) { $validCloser = false; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); $type = $tokens[$tokens[$scopeCloser]['scope_opener']]['type']; $openerType = $tokens[$opener]['type']; echo "* closer is not valid (mismatched opener type; $type != $openerType) *".PHP_EOL; } } else if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "* closer was valid *".PHP_EOL; } } else { // The closer was not processed, so we need to // complete that token as well. $todo[] = $scopeCloser; }//end if if ($validCloser === true) { foreach ($todo as $token) { $tokens[$token]['scope_condition'] = $stackPtr; $tokens[$token]['scope_opener'] = $opener; $tokens[$token]['scope_closer'] = $scopeCloser; } if ($tokenizer->scopeOpeners[$tokens[$stackPtr]['code']]['shared'] === true) { // As we are going back to where we started originally, restore // the ignore value back to its original value. $ignore = $originalIgnore; return $opener; } else if ($scopeCloser === $i && isset($tokenizer->scopeOpeners[$tokenType]) === true ) { // Unset scope_condition here or else the token will appear to have // already been processed, and it will be skipped. Normally we want that, // but in this case, the token is both a closer and an opener, so // it needs to act like an opener. This is also why we return the // token before this one; so the closer has a chance to be processed // a second time, but as an opener. unset($tokens[$scopeCloser]['scope_condition']); return ($i - 1); } else { return $i; } } else { continue; }//end if }//end if }//end if // Is this an opening condition ? if (isset($tokenizer->scopeOpeners[$tokenType]) === true) { if ($opener === null) { if ($tokenType === T_USE) { // PHP use keywords are special because they can be // used as blocks but also inline in function definitions. // So if we find them nested inside another opener, just skip them. continue; } if ($tokenType === T_FUNCTION && $tokens[$stackPtr]['code'] !== T_FUNCTION ) { // Probably a closure, so process it manually. if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$stackPtr]['type']; echo str_repeat("\t", $depth); echo "=> Found function before scope opener for $stackPtr:$type, processing manually".PHP_EOL; } if (isset($tokens[$i]['scope_closer']) === true) { // We've already processed this closure. if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo '* already processed, skipping *'.PHP_EOL; } $i = $tokens[$i]['scope_closer']; continue; } $i = self::_recurseScopeMap( $tokens, $numTokens, $tokenizer, $eolChar, $i, ($depth + 1), $ignore ); continue; }//end if // Found another opening condition but still haven't // found our opener, so we are never going to find one. if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$stackPtr]['type']; echo str_repeat("\t", $depth); echo "=> Found new opening condition before scope opener for $stackPtr:$type, bailing".PHP_EOL; } return $stackPtr; }//end if if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo '* token is an opening condition *'.PHP_EOL; } $isShared = ($tokenizer->scopeOpeners[$tokenType]['shared'] === true); if (isset($tokens[$i]['scope_condition']) === true) { // We've been here before. if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo '* already processed, skipping *'.PHP_EOL; } if ($isShared === false && isset($tokens[$i]['scope_closer']) === true ) { $i = $tokens[$i]['scope_closer']; } continue; } else if ($currType === $tokenType && $isShared === false && $opener === null ) { // We haven't yet found our opener, but we have found another // scope opener which is the same type as us, and we don't // share openers, so we will never find one. if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo '* it was another token\'s opener, bailing *'.PHP_EOL; } return $stackPtr; } else { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo '* searching for opener *'.PHP_EOL; } if (isset($tokenizer->scopeOpeners[$tokenType]['end'][T_CLOSE_CURLY_BRACKET]) === true) { $oldIgnore = $ignore; $ignore = 0; } // PHP has a max nesting level for functions. Stop before we hit that limit // because too many loops means we've run into trouble anyway. if ($depth > 50) { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo '* reached maximum nesting level; aborting *'.PHP_EOL; } throw new PHP_CodeSniffer_Exception('Maximum nesting level reached; file could not be processed'); } $oldDepth = $depth; if ($isShared === true && isset($tokenizer->scopeOpeners[$tokenType]['with'][$currType]) === true ) { // Don't allow the depth to increment because this is // possibly not a true nesting if we are sharing our closer. // This can happen, for example, when a SWITCH has a large // number of CASE statements with the same shared BREAK. $depth--; } $i = self::_recurseScopeMap( $tokens, $numTokens, $tokenizer, $eolChar, $i, ($depth + 1), $ignore ); $depth = $oldDepth; if (isset($tokenizer->scopeOpeners[$tokenType]['end'][T_CLOSE_CURLY_BRACKET]) === true) { $ignore = $oldIgnore; } }//end if }//end if if (isset($tokenizer->scopeOpeners[$currType]['start'][$tokenType]) === true && $opener === null ) { if ($tokenType === T_OPEN_CURLY_BRACKET) { if (isset($tokens[$stackPtr]['parenthesis_closer']) === true && $i < $tokens[$stackPtr]['parenthesis_closer'] ) { // We found a curly brace inside the condition of the // current scope opener, so it must be a string offset. if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo '* ignoring curly brace *'.PHP_EOL; } $ignore++; } else { // Make sure this is actually an opener and not a // string offset (e.g., $var{0}). for ($x = ($i - 1); $x > 0; $x--) { if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[$x]['code']]) === true) { continue; } else { // If the first non-whitespace/comment token is a // variable or object operator then this is an opener // for a string offset and not a scope. if ($tokens[$x]['code'] === T_VARIABLE || $tokens[$x]['code'] === T_OBJECT_OPERATOR ) { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo '* ignoring curly brace *'.PHP_EOL; } $ignore++; }//end if break; }//end if }//end for }//end if }//end if if ($ignore === 0 || $tokenType !== T_OPEN_CURLY_BRACKET) { // We found the opening scope token for $currType. if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$stackPtr]['type']; echo str_repeat("\t", $depth); echo "=> Found scope opener for $stackPtr:$type".PHP_EOL; } $opener = $i; } } else if ($tokenType === T_OPEN_PARENTHESIS) { if (isset($tokens[$i]['parenthesis_owner']) === true) { $owner = $tokens[$i]['parenthesis_owner']; if (isset(PHP_CodeSniffer_Tokens::$scopeOpeners[$tokens[$owner]['code']]) === true && isset($tokens[$i]['parenthesis_closer']) === true ) { // If we get into here, then we opened a parenthesis for // a scope (eg. an if or else if) so we need to update the // start of the line so that when we check to see // if the closing parenthesis is more than 3 lines away from // the statement, we check from the closing parenthesis. $startLine = $tokens[$tokens[$i]['parenthesis_closer']]['line']; } } } else if ($tokenType === T_OPEN_CURLY_BRACKET && $opener !== null) { // We opened something that we don't have a scope opener for. // Examples of this are curly brackets for string offsets etc. // We want to ignore this so that we don't have an invalid scope // map. if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo '* ignoring curly brace *'.PHP_EOL; } $ignore++; } else if ($tokenType === T_CLOSE_CURLY_BRACKET && $ignore > 0) { // We found the end token for the opener we were ignoring. if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo '* finished ignoring curly brace *'.PHP_EOL; } $ignore--; } else if ($opener === null && isset($tokenizer->scopeOpeners[$currType]) === true ) { // If we still haven't found the opener after 3 lines, // we're not going to find it, unless we know it requires // an opener (in which case we better keep looking) or the last // token was empty (in which case we'll just confirm there is // more code in this file and not just a big comment). if ($tokens[$i]['line'] >= ($startLine + 3) && isset(PHP_CodeSniffer_Tokens::$emptyTokens[$tokens[($i - 1)]['code']]) === false ) { if ($tokenizer->scopeOpeners[$currType]['strict'] === true) { if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$stackPtr]['type']; $lines = ($tokens[$i]['line'] - $startLine); echo str_repeat("\t", $depth); echo "=> Still looking for $stackPtr:$type scope opener after $lines lines".PHP_EOL; } } else { if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$stackPtr]['type']; echo str_repeat("\t", $depth); echo "=> Couldn't find scope opener for $stackPtr:$type, bailing".PHP_EOL; } return $stackPtr; } } } else if ($opener !== null && $tokenType !== T_BREAK && isset($tokenizer->endScopeTokens[$tokenType]) === true ) { if (isset($tokens[$i]['scope_condition']) === false) { if ($ignore > 0) { // We found the end token for the opener we were ignoring. if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo '* finished ignoring curly brace *'.PHP_EOL; } $ignore--; } else { // We found a token that closes the scope but it doesn't // have a condition, so it belongs to another token and // our token doesn't have a closer, so pretend this is // the closer. if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$stackPtr]['type']; echo str_repeat("\t", $depth); echo "=> Found (unexpected) scope closer for $stackPtr:$type".PHP_EOL; } foreach (array($stackPtr, $opener) as $token) { $tokens[$token]['scope_condition'] = $stackPtr; $tokens[$token]['scope_opener'] = $opener; $tokens[$token]['scope_closer'] = $i; } return ($i - 1); }//end if }//end if }//end if }//end for return $stackPtr; }//end _recurseScopeMap() /** * Constructs the level map. * * The level map adds a 'level' index to each token which indicates the * depth that a token within a set of scope blocks. It also adds a * 'condition' index which is an array of the scope conditions that opened * each of the scopes - position 0 being the first scope opener. * * @param array $tokens The array of tokens to process. * @param object $tokenizer The tokenizer being used to process this file. * @param string $eolChar The EOL character to use for splitting strings. * * @return void */ private static function _createLevelMap(&$tokens, $tokenizer, $eolChar) { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** START LEVEL MAP ***".PHP_EOL; } $numTokens = count($tokens); $level = 0; $conditions = array(); $lastOpener = null; $openers = array(); for ($i = 0; $i < $numTokens; $i++) { if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$i]['type']; $line = $tokens[$i]['line']; $len = $tokens[$i]['length']; $col = $tokens[$i]['column']; $content = PHP_CodeSniffer::prepareForOutput($tokens[$i]['content']); echo str_repeat("\t", ($level + 1)); echo "Process token $i on line $line [col:$col;len:$len;lvl:$level;"; if (empty($conditions) !== true) { $condString = 'conds;'; foreach ($conditions as $condition) { $condString .= token_name($condition).','; } echo rtrim($condString, ',').';'; } echo "]: $type => $content".PHP_EOL; }//end if $tokens[$i]['level'] = $level; $tokens[$i]['conditions'] = $conditions; if (isset($tokens[$i]['scope_condition']) === true) { // Check to see if this token opened the scope. if ($tokens[$i]['scope_opener'] === $i) { $stackPtr = $tokens[$i]['scope_condition']; if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$stackPtr]['type']; echo str_repeat("\t", ($level + 1)); echo "=> Found scope opener for $stackPtr:$type".PHP_EOL; } $stackPtr = $tokens[$i]['scope_condition']; // If we find a scope opener that has a shared closer, // then we need to go back over the condition map that we // just created and fix ourselves as we just added some // conditions where there was none. This happens for T_CASE // statements that are using the same break statement. if ($lastOpener !== null && $tokens[$lastOpener]['scope_closer'] === $tokens[$i]['scope_closer']) { // This opener shares its closer with the previous opener, // but we still need to check if the two openers share their // closer with each other directly (like CASE and DEFAULT) // or if they are just sharing because one doesn't have a // closer (like CASE with no BREAK using a SWITCHes closer). $thisType = $tokens[$tokens[$i]['scope_condition']]['code']; $opener = $tokens[$lastOpener]['scope_condition']; $isShared = isset($tokenizer->scopeOpeners[$thisType]['with'][$tokens[$opener]['code']]); reset($tokenizer->scopeOpeners[$thisType]['end']); reset($tokenizer->scopeOpeners[$tokens[$opener]['code']]['end']); $sameEnd = (current($tokenizer->scopeOpeners[$thisType]['end']) === current($tokenizer->scopeOpeners[$tokens[$opener]['code']]['end'])); if ($isShared === true && $sameEnd === true) { $badToken = $opener; if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$badToken]['type']; echo str_repeat("\t", ($level + 1)); echo "* shared closer, cleaning up $badToken:$type *".PHP_EOL; } for ($x = $tokens[$i]['scope_condition']; $x <= $i; $x++) { $oldConditions = $tokens[$x]['conditions']; $oldLevel = $tokens[$x]['level']; $tokens[$x]['level']--; unset($tokens[$x]['conditions'][$badToken]); if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$x]['type']; $oldConds = ''; foreach ($oldConditions as $condition) { $oldConds .= token_name($condition).','; } $oldConds = rtrim($oldConds, ','); $newConds = ''; foreach ($tokens[$x]['conditions'] as $condition) { $newConds .= token_name($condition).','; } $newConds = rtrim($newConds, ','); $newLevel = $tokens[$x]['level']; echo str_repeat("\t", ($level + 1)); echo "* cleaned $x:$type *".PHP_EOL; echo str_repeat("\t", ($level + 2)); echo "=> level changed from $oldLevel to $newLevel".PHP_EOL; echo str_repeat("\t", ($level + 2)); echo "=> conditions changed from $oldConds to $newConds".PHP_EOL; }//end if }//end for unset($conditions[$badToken]); if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$badToken]['type']; echo str_repeat("\t", ($level + 1)); echo "* token $badToken:$type removed from conditions array *".PHP_EOL; } unset($openers[$lastOpener]); $level--; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", ($level + 2)); echo '* level decreased *'.PHP_EOL; } }//end if }//end if $level++; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", ($level + 1)); echo '* level increased *'.PHP_EOL; } $conditions[$stackPtr] = $tokens[$stackPtr]['code']; if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$stackPtr]['type']; echo str_repeat("\t", ($level + 1)); echo "* token $stackPtr:$type added to conditions array *".PHP_EOL; } $lastOpener = $tokens[$i]['scope_opener']; if ($lastOpener !== null) { $openers[$lastOpener] = $lastOpener; } } else if ($lastOpener !== null && $tokens[$lastOpener]['scope_closer'] === $i) { foreach (array_reverse($openers) as $opener) { if ($tokens[$opener]['scope_closer'] === $i) { $oldOpener = array_pop($openers); if (empty($openers) === false) { $lastOpener = array_pop($openers); $openers[$lastOpener] = $lastOpener; } else { $lastOpener = null; } if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$oldOpener]['type']; echo str_repeat("\t", ($level + 1)); echo "=> Found scope closer for $oldOpener:$type".PHP_EOL; } $oldCondition = array_pop($conditions); if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", ($level + 1)); echo '* token '.token_name($oldCondition).' removed from conditions array *'.PHP_EOL; } // Make sure this closer actually belongs to us. // Either the condition also has to think this is the // closer, or it has to allow sharing with us. $condition = $tokens[$tokens[$i]['scope_condition']]['code']; if ($condition !== $oldCondition) { if (isset($tokenizer->scopeOpeners[$oldCondition]['with'][$condition]) === false) { $badToken = $tokens[$oldOpener]['scope_condition']; if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = token_name($oldCondition); echo str_repeat("\t", ($level + 1)); echo "* scope closer was bad, cleaning up $badToken:$type *".PHP_EOL; } for ($x = ($oldOpener + 1); $x <= $i; $x++) { $oldConditions = $tokens[$x]['conditions']; $oldLevel = $tokens[$x]['level']; $tokens[$x]['level']--; unset($tokens[$x]['conditions'][$badToken]); if (PHP_CODESNIFFER_VERBOSITY > 1) { $type = $tokens[$x]['type']; $oldConds = ''; foreach ($oldConditions as $condition) { $oldConds .= token_name($condition).','; } $oldConds = rtrim($oldConds, ','); $newConds = ''; foreach ($tokens[$x]['conditions'] as $condition) { $newConds .= token_name($condition).','; } $newConds = rtrim($newConds, ','); $newLevel = $tokens[$x]['level']; echo str_repeat("\t", ($level + 1)); echo "* cleaned $x:$type *".PHP_EOL; echo str_repeat("\t", ($level + 2)); echo "=> level changed from $oldLevel to $newLevel".PHP_EOL; echo str_repeat("\t", ($level + 2)); echo "=> conditions changed from $oldConds to $newConds".PHP_EOL; }//end if }//end for }//end if }//end if $level--; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", ($level + 2)); echo '* level decreased *'.PHP_EOL; } $tokens[$i]['level'] = $level; $tokens[$i]['conditions'] = $conditions; }//end if }//end foreach }//end if }//end if }//end for if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t*** END LEVEL MAP ***".PHP_EOL; } }//end _createLevelMap() /** * Returns the declaration names for T_CLASS, T_INTERFACE and T_FUNCTION tokens. * * @param int $stackPtr The position of the declaration token which * declared the class, interface or function. * * @return string|null The name of the class, interface or function. * or NULL if the function is a closure. * @throws PHP_CodeSniffer_Exception If the specified token is not of type * T_FUNCTION, T_CLASS or T_INTERFACE. */ public function getDeclarationName($stackPtr) { $tokenCode = $this->_tokens[$stackPtr]['code']; if ($tokenCode !== T_FUNCTION && $tokenCode !== T_CLASS && $tokenCode !== T_INTERFACE && $tokenCode !== T_TRAIT ) { throw new PHP_CodeSniffer_Exception('Token type "'.$this->_tokens[$stackPtr]['type'].'" is not T_FUNCTION, T_CLASS, T_INTERFACE or T_TRAIT'); } if ($tokenCode === T_FUNCTION && $this->isAnonymousFunction($stackPtr) === true ) { return null; } $content = null; for ($i = $stackPtr; $i < $this->numTokens; $i++) { if ($this->_tokens[$i]['code'] === T_STRING) { $content = $this->_tokens[$i]['content']; break; } } return $content; }//end getDeclarationName() /** * Check if the token at the specified position is a anonymous function. * * @param int $stackPtr The position of the declaration token which * declared the class, interface or function. * * @return boolean * @throws PHP_CodeSniffer_Exception If the specified token is not of type * T_FUNCTION */ public function isAnonymousFunction($stackPtr) { $tokenCode = $this->_tokens[$stackPtr]['code']; if ($tokenCode !== T_FUNCTION) { throw new PHP_CodeSniffer_Exception('Token type is not T_FUNCTION'); } if (isset($this->_tokens[$stackPtr]['parenthesis_opener']) === false) { // Something is not right with this function. return false; } $name = false; for ($i = ($stackPtr + 1); $i < $this->numTokens; $i++) { if ($this->_tokens[$i]['code'] === T_STRING) { $name = $i; break; } } if ($name === false) { // No name found. return true; } $open = $this->_tokens[$stackPtr]['parenthesis_opener']; if ($name > $open) { return true; } return false; }//end isAnonymousFunction() /** * Returns the method parameters for the specified T_FUNCTION token. * * Each parameter is in the following format: * * * 0 => array( * 'name' => '$var', // The variable name. * 'pass_by_reference' => false, // Passed by reference. * 'type_hint' => string, // Type hint for array or custom type * ) * * * Parameters with default values have an additional array index of * 'default' with the value of the default as a string. * * @param int $stackPtr The position in the stack of the T_FUNCTION token * to acquire the parameters for. * * @return array * @throws PHP_CodeSniffer_Exception If the specified $stackPtr is not of * type T_FUNCTION. */ public function getMethodParameters($stackPtr) { if ($this->_tokens[$stackPtr]['code'] !== T_FUNCTION) { throw new PHP_CodeSniffer_Exception('$stackPtr must be of type T_FUNCTION'); } $opener = $this->_tokens[$stackPtr]['parenthesis_opener']; $closer = $this->_tokens[$stackPtr]['parenthesis_closer']; $vars = array(); $currVar = null; $defaultStart = null; $paramCount = 0; $passByReference = false; $variableLength = false; $typeHint = ''; for ($i = ($opener + 1); $i <= $closer; $i++) { // Check to see if this token has a parenthesis or bracket opener. If it does // it's likely to be an array which might have arguments in it. This // could cause problems in our parsing below, so lets just skip to the // end of it. if (isset($this->_tokens[$i]['parenthesis_opener']) === true) { // Don't do this if it's the close parenthesis for the method. if ($i !== $this->_tokens[$i]['parenthesis_closer']) { $i = ($this->_tokens[$i]['parenthesis_closer'] + 1); } } if (isset($this->_tokens[$i]['bracket_opener']) === true) { // Don't do this if it's the close parenthesis for the method. if ($i !== $this->_tokens[$i]['bracket_closer']) { $i = ($this->_tokens[$i]['bracket_closer'] + 1); } } switch ($this->_tokens[$i]['code']) { case T_BITWISE_AND: $passByReference = true; break; case T_VARIABLE: $currVar = $i; break; case T_ELLIPSIS: $variableLength = true; break; case T_ARRAY_HINT: case T_CALLABLE: $typeHint = $this->_tokens[$i]['content']; break; case T_STRING: // This is a string, so it may be a type hint, but it could // also be a constant used as a default value. $prevComma = false; for ($t = $i; $t >= $opener; $t--) { if ($this->_tokens[$t]['code'] === T_COMMA) { $prevComma = $t; break; } } if ($prevComma !== false) { $nextEquals = false; for ($t = $prevComma; $t < $i; $t++) { if ($this->_tokens[$t]['code'] === T_EQUAL) { $nextEquals = $t; break; } } if ($nextEquals !== false) { break; } } if ($defaultStart === null) { $typeHint .= $this->_tokens[$i]['content']; } break; case T_NS_SEPARATOR: // Part of a type hint or default value. if ($defaultStart === null) { $typeHint .= $this->_tokens[$i]['content']; } break; case T_CLOSE_PARENTHESIS: case T_COMMA: // If it's null, then there must be no parameters for this // method. if ($currVar === null) { continue; } $vars[$paramCount] = array(); $vars[$paramCount]['name'] = $this->_tokens[$currVar]['content']; if ($defaultStart !== null) { $vars[$paramCount]['default'] = $this->getTokensAsString( $defaultStart, ($i - $defaultStart) ); } $vars[$paramCount]['pass_by_reference'] = $passByReference; $vars[$paramCount]['variable_length'] = $variableLength; $vars[$paramCount]['type_hint'] = $typeHint; // Reset the vars, as we are about to process the next parameter. $defaultStart = null; $passByReference = false; $variableLength = false; $typeHint = ''; $paramCount++; break; case T_EQUAL: $defaultStart = ($i + 1); break; }//end switch }//end for return $vars; }//end getMethodParameters() /** * Returns the visibility and implementation properties of a method. * * The format of the array is: * * array( * 'scope' => 'public', // public private or protected * 'scope_specified' => true, // true is scope keyword was found. * 'is_abstract' => false, // true if the abstract keyword was found. * 'is_final' => false, // true if the final keyword was found. * 'is_static' => false, // true if the static keyword was found. * 'is_closure' => false, // true if no name is found. * ); * * * @param int $stackPtr The position in the stack of the T_FUNCTION token to * acquire the properties for. * * @return array * @throws PHP_CodeSniffer_Exception If the specified position is not a * T_FUNCTION token. */ public function getMethodProperties($stackPtr) { if ($this->_tokens[$stackPtr]['code'] !== T_FUNCTION) { throw new PHP_CodeSniffer_Exception('$stackPtr must be of type T_FUNCTION'); } $valid = array( T_PUBLIC => T_PUBLIC, T_PRIVATE => T_PRIVATE, T_PROTECTED => T_PROTECTED, T_STATIC => T_STATIC, T_FINAL => T_FINAL, T_ABSTRACT => T_ABSTRACT, T_WHITESPACE => T_WHITESPACE, T_COMMENT => T_COMMENT, T_DOC_COMMENT => T_DOC_COMMENT, ); $scope = 'public'; $scopeSpecified = false; $isAbstract = false; $isFinal = false; $isStatic = false; $isClosure = $this->isAnonymousFunction($stackPtr); for ($i = ($stackPtr - 1); $i > 0; $i--) { if (isset($valid[$this->_tokens[$i]['code']]) === false) { break; } switch ($this->_tokens[$i]['code']) { case T_PUBLIC: $scope = 'public'; $scopeSpecified = true; break; case T_PRIVATE: $scope = 'private'; $scopeSpecified = true; break; case T_PROTECTED: $scope = 'protected'; $scopeSpecified = true; break; case T_ABSTRACT: $isAbstract = true; break; case T_FINAL: $isFinal = true; break; case T_STATIC: $isStatic = true; break; }//end switch }//end for return array( 'scope' => $scope, 'scope_specified' => $scopeSpecified, 'is_abstract' => $isAbstract, 'is_final' => $isFinal, 'is_static' => $isStatic, 'is_closure' => $isClosure, ); }//end getMethodProperties() /** * Returns the visibility and implementation properties of the class member * variable found at the specified position in the stack. * * The format of the array is: * * * array( * 'scope' => 'public', // public private or protected * 'is_static' => false, // true if the static keyword was found. * ); * * * @param int $stackPtr The position in the stack of the T_VARIABLE token to * acquire the properties for. * * @return array * @throws PHP_CodeSniffer_Exception If the specified position is not a * T_VARIABLE token, or if the position is not * a class member variable. */ public function getMemberProperties($stackPtr) { if ($this->_tokens[$stackPtr]['code'] !== T_VARIABLE) { throw new PHP_CodeSniffer_Exception('$stackPtr must be of type T_VARIABLE'); } $conditions = array_keys($this->_tokens[$stackPtr]['conditions']); $ptr = array_pop($conditions); if (isset($this->_tokens[$ptr]) === false || ($this->_tokens[$ptr]['code'] !== T_CLASS && $this->_tokens[$ptr]['code'] !== T_TRAIT) ) { if (isset($this->_tokens[$ptr]) === true && $this->_tokens[$ptr]['code'] === T_INTERFACE ) { // T_VARIABLEs in interfaces can actually be method arguments // but they wont be seen as being inside the method because there // are no scope openers and closers for abstract methods. If it is in // parentheses, we can be pretty sure it is a method argument. if (isset($this->_tokens[$stackPtr]['nested_parenthesis']) === false || empty($this->_tokens[$stackPtr]['nested_parenthesis']) === true ) { $error = 'Possible parse error: interfaces may not include member vars'; $this->addWarning($error, $stackPtr, 'Internal.ParseError.InterfaceHasMemberVar'); return array(); } } else { throw new PHP_CodeSniffer_Exception('$stackPtr is not a class member var'); } } $valid = array( T_PUBLIC => T_PUBLIC, T_PRIVATE => T_PRIVATE, T_PROTECTED => T_PROTECTED, T_STATIC => T_STATIC, T_WHITESPACE => T_WHITESPACE, T_COMMENT => T_COMMENT, T_DOC_COMMENT => T_DOC_COMMENT, T_VARIABLE => T_VARIABLE, T_COMMA => T_COMMA, ); $scope = 'public'; $scopeSpecified = false; $isStatic = false; for ($i = ($stackPtr - 1); $i > 0; $i--) { if (isset($valid[$this->_tokens[$i]['code']]) === false) { break; } switch ($this->_tokens[$i]['code']) { case T_PUBLIC: $scope = 'public'; $scopeSpecified = true; break; case T_PRIVATE: $scope = 'private'; $scopeSpecified = true; break; case T_PROTECTED: $scope = 'protected'; $scopeSpecified = true; break; case T_STATIC: $isStatic = true; break; } }//end for return array( 'scope' => $scope, 'scope_specified' => $scopeSpecified, 'is_static' => $isStatic, ); }//end getMemberProperties() /** * Returns the visibility and implementation properties of a class. * * The format of the array is: * * array( * 'is_abstract' => false, // true if the abstract keyword was found. * 'is_final' => false, // true if the final keyword was found. * ); * * * @param int $stackPtr The position in the stack of the T_CLASS token to * acquire the properties for. * * @return array * @throws PHP_CodeSniffer_Exception If the specified position is not a * T_CLASS token. */ public function getClassProperties($stackPtr) { if ($this->_tokens[$stackPtr]['code'] !== T_CLASS) { throw new PHP_CodeSniffer_Exception('$stackPtr must be of type T_CLASS'); } $valid = array( T_FINAL => T_FINAL, T_ABSTRACT => T_ABSTRACT, T_WHITESPACE => T_WHITESPACE, T_COMMENT => T_COMMENT, T_DOC_COMMENT => T_DOC_COMMENT, ); $isAbstract = false; $isFinal = false; for ($i = ($stackPtr - 1); $i > 0; $i--) { if (isset($valid[$this->_tokens[$i]['code']]) === false) { break; } switch ($this->_tokens[$i]['code']) { case T_ABSTRACT: $isAbstract = true; break; case T_FINAL: $isFinal = true; break; } }//end for return array( 'is_abstract' => $isAbstract, 'is_final' => $isFinal, ); }//end getClassProperties() /** * Determine if the passed token is a reference operator. * * Returns true if the specified token position represents a reference. * Returns false if the token represents a bitwise operator. * * @param int $stackPtr The position of the T_BITWISE_AND token. * * @return boolean */ public function isReference($stackPtr) { if ($this->_tokens[$stackPtr]['code'] !== T_BITWISE_AND) { return false; } $tokenBefore = $this->findPrevious( PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr - 1), null, true ); if ($this->_tokens[$tokenBefore]['code'] === T_FUNCTION) { // Function returns a reference. return true; } if ($this->_tokens[$tokenBefore]['code'] === T_DOUBLE_ARROW) { // Inside a foreach loop, this is a reference. return true; } if ($this->_tokens[$tokenBefore]['code'] === T_AS) { // Inside a foreach loop, this is a reference. return true; } if ($this->_tokens[$tokenBefore]['code'] === T_OPEN_SHORT_ARRAY) { // Inside an array declaration, this is a reference. return true; } if (isset(PHP_CodeSniffer_Tokens::$assignmentTokens[$this->_tokens[$tokenBefore]['code']]) === true) { // This is directly after an assignment. It's a reference. Even if // it is part of an operation, the other tests will handle it. return true; } if (isset($this->_tokens[$stackPtr]['nested_parenthesis']) === true) { $brackets = $this->_tokens[$stackPtr]['nested_parenthesis']; $lastBracket = array_pop($brackets); if (isset($this->_tokens[$lastBracket]['parenthesis_owner']) === true) { $owner = $this->_tokens[$this->_tokens[$lastBracket]['parenthesis_owner']]; if ($owner['code'] === T_FUNCTION || $owner['code'] === T_CLOSURE || $owner['code'] === T_ARRAY ) { // Inside a function or array declaration, this is a reference. return true; } } else { $prev = false; for ($t = ($this->_tokens[$lastBracket]['parenthesis_opener'] - 1); $t >= 0; $t--) { if ($this->_tokens[$t]['code'] !== T_WHITESPACE) { $prev = $t; break; } } if ($prev !== false && $this->_tokens[$prev]['code'] === T_USE) { return true; } }//end if }//end if $tokenAfter = $this->findNext( PHP_CodeSniffer_Tokens::$emptyTokens, ($stackPtr + 1), null, true ); if ($this->_tokens[$tokenAfter]['code'] === T_VARIABLE && ($this->_tokens[$tokenBefore]['code'] === T_OPEN_PARENTHESIS || $this->_tokens[$tokenBefore]['code'] === T_COMMA) ) { return true; } return false; }//end isReference() /** * Returns the content of the tokens from the specified start position in * the token stack for the specified length. * * @param int $start The position to start from in the token stack. * @param int $length The length of tokens to traverse from the start pos. * * @return string The token contents. */ public function getTokensAsString($start, $length) { $str = ''; $end = ($start + $length); if ($end > $this->numTokens) { $end = $this->numTokens; } for ($i = $start; $i < $end; $i++) { $str .= $this->_tokens[$i]['content']; } return $str; }//end getTokensAsString() /** * Returns the position of the next specified token(s). * * If a value is specified, the next token of the specified type(s) * containing the specified value will be returned. * * Returns false if no token can be found. * * @param int|array $types The type(s) of tokens to search for. * @param int $start The position to start searching from in the * token stack. * @param int $end The end position to fail if no token is found. * if not specified or null, end will default to * the start of the token stack. * @param bool $exclude If true, find the next token that are NOT of * the types specified in $types. * @param string $value The value that the token(s) must be equal to. * If value is omitted, tokens with any value will * be returned. * @param bool $local If true, tokens outside the current statement * will not be checked. IE. checking will stop * at the next semi-colon found. * * @return int|bool * @see findNext() */ public function findPrevious( $types, $start, $end=null, $exclude=false, $value=null, $local=false ) { $types = (array) $types; if ($end === null) { $end = 0; } for ($i = $start; $i >= $end; $i--) { $found = (bool) $exclude; foreach ($types as $type) { if ($this->_tokens[$i]['code'] === $type) { $found = !$exclude; break; } } if ($found === true) { if ($value === null) { return $i; } else if ($this->_tokens[$i]['content'] === $value) { return $i; } } if ($local === true) { if (isset($this->_tokens[$i]['scope_opener']) === true && $i === $this->_tokens[$i]['scope_closer'] ) { $i = $this->_tokens[$i]['scope_opener']; } else if (isset($this->_tokens[$i]['bracket_opener']) === true && $i === $this->_tokens[$i]['bracket_closer'] ) { $i = $this->_tokens[$i]['bracket_opener']; } else if (isset($this->_tokens[$i]['parenthesis_opener']) === true && $i === $this->_tokens[$i]['parenthesis_closer'] ) { $i = $this->_tokens[$i]['parenthesis_opener']; } else if ($this->_tokens[$i]['code'] === T_SEMICOLON) { break; } } }//end for return false; }//end findPrevious() /** * Returns the position of the next specified token(s). * * If a value is specified, the next token of the specified type(s) * containing the specified value will be returned. * * Returns false if no token can be found. * * @param int|array $types The type(s) of tokens to search for. * @param int $start The position to start searching from in the * token stack. * @param int $end The end position to fail if no token is found. * if not specified or null, end will default to * the end of the token stack. * @param bool $exclude If true, find the next token that is NOT of * a type specified in $types. * @param string $value The value that the token(s) must be equal to. * If value is omitted, tokens with any value will * be returned. * @param bool $local If true, tokens outside the current statement * will not be checked. i.e., checking will stop * at the next semi-colon found. * * @return int|bool * @see findPrevious() */ public function findNext( $types, $start, $end=null, $exclude=false, $value=null, $local=false ) { $types = (array) $types; if ($end === null || $end > $this->numTokens) { $end = $this->numTokens; } for ($i = $start; $i < $end; $i++) { $found = (bool) $exclude; foreach ($types as $type) { if ($this->_tokens[$i]['code'] === $type) { $found = !$exclude; break; } } if ($found === true) { if ($value === null) { return $i; } else if ($this->_tokens[$i]['content'] === $value) { return $i; } } if ($local === true && $this->_tokens[$i]['code'] === T_SEMICOLON) { break; } }//end for return false; }//end findNext() /** * Returns the position of the first non-whitespace token in a statement. * * @param int $start The position to start searching from in the token stack. * * @return int */ public function findStartOfStatement($start) { $endTokens = PHP_CodeSniffer_Tokens::$blockOpeners; $endTokens[T_COLON] = true; $endTokens[T_COMMA] = true; $endTokens[T_DOUBLE_ARROW] = true; $endTokens[T_SEMICOLON] = true; $endTokens[T_OPEN_TAG] = true; $endTokens[T_CLOSE_TAG] = true; $endTokens[T_OPEN_SHORT_ARRAY] = true; $lastNotEmpty = $start; for ($i = $start; $i >= 0; $i--) { if (isset($endTokens[$this->_tokens[$i]['code']]) === true) { // Found the end of the previous statement. return $lastNotEmpty; } if (isset($this->_tokens[$i]['scope_opener']) === true && $i === $this->_tokens[$i]['scope_closer'] ) { // Found the end of the previous scope block. return $lastNotEmpty; } // Skip nested statements. if (isset($this->_tokens[$i]['bracket_opener']) === true && $i === $this->_tokens[$i]['bracket_closer'] ) { $i = $this->_tokens[$i]['bracket_opener']; } else if (isset($this->_tokens[$i]['parenthesis_opener']) === true && $i === $this->_tokens[$i]['parenthesis_closer'] ) { $i = $this->_tokens[$i]['parenthesis_opener']; } if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$this->_tokens[$i]['code']]) === false) { $lastNotEmpty = $i; } }//end for return 0; }//end findStartOfStatement() /** * Returns the position of the last non-whitespace token in a statement. * * @param int $start The position to start searching from in the token stack. * * @return int */ public function findEndOfStatement($start) { $endTokens = array( T_COLON => true, T_COMMA => true, T_DOUBLE_ARROW => true, T_SEMICOLON => true, T_CLOSE_PARENTHESIS => true, T_CLOSE_SQUARE_BRACKET => true, T_CLOSE_CURLY_BRACKET => true, T_CLOSE_SHORT_ARRAY => true, T_OPEN_TAG => true, T_CLOSE_TAG => true, ); $lastNotEmpty = $start; for ($i = $start; $i < $this->numTokens; $i++) { if ($i !== $start && isset($endTokens[$this->_tokens[$i]['code']]) === true) { // Found the end of the statement. if ($this->_tokens[$i]['code'] === T_CLOSE_PARENTHESIS || $this->_tokens[$i]['code'] === T_CLOSE_SQUARE_BRACKET || $this->_tokens[$i]['code'] === T_CLOSE_CURLY_BRACKET || $this->_tokens[$i]['code'] === T_OPEN_TAG || $this->_tokens[$i]['code'] === T_CLOSE_TAG ) { return $lastNotEmpty; } return $i; } // Skip nested statements. if (isset($this->_tokens[$i]['scope_closer']) === true && ($i === $this->_tokens[$i]['scope_opener'] || $i === $this->_tokens[$i]['scope_condition']) ) { $i = $this->_tokens[$i]['scope_closer']; } else if (isset($this->_tokens[$i]['bracket_closer']) === true && $i === $this->_tokens[$i]['bracket_opener'] ) { $i = $this->_tokens[$i]['bracket_closer']; } else if (isset($this->_tokens[$i]['parenthesis_closer']) === true && $i === $this->_tokens[$i]['parenthesis_opener'] ) { $i = $this->_tokens[$i]['parenthesis_closer']; } if (isset(PHP_CodeSniffer_Tokens::$emptyTokens[$this->_tokens[$i]['code']]) === false) { $lastNotEmpty = $i; } }//end for return ($this->numTokens - 1); }//end findEndOfStatement() /** * Returns the position of the first token on a line, matching given type. * * Returns false if no token can be found. * * @param int|array $types The type(s) of tokens to search for. * @param int $start The position to start searching from in the * token stack. The first token matching on * this line before this token will be returned. * @param bool $exclude If true, find the token that is NOT of * the types specified in $types. * @param string $value The value that the token must be equal to. * If value is omitted, tokens with any value will * be returned. * * @return int | bool */ public function findFirstOnLine($types, $start, $exclude=false, $value=null) { if (is_array($types) === false) { $types = array($types); } $foundToken = false; for ($i = $start; $i >= 0; $i--) { if ($this->_tokens[$i]['line'] < $this->_tokens[$start]['line']) { break; } $found = $exclude; foreach ($types as $type) { if ($exclude === false) { if ($this->_tokens[$i]['code'] === $type) { $found = true; break; } } else { if ($this->_tokens[$i]['code'] === $type) { $found = false; break; } } } if ($found === true) { if ($value === null) { $foundToken = $i; } else if ($this->_tokens[$i]['content'] === $value) { $foundToken = $i; } } }//end for return $foundToken; }//end findFirstOnLine() /** * Determine if the passed token has a condition of one of the passed types. * * @param int $stackPtr The position of the token we are checking. * @param int|array $types The type(s) of tokens to search for. * * @return boolean */ public function hasCondition($stackPtr, $types) { // Check for the existence of the token. if (isset($this->_tokens[$stackPtr]) === false) { return false; } // Make sure the token has conditions. if (isset($this->_tokens[$stackPtr]['conditions']) === false) { return false; } $types = (array) $types; $conditions = $this->_tokens[$stackPtr]['conditions']; foreach ($types as $type) { if (in_array($type, $conditions) === true) { // We found a token with the required type. return true; } } return false; }//end hasCondition() /** * Return the position of the condition for the passed token. * * Returns FALSE if the token does not have the condition. * * @param int $stackPtr The position of the token we are checking. * @param int $type The type of token to search for. * * @return int */ public function getCondition($stackPtr, $type) { // Check for the existence of the token. if (isset($this->_tokens[$stackPtr]) === false) { return false; } // Make sure the token has conditions. if (isset($this->_tokens[$stackPtr]['conditions']) === false) { return false; } $conditions = $this->_tokens[$stackPtr]['conditions']; foreach ($conditions as $token => $condition) { if ($condition === $type) { return $token; } } return false; }//end getCondition() /** * Returns the name of the class that the specified class extends. * * Returns FALSE on error or if there is no extended class name. * * @param int $stackPtr The stack position of the class. * * @return string */ public function findExtendedClassName($stackPtr) { // Check for the existence of the token. if (isset($this->_tokens[$stackPtr]) === false) { return false; } if ($this->_tokens[$stackPtr]['code'] !== T_CLASS) { return false; } if (isset($this->_tokens[$stackPtr]['scope_closer']) === false) { return false; } $classCloserIndex = $this->_tokens[$stackPtr]['scope_closer']; $extendsIndex = $this->findNext(T_EXTENDS, $stackPtr, $classCloserIndex); if (false === $extendsIndex) { return false; } $find = array( T_NS_SEPARATOR, T_STRING, T_WHITESPACE, ); $end = $this->findNext($find, ($extendsIndex + 1), $classCloserIndex, true); $name = $this->getTokensAsString(($extendsIndex + 1), ($end - $extendsIndex - 1)); $name = trim($name); if ($name === '') { return false; } return $name; }//end findExtendedClassName() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Fixer.php0000644000076700000240000005116212647543456020305 0ustar gsherwoodstaff * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * A helper class for fixing errors. * * Provides helper functions that act upon a token array and modify the file * content. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @copyright 2006-2012 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Fixer { /** * Is the fixer enabled and fixing a file? * * Sniffs should check this value to ensure they are not * doing extra processing to prepare for a fix when fixing is * not required. * * @var boolean */ public $enabled = false; /** * The number of times we have looped over a file. * * @var int */ public $loops = 0; /** * The file being fixed. * * @var PHP_CodeSniffer_File */ private $_currentFile = null; /** * The list of tokens that make up the file contents. * * This is a simplified list which just contains the token content and nothing * else. This is the array that is updated as fixes are made, not the file's * token array. Imploding this array will give you the file content back. * * @var array(int => string) */ private $_tokens = array(); /** * A list of tokens that have already been fixed. * * We don't allow the same token to be fixed more than once each time * through a file as this can easily cause conflicts between sniffs. * * @var array(int) */ private $_fixedTokens = array(); /** * The last value of each fixed token. * * If a token is being "fixed" back to its last value, the fix is * probably conflicting with another. * * @var array(int => string) */ private $_oldTokenValues = array(); /** * A list of tokens that have been fixed during a changeset. * * All changes in changeset must be able to be applied, or else * the entire changeset is rejected. * * @var array() */ private $_changeset = array(); /** * Is there an open changeset. * * @var boolean */ private $_inChangeset = false; /** * Is the current fixing loop in conflict? * * @var boolean */ private $_inConflict = false; /** * The number of fixes that have been performed. * * @var int */ private $_numFixes = 0; /** * Starts fixing a new file. * * @param PHP_CodeSniffer_File $phpcsFile The file being fixed. * * @return void */ public function startFile($phpcsFile) { $this->_currentFile = $phpcsFile; $this->_numFixes = 0; $this->_fixedTokens = array(); $tokens = $phpcsFile->getTokens(); $this->_tokens = array(); foreach ($tokens as $index => $token) { if (isset($token['orig_content']) === true) { $this->_tokens[$index] = $token['orig_content']; } else { $this->_tokens[$index] = $token['content']; } } }//end startFile() /** * Attempt to fix the file by processing it until no fixes are made. * * @return boolean */ public function fixFile() { $fixable = $this->_currentFile->getFixableCount(); if ($fixable === 0) { // Nothing to fix. return false; } $stdin = false; $cliValues = $this->_currentFile->phpcs->cli->getCommandLineValues(); if (empty($cliValues['files']) === true) { $stdin = true; } $this->enabled = true; $this->loops = 0; while ($this->loops < 50) { ob_start(); // Only needed once file content has changed. $contents = $this->getContents(); if (PHP_CODESNIFFER_VERBOSITY > 2) { @ob_end_clean(); echo '---START FILE CONTENT---'.PHP_EOL; $lines = explode($this->_currentFile->eolChar, $contents); $max = strlen(count($lines)); foreach ($lines as $lineNum => $line) { $lineNum++; echo str_pad($lineNum, $max, ' ', STR_PAD_LEFT).'|'.$line.PHP_EOL; } echo '--- END FILE CONTENT ---'.PHP_EOL; ob_start(); } $this->_inConflict = false; $this->_currentFile->refreshTokenListeners(); $this->_currentFile->start($contents); ob_end_clean(); $this->loops++; if (PHP_CODESNIFFER_CBF === true && $stdin === false) { echo "\r".str_repeat(' ', 80)."\r"; echo "\t=> Fixing file: $this->_numFixes/$fixable violations remaining [made $this->loops pass"; if ($this->loops > 1) { echo 'es'; } echo ']... '; } if ($this->_numFixes === 0 && $this->_inConflict === false) { // Nothing left to do. break; } else if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "\t* fixed $this->_numFixes violations, starting loop ".($this->loops + 1).' *'.PHP_EOL; } }//end while $this->enabled = false; if ($this->_numFixes > 0) { if (PHP_CODESNIFFER_VERBOSITY > 1) { @ob_end_clean(); echo "\t*** Reached maximum number of loops with $this->_numFixes violations left unfixed ***".PHP_EOL; ob_start(); } return false; } return true; }//end fixFile() /** * Generates a text diff of the original file and the new content. * * @param string $filePath Optional file path to diff the file against. * If not specified, the original version of the * file will be used. * @param boolean $colors Print colored output or not. * * @return string */ public function generateDiff($filePath=null, $colors=true) { if ($filePath === null) { $filePath = $this->_currentFile->getFilename(); } $cwd = getcwd().DIRECTORY_SEPARATOR; $filename = str_replace($cwd, '', $filePath); $contents = $this->getContents(); if (function_exists('sys_get_temp_dir') === true) { // This is needed for HHVM support, but only available from 5.2.1. $tempName = tempnam(sys_get_temp_dir(), 'phpcs-fixer'); $fixedFile = fopen($tempName, 'w'); } else { $fixedFile = tmpfile(); $data = stream_get_meta_data($fixedFile); $tempName = $data['uri']; } fwrite($fixedFile, $contents); // We must use something like shell_exec() because whitespace at the end // of lines is critical to diff files. $cmd = "diff -u -L\"$filename\" -LPHP_CodeSniffer \"$filename\" \"$tempName\""; $diff = shell_exec($cmd); fclose($fixedFile); if (is_file($tempName) === true) { unlink($tempName); } if ($colors === false) { return $diff; } $diffLines = explode(PHP_EOL, $diff); if (count($diffLines) === 1) { // Seems to be required for cygwin. $diffLines = explode("\n", $diff); } $diff = array(); foreach ($diffLines as $line) { if (isset($line[0]) === true) { switch ($line[0]) { case '-': $diff[] = "\033[31m$line\033[0m"; break; case '+': $diff[] = "\033[32m$line\033[0m"; break; default: $diff[] = $line; } } } $diff = implode(PHP_EOL, $diff); return $diff; }//end generateDiff() /** * Get a count of fixes that have been performed on the file. * * This value is reset every time a new file is started, or an existing * file is restarted. * * @return int */ public function getFixCount() { return $this->_numFixes; }//end getFixCount() /** * Get the current content of the file, as a string. * * @return string */ public function getContents() { $contents = implode($this->_tokens); return $contents; }//end getContents() /** * Get the current fixed content of a token. * * This function takes changesets into account so should be used * instead of directly accessing the token array. * * @param int $stackPtr The position of the token in the token stack. * * @return string */ public function getTokenContent($stackPtr) { if ($this->_inChangeset === true && isset($this->_changeset[$stackPtr]) === true ) { return $this->_changeset[$stackPtr]; } else { return $this->_tokens[$stackPtr]; } }//end getTokenContent() /** * Start recording actions for a changeset. * * @return void */ public function beginChangeset() { if ($this->_inConflict === true) { return false; } if (PHP_CODESNIFFER_VERBOSITY > 1) { $bt = debug_backtrace(); $sniff = $bt[1]['class']; $line = $bt[0]['line']; @ob_end_clean(); echo "\t=> Changeset started by $sniff (line $line)".PHP_EOL; ob_start(); } $this->_changeset = array(); $this->_inChangeset = true; }//end beginChangeset() /** * Stop recording actions for a changeset, and apply logged changes. * * @return boolean */ public function endChangeset() { if ($this->_inConflict === true) { return false; } $this->_inChangeset = false; $success = true; $applied = array(); foreach ($this->_changeset as $stackPtr => $content) { $success = $this->replaceToken($stackPtr, $content); if ($success === false) { break; } else { $applied[] = $stackPtr; } } if ($success === false) { // Rolling back all changes. foreach ($applied as $stackPtr) { $this->revertToken($stackPtr); } if (PHP_CODESNIFFER_VERBOSITY > 1) { @ob_end_clean(); echo "\t=> Changeset failed to apply".PHP_EOL; ob_start(); } } else if (PHP_CODESNIFFER_VERBOSITY > 1) { $fixes = count($this->_changeset); @ob_end_clean(); echo "\t=> Changeset ended: $fixes changes applied".PHP_EOL; ob_start(); } $this->_changeset = array(); }//end endChangeset() /** * Replace the entire contents of a token. * * @param int $stackPtr The position of the token in the token stack. * @param string $content The new content of the token. * * @return bool If the change was accepted. */ public function replaceToken($stackPtr, $content) { if ($this->_inConflict === true) { return false; } if ($this->_inChangeset === false && isset($this->_fixedTokens[$stackPtr]) === true ) { $indent = "\t"; if (empty($this->_changeset) === false) { $indent .= "\t"; } if (PHP_CODESNIFFER_VERBOSITY > 1) { @ob_end_clean(); echo "$indent* token $stackPtr has already been modified, skipping *".PHP_EOL; ob_start(); } return false; } if (PHP_CODESNIFFER_VERBOSITY > 1) { $bt = debug_backtrace(); if ($bt[1]['class'] === 'PHP_CodeSniffer_Fixer') { $sniff = $bt[2]['class']; $line = $bt[1]['line']; } else { $sniff = $bt[1]['class']; $line = $bt[0]['line']; } $tokens = $this->_currentFile->getTokens(); $type = $tokens[$stackPtr]['type']; $oldContent = PHP_CodeSniffer::prepareForOutput($this->_tokens[$stackPtr]); $newContent = PHP_CodeSniffer::prepareForOutput($content); if (trim($this->_tokens[$stackPtr]) === '' && isset($this->_tokens[($stackPtr + 1)]) === true) { // Add some context for whitespace only changes. $append = PHP_CodeSniffer::prepareForOutput($this->_tokens[($stackPtr + 1)]); $oldContent .= $append; $newContent .= $append; } }//end if if ($this->_inChangeset === true) { $this->_changeset[$stackPtr] = $content; if (PHP_CODESNIFFER_VERBOSITY > 1) { @ob_end_clean(); echo "\t\tQ: $sniff (line $line) replaced token $stackPtr ($type) \"$oldContent\" => \"$newContent\"".PHP_EOL; ob_start(); } return true; } if (isset($this->_oldTokenValues[$stackPtr]) === false) { $this->_oldTokenValues[$stackPtr] = array( 'curr' => $content, 'prev' => $this->_tokens[$stackPtr], 'loop' => $this->loops, ); } else { if ($this->_oldTokenValues[$stackPtr]['prev'] === $content && $this->_oldTokenValues[$stackPtr]['loop'] === ($this->loops - 1) ) { if (PHP_CODESNIFFER_VERBOSITY > 1) { $indent = "\t"; if (empty($this->_changeset) === false) { $indent .= "\t"; } $loop = $this->_oldTokenValues[$stackPtr]['loop']; @ob_end_clean(); echo "$indent**** $sniff (line $line) has possible conflict with another sniff on loop $loop; caused by the following change ****".PHP_EOL; echo "$indent**** replaced token $stackPtr ($type) \"$oldContent\" => \"$newContent\" ****".PHP_EOL; } if ($this->_oldTokenValues[$stackPtr]['loop'] >= ($this->loops - 1)) { $this->_inConflict = true; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo "$indent**** ignoring all changes until next loop ****".PHP_EOL; } } if (PHP_CODESNIFFER_VERBOSITY > 1) { ob_start(); } return false; }//end if $this->_oldTokenValues[$stackPtr]['prev'] = $this->_oldTokenValues[$stackPtr]['curr']; $this->_oldTokenValues[$stackPtr]['curr'] = $content; $this->_oldTokenValues[$stackPtr]['loop'] = $this->loops; }//end if $this->_fixedTokens[$stackPtr] = $this->_tokens[$stackPtr]; $this->_tokens[$stackPtr] = $content; $this->_numFixes++; if (PHP_CODESNIFFER_VERBOSITY > 1) { $indent = "\t"; if (empty($this->_changeset) === false) { $indent .= "\tA: "; } @ob_end_clean(); echo "$indent$sniff (line $line) replaced token $stackPtr ($type) \"$oldContent\" => \"$newContent\"".PHP_EOL; ob_start(); } return true; }//end replaceToken() /** * Reverts the previous fix made to a token. * * @param int $stackPtr The position of the token in the token stack. * * @return bool If a change was reverted. */ public function revertToken($stackPtr) { if (isset($this->_fixedTokens[$stackPtr]) === false) { return false; } if (PHP_CODESNIFFER_VERBOSITY > 1) { $bt = debug_backtrace(); if ($bt[1]['class'] === 'PHP_CodeSniffer_Fixer') { $sniff = $bt[2]['class']; $line = $bt[1]['line']; } else { $sniff = $bt[1]['class']; $line = $bt[0]['line']; } $tokens = $this->_currentFile->getTokens(); $type = $tokens[$stackPtr]['type']; $oldContent = PHP_CodeSniffer::prepareForOutput($this->_tokens[$stackPtr]); $newContent = PHP_CodeSniffer::prepareForOutput($this->_fixedTokens[$stackPtr]); if (trim($this->_tokens[$stackPtr]) === '' && isset($tokens[($stackPtr + 1)]) === true) { // Add some context for whitespace only changes. $append = PHP_CodeSniffer::prepareForOutput($this->_tokens[($stackPtr + 1)]); $oldContent .= $append; $newContent .= $append; } }//end if $this->_tokens[$stackPtr] = $this->_fixedTokens[$stackPtr]; unset($this->_fixedTokens[$stackPtr]); $this->_numFixes--; if (PHP_CODESNIFFER_VERBOSITY > 1) { $indent = "\t"; if (empty($this->_changeset) === false) { $indent .= "\tR: "; } @ob_end_clean(); echo "$indent$sniff (line $line) reverted token $stackPtr ($type) \"$oldContent\" => \"$newContent\"".PHP_EOL; ob_start(); } return true; }//end revertToken() /** * Replace the content of a token with a part of its current content. * * @param int $stackPtr The position of the token in the token stack. * @param int $start The first character to keep. * @param int $length The number of chacters to keep. If NULL, the content of * the token from $start to the end of the content is kept. * * @return bool If the change was accepted. */ public function substrToken($stackPtr, $start, $length=null) { $current = $this->getTokenContent($stackPtr); if ($length === null) { $newContent = substr($current, $start); } else { $newContent = substr($current, $start, $length); } return $this->replaceToken($stackPtr, $newContent); }//end substrToken() /** * Adds a newline to end of a token's content. * * @param int $stackPtr The position of the token in the token stack. * * @return bool If the change was accepted. */ public function addNewline($stackPtr) { $current = $this->getTokenContent($stackPtr); return $this->replaceToken($stackPtr, $current.$this->_currentFile->eolChar); }//end addNewline() /** * Adds a newline to the start of a token's content. * * @param int $stackPtr The position of the token in the token stack. * * @return bool If the change was accepted. */ public function addNewlineBefore($stackPtr) { $current = $this->getTokenContent($stackPtr); return $this->replaceToken($stackPtr, $this->_currentFile->eolChar.$current); }//end addNewlineBefore() /** * Adds content to the end of a token's current content. * * @param int $stackPtr The position of the token in the token stack. * @param string $content The content to add. * * @return bool If the change was accepted. */ public function addContent($stackPtr, $content) { $current = $this->getTokenContent($stackPtr); return $this->replaceToken($stackPtr, $current.$content); }//end addContent() /** * Adds content to the start of a token's current content. * * @param int $stackPtr The position of the token in the token stack. * @param string $content The content to add. * * @return bool If the change was accepted. */ public function addContentBefore($stackPtr, $content) { $current = $this->getTokenContent($stackPtr); return $this->replaceToken($stackPtr, $content.$current); }//end addContentBefore() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Report.php0000644000076700000240000000534112647543456020501 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Represents a PHP_CodeSniffer report. * * @category PHP * @package PHP_CodeSniffer * @author Gabriele Santini * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ interface PHP_CodeSniffer_Report { /** * Generate a partial report for a single processed file. * * Function should return TRUE if it printed or stored data about the file * and FALSE if it ignored the file. Returning TRUE indicates that the file and * its data should be counted in the grand totals. * * @param array $report Prepared report data. * @param PHP_CodeSniffer_File $phpcsFile The file being reported on. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * * @return boolean */ public function generateFileReport( $report, PHP_CodeSniffer_File $phpcsFile, $showSources=false, $width=80 ); /** * Generate the actual report. * * @param string $cachedData Any partial report data that was returned from * generateFileReport during the run. * @param int $totalFiles Total number of files processed during the run. * @param int $totalErrors Total number of errors found during the run. * @param int $totalWarnings Total number of warnings found during the run. * @param int $totalFixable Total number of problems that can be fixed. * @param boolean $showSources Show sources? * @param int $width Maximum allowed line width. * @param boolean $toScreen Is the report being printed to screen? * * @return void */ public function generate( $cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources=false, $width=80, $toScreen=true ); }//end interface PHP_CodeSniffer-2.5.1/CodeSniffer/Reporting.php0000644000076700000240000003142112647543456021175 0ustar gsherwoodstaff * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * A class to manage reporting. * * @category PHP * @package PHP_CodeSniffer * @author Gabriele Santini * @author Greg Sherwood * @copyright 2009-2014 SQLI * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer_Reporting { /** * Total number of files that contain errors or warnings. * * @var int */ public $totalFiles = 0; /** * Total number of errors found during the run. * * @var int */ public $totalErrors = 0; /** * Total number of warnings found during the run. * * @var int */ public $totalWarnings = 0; /** * Total number of errors/warnings that can be fixed. * * @var int */ public $totalFixable = 0; /** * When the PHPCS run started. * * @var float */ public static $startTime = 0; /** * A list of reports that have written partial report output. * * @var array */ private $_cachedReports = array(); /** * A cache of report objects. * * @var array */ private $_reports = array(); /** * A cache of opened tmp files. * * @var array */ private $_tmpFiles = array(); /** * Produce the appropriate report object based on $type parameter. * * @param string $type The type of the report. * * @return PHP_CodeSniffer_Report * @throws PHP_CodeSniffer_Exception If report is not available. */ public function factory($type) { $type = ucfirst($type); if (isset($this->_reports[$type]) === true) { return $this->_reports[$type]; } if (strpos($type, '.') !== false) { // This is a path to a custom report class. $filename = realpath($type); if ($filename === false) { echo 'ERROR: Custom report "'.$type.'" not found'.PHP_EOL; exit(2); } $reportClassName = 'PHP_CodeSniffer_Reports_'.basename($filename); $reportClassName = substr($reportClassName, 0, strpos($reportClassName, '.')); include_once $filename; } else { $filename = $type.'.php'; $reportClassName = 'PHP_CodeSniffer_Reports_'.$type; if (class_exists($reportClassName, true) === false) { echo 'ERROR: Report type "'.$type.'" not found'.PHP_EOL; exit(2); } }//end if $reportClass = new $reportClassName(); if (false === ($reportClass instanceof PHP_CodeSniffer_Report)) { throw new PHP_CodeSniffer_Exception('Class "'.$reportClassName.'" must implement the "PHP_CodeSniffer_Report" interface.'); } $this->_reports[$type] = $reportClass; return $this->_reports[$type]; }//end factory() /** * Actually generates the report. * * @param PHP_CodeSniffer_File $phpcsFile The file that has been processed. * @param array $cliValues An array of command line arguments. * * @return void */ public function cacheFileReport(PHP_CodeSniffer_File $phpcsFile, array $cliValues) { if (isset($cliValues['reports']) === false) { // This happens during unit testing, or any time someone just wants // the error data and not the printed report. return; } $reportData = $this->prepareFileReport($phpcsFile); $errorsShown = false; foreach ($cliValues['reports'] as $report => $output) { $reportClass = $this->factory($report); $report = get_class($reportClass); ob_start(); $result = $reportClass->generateFileReport($reportData, $phpcsFile, $cliValues['showSources'], $cliValues['reportWidth']); if ($result === true) { $errorsShown = true; } $generatedReport = ob_get_contents(); ob_end_clean(); if ($output === null && $cliValues['reportFile'] !== null) { $output = $cliValues['reportFile']; } if ($output === null) { // Using a temp file. if (isset($this->_tmpFiles[$report]) === false) { if (function_exists('sys_get_temp_dir') === true) { // This is needed for HHVM support, but only available from 5.2.1. $this->_tmpFiles[$report] = fopen(tempnam(sys_get_temp_dir(), 'phpcs'), 'w'); } else { $this->_tmpFiles[$report] = tmpfile(); } } fwrite($this->_tmpFiles[$report], $generatedReport); } else { $flags = FILE_APPEND; if (isset($this->_cachedReports[$report]) === false) { $this->_cachedReports[$report] = true; $flags = null; } file_put_contents($output, $generatedReport, $flags); }//end if }//end foreach if ($errorsShown === true) { $this->totalFiles++; $this->totalErrors += $reportData['errors']; $this->totalWarnings += $reportData['warnings']; $this->totalFixable += $reportData['fixable']; } }//end cacheFileReport() /** * Generates and prints a final report. * * Returns an array with the number of errors and the number of * warnings, in the form ['errors' => int, 'warnings' => int]. * * @param string $report Report type. * @param boolean $showSources Show sources? * @param array $cliValues An array of command line arguments. * @param string $reportFile Report file to generate. * @param integer $reportWidth Report max width. * * @return int[] */ public function printReport( $report, $showSources, array $cliValues, $reportFile='', $reportWidth=80 ) { $reportClass = $this->factory($report); $report = get_class($reportClass); if ($reportFile !== null) { $filename = $reportFile; $toScreen = false; if (file_exists($filename) === true && isset($this->_cachedReports[$report]) === true ) { $reportCache = file_get_contents($filename); } else { $reportCache = ''; } } else { if (isset($this->_tmpFiles[$report]) === true) { $data = stream_get_meta_data($this->_tmpFiles[$report]); $filename = $data['uri']; $reportCache = file_get_contents($filename); fclose($this->_tmpFiles[$report]); } else { $reportCache = ''; $filename = null; } $toScreen = true; }//end if ob_start(); $reportClass->generate( $reportCache, $this->totalFiles, $this->totalErrors, $this->totalWarnings, $this->totalFixable, $showSources, $reportWidth, $toScreen ); $generatedReport = ob_get_contents(); ob_end_clean(); if ($cliValues['colors'] !== true || $reportFile !== null) { $generatedReport = preg_replace('`\033\[[0-9]+m`', '', $generatedReport); } if ($reportFile !== null) { if (PHP_CODESNIFFER_VERBOSITY > 0) { echo $generatedReport; } file_put_contents($reportFile, $generatedReport.PHP_EOL); } else { echo $generatedReport; if ($filename !== null && file_exists($filename) === true) { unlink($filename); } } return array( 'errors' => $this->totalErrors, 'warnings' => $this->totalWarnings, ); }//end printReport() /** * Pre-process and package violations for all files. * * Used by error reports to get a packaged list of all errors in each file. * * @param PHP_CodeSniffer_File $phpcsFile The file that has been processed. * * @return array */ public function prepareFileReport(PHP_CodeSniffer_File $phpcsFile) { $report = array( 'filename' => $phpcsFile->getFilename(), 'errors' => $phpcsFile->getErrorCount(), 'warnings' => $phpcsFile->getWarningCount(), 'fixable' => $phpcsFile->getFixableCount(), 'messages' => array(), ); if ($report['errors'] === 0 && $report['warnings'] === 0) { // Prefect score! return $report; } $errors = array(); // Merge errors and warnings. foreach ($phpcsFile->getErrors() as $line => $lineErrors) { if (is_array($lineErrors) === false) { continue; } foreach ($lineErrors as $column => $colErrors) { $newErrors = array(); foreach ($colErrors as $data) { $newErrors[] = array( 'message' => $data['message'], 'source' => $data['source'], 'severity' => $data['severity'], 'fixable' => $data['fixable'], 'type' => 'ERROR', ); }//end foreach $errors[$line][$column] = $newErrors; }//end foreach ksort($errors[$line]); }//end foreach foreach ($phpcsFile->getWarnings() as $line => $lineWarnings) { if (is_array($lineWarnings) === false) { continue; } foreach ($lineWarnings as $column => $colWarnings) { $newWarnings = array(); foreach ($colWarnings as $data) { $newWarnings[] = array( 'message' => $data['message'], 'source' => $data['source'], 'severity' => $data['severity'], 'fixable' => $data['fixable'], 'type' => 'WARNING', ); }//end foreach if (isset($errors[$line]) === false) { $errors[$line] = array(); } if (isset($errors[$line][$column]) === true) { $errors[$line][$column] = array_merge( $newWarnings, $errors[$line][$column] ); } else { $errors[$line][$column] = $newWarnings; } }//end foreach ksort($errors[$line]); }//end foreach ksort($errors); $report['messages'] = $errors; return $report; }//end prepareFileReport() /** * Start recording time for the run. * * @return void */ public static function startTiming() { self::$startTime = microtime(true); }//end startTiming() /** * Print information about the run. * * @return void */ public static function printRunTime() { $time = ((microtime(true) - self::$startTime) * 1000); if ($time > 60000) { $mins = floor($time / 60000); $secs = round((($time % 60000) / 1000), 2); $time = $mins.' mins'; if ($secs !== 0) { $time .= ", $secs secs"; } } else if ($time > 1000) { $time = round(($time / 1000), 2).' secs'; } else { $time = round($time).'ms'; } $mem = round((memory_get_peak_usage(true) / (1024 * 1024)), 2).'Mb'; echo "Time: $time; Memory: $mem".PHP_EOL.PHP_EOL; }//end printRunTime() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer/Sniff.php0000644000076700000240000000644212647543456020276 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ /** * Represents a PHP_CodeSniffer sniff for sniffing coding standards. * * A sniff registers what token types it wishes to listen for, then, when * PHP_CodeSniffer encounters that token, the sniff is invoked and passed * information about where the token was found in the stack, and the * PHP_CodeSniffer file in which the token was found. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ interface PHP_CodeSniffer_Sniff { /** * Registers the tokens that this sniff wants to listen for. * * An example return value for a sniff that wants to listen for whitespace * and any comments would be: * * * return array( * T_WHITESPACE, * T_DOC_COMMENT, * T_COMMENT, * ); * * * @return int[] * @see Tokens.php */ public function register(); /** * Called when one of the token types that this sniff is listening for * is found. * * The stackPtr variable indicates where in the stack the token was found. * A sniff can acquire information this token, along with all the other * tokens within the stack by first acquiring the token stack: * * * $tokens = $phpcsFile->getTokens(); * echo 'Encountered a '.$tokens[$stackPtr]['type'].' token'; * echo 'token information: '; * print_r($tokens[$stackPtr]); * * * If the sniff discovers an anomaly in the code, they can raise an error * by calling addError() on the PHP_CodeSniffer_File object, specifying an error * message and the position of the offending token: * * * $phpcsFile->addError('Encountered an error', $stackPtr); * * * @param PHP_CodeSniffer_File $phpcsFile The PHP_CodeSniffer file where the * token was found. * @param int $stackPtr The position in the PHP_CodeSniffer * file's token stack where the token * was found. * * @return void|int Optionally returns a stack pointer. The sniff will not be * called again on the current file until the returned stack * pointer is reached. Return (count($tokens) + 1) to skip * the rest of the file. */ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr); }//end interface PHP_CodeSniffer-2.5.1/CodeSniffer/Tokens.php0000644000076700000240000010265612647543456020500 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ define('T_NONE', 'PHPCS_T_NONE'); define('T_OPEN_CURLY_BRACKET', 'PHPCS_T_OPEN_CURLY_BRACKET'); define('T_CLOSE_CURLY_BRACKET', 'PHPCS_T_CLOSE_CURLY_BRACKET'); define('T_OPEN_SQUARE_BRACKET', 'PHPCS_T_OPEN_SQUARE_BRACKET'); define('T_CLOSE_SQUARE_BRACKET', 'PHPCS_T_CLOSE_SQUARE_BRACKET'); define('T_OPEN_PARENTHESIS', 'PHPCS_T_OPEN_PARENTHESIS'); define('T_CLOSE_PARENTHESIS', 'PHPCS_T_CLOSE_PARENTHESIS'); define('T_COLON', 'PHPCS_T_COLON'); define('T_STRING_CONCAT', 'PHPCS_T_STRING_CONCAT'); define('T_INLINE_THEN', 'PHPCS_T_INLINE_THEN'); define('T_INLINE_ELSE', 'PHPCS_T_INLINE_ELSE'); define('T_NULL', 'PHPCS_T_NULL'); define('T_FALSE', 'PHPCS_T_FALSE'); define('T_TRUE', 'PHPCS_T_TRUE'); define('T_SEMICOLON', 'PHPCS_T_SEMICOLON'); define('T_EQUAL', 'PHPCS_T_EQUAL'); define('T_MULTIPLY', 'PHPCS_T_MULTIPLY'); define('T_DIVIDE', 'PHPCS_T_DIVIDE'); define('T_PLUS', 'PHPCS_T_PLUS'); define('T_MINUS', 'PHPCS_T_MINUS'); define('T_MODULUS', 'PHPCS_T_MODULUS'); define('T_BITWISE_AND', 'PHPCS_T_BITWISE_AND'); define('T_BITWISE_OR', 'PHPCS_T_BITWISE_OR'); define('T_BITWISE_XOR', 'PHPCS_T_BITWISE_XOR'); define('T_ARRAY_HINT', 'PHPCS_T_ARRAY_HINT'); define('T_GREATER_THAN', 'PHPCS_T_GREATER_THAN'); define('T_LESS_THAN', 'PHPCS_T_LESS_THAN'); define('T_BOOLEAN_NOT', 'PHPCS_T_BOOLEAN_NOT'); define('T_SELF', 'PHPCS_T_SELF'); define('T_PARENT', 'PHPCS_T_PARENT'); define('T_DOUBLE_QUOTED_STRING', 'PHPCS_T_DOUBLE_QUOTED_STRING'); define('T_COMMA', 'PHPCS_T_COMMA'); define('T_HEREDOC', 'PHPCS_T_HEREDOC'); define('T_PROTOTYPE', 'PHPCS_T_PROTOTYPE'); define('T_THIS', 'PHPCS_T_THIS'); define('T_REGULAR_EXPRESSION', 'PHPCS_T_REGULAR_EXPRESSION'); define('T_PROPERTY', 'PHPCS_T_PROPERTY'); define('T_LABEL', 'PHPCS_T_LABEL'); define('T_OBJECT', 'PHPCS_T_OBJECT'); define('T_CLOSE_OBJECT', 'PHPCS_T_CLOSE_OBJECT'); define('T_COLOUR', 'PHPCS_T_COLOUR'); define('T_HASH', 'PHPCS_T_HASH'); define('T_URL', 'PHPCS_T_URL'); define('T_STYLE', 'PHPCS_T_STYLE'); define('T_ASPERAND', 'PHPCS_T_ASPERAND'); define('T_DOLLAR', 'PHPCS_T_DOLLAR'); define('T_TYPEOF', 'PHPCS_T_TYPEOF'); define('T_CLOSURE', 'PHPCS_T_CLOSURE'); define('T_ANON_CLASS', 'PHPCS_T_ANON_CLASS'); define('T_BACKTICK', 'PHPCS_T_BACKTICK'); define('T_START_NOWDOC', 'PHPCS_T_START_NOWDOC'); define('T_NOWDOC', 'PHPCS_T_NOWDOC'); define('T_END_NOWDOC', 'PHPCS_T_END_NOWDOC'); define('T_OPEN_SHORT_ARRAY', 'PHPCS_T_OPEN_SHORT_ARRAY'); define('T_CLOSE_SHORT_ARRAY', 'PHPCS_T_CLOSE_SHORT_ARRAY'); define('T_GOTO_LABEL', 'PHPCS_T_GOTO_LABEL'); define('T_BINARY_CAST', 'PHPCS_T_BINARY_CAST'); define('T_EMBEDDED_PHP', 'PHPCS_T_EMBEDDED_PHP'); define('T_RETURN_TYPE', 'PHPCS_T_RETURN_TYPE'); // Some PHP 5.3 tokens, replicated for lower versions. if (defined('T_NAMESPACE') === false) { define('T_NAMESPACE', 'PHPCS_T_NAMESPACE'); } if (defined('T_NS_C') === false) { define('T_NS_C', 'PHPCS_T_NS_C'); } if (defined('T_NS_SEPARATOR') === false) { define('T_NS_SEPARATOR', 'PHPCS_T_NS_SEPARATOR'); } if (defined('T_GOTO') === false) { define('T_GOTO', 'PHPCS_T_GOTO'); } if (defined('T_DIR') === false) { define('T_DIR', 'PHPCS_T_DIR'); } // Some PHP 5.4 tokens, replicated for lower versions. if (defined('T_TRAIT') === false) { define('T_TRAIT', 'PHPCS_T_TRAIT'); } if (defined('T_TRAIT_C') === false) { define('T_TRAIT_C', 'PHPCS_T_TRAIT_C'); } if (defined('T_INSTEADOF') === false) { define('T_INSTEADOF', 'PHPCS_T_INSTEADOF'); } if (defined('T_CALLABLE') === false) { define('T_CALLABLE', 'PHPCS_T_CALLABLE'); } // Some PHP 5.5 tokens, replicated for lower versions. if (defined('T_FINALLY') === false) { define('T_FINALLY', 'PHPCS_T_FINALLY'); } if (defined('T_YIELD') === false) { define('T_YIELD', 'PHPCS_T_YIELD'); } // Some PHP 5.6 tokens, replicated for lower versions. if (defined('T_ELLIPSIS') === false) { define('T_ELLIPSIS', 'PHPCS_T_ELLIPSIS'); } if (defined('T_POW') === false) { define('T_POW', 'PHPCS_T_POW'); } // Some PHP 7 tokens, replicated for lower versions. if (defined('T_SPACESHIP') === false) { define('T_SPACESHIP', 'PHPCS_T_SPACESHIP'); } // Tokens used for parsing doc blocks. define('T_DOC_COMMENT_STAR', 'PHPCS_T_DOC_COMMENT_STAR'); define('T_DOC_COMMENT_WHITESPACE', 'PHPCS_T_DOC_COMMENT_WHITESPACE'); define('T_DOC_COMMENT_TAG', 'PHPCS_T_DOC_COMMENT_TAG'); define('T_DOC_COMMENT_OPEN_TAG', 'PHPCS_T_DOC_COMMENT_OPEN_TAG'); define('T_DOC_COMMENT_CLOSE_TAG', 'PHPCS_T_DOC_COMMENT_CLOSE_TAG'); define('T_DOC_COMMENT_STRING', 'PHPCS_T_DOC_COMMENT_STRING'); /** * The Tokens class contains weightings for tokens based on their * probability of occurrence in a file. * * The less the chance of a high occurrence of an arbitrary token, the higher * the weighting. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: 2.5.1 * @link http://pear.php.net/package/PHP_CodeSniffer */ final class PHP_CodeSniffer_Tokens { /** * The token weightings. * * @var array(int => int) */ public static $weightings = array( T_CLASS => 1000, T_INTERFACE => 1000, T_TRAIT => 1000, T_NAMESPACE => 1000, T_FUNCTION => 100, T_CLOSURE => 100, /* Conditions. */ T_WHILE => 50, T_FOR => 50, T_FOREACH => 50, T_IF => 50, T_ELSE => 50, T_ELSEIF => 50, T_DO => 50, T_TRY => 50, T_CATCH => 50, T_FINALLY => 50, T_SWITCH => 50, T_SELF => 25, T_PARENT => 25, /* Operators and arithmetic. */ T_BITWISE_AND => 8, T_BITWISE_OR => 8, T_BITWISE_XOR => 8, T_MULTIPLY => 5, T_DIVIDE => 5, T_PLUS => 5, T_MINUS => 5, T_MODULUS => 5, T_POW => 5, T_SPACESHIP => 5, T_SL => 5, T_SR => 5, T_SL_EQUAL => 5, T_SR_EQUAL => 5, T_EQUAL => 5, T_AND_EQUAL => 5, T_CONCAT_EQUAL => 5, T_DIV_EQUAL => 5, T_MINUS_EQUAL => 5, T_MOD_EQUAL => 5, T_MUL_EQUAL => 5, T_OR_EQUAL => 5, T_PLUS_EQUAL => 5, T_XOR_EQUAL => 5, T_BOOLEAN_AND => 5, T_BOOLEAN_OR => 5, /* Equality. */ T_IS_EQUAL => 5, T_IS_NOT_EQUAL => 5, T_IS_IDENTICAL => 5, T_IS_NOT_IDENTICAL => 5, T_IS_SMALLER_OR_EQUAL => 5, T_IS_GREATER_OR_EQUAL => 5, ); /** * The token weightings. * * @var array(int => int) */ public static $knownLengths = array( T_ABSTRACT => 8, T_AND_EQUAL => 2, T_ARRAY => 5, T_AS => 2, T_BOOLEAN_AND => 2, T_BOOLEAN_OR => 2, T_BREAK => 5, T_CALLABLE => 8, T_CASE => 4, T_CATCH => 5, T_CLASS => 5, T_CLASS_C => 9, T_CLONE => 5, T_CONCAT_EQUAL => 2, T_CONST => 5, T_CONTINUE => 8, T_CURLY_OPEN => 2, T_DEC => 2, T_DECLARE => 7, T_DEFAULT => 7, T_DIR => 7, T_DIV_EQUAL => 2, T_DO => 2, T_DOLLAR_OPEN_CURLY_BRACES => 2, T_DOUBLE_ARROW => 2, T_DOUBLE_COLON => 2, T_ECHO => 4, T_ELSE => 4, T_ELSEIF => 6, T_EMPTY => 5, T_ENDDECLARE => 10, T_ENDFOR => 6, T_ENDFOREACH => 10, T_ENDIF => 5, T_ENDSWITCH => 9, T_ENDWHILE => 8, T_EVAL => 4, T_EXTENDS => 7, T_FILE => 8, T_FINAL => 5, T_FINALLY => 7, T_FOR => 3, T_FOREACH => 7, T_FUNCTION => 8, T_FUNC_C => 12, T_GLOBAL => 6, T_GOTO => 4, T_HALT_COMPILER => 15, T_IF => 2, T_IMPLEMENTS => 10, T_INC => 2, T_INCLUDE => 7, T_INCLUDE_ONCE => 12, T_INSTANCEOF => 10, T_INSTEADOF => 9, T_INTERFACE => 9, T_ISSET => 5, T_IS_EQUAL => 2, T_IS_GREATER_OR_EQUAL => 2, T_IS_IDENTICAL => 3, T_IS_NOT_EQUAL => 2, T_IS_NOT_IDENTICAL => 3, T_IS_SMALLER_OR_EQUAL => 2, T_LINE => 8, T_LIST => 4, T_LOGICAL_AND => 3, T_LOGICAL_OR => 2, T_LOGICAL_XOR => 3, T_METHOD_C => 10, T_MINUS_EQUAL => 2, T_MOD_EQUAL => 2, T_MUL_EQUAL => 2, T_NAMESPACE => 9, T_NS_C => 13, T_NS_SEPARATOR => 1, T_NEW => 3, T_OBJECT_OPERATOR => 2, T_OPEN_TAG_WITH_ECHO => 3, T_OR_EQUAL => 2, T_PLUS_EQUAL => 2, T_PRINT => 5, T_PRIVATE => 7, T_PUBLIC => 6, T_PROTECTED => 9, T_REQUIRE => 7, T_REQUIRE_ONCE => 12, T_RETURN => 6, T_STATIC => 6, T_SWITCH => 6, T_THROW => 5, T_TRAIT => 5, T_TRAIT_C => 9, T_TRY => 3, T_UNSET => 5, T_USE => 3, T_VAR => 3, T_WHILE => 5, T_XOR_EQUAL => 2, T_YIELD => 5, T_OPEN_CURLY_BRACKET => 1, T_CLOSE_CURLY_BRACKET => 1, T_OPEN_SQUARE_BRACKET => 1, T_CLOSE_SQUARE_BRACKET => 1, T_OPEN_PARENTHESIS => 1, T_CLOSE_PARENTHESIS => 1, T_COLON => 1, T_STRING_CONCAT => 1, T_INLINE_THEN => 1, T_INLINE_ELSE => 1, T_NULL => 4, T_FALSE => 5, T_TRUE => 4, T_SEMICOLON => 1, T_EQUAL => 1, T_MULTIPLY => 1, T_DIVIDE => 1, T_PLUS => 1, T_MINUS => 1, T_MODULUS => 1, T_POW => 2, T_SPACESHIP => 3, T_BITWISE_AND => 1, T_BITWISE_OR => 1, T_BITWISE_XOR => 1, T_SL => 2, T_SR => 2, T_SL_EQUAL => 3, T_SR_EQUAL => 3, T_ARRAY_HINT => 5, T_GREATER_THAN => 1, T_LESS_THAN => 1, T_BOOLEAN_NOT => 1, T_SELF => 4, T_PARENT => 6, T_COMMA => 1, T_THIS => 4, T_CLOSURE => 8, T_BACKTICK => 1, T_OPEN_SHORT_ARRAY => 1, T_CLOSE_SHORT_ARRAY => 1, ); /** * Tokens that represent assignments. * * @var array(int) */ public static $assignmentTokens = array( T_EQUAL => T_EQUAL, T_AND_EQUAL => T_AND_EQUAL, T_CONCAT_EQUAL => T_CONCAT_EQUAL, T_DIV_EQUAL => T_DIV_EQUAL, T_MINUS_EQUAL => T_MINUS_EQUAL, T_MOD_EQUAL => T_MOD_EQUAL, T_MUL_EQUAL => T_MUL_EQUAL, T_PLUS_EQUAL => T_PLUS_EQUAL, T_XOR_EQUAL => T_XOR_EQUAL, T_DOUBLE_ARROW => T_DOUBLE_ARROW, T_SL_EQUAL => T_SL_EQUAL, T_SR_EQUAL => T_SR_EQUAL, ); /** * Tokens that represent equality comparisons. * * @var array(int) */ public static $equalityTokens = array( T_IS_EQUAL => T_IS_EQUAL, T_IS_NOT_EQUAL => T_IS_NOT_EQUAL, T_IS_IDENTICAL => T_IS_IDENTICAL, T_IS_NOT_IDENTICAL => T_IS_NOT_IDENTICAL, T_IS_SMALLER_OR_EQUAL => T_IS_SMALLER_OR_EQUAL, T_IS_GREATER_OR_EQUAL => T_IS_GREATER_OR_EQUAL, ); /** * Tokens that represent comparison operator. * * @var array(int) */ public static $comparisonTokens = array( T_IS_EQUAL => T_IS_EQUAL, T_IS_IDENTICAL => T_IS_IDENTICAL, T_IS_NOT_EQUAL => T_IS_NOT_EQUAL, T_IS_NOT_IDENTICAL => T_IS_NOT_IDENTICAL, T_LESS_THAN => T_LESS_THAN, T_GREATER_THAN => T_GREATER_THAN, T_IS_SMALLER_OR_EQUAL => T_IS_SMALLER_OR_EQUAL, T_IS_GREATER_OR_EQUAL => T_IS_GREATER_OR_EQUAL, ); /** * Tokens that represent arithmetic operators. * * @var array(int) */ public static $arithmeticTokens = array( T_PLUS => T_PLUS, T_MINUS => T_MINUS, T_MULTIPLY => T_MULTIPLY, T_DIVIDE => T_DIVIDE, T_MODULUS => T_MODULUS, ); /** * Tokens that represent casting. * * @var array(int) */ public static $castTokens = array( T_INT_CAST => T_INT_CAST, T_STRING_CAST => T_STRING_CAST, T_DOUBLE_CAST => T_DOUBLE_CAST, T_ARRAY_CAST => T_ARRAY_CAST, T_BOOL_CAST => T_BOOL_CAST, T_OBJECT_CAST => T_OBJECT_CAST, T_UNSET_CAST => T_UNSET_CAST, T_BINARY_CAST => T_BINARY_CAST, ); /** * Token types that open parenthesis. * * @var array(int) */ public static $parenthesisOpeners = array( T_ARRAY => T_ARRAY, T_FUNCTION => T_FUNCTION, T_CLOSURE => T_CLOSURE, T_WHILE => T_WHILE, T_FOR => T_FOR, T_FOREACH => T_FOREACH, T_SWITCH => T_SWITCH, T_IF => T_IF, T_ELSEIF => T_ELSEIF, T_CATCH => T_CATCH, T_DECLARE => T_DECLARE, ); /** * Tokens that are allowed to open scopes. * * @var array(int) */ public static $scopeOpeners = array( T_CLASS => T_CLASS, T_INTERFACE => T_INTERFACE, T_TRAIT => T_TRAIT, T_NAMESPACE => T_NAMESPACE, T_FUNCTION => T_FUNCTION, T_CLOSURE => T_CLOSURE, T_IF => T_IF, T_SWITCH => T_SWITCH, T_CASE => T_CASE, T_DECLARE => T_DECLARE, T_DEFAULT => T_DEFAULT, T_WHILE => T_WHILE, T_ELSE => T_ELSE, T_ELSEIF => T_ELSEIF, T_FOR => T_FOR, T_FOREACH => T_FOREACH, T_DO => T_DO, T_TRY => T_TRY, T_CATCH => T_CATCH, T_FINALLY => T_FINALLY, T_PROPERTY => T_PROPERTY, T_OBJECT => T_OBJECT, T_USE => T_USE, ); /** * Tokens that represent scope modifiers. * * @var array(int) */ public static $scopeModifiers = array( T_PRIVATE => T_PRIVATE, T_PUBLIC => T_PUBLIC, T_PROTECTED => T_PROTECTED, ); /** * Tokens that can prefix a method name * * @var array(int) */ public static $methodPrefixes = array( T_PRIVATE => T_PRIVATE, T_PUBLIC => T_PUBLIC, T_PROTECTED => T_PROTECTED, T_ABSTRACT => T_ABSTRACT, T_STATIC => T_STATIC, T_FINAL => T_FINAL, ); /** * Tokens that perform operations. * * @var array(int) */ public static $operators = array( T_MINUS => T_MINUS, T_PLUS => T_PLUS, T_MULTIPLY => T_MULTIPLY, T_DIVIDE => T_DIVIDE, T_MODULUS => T_MODULUS, T_POW => T_POW, T_SPACESHIP => T_SPACESHIP, T_BITWISE_AND => T_BITWISE_AND, T_BITWISE_OR => T_BITWISE_OR, T_BITWISE_XOR => T_BITWISE_XOR, T_SL => T_SL, T_SR => T_SR, ); /** * Tokens that perform boolean operations. * * @var array(int) */ public static $booleanOperators = array( T_BOOLEAN_AND => T_BOOLEAN_AND, T_BOOLEAN_OR => T_BOOLEAN_OR, T_LOGICAL_AND => T_LOGICAL_AND, T_LOGICAL_OR => T_LOGICAL_OR, T_LOGICAL_XOR => T_LOGICAL_XOR, ); /** * Tokens that open code blocks. * * @var array(int) */ public static $blockOpeners = array( T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET, T_OPEN_SQUARE_BRACKET => T_OPEN_SQUARE_BRACKET, T_OPEN_PARENTHESIS => T_OPEN_PARENTHESIS, T_OBJECT => T_OBJECT, ); /** * Tokens that don't represent code. * * @var array(int) */ public static $emptyTokens = array( T_WHITESPACE => T_WHITESPACE, T_COMMENT => T_COMMENT, T_DOC_COMMENT => T_DOC_COMMENT, T_DOC_COMMENT_STAR => T_DOC_COMMENT_STAR, T_DOC_COMMENT_WHITESPACE => T_DOC_COMMENT_WHITESPACE, T_DOC_COMMENT_TAG => T_DOC_COMMENT_TAG, T_DOC_COMMENT_OPEN_TAG => T_DOC_COMMENT_OPEN_TAG, T_DOC_COMMENT_CLOSE_TAG => T_DOC_COMMENT_CLOSE_TAG, T_DOC_COMMENT_STRING => T_DOC_COMMENT_STRING, ); /** * Tokens that are comments. * * @var array(int) */ public static $commentTokens = array( T_COMMENT => T_COMMENT, T_DOC_COMMENT => T_DOC_COMMENT, T_DOC_COMMENT_STAR => T_DOC_COMMENT_STAR, T_DOC_COMMENT_WHITESPACE => T_DOC_COMMENT_WHITESPACE, T_DOC_COMMENT_TAG => T_DOC_COMMENT_TAG, T_DOC_COMMENT_OPEN_TAG => T_DOC_COMMENT_OPEN_TAG, T_DOC_COMMENT_CLOSE_TAG => T_DOC_COMMENT_CLOSE_TAG, T_DOC_COMMENT_STRING => T_DOC_COMMENT_STRING, ); /** * Tokens that represent strings. * * Note that T_STRINGS are NOT represented in this list. * * @var array(int) */ public static $stringTokens = array( T_CONSTANT_ENCAPSED_STRING => T_CONSTANT_ENCAPSED_STRING, T_DOUBLE_QUOTED_STRING => T_DOUBLE_QUOTED_STRING, ); /** * Tokens that represent brackets and parenthesis. * * @var array(int) */ public static $bracketTokens = array( T_OPEN_CURLY_BRACKET => T_OPEN_CURLY_BRACKET, T_CLOSE_CURLY_BRACKET => T_CLOSE_CURLY_BRACKET, T_OPEN_SQUARE_BRACKET => T_OPEN_SQUARE_BRACKET, T_CLOSE_SQUARE_BRACKET => T_CLOSE_SQUARE_BRACKET, T_OPEN_PARENTHESIS => T_OPEN_PARENTHESIS, T_CLOSE_PARENTHESIS => T_CLOSE_PARENTHESIS, ); /** * Tokens that include files. * * @var array(int) */ public static $includeTokens = array( T_REQUIRE_ONCE => T_REQUIRE_ONCE, T_REQUIRE => T_REQUIRE, T_INCLUDE_ONCE => T_INCLUDE_ONCE, T_INCLUDE => T_INCLUDE, ); /** * Tokens that make up a heredoc string. * * @var array(int) */ public static $heredocTokens = array( T_START_HEREDOC => T_START_HEREDOC, T_END_HEREDOC => T_END_HEREDOC, T_HEREDOC => T_HEREDOC, T_START_NOWDOC => T_START_NOWDOC, T_END_NOWDOC => T_END_NOWDOC, T_NOWDOC => T_NOWDOC, ); /** * Tokens that represent the names of called functions. * * Mostly, these are just strings. But PHP tokeizes some language * constructs and functions using their own tokens. * * @var array(int) */ public static $functionNameTokens = array( T_STRING => T_STRING, T_EVAL => T_EVAL, T_EXIT => T_EXIT, T_INCLUDE => T_INCLUDE, T_INCLUDE_ONCE => T_INCLUDE_ONCE, T_REQUIRE => T_REQUIRE, T_REQUIRE_ONCE => T_REQUIRE_ONCE, T_ISSET => T_ISSET, T_UNSET => T_UNSET, T_EMPTY => T_EMPTY, ); /** * A PHP_CodeSniffer_Tokens class cannot be constructed. * * Only static calls are allowed. */ private function __construct() { }//end __construct() /** * Returns the highest weighted token type. * * Tokens are weighted by their approximate frequency of appearance in code * - the less frequently they appear in the code, the higher the weighting. * For example T_CLASS tokens appear very infrequently in a file, and * therefore have a high weighting. * * Returns false if there are no weightings for any of the specified tokens. * * @param array(int) $tokens The token types to get the highest weighted * type for. * * @return int The highest weighted token. */ public static function getHighestWeightedToken(array $tokens) { $highest = -1; $highestType = false; $weights = self::$weightings; foreach ($tokens as $token) { if (isset($weights[$token]) === true) { $weight = $weights[$token]; } else { $weight = 0; } if ($weight > $highest) { $highest = $weight; $highestType = $token; } } return $highestType; }//end getHighestWeightedToken() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer.php0000644000076700000240000024725412647543456017241 0ustar gsherwoodstaff * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @link http://pear.php.net/package/PHP_CodeSniffer */ spl_autoload_register(array('PHP_CodeSniffer', 'autoload')); if (class_exists('PHP_CodeSniffer_Exception', true) === false) { throw new Exception('Class PHP_CodeSniffer_Exception not found'); } if (class_exists('PHP_CodeSniffer_File', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_File not found'); } if (class_exists('PHP_CodeSniffer_Fixer', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Fixer not found'); } if (class_exists('PHP_CodeSniffer_Tokens', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_Tokens not found'); } if (class_exists('PHP_CodeSniffer_CLI', true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_CLI not found'); } if (interface_exists('PHP_CodeSniffer_Sniff', true) === false) { throw new PHP_CodeSniffer_Exception('Interface PHP_CodeSniffer_Sniff not found'); } /** * PHP_CodeSniffer tokenizes PHP code and detects violations of a * defined set of coding standards. * * Standards are specified by classes that implement the PHP_CodeSniffer_Sniff * interface. A sniff registers what token types it wishes to listen for, then * PHP_CodeSniffer encounters that token, the sniff is invoked and passed * information about where the token was found in the stack, and the token stack * itself. * * Sniff files and their containing class must be prefixed with Sniff, and * have an extension of .php. * * Multiple PHP_CodeSniffer operations can be performed by re-calling the * process function with different parameters. * * @category PHP * @package PHP_CodeSniffer * @author Greg Sherwood * @author Marc McIntyre * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600) * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence * @version Release: @package_version@ * @link http://pear.php.net/package/PHP_CodeSniffer */ class PHP_CodeSniffer { /** * The current version. * * @var string */ const VERSION = '2.5.1'; /** * Package stability; either stable, beta or alpha. * * @var string */ const STABILITY = 'stable'; /** * The file or directory that is currently being processed. * * @var string */ protected $file = ''; /** * The directories that the processed rulesets are in. * * This is declared static because it is also used in the * autoloader to look for sniffs outside the PHPCS install. * This way, standards designed to be installed inside PHPCS can * also be used from outside the PHPCS Standards directory. * * @var string */ protected static $rulesetDirs = array(); /** * The CLI object controlling the run. * * @var PHP_CodeSniffer_CLI */ public $cli = null; /** * The Reporting object controlling report generation. * * @var PHP_CodeSniffer_Reporting */ public $reporting = null; /** * An array of sniff objects that are being used to check files. * * @var array(PHP_CodeSniffer_Sniff) */ protected $listeners = array(); /** * An array of sniffs that are being used to check files. * * @var array(string) */ protected $sniffs = array(); /** * The listeners array, indexed by token type. * * @var array */ private $_tokenListeners = array(); /** * An array of rules from the ruleset.xml file. * * It may be empty, indicating that the ruleset does not override * any of the default sniff settings. * * @var array */ protected $ruleset = array(); /** * An array of patterns to use for skipping files. * * @var array */ protected $ignorePatterns = array(); /** * An array of extensions for files we will check. * * @var array */ public $allowedFileExtensions = array(); /** * An array of default extensions and associated tokenizers. * * If no extensions are set, these will be used as the defaults. * If extensions are set, these will be used when the correct tokenizer * can not be determined, such as when checking a passed filename instead * of files in a directory. * * @var array */ public $defaultFileExtensions = array( 'php' => 'PHP', 'inc' => 'PHP', 'js' => 'JS', 'css' => 'CSS', ); /** * An array of variable types for param/var we will check. * * @var array(string) */ public static $allowedTypes = array( 'array', 'boolean', 'float', 'integer', 'mixed', 'object', 'string', 'resource', 'callable', ); /** * Constructs a PHP_CodeSniffer object. * * @param int $verbosity The verbosity level. * 1: Print progress information. * 2: Print tokenizer debug information. * 3: Print sniff debug information. * @param int $tabWidth The number of spaces each tab represents. * If greater than zero, tabs will be replaced * by spaces before testing each file. * @param string $encoding The charset of the sniffed files. * This is important for some reports that output * with utf-8 encoding as you don't want it double * encoding messages. * @param bool $interactive If TRUE, will stop after each file with errors * and wait for user input. * * @see process() */ public function __construct( $verbosity=0, $tabWidth=0, $encoding='iso-8859-1', $interactive=false ) { if ($verbosity !== null) { $this->setVerbosity($verbosity); } if ($tabWidth !== null) { $this->setTabWidth($tabWidth); } if ($encoding !== null) { $this->setEncoding($encoding); } if ($interactive !== null) { $this->setInteractive($interactive); } if (defined('PHPCS_DEFAULT_ERROR_SEV') === false) { define('PHPCS_DEFAULT_ERROR_SEV', 5); } if (defined('PHPCS_DEFAULT_WARN_SEV') === false) { define('PHPCS_DEFAULT_WARN_SEV', 5); } if (defined('PHP_CODESNIFFER_CBF') === false) { define('PHP_CODESNIFFER_CBF', false); } // Set default CLI object in case someone is running us // without using the command line script. $this->cli = new PHP_CodeSniffer_CLI(); $this->cli->errorSeverity = PHPCS_DEFAULT_ERROR_SEV; $this->cli->warningSeverity = PHPCS_DEFAULT_WARN_SEV; $this->cli->dieOnUnknownArg = false; $this->reporting = new PHP_CodeSniffer_Reporting(); }//end __construct() /** * Autoload static method for loading classes and interfaces. * * @param string $className The name of the class or interface. * * @return void */ public static function autoload($className) { if (substr($className, 0, 4) === 'PHP_') { $newClassName = substr($className, 4); } else { $newClassName = $className; } $path = str_replace(array('_', '\\'), DIRECTORY_SEPARATOR, $newClassName).'.php'; if (is_file(dirname(__FILE__).DIRECTORY_SEPARATOR.$path) === true) { // Check standard file locations based on class name. include dirname(__FILE__).DIRECTORY_SEPARATOR.$path; return; } else { // Check for included sniffs. $installedPaths = PHP_CodeSniffer::getInstalledStandardPaths(); foreach ($installedPaths as $installedPath) { if (is_file($installedPath.DIRECTORY_SEPARATOR.$path) === true) { include $installedPath.DIRECTORY_SEPARATOR.$path; return; } } // Check standard file locations based on the loaded rulesets. foreach (self::$rulesetDirs as $rulesetDir) { if (is_file(dirname($rulesetDir).DIRECTORY_SEPARATOR.$path) === true) { include_once dirname($rulesetDir).DIRECTORY_SEPARATOR.$path; return; } } }//end if // Everything else. @include $path; }//end autoload() /** * Sets the verbosity level. * * @param int $verbosity The verbosity level. * 1: Print progress information. * 2: Print tokenizer debug information. * 3: Print sniff debug information. * * @return void */ public function setVerbosity($verbosity) { if (defined('PHP_CODESNIFFER_VERBOSITY') === false) { define('PHP_CODESNIFFER_VERBOSITY', $verbosity); } }//end setVerbosity() /** * Sets the tab width. * * @param int $tabWidth The number of spaces each tab represents. * If greater than zero, tabs will be replaced * by spaces before testing each file. * * @return void */ public function setTabWidth($tabWidth) { if (defined('PHP_CODESNIFFER_TAB_WIDTH') === false) { define('PHP_CODESNIFFER_TAB_WIDTH', $tabWidth); } }//end setTabWidth() /** * Sets the encoding. * * @param string $encoding The charset of the sniffed files. * This is important for some reports that output * with utf-8 encoding as you don't want it double * encoding messages. * * @return void */ public function setEncoding($encoding) { if (defined('PHP_CODESNIFFER_ENCODING') === false) { define('PHP_CODESNIFFER_ENCODING', $encoding); } }//end setEncoding() /** * Sets the interactive flag. * * @param bool $interactive If TRUE, will stop after each file with errors * and wait for user input. * * @return void */ public function setInteractive($interactive) { if (defined('PHP_CODESNIFFER_INTERACTIVE') === false) { define('PHP_CODESNIFFER_INTERACTIVE', $interactive); } }//end setInteractive() /** * Sets an array of file extensions that we will allow checking of. * * If the extension is one of the defaults, a specific tokenizer * will be used. Otherwise, the PHP tokenizer will be used for * all extensions passed. * * @param array $extensions An array of file extensions. * * @return void */ public function setAllowedFileExtensions(array $extensions) { $newExtensions = array(); foreach ($extensions as $ext) { $slash = strpos($ext, '/'); if ($slash !== false) { // They specified the tokenizer too. list($ext, $tokenizer) = explode('/', $ext); $newExtensions[$ext] = strtoupper($tokenizer); continue; } if (isset($this->allowedFileExtensions[$ext]) === true) { $newExtensions[$ext] = $this->allowedFileExtensions[$ext]; } else if (isset($this->defaultFileExtensions[$ext]) === true) { $newExtensions[$ext] = $this->defaultFileExtensions[$ext]; } else { $newExtensions[$ext] = 'PHP'; } } $this->allowedFileExtensions = $newExtensions; }//end setAllowedFileExtensions() /** * Sets an array of ignore patterns that we use to skip files and folders. * * Patterns are not case sensitive. * * @param array $patterns An array of ignore patterns. The pattern is the key * and the value is either "absolute" or "relative", * depending on how the pattern should be applied to a * file path. * * @return void */ public function setIgnorePatterns(array $patterns) { $this->ignorePatterns = $patterns; }//end setIgnorePatterns() /** * Gets the array of ignore patterns. * * Optionally takes a listener to get ignore patterns specified * for that sniff only. * * @param string $listener The listener to get patterns for. If NULL, all * patterns are returned. * * @return array */ public function getIgnorePatterns($listener=null) { if ($listener === null) { return $this->ignorePatterns; } if (isset($this->ignorePatterns[$listener]) === true) { return $this->ignorePatterns[$listener]; } return array(); }//end getIgnorePatterns() /** * Sets the internal CLI object. * * @param object $cli The CLI object controlling the run. * * @return void */ public function setCli($cli) { $this->cli = $cli; }//end setCli() /** * Start a PHP_CodeSniffer run. * * @param string|array $files The files and directories to process. For * directories, each sub directory will also * be traversed for source files. * @param string|array $standards The set of code sniffs we are testing * against. * @param array $restrictions The sniff codes to restrict the * violations to. * @param boolean $local If true, don't recurse into directories. * * @return void */ public function process($files, $standards, array $restrictions=array(), $local=false) { $files = (array) $files; $this->initStandard($standards, $restrictions); $this->processFiles($files, $local); }//end process() /** * Initialise the standard that the run will use. * * @param string|array $standards The set of code sniffs we are testing * against. * @param array $restrictions The sniff codes to restrict the * * @return void */ public function initStandard($standards, array $restrictions=array()) { $standards = (array) $standards; // Reset the members. $this->listeners = array(); $this->sniffs = array(); $this->ruleset = array(); $this->_tokenListeners = array(); self::$rulesetDirs = array(); // Ensure this option is enabled or else line endings will not always // be detected properly for files created on a Mac with the /r line ending. ini_set('auto_detect_line_endings', true); $sniffs = array(); foreach ($standards as $standard) { $installed = $this->getInstalledStandardPath($standard); if ($installed !== null) { $standard = $installed; } else { $standard = self::realpath($standard); if (is_dir($standard) === true && is_file(self::realpath($standard.DIRECTORY_SEPARATOR.'ruleset.xml')) === true ) { $standard = self::realpath($standard.DIRECTORY_SEPARATOR.'ruleset.xml'); } } if (PHP_CODESNIFFER_VERBOSITY === 1) { $ruleset = simplexml_load_string(file_get_contents($standard)); if ($ruleset !== false) { $standardName = (string) $ruleset['name']; } echo "Registering sniffs in the $standardName standard... "; if (count($standards) > 1 || PHP_CODESNIFFER_VERBOSITY > 2) { echo PHP_EOL; } } $sniffs = array_merge($sniffs, $this->processRuleset($standard)); }//end foreach $sniffRestrictions = array(); foreach ($restrictions as $sniffCode) { $parts = explode('.', strtolower($sniffCode)); $sniffRestrictions[] = $parts[0].'_sniffs_'.$parts[1].'_'.$parts[2].'sniff'; } $this->registerSniffs($sniffs, $sniffRestrictions); $this->populateTokenListeners(); if (PHP_CODESNIFFER_VERBOSITY === 1) { $numSniffs = count($this->sniffs); echo "DONE ($numSniffs sniffs registered)".PHP_EOL; } }//end initStandard() /** * Processes the files/directories that PHP_CodeSniffer was constructed with. * * @param string|array $files The files and directories to process. For * directories, each sub directory will also * be traversed for source files. * @param boolean $local If true, don't recurse into directories. * * @return void * @throws PHP_CodeSniffer_Exception If files are invalid. */ public function processFiles($files, $local=false) { $files = (array) $files; $cliValues = $this->cli->getCommandLineValues(); $showProgress = $cliValues['showProgress']; $useColors = $cliValues['colors']; if (PHP_CODESNIFFER_VERBOSITY > 0) { echo 'Creating file list... '; } if (empty($this->allowedFileExtensions) === true) { $this->allowedFileExtensions = $this->defaultFileExtensions; } $todo = $this->getFilesToProcess($files, $local); $numFiles = count($todo); if (PHP_CODESNIFFER_VERBOSITY > 0) { echo "DONE ($numFiles files in queue)".PHP_EOL; } $numProcessed = 0; $dots = 0; $maxLength = strlen($numFiles); $lastDir = ''; foreach ($todo as $file) { $this->file = $file; $currDir = dirname($file); if ($lastDir !== $currDir) { if (PHP_CODESNIFFER_VERBOSITY > 0 || PHP_CODESNIFFER_CBF === true) { echo 'Changing into directory '.$currDir.PHP_EOL; } $lastDir = $currDir; } $phpcsFile = $this->processFile($file, null); $numProcessed++; if (PHP_CODESNIFFER_VERBOSITY > 0 || PHP_CODESNIFFER_INTERACTIVE === true || $showProgress === false ) { continue; } // Show progress information. if ($phpcsFile === null) { echo 'S'; } else { $errors = $phpcsFile->getErrorCount(); $warnings = $phpcsFile->getWarningCount(); if ($errors > 0) { if ($useColors === true) { echo "\033[31m"; } echo 'E'; } else if ($warnings > 0) { if ($useColors === true) { echo "\033[33m"; } echo 'W'; } else { echo '.'; } if ($useColors === true) { echo "\033[0m"; } }//end if $dots++; if ($dots === 60) { $padding = ($maxLength - strlen($numProcessed)); echo str_repeat(' ', $padding); $percent = round(($numProcessed / $numFiles) * 100); echo " $numProcessed / $numFiles ($percent%)".PHP_EOL; $dots = 0; } }//end foreach if (PHP_CODESNIFFER_VERBOSITY === 0 && PHP_CODESNIFFER_INTERACTIVE === false && $showProgress === true ) { echo PHP_EOL.PHP_EOL; } }//end processFiles() /** * Processes a single ruleset and returns a list of the sniffs it represents. * * Rules founds within the ruleset are processed immediately, but sniff classes * are not registered by this method. * * @param string $rulesetPath The path to a ruleset XML file. * @param int $depth How many nested processing steps we are in. This * is only used for debug output. * * @return array * @throws PHP_CodeSniffer_Exception If the ruleset path is invalid. */ public function processRuleset($rulesetPath, $depth=0) { $rulesetPath = self::realpath($rulesetPath); if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "Processing ruleset $rulesetPath".PHP_EOL; } $ruleset = simplexml_load_string(file_get_contents($rulesetPath)); if ($ruleset === false) { throw new PHP_CodeSniffer_Exception("Ruleset $rulesetPath is not valid"); } $ownSniffs = array(); $includedSniffs = array(); $excludedSniffs = array(); $cliValues = $this->cli->getCommandLineValues(); $rulesetDir = dirname($rulesetPath); $rulesetName = basename($rulesetPath); self::$rulesetDirs[] = $rulesetDir; if (is_dir($rulesetDir.DIRECTORY_SEPARATOR.'Sniffs') === true) { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\tAdding sniff files from \"/.../".basename($rulesetDir)."/Sniffs/\" directory".PHP_EOL; } $ownSniffs = $this->_expandSniffDirectory($rulesetDir.DIRECTORY_SEPARATOR.'Sniffs', $depth); } foreach ($ruleset->rule as $rule) { if (isset($rule['ref']) === false || $this->_shouldProcessElement($rule) === false ) { continue; } if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\tProcessing rule \"".$rule['ref'].'"'.PHP_EOL; } $includedSniffs = array_merge( $includedSniffs, $this->_expandRulesetReference($rule['ref'], $rulesetDir, $depth) ); if (isset($rule->exclude) === true) { foreach ($rule->exclude as $exclude) { if ($this->_shouldProcessElement($exclude) === false) { continue; } if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\tExcluding rule \"".$exclude['name'].'"'.PHP_EOL; } // Check if a single code is being excluded, which is a shortcut // for setting the severity of the message to 0. $parts = explode('.', $exclude['name']); if (count($parts) === 4) { $this->ruleset[(string) $exclude['name']]['severity'] = 0; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t=> severity set to 0".PHP_EOL; } } else { $excludedSniffs = array_merge( $excludedSniffs, $this->_expandRulesetReference($exclude['name'], $rulesetDir, ($depth + 1)) ); } }//end foreach }//end if $this->_processRule($rule, $depth); }//end foreach // Process custom command line arguments. $cliArgs = array(); foreach ($ruleset->{'arg'} as $arg) { if ($this->_shouldProcessElement($arg) === false) { continue; } if (isset($arg['name']) === true) { $argString = '--'.(string) $arg['name']; if (isset($arg['value']) === true) { $argString .= '='.(string) $arg['value']; } } else { $argString = '-'.(string) $arg['value']; } $cliArgs[] = $argString; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t=> set command line value $argString".PHP_EOL; } }//end foreach // Set custom php ini values as CLI args. foreach ($ruleset->{'ini'} as $arg) { if ($this->_shouldProcessElement($arg) === false) { continue; } if (isset($arg['name']) === false) { continue; } $name = (string) $arg['name']; $argString = $name; if (isset($arg['value']) === true) { $value = (string) $arg['value']; $argString .= "=$value"; } else { $value = 'true'; } $cliArgs[] = '-d'; $cliArgs[] = $argString; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t=> set PHP ini value $name to $value".PHP_EOL; } }//end foreach if (empty($cliValues['files']) === true) { // Process hard-coded file paths. foreach ($ruleset->{'file'} as $file) { $file = (string) $file; $cliArgs[] = $file; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t=> added \"$file\" to the file list".PHP_EOL; } } } if (empty($cliArgs) === false) { $this->cli->setCommandLineValues($cliArgs); } // Process custom sniff config settings. foreach ($ruleset->{'config'} as $config) { if ($this->_shouldProcessElement($config) === false) { continue; } $this->setConfigData((string) $config['name'], (string) $config['value'], true); if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t=> set config value ".(string) $config['name'].': '.(string) $config['value'].PHP_EOL; } } // Process custom ignore pattern rules. foreach ($ruleset->{'exclude-pattern'} as $pattern) { if ($this->_shouldProcessElement($pattern) === false) { continue; } if (isset($pattern['type']) === false) { $pattern['type'] = 'absolute'; } $this->ignorePatterns[(string) $pattern] = (string) $pattern['type']; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t=> added global ".(string) $pattern['type'].' ignore pattern: '.(string) $pattern.PHP_EOL; } } $includedSniffs = array_unique(array_merge($ownSniffs, $includedSniffs)); $excludedSniffs = array_unique($excludedSniffs); if (PHP_CODESNIFFER_VERBOSITY > 1) { $included = count($includedSniffs); $excluded = count($excludedSniffs); echo str_repeat("\t", $depth); echo "=> Ruleset processing complete; included $included sniffs and excluded $excluded".PHP_EOL; } // Merge our own sniff list with our externally included // sniff list, but filter out any excluded sniffs. $files = array(); foreach ($includedSniffs as $sniff) { if (in_array($sniff, $excludedSniffs) === true) { continue; } else { $files[] = self::realpath($sniff); } } return $files; }//end processRuleset() /** * Expands a directory into a list of sniff files within. * * @param string $directory The path to a directory. * @param int $depth How many nested processing steps we are in. This * is only used for debug output. * * @return array */ private function _expandSniffDirectory($directory, $depth=0) { $sniffs = array(); if (defined('RecursiveDirectoryIterator::FOLLOW_SYMLINKS') === true) { $rdi = new RecursiveDirectoryIterator($directory, RecursiveDirectoryIterator::FOLLOW_SYMLINKS); } else { $rdi = new RecursiveDirectoryIterator($directory); } $di = new RecursiveIteratorIterator($rdi, 0, RecursiveIteratorIterator::CATCH_GET_CHILD); $dirLen = strlen($directory); foreach ($di as $file) { $filename = $file->getFilename(); // Skip hidden files. if (substr($filename, 0, 1) === '.') { continue; } // We are only interested in PHP and sniff files. $fileParts = explode('.', $filename); if (array_pop($fileParts) !== 'php') { continue; } $basename = basename($filename, '.php'); if (substr($basename, -5) !== 'Sniff') { continue; } $path = $file->getPathname(); // Skip files in hidden directories within the Sniffs directory of this // standard. We use the offset with strpos() to allow hidden directories // before, valid example: // /home/foo/.composer/vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/... if (strpos($path, DIRECTORY_SEPARATOR.'.', $dirLen) !== false) { continue; } if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t=> $path".PHP_EOL; } $sniffs[] = $path; }//end foreach return $sniffs; }//end _expandSniffDirectory() /** * Expands a ruleset reference into a list of sniff files. * * @param string $ref The reference from the ruleset XML file. * @param string $rulesetDir The directory of the ruleset XML file, used to * evaluate relative paths. * @param int $depth How many nested processing steps we are in. This * is only used for debug output. * * @return array * @throws PHP_CodeSniffer_Exception If the reference is invalid. */ private function _expandRulesetReference($ref, $rulesetDir, $depth=0) { // Ignore internal sniffs codes as they are used to only // hide and change internal messages. if (substr($ref, 0, 9) === 'Internal.') { if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t* ignoring internal sniff code *".PHP_EOL; } return array(); } // As sniffs can't begin with a full stop, assume references in // this format are relative paths and attempt to convert them // to absolute paths. If this fails, let the reference run through // the normal checks and have it fail as normal. if (substr($ref, 0, 1) === '.') { $realpath = self::realpath($rulesetDir.'/'.$ref); if ($realpath !== false) { $ref = $realpath; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t=> $ref".PHP_EOL; } } } // As sniffs can't begin with a tilde, assume references in // this format at relative to the user's home directory. if (substr($ref, 0, 2) === '~/') { $realpath = self::realpath($ref); if ($realpath !== false) { $ref = $realpath; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t=> $ref".PHP_EOL; } } } if (is_file($ref) === true) { if (substr($ref, -9) === 'Sniff.php') { // A single external sniff. self::$rulesetDirs[] = dirname(dirname(dirname($ref))); return array($ref); } } else { // See if this is a whole standard being referenced. $path = $this->getInstalledStandardPath($ref); if (self::isPharFile($path) === true && strpos($path, 'ruleset.xml') === false) { // If the ruleset exists inside the phar file, use it. if (file_exists($path.DIRECTORY_SEPARATOR.'ruleset.xml') === true) { $path = $path.DIRECTORY_SEPARATOR.'ruleset.xml'; } else { $path = null; } } if ($path !== null) { $ref = $path; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t=> $ref".PHP_EOL; } } else if (is_dir($ref) === false) { // Work out the sniff path. $sepPos = strpos($ref, DIRECTORY_SEPARATOR); if ($sepPos !== false) { $stdName = substr($ref, 0, $sepPos); $path = substr($ref, $sepPos); } else { $parts = explode('.', $ref); $stdName = $parts[0]; if (count($parts) === 1) { // A whole standard? $path = ''; } else if (count($parts) === 2) { // A directory of sniffs? $path = DIRECTORY_SEPARATOR.'Sniffs'.DIRECTORY_SEPARATOR.$parts[1]; } else { // A single sniff? $path = DIRECTORY_SEPARATOR.'Sniffs'.DIRECTORY_SEPARATOR.$parts[1].DIRECTORY_SEPARATOR.$parts[2].'Sniff.php'; } } $newRef = false; $stdPath = $this->getInstalledStandardPath($stdName); if ($stdPath !== null && $path !== '') { if (self::isPharFile($stdPath) === true && strpos($stdPath, 'ruleset.xml') === false ) { // Phar files can only return the directory, // since ruleset can be omitted if building one standard. $newRef = self::realpath($stdPath.$path); } else { $newRef = self::realpath(dirname($stdPath).$path); } } if ($newRef === false) { // The sniff is not locally installed, so check if it is being // referenced as a remote sniff outside the install. We do this // by looking through all directories where we have found ruleset // files before, looking for ones for this particular standard, // and seeing if it is in there. foreach (self::$rulesetDirs as $dir) { if (strtolower(basename($dir)) !== strtolower($stdName)) { continue; } $newRef = self::realpath($dir.$path); if ($newRef !== false) { $ref = $newRef; } } } else { $ref = $newRef; } if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t=> $ref".PHP_EOL; } }//end if }//end if if (is_dir($ref) === true) { if (is_file($ref.DIRECTORY_SEPARATOR.'ruleset.xml') === true) { // We are referencing an external coding standard. if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t* rule is referencing a standard using directory name; processing *".PHP_EOL; } return $this->processRuleset($ref.DIRECTORY_SEPARATOR.'ruleset.xml', ($depth + 2)); } else { // We are referencing a whole directory of sniffs. if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t* rule is referencing a directory of sniffs *".PHP_EOL; echo str_repeat("\t", $depth); echo "\t\tAdding sniff files from directory".PHP_EOL; } return $this->_expandSniffDirectory($ref, ($depth + 1)); } } else { if (is_file($ref) === false) { $error = "Referenced sniff \"$ref\" does not exist"; throw new PHP_CodeSniffer_Exception($error); } if (substr($ref, -9) === 'Sniff.php') { // A single sniff. return array($ref); } else { // Assume an external ruleset.xml file. if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t* rule is referencing a standard using ruleset path; processing *".PHP_EOL; } return $this->processRuleset($ref, ($depth + 2)); } }//end if }//end _expandRulesetReference() /** * Processes a rule from a ruleset XML file, overriding built-in defaults. * * @param SimpleXMLElement $rule The rule object from a ruleset XML file. * @param int $depth How many nested processing steps we are in. * This is only used for debug output. * * @return void */ private function _processRule($rule, $depth=0) { $code = (string) $rule['ref']; // Custom severity. if (isset($rule->severity) === true && $this->_shouldProcessElement($rule->severity) === true ) { if (isset($this->ruleset[$code]) === false) { $this->ruleset[$code] = array(); } $this->ruleset[$code]['severity'] = (int) $rule->severity; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t=> severity set to ".(int) $rule->severity.PHP_EOL; } } // Custom message type. if (isset($rule->type) === true && $this->_shouldProcessElement($rule->type) === true ) { if (isset($this->ruleset[$code]) === false) { $this->ruleset[$code] = array(); } $this->ruleset[$code]['type'] = (string) $rule->type; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t=> message type set to ".(string) $rule->type.PHP_EOL; } } // Custom message. if (isset($rule->message) === true && $this->_shouldProcessElement($rule->message) === true ) { if (isset($this->ruleset[$code]) === false) { $this->ruleset[$code] = array(); } $this->ruleset[$code]['message'] = (string) $rule->message; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t=> message set to ".(string) $rule->message.PHP_EOL; } } // Custom properties. if (isset($rule->properties) === true && $this->_shouldProcessElement($rule->properties) === true ) { foreach ($rule->properties->property as $prop) { if ($this->_shouldProcessElement($prop) === false) { continue; } if (isset($this->ruleset[$code]) === false) { $this->ruleset[$code] = array( 'properties' => array(), ); } else if (isset($this->ruleset[$code]['properties']) === false) { $this->ruleset[$code]['properties'] = array(); } $name = (string) $prop['name']; if (isset($prop['type']) === true && (string) $prop['type'] === 'array' ) { $value = (string) $prop['value']; $values = array(); foreach (explode(',', $value) as $val) { $v = ''; list($k,$v) = explode('=>', $val.'=>'); if ($v !== '') { $values[$k] = $v; } else { $values[] = $k; } } $this->ruleset[$code]['properties'][$name] = $values; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t=> array property \"$name\" set to \"$value\"".PHP_EOL; } } else { $this->ruleset[$code]['properties'][$name] = (string) $prop['value']; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t=> property \"$name\" set to \"".(string) $prop['value'].'"'.PHP_EOL; } }//end if }//end foreach }//end if // Ignore patterns. foreach ($rule->{'exclude-pattern'} as $pattern) { if ($this->_shouldProcessElement($pattern) === false) { continue; } if (isset($this->ignorePatterns[$code]) === false) { $this->ignorePatterns[$code] = array(); } if (isset($pattern['type']) === false) { $pattern['type'] = 'absolute'; } $this->ignorePatterns[$code][(string) $pattern] = (string) $pattern['type']; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo str_repeat("\t", $depth); echo "\t\t=> added sniff-specific ".(string) $pattern['type'].' ignore pattern: '.(string) $pattern.PHP_EOL; } } }//end _processRule() /** * Determine if an element should be processed or ignored. * * @param SimpleXMLElement $element An object from a ruleset XML file. * @param int $depth How many nested processing steps we are in. * This is only used for debug output. * * @return bool */ private function _shouldProcessElement($element, $depth=0) { if (isset($element['phpcbf-only']) === false && isset($element['phpcs-only']) === false ) { // No exceptions are being made. return true; } if (PHP_CODESNIFFER_CBF === true && isset($element['phpcbf-only']) === true && (string) $element['phpcbf-only'] === 'true' ) { return true; } if (PHP_CODESNIFFER_CBF === false && isset($element['phpcs-only']) === true && (string) $element['phpcs-only'] === 'true' ) { return true; } return false; }//end _shouldProcessElement() /** * Loads and stores sniffs objects used for sniffing files. * * @param array $files Paths to the sniff files to register. * @param array $restrictions The sniff class names to restrict the allowed * listeners to. * * @return void * @throws PHP_CodeSniffer_Exception If a sniff file path is invalid. */ public function registerSniffs($files, $restrictions) { $listeners = array(); foreach ($files as $file) { // Work out where the position of /StandardName/Sniffs/... is // so we can determine what the class will be called. $sniffPos = strrpos($file, DIRECTORY_SEPARATOR.'Sniffs'.DIRECTORY_SEPARATOR); if ($sniffPos === false) { continue; } $slashPos = strrpos(substr($file, 0, $sniffPos), DIRECTORY_SEPARATOR); if ($slashPos === false) { continue; } $className = substr($file, ($slashPos + 1)); if (substr_count($className, DIRECTORY_SEPARATOR) !== 3) { throw new PHP_CodeSniffer_Exception("Sniff file $className is not valid; sniff files must be located in a .../StandardName/Sniffs/CategoryName/ directory"); } $className = substr($className, 0, -4); $className = str_replace(DIRECTORY_SEPARATOR, '_', $className); // If they have specified a list of sniffs to restrict to, check // to see if this sniff is allowed. if (empty($restrictions) === false && in_array(strtolower($className), $restrictions) === false ) { continue; } include_once $file; // Support the use of PHP namespaces. If the class name we included // contains namespace separators instead of underscores, use this as the // class name from now on. $classNameNS = str_replace('_', '\\', $className); if (class_exists($classNameNS, false) === true) { $className = $classNameNS; } // Skip abstract classes. $reflection = new ReflectionClass($className); if ($reflection->isAbstract() === true) { continue; } $listeners[$className] = $className; if (PHP_CODESNIFFER_VERBOSITY > 2) { echo "Registered $className".PHP_EOL; } }//end foreach $this->sniffs = $listeners; }//end registerSniffs() /** * Populates the array of PHP_CodeSniffer_Sniff's for this file. * * @return void * @throws PHP_CodeSniffer_Exception If sniff registration fails. */ public function populateTokenListeners() { // Construct a list of listeners indexed by token being listened for. $this->_tokenListeners = array(); foreach ($this->sniffs as $listenerClass) { // Work out the internal code for this sniff. Detect usage of namespace // separators instead of underscores to support PHP namespaces. if (strstr($listenerClass, '\\') === false) { $parts = explode('_', $listenerClass); } else { $parts = explode('\\', $listenerClass); } $code = $parts[0].'.'.$parts[2].'.'.$parts[3]; $code = substr($code, 0, -5); $this->listeners[$listenerClass] = new $listenerClass(); // Set custom properties. if (isset($this->ruleset[$code]['properties']) === true) { foreach ($this->ruleset[$code]['properties'] as $name => $value) { $this->setSniffProperty($listenerClass, $name, $value); } } $tokenizers = array(); $vars = get_class_vars($listenerClass); if (isset($vars['supportedTokenizers']) === true) { foreach ($vars['supportedTokenizers'] as $tokenizer) { $tokenizers[$tokenizer] = $tokenizer; } } else { $tokenizers = array('PHP' => 'PHP'); } $tokens = $this->listeners[$listenerClass]->register(); if (is_array($tokens) === false) { $msg = "Sniff $listenerClass register() method must return an array"; throw new PHP_CodeSniffer_Exception($msg); } $parts = explode('_', str_replace('\\', '_', $listenerClass)); $listenerSource = $parts[0].'.'.$parts[2].'.'.substr($parts[3], 0, -5); $ignorePatterns = array(); $patterns = $this->getIgnorePatterns($listenerSource); foreach ($patterns as $pattern => $type) { // While there is support for a type of each pattern // (absolute or relative) we don't actually support it here. $replacements = array( '\\,' => ',', '*' => '.*', ); $ignorePatterns[] = strtr($pattern, $replacements); } foreach ($tokens as $token) { if (isset($this->_tokenListeners[$token]) === false) { $this->_tokenListeners[$token] = array(); } if (isset($this->_tokenListeners[$token][$listenerClass]) === false) { $this->_tokenListeners[$token][$listenerClass] = array( 'class' => $listenerClass, 'source' => $listenerSource, 'tokenizers' => $tokenizers, 'ignore' => $ignorePatterns, ); } } }//end foreach }//end populateTokenListeners() /** * Set a single property for a sniff. * * @param string $listenerClass The class name of the sniff. * @param string $name The name of the property to change. * @param string $value The new value of the property. * * @return void */ public function setSniffProperty($listenerClass, $name, $value) { // Setting a property for a sniff we are not using. if (isset($this->listeners[$listenerClass]) === false) { return; } $name = trim($name); if (is_string($value) === true) { $value = trim($value); } // Special case for booleans. if ($value === 'true') { $value = true; } else if ($value === 'false') { $value = false; } $this->listeners[$listenerClass]->$name = $value; }//end setSniffProperty() /** * Get a list of files that will be processed. * * If passed directories, this method will find all files within them. * The method will also perform file extension and ignore pattern filtering. * * @param string $paths A list of file or directory paths to process. * @param boolean $local If true, only process 1 level of files in directories * * @return array * @throws Exception If there was an error opening a directory. * @see shouldProcessFile() */ public function getFilesToProcess($paths, $local=false) { $files = array(); foreach ($paths as $path) { if (is_dir($path) === true || self::isPharFile($path) === true) { if (self::isPharFile($path) === true) { $path = 'phar://'.$path; } if ($local === true) { $di = new DirectoryIterator($path); } else { $di = new RecursiveIteratorIterator( new RecursiveDirectoryIterator($path), 0, RecursiveIteratorIterator::CATCH_GET_CHILD ); } foreach ($di as $file) { // Check if the file exists after all symlinks are resolved. $filePath = self::realpath($file->getPathname()); if ($filePath === false) { continue; } if (is_dir($filePath) === true) { continue; } if ($this->shouldProcessFile($file->getPathname(), $path) === false) { continue; } $files[] = $file->getPathname(); }//end foreach } else { if ($this->shouldIgnoreFile($path, dirname($path)) === true) { continue; } $files[] = $path; }//end if }//end foreach return $files; }//end getFilesToProcess() /** * Checks filtering rules to see if a file should be checked. * * Checks both file extension filters and path ignore filters. * * @param string $path The path to the file being checked. * @param string $basedir The directory to use for relative path checks. * * @return bool */ public function shouldProcessFile($path, $basedir) { // Check that the file's extension is one we are checking. // We are strict about checking the extension and we don't // let files through with no extension or that start with a dot. $fileName = basename($path); $fileParts = explode('.', $fileName); if ($fileParts[0] === $fileName || $fileParts[0] === '') { return false; } // Checking multi-part file extensions, so need to create a // complete extension list and make sure one is allowed. $extensions = array(); array_shift($fileParts); foreach ($fileParts as $part) { $extensions[implode('.', $fileParts)] = 1; array_shift($fileParts); } $matches = array_intersect_key($extensions, $this->allowedFileExtensions); if (empty($matches) === true) { return false; } // If the file's path matches one of our ignore patterns, skip it. if ($this->shouldIgnoreFile($path, $basedir) === true) { return false; } return true; }//end shouldProcessFile() /** * Checks filtering rules to see if a file should be ignored. * * @param string $path The path to the file being checked. * @param string $basedir The directory to use for relative path checks. * * @return bool */ public function shouldIgnoreFile($path, $basedir) { $relativePath = $path; if (strpos($path, $basedir) === 0) { // The +1 cuts off the directory separator as well. $relativePath = substr($path, (strlen($basedir) + 1)); } foreach ($this->ignorePatterns as $pattern => $type) { if (is_array($type) === true) { // A sniff specific ignore pattern. continue; } // Maintains backwards compatibility in case the ignore pattern does // not have a relative/absolute value. if (is_int($pattern) === true) { $pattern = $type; $type = 'absolute'; } $replacements = array( '\\,' => ',', '*' => '.*', ); // We assume a / directory separator, as do the exclude rules // most developers write, so we need a special case for any system // that is different. if (DIRECTORY_SEPARATOR === '\\') { $replacements['/'] = '\\\\'; } $pattern = strtr($pattern, $replacements); if ($type === 'relative') { $testPath = $relativePath; } else { $testPath = $path; } $pattern = '`'.$pattern.'`i'; if (preg_match($pattern, $testPath) === 1) { return true; } }//end foreach return false; }//end shouldIgnoreFile() /** * Run the code sniffs over a single given file. * * Processes the file and runs the PHP_CodeSniffer sniffs to verify that it * conforms with the standard. Returns the processed file object, or NULL * if no file was processed due to error. * * @param string $file The file to process. * @param string $contents The contents to parse. If NULL, the content * is taken from the file system. * * @return PHP_CodeSniffer_File * @throws PHP_CodeSniffer_Exception If the file could not be processed. * @see _processFile() */ public function processFile($file, $contents=null) { if ($contents === null && file_exists($file) === false) { throw new PHP_CodeSniffer_Exception("Source file $file does not exist"); } $filePath = self::realpath($file); if ($filePath === false) { $filePath = $file; } // Before we go and spend time tokenizing this file, just check // to see if there is a tag up top to indicate that the whole // file should be ignored. It must be on one of the first two lines. $firstContent = $contents; if ($contents === null && is_readable($filePath) === true) { $handle = fopen($filePath, 'r'); if ($handle !== false) { $firstContent = fgets($handle); $firstContent .= fgets($handle); fclose($handle); if (strpos($firstContent, '@codingStandardsIgnoreFile') !== false) { // We are ignoring the whole file. if (PHP_CODESNIFFER_VERBOSITY > 0) { echo 'Ignoring '.basename($filePath).PHP_EOL; } return null; } } }//end if try { $phpcsFile = $this->_processFile($file, $contents); } catch (Exception $e) { $trace = $e->getTrace(); $filename = $trace[0]['args'][0]; if (is_object($filename) === true && get_class($filename) === 'PHP_CodeSniffer_File' ) { $filename = $filename->getFilename(); } else if (is_numeric($filename) === true) { // See if we can find the PHP_CodeSniffer_File object. foreach ($trace as $data) { if (isset($data['args'][0]) === true && ($data['args'][0] instanceof PHP_CodeSniffer_File) === true ) { $filename = $data['args'][0]->getFilename(); } } } else if (is_string($filename) === false) { $filename = (string) $filename; } $errorMessage = '"'.$e->getMessage().'" at '.$e->getFile().':'.$e->getLine(); $error = "An error occurred during processing; checking has been aborted. The error message was: $errorMessage"; $phpcsFile = new PHP_CodeSniffer_File( $filename, $this->_tokenListeners, $this->ruleset, $this ); $phpcsFile->addError($error, null); }//end try $cliValues = $this->cli->getCommandLineValues(); if (PHP_CODESNIFFER_INTERACTIVE === false) { // Cache the report data for this file so we can unset it to save memory. $this->reporting->cacheFileReport($phpcsFile, $cliValues); $phpcsFile->cleanUp(); return $phpcsFile; } /* Running interactively. Print the error report for the current file and then wait for user input. */ // Get current violations and then clear the list to make sure // we only print violations for a single file each time. $numErrors = null; while ($numErrors !== 0) { $numErrors = ($phpcsFile->getErrorCount() + $phpcsFile->getWarningCount()); if ($numErrors === 0) { continue; } $reportClass = $this->reporting->factory('full'); $reportData = $this->reporting->prepareFileReport($phpcsFile); $reportClass->generateFileReport($reportData, $phpcsFile, $cliValues['showSources'], $cliValues['reportWidth']); echo ' to recheck, [s] to skip or [q] to quit : '; $input = fgets(STDIN); $input = trim($input); switch ($input) { case 's': break(2); case 'q': exit(0); break; default: // Repopulate the sniffs because some of them save their state // and only clear it when the file changes, but we are rechecking // the same file. $this->populateTokenListeners(); $phpcsFile = $this->_processFile($file, $contents); break; } }//end while return $phpcsFile; }//end processFile() /** * Process the sniffs for a single file. * * Does raw processing only. No interactive support or error checking. * * @param string $file The file to process. * @param string $contents The contents to parse. If NULL, the content * is taken from the file system. * * @return PHP_CodeSniffer_File * @see processFile() */ private function _processFile($file, $contents) { $stdin = false; $cliValues = $this->cli->getCommandLineValues(); if (empty($cliValues['files']) === true) { $stdin = true; } if (PHP_CODESNIFFER_VERBOSITY > 0 || (PHP_CODESNIFFER_CBF === true && $stdin === false)) { $startTime = microtime(true); echo 'Processing '.basename($file).' '; if (PHP_CODESNIFFER_VERBOSITY > 1) { echo PHP_EOL; } } $phpcsFile = new PHP_CodeSniffer_File( $file, $this->_tokenListeners, $this->ruleset, $this ); $phpcsFile->start($contents); if (PHP_CODESNIFFER_VERBOSITY > 0 || (PHP_CODESNIFFER_CBF === true && $stdin === false)) { $timeTaken = ((microtime(true) - $startTime) * 1000); if ($timeTaken < 1000) { $timeTaken = round($timeTaken); echo "DONE in {$timeTaken}ms"; } else { $timeTaken = round(($timeTaken / 1000), 2); echo "DONE in $timeTaken secs"; } if (PHP_CODESNIFFER_CBF === true) { $errors = $phpcsFile->getFixableCount(); echo " ($errors fixable violations)".PHP_EOL; } else { $errors = $phpcsFile->getErrorCount(); $warnings = $phpcsFile->getWarningCount(); echo " ($errors errors, $warnings warnings)".PHP_EOL; } } return $phpcsFile; }//end _processFile() /** * Generates documentation for a coding standard. * * @param string $standard The standard to generate docs for * @param array $sniffs A list of sniffs to limit the docs to. * @param string $generator The name of the generator class to use. * * @return void */ public function generateDocs($standard, array $sniffs=array(), $generator='Text') { if (class_exists('PHP_CodeSniffer_DocGenerators_'.$generator, true) === false) { throw new PHP_CodeSniffer_Exception('Class PHP_CodeSniffer_DocGenerators_'.$generator.' not found'); } $class = "PHP_CodeSniffer_DocGenerators_$generator"; $generator = new $class($standard, $sniffs); $generator->generate(); }//end generateDocs() /** * Gets the array of PHP_CodeSniffer_Sniff's. * * @return PHP_CodeSniffer_Sniff[] */ public function getSniffs() { return $this->listeners; }//end getSniffs() /** * Gets the array of PHP_CodeSniffer_Sniff's indexed by token type. * * @return array */ public function getTokenSniffs() { return $this->_tokenListeners; }//end getTokenSniffs() /** * Returns true if the specified string is in the camel caps format. * * @param string $string The string the verify. * @param boolean $classFormat If true, check to see if the string is in the * class format. Class format strings must start * with a capital letter and contain no * underscores. * @param boolean $public If true, the first character in the string * must be an a-z character. If false, the * character must be an underscore. This * argument is only applicable if $classFormat * is false. * @param boolean $strict If true, the string must not have two capital * letters next to each other. If false, a * relaxed camel caps policy is used to allow * for acronyms. * * @return boolean */ public static function isCamelCaps( $string, $classFormat=false, $public=true, $strict=true ) { // Check the first character first. if ($classFormat === false) { $legalFirstChar = ''; if ($public === false) { $legalFirstChar = '[_]'; } if ($strict === false) { // Can either start with a lowercase letter, or multiple uppercase // in a row, representing an acronym. $legalFirstChar .= '([A-Z]{2,}|[a-z])'; } else { $legalFirstChar .= '[a-z]'; } } else { $legalFirstChar = '[A-Z]'; } if (preg_match("/^$legalFirstChar/", $string) === 0) { return false; } // Check that the name only contains legal characters. $legalChars = 'a-zA-Z0-9'; if (preg_match("|[^$legalChars]|", substr($string, 1)) > 0) { return false; } if ($strict === true) { // Check that there are not two capital letters next to each other. $length = strlen($string); $lastCharWasCaps = $classFormat; for ($i = 1; $i < $length; $i++) { $ascii = ord($string{$i}); if ($ascii >= 48 && $ascii <= 57) { // The character is a number, so it cant be a capital. $isCaps = false; } else { if (strtoupper($string{$i}) === $string{$i}) { $isCaps = true; } else { $isCaps = false; } } if ($isCaps === true && $lastCharWasCaps === true) { return false; } $lastCharWasCaps = $isCaps; } }//end if return true; }//end isCamelCaps() /** * Returns true if the specified string is in the underscore caps format. * * @param string $string The string to verify. * * @return boolean */ public static function isUnderscoreName($string) { // If there are space in the name, it can't be valid. if (strpos($string, ' ') !== false) { return false; } $validName = true; $nameBits = explode('_', $string); if (preg_match('|^[A-Z]|', $string) === 0) { // Name does not begin with a capital letter. $validName = false; } else { foreach ($nameBits as $bit) { if ($bit === '') { continue; } if ($bit{0} !== strtoupper($bit{0})) { $validName = false; break; } } } return $validName; }//end isUnderscoreName() /** * Returns a valid variable type for param/var tag. * * If type is not one of the standard type, it must be a custom type. * Returns the correct type name suggestion if type name is invalid. * * @param string $varType The variable type to process. * * @return string */ public static function suggestType($varType) { if ($varType === '') { return ''; } if (in_array($varType, self::$allowedTypes) === true) { return $varType; } else { $lowerVarType = strtolower($varType); switch ($lowerVarType) { case 'bool': return 'boolean'; case 'double': case 'real': return 'float'; case 'int': return 'integer'; case 'array()': return 'array'; }//end switch if (strpos($lowerVarType, 'array(') !== false) { // Valid array declaration: // array, array(type), array(type1 => type2). $matches = array(); $pattern = '/^array\(\s*([^\s^=^>]*)(\s*=>\s*(.*))?\s*\)/i'; if (preg_match($pattern, $varType, $matches) !== 0) { $type1 = ''; if (isset($matches[1]) === true) { $type1 = $matches[1]; } $type2 = ''; if (isset($matches[3]) === true) { $type2 = $matches[3]; } $type1 = self::suggestType($type1); $type2 = self::suggestType($type2); if ($type2 !== '') { $type2 = ' => '.$type2; } return "array($type1$type2)"; } else { return 'array'; }//end if } else if (in_array($lowerVarType, self::$allowedTypes) === true) { // A valid type, but not lower cased. return $lowerVarType; } else { // Must be a custom type name. return $varType; }//end if }//end if }//end suggestType() /** * Prepares token content for output to screen. * * Replaces invisible characters so they are visible. On non-Windows * OSes it will also colour the invisible characters. * * @param string $content The content to prepare. * * @return string */ public static function prepareForOutput($content) { if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') { $content = str_replace("\r", '\r', $content); $content = str_replace("\n", '\n', $content); $content = str_replace("\t", '\t', $content); } else { $content = str_replace("\r", "\033[30;1m\\r\033[0m", $content); $content = str_replace("\n", "\033[30;1m\\n\033[0m", $content); $content = str_replace("\t", "\033[30;1m\\t\033[0m", $content); $content = str_replace(' ', "\033[30;1m·\033[0m", $content); } return $content; }//end prepareForOutput() /** * Get a list paths where standards are installed. * * @return array */ public static function getInstalledStandardPaths() { $installedPaths = array(dirname(__FILE__).DIRECTORY_SEPARATOR.'CodeSniffer'.DIRECTORY_SEPARATOR.'Standards'); $configPaths = PHP_CodeSniffer::getConfigData('installed_paths'); if ($configPaths !== null) { $installedPaths = array_merge($installedPaths, explode(',', $configPaths)); } $resolvedInstalledPaths = array(); foreach ($installedPaths as $installedPath) { if (substr($installedPath, 0, 1) === '.') { $installedPath = dirname(__FILE__).DIRECTORY_SEPARATOR.$installedPath; } $resolvedInstalledPaths[] = $installedPath; } return $resolvedInstalledPaths; }//end getInstalledStandardPaths() /** * Get a list of all coding standards installed. * * Coding standards are directories located in the * CodeSniffer/Standards directory. Valid coding standards * include a Sniffs subdirectory. * * @param boolean $includeGeneric If true, the special "Generic" * coding standard will be included * if installed. * @param string $standardsDir A specific directory to look for standards * in. If not specified, PHP_CodeSniffer will * look in its default locations. * * @return array * @see isInstalledStandard() */ public static function getInstalledStandards( $includeGeneric=false, $standardsDir='' ) { $installedStandards = array(); if ($standardsDir === '') { $installedPaths = self::getInstalledStandardPaths(); } else { $installedPaths = array($standardsDir); } foreach ($installedPaths as $standardsDir) { $di = new DirectoryIterator($standardsDir); foreach ($di as $file) { if ($file->isDir() === true && $file->isDot() === false) { $filename = $file->getFilename(); // Ignore the special "Generic" standard. if ($includeGeneric === false && $filename === 'Generic') { continue; } // Valid coding standard dirs include a ruleset. $csFile = $file->getPathname().'/ruleset.xml'; if (is_file($csFile) === true) { $installedStandards[] = $filename; } } } }//end foreach return $installedStandards; }//end getInstalledStandards() /** * Determine if a standard is installed. * * Coding standards are directories located in the * CodeSniffer/Standards directory. Valid coding standards * include a ruleset.xml file. * * @param string $standard The name of the coding standard. * * @return boolean * @see getInstalledStandards() */ public static function isInstalledStandard($standard) { $path = self::getInstalledStandardPath($standard); if ($path !== null && strpos($path, 'ruleset.xml') !== false) { return true; } else { // This could be a custom standard, installed outside our // standards directory. $standard = self::realPath($standard); // Might be an actual ruleset file itself. // If it has an XML extension, let's at least try it. if (is_file($standard) === true && (substr(strtolower($standard), -4) === '.xml' || substr(strtolower($standard), -9) === '.xml.dist') ) { return true; } // If it is a directory with a ruleset.xml file in it, // it is a standard. $ruleset = rtrim($standard, ' /\\').DIRECTORY_SEPARATOR.'ruleset.xml'; if (is_file($ruleset) === true) { return true; } }//end if return false; }//end isInstalledStandard() /** * Return the path of an installed coding standard. * * Coding standards are directories located in the * CodeSniffer/Standards directory. Valid coding standards * include a ruleset.xml file. * * @param string $standard The name of the coding standard. * * @return string|null */ public static function getInstalledStandardPath($standard) { $installedPaths = self::getInstalledStandardPaths(); foreach ($installedPaths as $installedPath) { $standardPath = $installedPath.DIRECTORY_SEPARATOR.$standard; $path = self::realpath($standardPath.DIRECTORY_SEPARATOR.'ruleset.xml'); if (is_file($path) === true) { return $path; } else if (self::isPharFile($standardPath) === true) { $path = self::realpath($standardPath); if ($path !== false) { return $path; } } } return null; }//end getInstalledStandardPath() /** * Get a single config value. * * Config data is stored in the data dir, in a file called * CodeSniffer.conf. It is a simple PHP array. * * @param string $key The name of the config value. * * @return string|null * @see setConfigData() * @see getAllConfigData() */ public static function getConfigData($key) { $phpCodeSnifferConfig = self::getAllConfigData(); if ($phpCodeSnifferConfig === null) { return null; } if (isset($phpCodeSnifferConfig[$key]) === false) { return null; } return $phpCodeSnifferConfig[$key]; }//end getConfigData() /** * Set a single config value. * * Config data is stored in the data dir, in a file called * CodeSniffer.conf. It is a simple PHP array. * * @param string $key The name of the config value. * @param string|null $value The value to set. If null, the config * entry is deleted, reverting it to the * default value. * @param boolean $temp Set this config data temporarily for this * script run. This will not write the config * data to the config file. * * @return boolean * @see getConfigData() * @throws PHP_CodeSniffer_Exception If the config file can not be written. */ public static function setConfigData($key, $value, $temp=false) { if ($temp === false) { $path = ''; if (is_callable('Phar::running') === true) { $path = Phar::running(false); } if ($path !== '') { $configFile = dirname($path).'/CodeSniffer.conf'; } else { $configFile = dirname(__FILE__).'/CodeSniffer.conf'; if (is_file($configFile) === false && strpos('@data_dir@', '@data_dir') === false ) { // If data_dir was replaced, this is a PEAR install and we can // use the PEAR data dir to store the conf file. $configFile = '@data_dir@/PHP_CodeSniffer/CodeSniffer.conf'; } } if (is_file($configFile) === true && is_writable($configFile) === false ) { $error = 'Config file '.$configFile.' is not writable'; throw new PHP_CodeSniffer_Exception($error); } }//end if $phpCodeSnifferConfig = self::getAllConfigData(); if ($value === null) { if (isset($phpCodeSnifferConfig[$key]) === true) { unset($phpCodeSnifferConfig[$key]); } } else { $phpCodeSnifferConfig[$key] = $value; } if ($temp === false) { $output = '<'.'?php'."\n".' $phpCodeSnifferConfig = '; $output .= var_export($phpCodeSnifferConfig, true); $output .= "\n?".'>'; if (file_put_contents($configFile, $output) === false) { return false; } } $GLOBALS['PHP_CODESNIFFER_CONFIG_DATA'] = $phpCodeSnifferConfig; return true; }//end setConfigData() /** * Get all config data in an array. * * @return array * @see getConfigData() */ public static function getAllConfigData() { if (isset($GLOBALS['PHP_CODESNIFFER_CONFIG_DATA']) === true) { return $GLOBALS['PHP_CODESNIFFER_CONFIG_DATA']; } $path = ''; if (is_callable('Phar::running') === true) { $path = Phar::running(false); } if ($path !== '') { $configFile = dirname($path).'/CodeSniffer.conf'; } else { $configFile = dirname(__FILE__).'/CodeSniffer.conf'; if (is_file($configFile) === false) { $configFile = '@data_dir@/PHP_CodeSniffer/CodeSniffer.conf'; } } if (is_file($configFile) === false) { $GLOBALS['PHP_CODESNIFFER_CONFIG_DATA'] = array(); return array(); } include $configFile; $GLOBALS['PHP_CODESNIFFER_CONFIG_DATA'] = $phpCodeSnifferConfig; return $GLOBALS['PHP_CODESNIFFER_CONFIG_DATA']; }//end getAllConfigData() /** * Return TRUE, if the path is a phar file. * * @param string $path The path to use. * * @return mixed */ public static function isPharFile($path) { if (strpos($path, 'phar://') === 0) { return true; } return false; }//end isPharFile() /** * CodeSniffer alternative for realpath. * * Allows for phar support. * * @param string $path The path to use. * * @return mixed */ public static function realpath($path) { // Support the path replacement of ~ with the user's home directory. if (substr($path, 0, 2) === '~/') { $homeDir = getenv('HOME'); if ($homeDir !== false) { $path = $homeDir.substr($path, 1); } } // No extra work needed if this is not a phar file. if (self::isPharFile($path) === false) { return realpath($path); } // Before trying to break down the file path, // check if it exists first because it will mostly not // change after running the below code. if (file_exists($path) === true) { return $path; } $phar = Phar::running(false); $extra = str_replace('phar://'.$phar, '', $path); $path = realpath($phar); if ($path === false) { return false; } $path = 'phar://'.$path.$extra; if (file_exists($path) === true) { return $path; } return false; }//end realpath() /** * CodeSniffer alternative for chdir(). * * Allows for phar support. * * @param string $path The path to use. * * @return void */ public static function chdir($path) { if (self::isPharFile($path) === true) { $phar = Phar::running(false); chdir(dirname($phar)); } else { chdir($path); } }//end chdir() }//end class PHP_CodeSniffer-2.5.1/CodeSniffer.conf.dist0000644000076700000240000000027312647543456020325 0ustar gsherwoodstaff 'PSR2', 'report_format' => 'summary', 'show_warnings' => '0', 'show_progress' => '1', 'report_width' => '120', ) ?> PHP_CodeSniffer-2.5.1/README.md0000644000076700000240000000675212647543456015614 0ustar gsherwoodstaffAbout ----- PHP\_CodeSniffer is a set of two PHP scripts; the main `phpcs` script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second `phpcbf` script to automatically correct coding standard violations. PHP\_CodeSniffer is an essential development tool that ensures your code remains clean and consistent. [![Build Status](https://travis-ci.org/squizlabs/PHP_CodeSniffer.svg?branch=phpcs-fixer)](https://travis-ci.org/squizlabs/PHP_CodeSniffer) [![Code consistency](http://squizlabs.github.io/PHP_CodeSniffer/analysis/squizlabs/PHP_CodeSniffer/grade.svg)](http://squizlabs.github.io/PHP_CodeSniffer/analysis/squizlabs/PHP_CodeSniffer) [![Join the chat at https://gitter.im/squizlabs/PHP_CodeSniffer](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/squizlabs/PHP_CodeSniffer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) Requirements ------------ PHP\_CodeSniffer requires PHP version 5.1.2 or greater, although individual sniffs may have additional requirements such as external applications and scripts. See the [Configuration Options manual page](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options) for a list of these requirements. The SVN pre-commit hook requires PHP version 5.2.4 or greater due to its use of the vertical whitespace character. Installation ------------ The easiest way to get started with PHP\_CodeSniffer is to download the [Phar](http://php.net/manual/en/intro.phar.php) files for each of the commands: curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar php phpcs.phar -h curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar php phpcbf.phar -h If you use PEAR, you can install PHP\_CodeSniffer using the PEAR installer. This will make the `phpcs` and `phpcbf` commands immediately available for use. To install PHP\_CodeSniffer using the PEAR installer, first ensure you have [installed PEAR](http://pear.php.net/manual/en/installation.getting.php) and then run the following command: pear install PHP_CodeSniffer If you prefer using [Composer](http://getcomposer.org/) you can easily install PHP_CodeSniffer system-wide with the following command: composer global require "squizlabs/php_codesniffer=*" Make sure you have `~/.composer/vendor/bin/` in your PATH. Or alternatively, include a dependency for `squizlabs/php_codesniffer` in your `composer.json` file. For example: ```json { "require-dev": { "squizlabs/php_codesniffer": "2.*" } } ``` You will then be able to run PHP_CodeSniffer from the vendor bin directory: ./vendor/bin/phpcs -h ./vendor/bin/phpcbf -h You can also download the PHP\_CodeSniffer source and run the `phpcs` and `phpcbf` commands directly from the Git checkout: git clone git://github.com/squizlabs/PHP_CodeSniffer.git cd PHP_CodeSniffer php scripts/phpcs -h php scripts/phpcbf -h Documentation ------------- The documentation for PHP\_CodeSniffer is available on the [Github wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki). Information about upcoming features and releases is available on the [Squiz Labs blog](http://www.squizlabs.com/php-codesniffer). Issues ------ Bug reports and feature requests can be submitted on the [Github Issue Tracker](https://github.com/squizlabs/PHP_CodeSniffer/issues) or the [PEAR bug tracker](http://pear.php.net/package/PHP_CodeSniffer/bugs). Contributing ------------- See [CONTRIBUTING.md](CONTRIBUTING.md) for information. PHP_CodeSniffer-2.5.1/CONTRIBUTING.md0000644000076700000240000000127612647543456016562 0ustar gsherwoodstaffContributing ------------- Before you contribute code to PHP\_CodeSniffer, please make sure it conforms to the PHPCS coding standard and that the PHP\_CodeSniffer unit tests still pass. The easiest way to contribute is to work on a checkout of the repository, or your own fork, rather than an installed PEAR version. If you do this, you can run the following commands to check if everything is ready to submit: cd PHP_CodeSniffer php scripts/phpcs . --standard=PHPCS -np Which should give you no output, indicating that there are no coding standard errors. And then: phpunit Which should give you no failures or errors. You can ignore any skipped tests as these are for external tools.PHP_CodeSniffer-2.5.1/licence.txt0000644000076700000240000000277512647543456016501 0ustar gsherwoodstaffCopyright (c) 2012, Squiz Pty Ltd (ABN 77 084 670 600) All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Squiz Pty Ltd nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.