Documentation

Alias for the \PHPCSUtils\Utils\ObjectDeclarations::getName() method.

The format of the return value is: array( 'scope' => 'public', // Public, private, or protected 'scope_specified' => true, // TRUE if the scope keyword was found. 'return_type' => '', // The return type of the method. 'return_type_token' => integer, // The stack pointer to the start of the return type // or FALSE if there is no return type. 'return_type_end_token' => integer, // The stack pointer to the end of the return type // or FALSE if there is no return type. 'nullable_return_type' => false, // TRUE if the return type is nullable. '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. 'has_body' => false, // TRUE if the method has a body );

Main differences with the PHPCS version:

• Bugs fixed:
  • Handling of PHPCS annotations.
  • has_body index could be set to true for functions without body in the case of parse errors or live coding.
• Defensive coding against incorrect calls to this method.
• More efficient checking whether a function has a body.
• New return_type_end_token (int|false) array index.
• To allow for backward compatible handling of arrow functions, this method will also accept T_STRING tokens and examine them to check if these are arrow functions.

Also supports passing in a USE token for a closure use group.

The returned array will contain the following information for each parameter:

0 => array( 'name' => '$var', // The variable name. 'token' => integer, // The stack pointer to the variable name. 'content' => string, // The full content of the variable definition. 'pass_by_reference' => boolean, // Is the variable passed by reference? 'reference_token' => integer, // The stack pointer to the reference operator // or FALSE if the param is not passed by reference. 'variable_length' => boolean, // Is the param of variable length through use of ... ? 'variadic_token' => integer, // The stack pointer to the ... operator // or FALSE if the param is not variable length. 'type_hint' => string, // The type hint for the variable. 'type_hint_token' => integer, // The stack pointer to the start of the type hint // or FALSE if there is no type hint. 'type_hint_end_token' => integer, // The stack pointer to the end of the type hint // or FALSE if there is no type hint. 'nullable_type' => boolean, // TRUE if the var type is nullable. 'comma_token' => integer, // The stack pointer to the comma after the param // or FALSE if this is the last param. )

Parameters with default values have the following additional array indexes: 'default' => string, // The full content of the default value. 'default_token' => integer, // The stack pointer to the start of the default value. 'default_equal_token' => integer, // The stack pointer to the equals sign.

Main differences with the PHPCS version:

• Defensive coding against incorrect calls to this method.
• More efficient and more stable checking whether a T_USE token is a closure use.
• More efficient and more stable looping of the default value.
• Clearer exception message when a non-closure use token was passed to the function.
• To allow for backward compatible handling of arrow functions, this method will also accept T_STRING tokens and examine them to check if these are arrow functions.

Helper function for cross-version compatibility with both PHP as well as PHPCS.

• PHP 7.4+ will tokenize most tokens with the content "fn" as T_FN, even when it isn't an arrow function.
• PHPCS < 3.5.3 will tokenize arrow functions keywords as T_STRING.
• PHPCS 3.5.3/3.5.4 will tokenize the keyword differently depending on which PHP version is used and similar to PHP will tokenize most tokens with the content "fn" as T_FN, even when it's not an arrow function. Note: the tokens tokenized by PHPCS 3.5.3 - 3.5.4 as T_FN are not 100% the same as those tokenized by PHP 7.4+ as T_FN.

Either way, the T_FN token is not a reliable indicator that something is in actual fact an arrow function. This function solves that and will give reliable results in the same way as this is now solved in PHPCS 3.5.5.

Helper function for cross-version compatibility with both PHP as well as PHPCS. In PHPCS versions prior to PHPCS 3.5.3/3.5.4, the T_FN token is not yet backfilled and does not have parenthesis opener/closer nor scope opener/closer indexes assigned in the $tokens array.