MethodArgumentsSniff Class Reference

Inheritance diagram for MethodArgumentsSniff:

Public Member Functions
	register ()
	process (File $phpcsFile, $stackPtr)

Detailed Description

Sniff to validate method arguments annotations

Definition at line 17 of file MethodArgumentsSniff.php.

Member Function Documentation

process()

process	(	File	$phpcsFile,
			$stackPtr
	)

Definition at line 539 of file MethodArgumentsSniff.php.

    {
        $tokens = $phpcsFile->getTokens();
        $numTokens = count($tokens);
        $previousCommentOpenPtr = $phpcsFile->findPrevious(T_DOC_COMMENT_OPEN_TAG, $stackPtr-1, 0);
        $previousCommentClosePtr = $phpcsFile->findPrevious(T_DOC_COMMENT_CLOSE_TAG, $stackPtr-1, 0);
        if (!$this->validateCommentBlockExists($phpcsFile, $previousCommentClosePtr, $stackPtr)) {
            $phpcsFile->addError('Comment block is missing', $stackPtr, 'MethodArguments');
            return;
        }
        $openParenthesisPtr = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr+1, $numTokens);
        $closedParenthesisPtr = $phpcsFile->findNext(T_CLOSE_PARENTHESIS, $stackPtr+1, $numTokens);
        $methodArguments = $this->getMethodArguments($phpcsFile, $openParenthesisPtr, $closedParenthesisPtr);
        $paramPointers = $paramDefinitions = [];
        for ($tempPtr = $previousCommentOpenPtr; $tempPtr < $previousCommentClosePtr; $tempPtr++) {
            if (strtolower($tokens[$tempPtr]['content']) === '@param') {
                $paramPointers[] = $tempPtr;
                $paramAnnotationParts = explode(' ', $tokens[$tempPtr+2]['content']);
                if (count($paramAnnotationParts) === 1) {
                    if ((preg_match('/^\$.*/', $paramAnnotationParts[0]))) {
                        $paramDefinitions[] = [
                            'type' => null,
                            'paramName' => rtrim(ltrim($tokens[$tempPtr+2]['content'], '&'), ',')
                        ];
                    } else {
                        $paramDefinitions[] = [
                            'type' => $tokens[$tempPtr+2]['content'],
                            'paramName' => null
                        ];
                    }
                } else {
                    $paramDefinitions[] = [
                        'type' => $paramAnnotationParts[0],
                        'paramName' => rtrim(ltrim($paramAnnotationParts[1], '&'), ',')
                    ];
                }
            }
        }
        $this->validateMethodParameterAnnotations(
            $stackPtr,
            $paramDefinitions,
            $paramPointers,
            $phpcsFile,
            $methodArguments,
            $previousCommentOpenPtr,
            $previousCommentClosePtr
        );
    }

register()

register

(

)

Definition at line 45 of file MethodArgumentsSniff.php.

                               : array
    {
        return [
            T_FUNCTION
        ];
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/dev/tests/static/framework/Magento/Sniffs/Annotation/MethodArgumentsSniff.php