<?php
namespace EasyBib\Sniffs\Commenting;
 
class ReturnStatementsSniff implements \PHP_CodeSniffer_Sniff
{
    /**
     * @var \PHP_CodeSniffer_File
     */
    protected $phpcsFile;
 
    /**
     * @var array
     */
    protected $tokens;
 
    public function register()
    {
        return array(T_FUNCTION);
    }
 
    public function process(\PHP_CodeSniffer_File $phpcsFile, $stackPtr)
    {
        $this->phpcsFile = $phpcsFile;
 
        $methodName = $this->phpcsFile->getDeclarationName($stackPtr);
        if (null === $methodName) {
            return;
        }
 
        $this->tokens = $phpcsFile->getTokens();
 
        // enforce no `@return void` on __construct
        if ('__construct' === $methodName) {
            $this->findReturnVoid($stackPtr, true);
            return;
        }
    }
 
    /**
     * @param int  $stackPtr Position in the stack.
     * @param bool $ctor     Is this a __construct.
     *
     * @return void
     */
    protected function findReturnVoid($stackPtr, $ctor = false)
    {
        $toFind     = array(T_DOC_COMMENT,);
        $commentEnd = $this->phpcsFile->findPrevious(T_DOC_COMMENT, ($stackPtr-1));
        if (false === $commentEnd) {
            return; // no docblock, different concern
        }
 
        $look = $commentEnd-1;
        while (true && ($look > 0)) {
            $docComment = $this->phpcsFile->findPrevious(T_DOC_COMMENT, ($look));
            if (false === $docComment) {
                return;
            }
            $docRow  = $this->tokens[$docComment];
            $content = trim($docRow['content']);
            if (strstr($content, '@return void')) {
                if (true === $ctor) {
                   $this->phpcsFile->addError('`@return void` for __construct is invalid.', $docComment, 'ConstructNoReturnVoid');
                } else {
                    $this->phpcsFile->addWarning('Consider adding a fluent interface instead of `@return void`', $docComment, 'AddSetReturnsVoid');
                }
                return;
            }
            if ('/**' == $content) {
                return;
            }
            --$look;
        }
        return;
    }
}
 

<?php
/**
 * EasyBib\Sniffs\Methods\AddSetShouldBeFluentSniff
 *
 * PHP version 5.3
 *
 * @category QA
 * @package  EasyBib\Sniffs
 * @author   Till Klampaeckel <till@php.net>
 * @license  http://opensource.org/licenses/bsd-license.php New BSD License
 * @version  GIT: <git_id>
 * @link     http://
 */
 
namespace EasyBib\Sniffs\Methods;
 
/**
 * EasyBib\Sniffs\Methods\AddSetShouldBeFluentSniff
 *
 * Ensures that there are no `return` statements in a `__construct` and that the docblock
 * says `return $this` - if anything.
 *
 * @category  QA
 * @package   EasyBib\Sniffs
 * @author    Till Klampaeckel <till@php.net>
 * @license   http://opensource.org/licenses/bsd-license.php New BSD License
 * @version   Release: @package_version@
 * @link      http://
 */
class AddSetShouldBeFluentSniff implements \PHP_CodeSniffer_Sniff
{
    public function register()
    {
        return array(T_FUNCTION);
    }
 
    /**
     * 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)
    {
        $methodName = $phpcsFile->getDeclarationName($stackPtr);
        if (null === $methodName) {
            return;
        }
 
        // check fluent interface for `set*()` and `add*()`.
        $methodType = substr($methodName, 0, 3);
        if (false === in_array($methodType, array('set', 'add'))) {
            return;
        }
 
        // for `fooAction` methods in controllers
        if (substr($methodName, -6) == 'Action') {
            return;
        }
 
        if (strtolower(substr($methodName, 0, 5)) === 'setup') {
            return;
        }
 
        $error = sprintf('`%s` should implement a fluent interface', $methodName);
 
        $t_return = $phpcsFile->findNext(T_RETURN, $stackPtr);
        if (false === $t_return) {
            $phpcsFile->addError(
                $error,
                $stackPtr,
                'AddSetNoFluentInterface'
            );
            return;
        }
 
        $tokens = $phpcsFile->getTokens();
        if ($tokens[($t_return+1)]['type'] !== 'T_WHITESPACE') {
            $phpcsFile->addError(
                $error,
                ($t_return+1),
                'AddSetNoFluentInterface'
            );
            return;
        }
        if ($tokens[($t_return+2)]['content'] !== '$this') {
            $phpcsFile->addError(
                $error,
                ($t_return+2),
                'AddSetNoFluentInterface'
            );
            return;
        }
    }
}
 

<?php
/**
 * EasyBib\Sniffs\Methods\ConstructShouldNotReturnSniff
 *
 * PHP version 5.3
 *
 * @category QA
 * @package  EasyBib\Sniffs
 * @author   Till Klampaeckel <till@php.net>
 * @license  http://opensource.org/licenses/bsd-license.php New BSD License
 * @version  GIT: <git_id>
 * @link     http://
 */
 
namespace EasyBib\Sniffs\Methods;
 
/**
 * EasyBib\Sniffs\Methods\ConstructShouldNotReturnSniff
 *
 * Ensures that there are no `return` statements in a `__construct` and that the docblock
 * says `return $this` - if anything.
 *
 * @category  QA
 * @package   EasyBib\Sniffs
 * @author    Till Klampaeckel <till@php.net>
 * @license   http://opensource.org/licenses/bsd-license.php New BSD License
 * @version   Release: @package_version@
 * @link      http://
 */
class ConstructShouldNotReturnSniff extends \PHP_CodeSniffer_Standards_AbstractScopeSniff
{
    public function __construct()
    {
        parent::__construct(array(T_FUNCTION), array(T_RETURN));
    }
 
    /**
     * 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.
     * @param int                  $currScope The current scope opener token.
     *
     * @return void
     */
    protected function processTokenWithinScope(\PHP_CodeSniffer_File $phpcsFile, $stackPtr, $currScope)
    {
        $methodName = $phpcsFile->getDeclarationName($currScope);
        if (null === $methodName) {
            return;
        }
        if ('__construct' !== $methodName) {
            return;
        }
 
        $tokens = $phpcsFile->getTokens();
        if (!isset($tokens[$stackPtr])) {
            return;
        }
 
        if ('T_RETURN' === $tokens[$stackPtr]['type'] && 'T_SEMICOLON' !== $tokens[$stackPtr+1]['type']) {
            $phpcsFile->addWarning('__construct cannot return anything', $stackPtr, 'NoReturnInConstruct');
            return;
        }
    }
}
 

<?php
require './vendor/autoload.php';
 
$cs = new \EasyBib\PHP\CodeSniffer\CodingStandard;
$cs->getIncludedSniffs();