File "GetMemberPropertiesTest.php"
Full Path: /home/warrior1/public_html/wp-content/themes/storefront/vendor/squizlabs/php_codesniffer/tests/Core/File/GetMemberPropertiesTest.php
File size: 30.24 KB
MIME-type: text/x-php
Charset: utf-8
<?php
/**
* Tests for the \PHP_CodeSniffer\Files\File::getMemberProperties method.
*
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
*/
namespace PHP_CodeSniffer\Tests\Core\File;
use PHP_CodeSniffer\Tests\Core\AbstractMethodUnitTest;
class GetMemberPropertiesTest extends AbstractMethodUnitTest
{
/**
* Test the getMemberProperties() method.
*
* @param string $identifier Comment which precedes the test case.
* @param bool $expected Expected function output.
*
* @dataProvider dataGetMemberProperties
*
* @return void
*/
public function testGetMemberProperties($identifier, $expected)
{
$variable = $this->getTargetToken($identifier, T_VARIABLE);
$result = self::$phpcsFile->getMemberProperties($variable);
$this->assertArraySubset($expected, $result, true);
}//end testGetMemberProperties()
/**
* Data provider for the GetMemberProperties test.
*
* @see testGetMemberProperties()
*
* @return array
*/
public function dataGetMemberProperties()
{
return [
[
'/* testVar */',
[
'scope' => 'public',
'scope_specified' => false,
'is_static' => false,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testVarType */',
[
'scope' => 'public',
'scope_specified' => false,
'is_static' => false,
'is_readonly' => false,
'type' => '?int',
'nullable_type' => true,
],
],
[
'/* testPublic */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testPublicType */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'string',
'nullable_type' => false,
],
],
[
'/* testProtected */',
[
'scope' => 'protected',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testProtectedType */',
[
'scope' => 'protected',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'bool',
'nullable_type' => false,
],
],
[
'/* testPrivate */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testPrivateType */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'array',
'nullable_type' => false,
],
],
[
'/* testStatic */',
[
'scope' => 'public',
'scope_specified' => false,
'is_static' => true,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testStaticType */',
[
'scope' => 'public',
'scope_specified' => false,
'is_static' => true,
'is_readonly' => false,
'type' => '?string',
'nullable_type' => true,
],
],
[
'/* testStaticVar */',
[
'scope' => 'public',
'scope_specified' => false,
'is_static' => true,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testVarStatic */',
[
'scope' => 'public',
'scope_specified' => false,
'is_static' => true,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testPublicStatic */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => true,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testProtectedStatic */',
[
'scope' => 'protected',
'scope_specified' => true,
'is_static' => true,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testPrivateStatic */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => true,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testPublicStaticWithDocblock */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => true,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testProtectedStaticWithDocblock */',
[
'scope' => 'protected',
'scope_specified' => true,
'is_static' => true,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testPrivateStaticWithDocblock */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => true,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testGroupType 1 */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'float',
'nullable_type' => false,
],
],
[
'/* testGroupType 2 */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'float',
'nullable_type' => false,
],
],
[
'/* testGroupNullableType 1 */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => true,
'is_readonly' => false,
'type' => '?string',
'nullable_type' => true,
],
],
[
'/* testGroupNullableType 2 */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => true,
'is_readonly' => false,
'type' => '?string',
'nullable_type' => true,
],
],
[
'/* testNoPrefix */',
[
'scope' => 'public',
'scope_specified' => false,
'is_static' => false,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testGroupProtectedStatic 1 */',
[
'scope' => 'protected',
'scope_specified' => true,
'is_static' => true,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testGroupProtectedStatic 2 */',
[
'scope' => 'protected',
'scope_specified' => true,
'is_static' => true,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testGroupProtectedStatic 3 */',
[
'scope' => 'protected',
'scope_specified' => true,
'is_static' => true,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testGroupPrivate 1 */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testGroupPrivate 2 */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testGroupPrivate 3 */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testGroupPrivate 4 */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testGroupPrivate 5 */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testGroupPrivate 6 */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testGroupPrivate 7 */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testMessyNullableType */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '?array',
'nullable_type' => true,
],
],
[
'/* testNamespaceType */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '\MyNamespace\MyClass',
'nullable_type' => false,
],
],
[
'/* testNullableNamespaceType 1 */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '?ClassName',
'nullable_type' => true,
],
],
[
'/* testNullableNamespaceType 2 */',
[
'scope' => 'protected',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '?Folder\ClassName',
'nullable_type' => true,
],
],
[
'/* testMultilineNamespaceType */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '\MyNamespace\MyClass\Foo',
'nullable_type' => false,
],
],
[
'/* testPropertyAfterMethod */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => true,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testInterfaceProperty */',
[],
],
[
'/* testNestedProperty 1 */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testNestedProperty 2 */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '',
'nullable_type' => false,
],
],
[
'/* testPHP8MixedTypeHint */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => true,
'is_readonly' => false,
'type' => 'miXed',
'nullable_type' => false,
],
],
[
'/* testPHP8MixedTypeHintNullable */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '?mixed',
'nullable_type' => true,
],
],
[
'/* testNamespaceOperatorTypeHint */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '?namespace\Name',
'nullable_type' => true,
],
],
[
'/* testPHP8UnionTypesSimple */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'int|float',
'nullable_type' => false,
],
],
[
'/* testPHP8UnionTypesTwoClasses */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'MyClassA|\Package\MyClassB',
'nullable_type' => false,
],
],
[
'/* testPHP8UnionTypesAllBaseTypes */',
[
'scope' => 'protected',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'array|bool|int|float|NULL|object|string',
'nullable_type' => false,
],
],
[
'/* testPHP8UnionTypesAllPseudoTypes */',
[
'scope' => 'public',
'scope_specified' => false,
'is_static' => false,
'is_readonly' => false,
'type' => 'false|mixed|self|parent|iterable|Resource',
'nullable_type' => false,
],
],
[
'/* testPHP8UnionTypesIllegalTypes */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
// Missing static, but that's OK as not an allowed syntax.
'type' => 'callable||void',
'nullable_type' => false,
],
],
[
'/* testPHP8UnionTypesNullable */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '?int|float',
'nullable_type' => true,
],
],
[
'/* testPHP8PseudoTypeNull */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'null',
'nullable_type' => false,
],
],
[
'/* testPHP8PseudoTypeFalse */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'false',
'nullable_type' => false,
],
],
[
'/* testPHP8PseudoTypeFalseAndBool */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'bool|FALSE',
'nullable_type' => false,
],
],
[
'/* testPHP8ObjectAndClass */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'object|ClassName',
'nullable_type' => false,
],
],
[
'/* testPHP8PseudoTypeIterableAndArray */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'iterable|array|Traversable',
'nullable_type' => false,
],
],
[
'/* testPHP8DuplicateTypeInUnionWhitespaceAndComment */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'int|string|INT',
'nullable_type' => false,
],
],
[
'/* testPHP81Readonly */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => true,
'type' => 'int',
'nullable_type' => false,
],
],
[
'/* testPHP81ReadonlyWithNullableType */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => true,
'type' => '?array',
'nullable_type' => true,
],
],
[
'/* testPHP81ReadonlyWithUnionType */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => true,
'type' => 'string|int',
'nullable_type' => false,
],
],
[
'/* testPHP81ReadonlyWithUnionTypeWithNull */',
[
'scope' => 'protected',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => true,
'type' => 'string|null',
'nullable_type' => false,
],
],
[
'/* testPHP81OnlyReadonlyWithUnionType */',
[
'scope' => 'public',
'scope_specified' => false,
'is_static' => false,
'is_readonly' => true,
'type' => 'string|int',
'nullable_type' => false,
],
],
[
'/* testPHP8PropertySingleAttribute */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'string',
'nullable_type' => false,
],
],
[
'/* testPHP8PropertyMultipleAttributes */',
[
'scope' => 'protected',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => '?int|float',
'nullable_type' => true,
],
],
[
'/* testPHP8PropertyMultilineAttribute */',
[
'scope' => 'private',
'scope_specified' => true,
'is_static' => false,
'is_readonly' => false,
'type' => 'mixed',
'nullable_type' => false,
],
],
[
'/* testEnumProperty */',
[],
],
[
'/* testPHP81IntersectionTypes */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'type' => 'Foo&Bar',
'nullable_type' => false,
],
],
[
'/* testPHP81MoreIntersectionTypes */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'type' => 'Foo&Bar&Baz',
'nullable_type' => false,
],
],
[
'/* testPHP81IllegalIntersectionTypes */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'type' => 'int&string',
'nullable_type' => false,
],
],
[
'/* testPHP81NulltableIntersectionType */',
[
'scope' => 'public',
'scope_specified' => true,
'is_static' => false,
'type' => '?Foo&Bar',
'nullable_type' => true,
],
],
];
}//end dataGetMemberProperties()
/**
* Test receiving an expected exception when a non property is passed.
*
* @param string $identifier Comment which precedes the test case.
*
* @expectedException PHP_CodeSniffer\Exceptions\RuntimeException
* @expectedExceptionMessage $stackPtr is not a class member var
*
* @dataProvider dataNotClassProperty
*
* @return void
*/
public function testNotClassPropertyException($identifier)
{
$variable = $this->getTargetToken($identifier, T_VARIABLE);
$result = self::$phpcsFile->getMemberProperties($variable);
}//end testNotClassPropertyException()
/**
* Data provider for the NotClassPropertyException test.
*
* @see testNotClassPropertyException()
*
* @return array
*/
public function dataNotClassProperty()
{
return [
['/* testMethodParam */'],
['/* testImportedGlobal */'],
['/* testLocalVariable */'],
['/* testGlobalVariable */'],
['/* testNestedMethodParam 1 */'],
['/* testNestedMethodParam 2 */'],
['/* testEnumMethodParamNotProperty */'],
];
}//end dataNotClassProperty()
/**
* Test receiving an expected exception when a non variable is passed.
*
* @expectedException PHP_CodeSniffer\Exceptions\RuntimeException
* @expectedExceptionMessage $stackPtr must be of type T_VARIABLE
*
* @return void
*/
public function testNotAVariableException()
{
$next = $this->getTargetToken('/* testNotAVariable */', T_RETURN);
$result = self::$phpcsFile->getMemberProperties($next);
}//end testNotAVariableException()
}//end class