ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: opt / cpanel / ea-wappspector / vendor / squizlabs / php_codesniffer / src / Standards / Squiz / Tests / Commenting

<?php
class FunctionCommentThrowTagUnitTest
{

/**
     * Missing throw tag.
     *
     */
    public function missingThrowTag()
    {
        throw new PHP_Exception('Error');

}//end missingThrowTag()

/**
     * Tag and token number mismatch.
     *
     * @throws PHP_Exception1
     */
    public function oneMoreThrowsTagNeeded()
    {
        throw new PHP_Exception1('Error');
        throw new PHP_Exception2('Error');

}//end oneMoreThrowsTagNeeded()

/**
     * Tag and token number mismatch.
     *
     * @throws PHP_Exception1
     * @throws PHP_Exception2
     */
    public function oneLessThrowsTagNeeded()
    {
        throw new PHP_Exception1('Error');

}//end oneLessThrowsTagNeeded()

/**
     * Wrong exception type name.
     *
     * @throws PHP_Wrong_Exception
     */
    public function wrongExceptionName()
    {
        throw new PHP_Correct_Exception('Error');

}//end wrongExceptionName()

/**
     * Wrong exception type name.
     *
     * @throws PHP_Correct_Exception1
     * @throws PHP_Wrong_Exception2
     * @throws PHP_Wrong_Exception3
     */
    public function moreWrongExceptionName()
    {
        throw new PHP_Correct_Exception1('Error');
        throw new PHP_Correct_Exception2('Error');
        throw new PHP_Correct_Exception3('Error');

}//end moreWrongExceptionName()

/**
     * Wrong exception type name.
     *
     * @throws PHP_Correct_Exception
     */
    public function sameExceptionName()
    {
        throw new PHP_Correct_Exception('Error');
        throw new PHP_Correct_Exception('Error');

}//end sameExceptionName()

/**
     * This is a valid chunk.
     *
     * @throws PHP_Exception1
     * @throws PHP_Exception2
     */
    public function thisShouldWorkOK()
    {
        throw new PHP_Exception2('Error');
        throw new PHP_Exception1('Error');
        throw new PHP_Exception2('Error');
        throw new PHP_Exception1('Error');
        throw new PHP_Exception2('Error');

}//end thisShouldWorkOK()

/**
     * This is not OK, missing 2 @throws tag.
     *
     * @throws PHP_Exception1
     * @throws PHP_Exception2
     */
    public function notOK()
    {
        throw new PHP_Missing_Exception1('Error');
        throw new PHP_Exception2('Error');
        throw new PHP_Missing_Exception2('Error');
        throw new PHP_Missing_Exception2('Error');
        throw new PHP_Exception1('Error');
        throw new PHP_Exception2('Error');
        throw new PHP_Missing_Exception1('Error');

}//end notOK()

/**
     * Needs at least 1 throws tag, even though we
     * don't know what it is.
     */
    public function notOKVariable()
    {
        try {
            // Do something.
        } catch (PHP_Exception2 $e) {
            logError();
            throw $e;
        }

}//end notOKVariable()

/**
     * Needs at least 1 throws tag, even though we
     * don't know what it is.
     *
     * @throws PHP_Exception1
     */
    public function okVariable()
    {
        throw new PHP_Exception1('Error');

try {
            // Do something.
        } catch (PHP_Exception1 $e) {
            logError();
            throw $e;
        }

}//end okVariable()

/**
     * Needs 1 @throws tag.
     *
     * @throws Exception Unknown exception type.
     */
    function okVariable()
    {
        throw $e;

}//end okVariable()

/**
     * Needs 1 @throws tag.
     *
     * @throws Exception Unknown exception type.
     */
    function okFunction()
    {
        throw $this->callSomeFunction();

}//end okFunction()

/**
     * Comment inside function.
     *
     * @throws Exception
     */
    function okFunction()
    {
        /**
         * @var FooClass
         */
        $foo = FooFactory::factory();
        throw new Exception;

}//end okFunction

/**
     * Needs at throws tag for rethrown exception,
     * even though we have one throws tag.
     *
     * @throws PHP_Exception1
     */
    public function notOkVariableRethrown()
    {
        throw new PHP_Exception1('Error');

try {
            // Do something.
        } catch (PHP_Exception2 $e) {
            logError();
            throw $e;
        }

}//end notOkVariableRethrown()

try {
            // Do something.
        } catch (PHP_Exception1 | PHP_Exception2 $e) {
            logError();
            throw $e;
        }

}//end notOkVariableRethrown()

/**
     * Has correct throws tags for all exceptions
     *
     * @throws PHP_Exception1
     * @throws PHP_Exception2
     */
    public function okVariableRethrown()
    {
        throw new PHP_Exception1('Error');

try {
            // Do something.
        } catch (PHP_Exception2 $e) {
            logError();
            throw $e;
        }

}//end okVariableRethrown()

/**
     * Has correct throws tags for all exceptions
     *
     * @throws PHP_Exception1
     * @throws PHP_Exception2
     */
    public function okVariableMultiRethrown()
    {
        try {
            // Do something.
        } catch (PHP_Exception1 | PHP_Exception2 $e) {
            logError();
            throw $e;
        }

}//end okVariableMultiRethrown()
}//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.');
        }
    }

/*
     *
     */
    protected function foo()
    {
    }

/**
     * @return Closure
     */
    public function getStuff()
    {
        return function () {
            throw new RuntimeException("bam!");
        };
    }
}

/**
 * Class comment.
 */
class A
{
    /**
     * Function B.
     */
    public function b()
    {
        return new class {
            public function c()
            {
                throw new \Exception();
            }
        }
    }
}

/**
 * Class comment.
 */
class A
{
    /**
     * Function B.
     */
    public function b()
    {
        return new class {
            /**
             * Tag and token number mismatch.
             *
             * @throws PHP_Exception1
             * @throws PHP_Exception2
             */
            public function oneLessThrowsTagNeeded()
            {
                throw new PHP_Exception1('Error');

}//end oneLessThrowsTagNeeded()
        }
    }
}

abstract class SomeClass {
    /**
     * Comment here.
     */
    abstract public function getGroups();
}

class SomeClass {
    /**
     * Validates something.
     *
     * @param string $method The set method parameter.
     *
     * @return string The validated method.
     *
     * @throws Prefix_Invalid_Argument_Exception The invalid argument exception.
     * @throws InvalidArgumentException          The invalid argument exception.
     */
    protected function validate_something( $something ) {
        if ( ! Prefix_Validator::is_string( $something ) ) {
            throw Prefix_Invalid_Argument_Exception::invalid_string_parameter( $something, 'something' );
        }

if ( ! in_array( $something, $this->valid_http_something, true ) ) {
            throw new InvalidArgumentException( sprintf( '%s is not a valid HTTP something', $something ) );
        }

return $something;
    }

/**
     * Comment
     *
     * @throws Exception1 Comment.
     * @throws Exception2 Comment.
     * @throws Exception3 Comment.
     */
    public function foo() {
        switch ($foo) {
            case 1:
                throw Exception1::a();
            case 2:
                throw Exception1::b();
            case 3:
                throw Exception1::c();
            case 4:
                throw Exception2::a();
            case 5:
                throw Exception2::b();
            default:
                throw new Exception3;

}
    }
}

namespace Test\Admin {
    class NameSpacedClass {
        /**
         * @throws \ExceptionFromGlobalNamespace
         */
        public function ExceptionInGlobalNamespace() {
            throw new \ExceptionFromGlobalNamespace();
        }

/**
         * @throws ExceptionFromSameNamespace
         */
        public function ExceptionInSameNamespace() {
            throw new ExceptionFromSameNamespace();
        }

/**
         * @throws \Test\Admin\ExceptionFromSameNamespace
         */
        public function ExceptionInSameNamespaceToo() {
            throw new ExceptionFromSameNamespace();
        }

/**
         * @throws \Different\NameSpaceName\ExceptionFromDifferentNamespace
         */
        public function ExceptionInSameNamespaceToo() {
            throw new \Different\NameSpaceName\ExceptionFromDifferentNamespace();
        }
    }
}

namespace {
    class GlobalNameSpaceClass {
        /**
         * @throws SomeGlobalException
         */
        public function ThrowGlobalException() {
            throw new SomeGlobalException();
        }

/**
         * @throws \SomeGlobalException
         */
        public function ThrowGlobalExceptionToo() {
            throw new SomeGlobalException();
        }
    }
}

$anon = new class {
    /**
     * Tag and token number mismatch.
     *
     * @throws PHP_Exception1
     * @throws PHP_Exception2
     */
    #[AnAttribute]
    #[AnotherAttribute]
    public function JumpOverAttributesToFindDocblock() {
        throw new PHP_Exception1('Error');
    }
};

/**
 * @throws Wrong_Exception
 */
public function ImproveCommentTolerance() {
    throw /*comment*/ new /*comment*/ Right_Exception('Error');
}

[-] ClosingDeclarationCommentUnitTest.4.inc.fixed [edit]
[-] LongConditionClosingCommentUnitTest.js [edit]
[-] ClosingDeclarationCommentUnitTest.1.inc.fixed [edit]
[-] FileCommentUnitTest.9.inc [edit]
[-] VariableCommentUnitTest.php [edit]
[-] FunctionCommentThrowTagUnitTest.inc [edit]
[-] LongConditionClosingCommentUnitTest.php [edit]
[-] FileCommentUnitTest.1.inc.fixed [edit]
[-] PostStatementCommentUnitTest.1.js [edit]
[-] LongConditionClosingCommentUnitTest.inc [edit]
[-] BlockCommentUnitTest.inc.fixed [edit]
[-] FileCommentUnitTest.1.js.fixed [edit]
[-] DocCommentAlignmentUnitTest.js.fixed [edit]
[+] ..
[-] FileCommentUnitTest.2.js [edit]
[-] ClosingDeclarationCommentUnitTest.5.inc.fixed [edit]
[-] FileCommentUnitTest.6.inc [edit]
[-] BlockCommentUnitTest.inc [edit]
[-] PostStatementCommentUnitTest.1.js.fixed [edit]
[-] FunctionCommentUnitTest.inc.fixed [edit]
[-] FileCommentUnitTest.2.inc [edit]
[-] FileCommentUnitTest.5.inc [edit]
[-] ClosingDeclarationCommentUnitTest.1.inc [edit]
[-] FileCommentUnitTest.1.inc [edit]
[-] FunctionCommentUnitTest.inc [edit]
[-] InlineCommentUnitTest.js [edit]
[-] ClosingDeclarationCommentUnitTest.3.inc [edit]
[-] VariableCommentUnitTest.inc.fixed [edit]
[-] FunctionCommentUnitTest.php [edit]
[-] ClosingDeclarationCommentUnitTest.5.inc [edit]
[-] EmptyCatchCommentUnitTest.php [edit]
[-] FunctionCommentThrowTagUnitTest.php [edit]
[-] FileCommentUnitTest.10.inc [edit]
[-] FileCommentUnitTest.3.inc [edit]
[-] ClassCommentUnitTest.inc [edit]
[-] FileCommentUnitTest.4.inc [edit]
[-] ClosingDeclarationCommentUnitTest.4.inc [edit]
[-] LongConditionClosingCommentUnitTest.inc.fixed [edit]
[-] PostStatementCommentUnitTest.2.js [edit]
[-] EmptyCatchCommentUnitTest.inc [edit]
[-] InlineCommentUnitTest.js.fixed [edit]
[-] FileCommentUnitTest.8.inc [edit]
[-] InlineCommentUnitTest.inc.fixed [edit]
[-] PostStatementCommentUnitTest.inc [edit]
[-] BlockCommentUnitTest.php [edit]
[-] DocCommentAlignmentUnitTest.js [edit]
[-] PostStatementCommentUnitTest.php [edit]
[-] ClosingDeclarationCommentUnitTest.php [edit]
[-] VariableCommentUnitTest.inc [edit]
[-] FileCommentUnitTest.7.inc [edit]
[-] FileCommentUnitTest.1.js [edit]
[-] InlineCommentUnitTest.inc [edit]
[-] ClassCommentUnitTest.php [edit]
[-] ClosingDeclarationCommentUnitTest.2.inc [edit]
[-] DocCommentAlignmentUnitTest.php [edit]
[-] DocCommentAlignmentUnitTest.inc.fixed [edit]
[-] FileCommentUnitTest.php [edit]
[-] LongConditionClosingCommentUnitTest.js.fixed [edit]
[-] InlineCommentUnitTest.php [edit]
[-] PostStatementCommentUnitTest.inc.fixed [edit]
[-] DocCommentAlignmentUnitTest.inc [edit]