24698292519

Committed 21 Apr 2026 12:55AM UTC coverage: 84.815%. Remained the same

Build # 24698292519

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #87 from voku/renovate/actions-cache-5.x

Update actions/cache action to v5.0.5

Coverage Stats

1765 of 2081 relevant lines covered (84.81%)

165.91 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.41

/src/voku/SimplePhpParser/Model/PHPClass.php

<?php

declare(strict_types=1);

namespace voku\SimplePhpParser\Model;

use PhpParser\Comment\Doc;
use PhpParser\Node\Stmt\Class_;
use ReflectionClass;
use voku\SimplePhpParser\Parsers\Helper\DocFactoryProvider;
use voku\SimplePhpParser\Parsers\Helper\Utils;

class PHPClass extends BasePHPClass
{
    /**
     * @phpstan-var class-string
     */
    public string $name;

    /**
     * @phpstan-var class-string|null
     */
    public ?string $parentClass = null;

    /**
     * @var string[]
     *
     * @phpstan-var class-string[]
     */
    public array $interfaces = [];

    /**
     * @param Class_ $node
     * @param null   $dummy
     *
     * @return $this
     */
    public function readObjectFromPhpNode($node, $dummy = null): self
    {
        $this->prepareNode($node);

        $this->name = static::getFQN($node);

        $this->is_final = $node->isFinal();

        $this->is_abstract = $node->isAbstract();

        // Keep the guard for cross-version php-parser compatibility when readonly
        // helpers are restored or backported differently in downstream installs.
        if (\method_exists($node, 'isReadonly')) {
            $this->is_readonly = $node->isReadonly();
        }

        $this->is_anonymous = $node->isAnonymous();

        // Extract PHP 8.0+ attributes
        if (!empty($node->attrGroups)) {
            $this->attributes = Utils::extractAttributesFromAstNode($node->attrGroups);
        }

        // Skip autoloading when the current runtime cannot safely compile newer syntax;
        // AST data is still read from the node below.
        $canAutoload = self::canAutoloadFromPhpNode($node);
        $classExists = false;
        if ($canAutoload) {
            try {
                if (\class_exists($this->name, true)) {
                    $classExists = true;
                }
            } catch (\Throwable $e) {
                // nothing
            }
        }
        if ($classExists) {
            $reflectionClass = Utils::createClassReflectionInstance($this->name);
            $this->readObjectFromReflection($reflectionClass);
        }

        $this->collectTags($node);

        if (!empty($node->extends)) {
            $classExtended = $node->extends->toString();
            /** @noinspection PhpSillyAssignmentInspection - hack for phpstan */
            /** @var class-string $classExtended */
            $classExtended = $classExtended;
            $this->parentClass = $classExtended;
        }

        $docComment = $node->getDocComment();
        if ($docComment) {
            $this->readPhpDocProperties($docComment->getText());
        }

        foreach ($node->getProperties() as $property) {
            $propertyNameTmp = $this->getConstantFQN($property, $property->props[0]->name->name);

            if (isset($this->properties[$propertyNameTmp])) {
                $this->properties[$propertyNameTmp] = $this->properties[$propertyNameTmp]->readObjectFromPhpNode($property, $this->name);
            } else {
                $this->properties[$propertyNameTmp] = (new PHPProperty($this->parserContainer))->readObjectFromPhpNode($property, $this->name);
            }

            if ($this->is_readonly) {
                $this->properties[$propertyNameTmp]->is_readonly = true;
            }
        }

        foreach ($node->getMethods() as $method) {
            $methodNameTmp = $method->name->name;

            if (isset($this->methods[$methodNameTmp])) {
                $this->methods[$methodNameTmp] = $this->methods[$methodNameTmp]->readObjectFromPhpNode($method, $this->name);
            } else {
                $this->methods[$methodNameTmp] = (new PHPMethod($this->parserContainer))->readObjectFromPhpNode($method, $this->name);
            }

            if (!$this->methods[$methodNameTmp]->file) {
                $this->methods[$methodNameTmp]->file = $this->file;
            }
        }

        $this->addPromotedPropertiesFromConstructor($node);

        if (!empty($node->implements)) {
            foreach ($node->implements as $interfaceObject) {
                $interfaceFQN = $interfaceObject->toString();
                /** @noinspection PhpSillyAssignmentInspection - hack for phpstan */
                /** @var class-string $interfaceFQN */
                $interfaceFQN = $interfaceFQN;
                $this->interfaces[$interfaceFQN] = $interfaceFQN;
            }
        }

        return $this;
    }

    /**
     * @param ReflectionClass<object> $clazz
     *
     * @return $this
     */
    public function readObjectFromReflection($clazz): self
    {
        $this->name = $clazz->getName();

        if (!$this->line) {
            $lineTmp = $clazz->getStartLine();
            if ($lineTmp !== false) {
                $this->line = $lineTmp;
            }
        }

        $file = $clazz->getFileName();
        if ($file) {
            $this->file = $file;
        }

        $this->is_final = $clazz->isFinal();

        $this->is_abstract = $clazz->isAbstract();

        if (method_exists($clazz, 'isReadOnly')) {
            $this->is_readonly = $clazz->isReadOnly();
        }

        $this->is_anonymous = $clazz->isAnonymous();

        $this->is_cloneable = $clazz->isCloneable();

        $this->is_instantiable = $clazz->isInstantiable();

        $this->is_iterable = $clazz->isIterable();

        // Extract PHP 8.0+ attributes
        $this->attributes = Utils::extractAttributesFromReflection($clazz);

        $parent = $clazz->getParentClass();
        if ($parent) {
            $this->parentClass = $parent->getName();

            $classExists = false;
            try {
                if (
                    !$this->parserContainer->getClass($this->parentClass)
                    &&
                    \class_exists($this->parentClass, true)
                ) {
                    $classExists = true;
                }
            } catch (\Throwable $e) {
                // nothing
            }
            if ($classExists) {
                $reflectionClass = Utils::createClassReflectionInstance($this->parentClass);
                $class = (new self($this->parserContainer))->readObjectFromReflection($reflectionClass);
                $this->parserContainer->addClass($class);
            }
        }

        foreach ($clazz->getProperties() as $property) {
            $propertyPhp = (new PHPProperty($this->parserContainer))->readObjectFromReflection($property);
            $this->properties[$propertyPhp->name] = $propertyPhp;

            if ($this->is_readonly) {
                $this->properties[$propertyPhp->name]->is_readonly = true;
            }
        }

        foreach ($clazz->getInterfaceNames() as $interfaceName) {
            /** @noinspection PhpSillyAssignmentInspection - hack for phpstan */
            /** @var class-string $interfaceName */
            $interfaceName = $interfaceName;
            $this->interfaces[$interfaceName] = $interfaceName;
        }

        foreach ($clazz->getMethods() as $method) {
            $methodNameTmp = $method->getName();

            $this->methods[$methodNameTmp] = (new PHPMethod($this->parserContainer))->readObjectFromReflection($method);

            if (!$this->methods[$methodNameTmp]->file) {
                $this->methods[$methodNameTmp]->file = $this->file;
            }
        }

        foreach ($clazz->getReflectionConstants() as $constant) {
            $constantNameTmp = $constant->getName();

            $this->constants[$constantNameTmp] = (new PHPConst($this->parserContainer))->readObjectFromReflection($constant);

            if (!$this->constants[$constantNameTmp]->file) {
                $this->constants[$constantNameTmp]->file = $this->file;
            }
        }

        return $this;
    }

    /**
     * @param string[] $access
     * @param bool     $skipMethodsWithLeadingUnderscore
     *
     * @return array
     *
     * @psalm-return array<string, array{
     *     type: null|string,
     *     typeFromPhpDocMaybeWithComment: null|string,
     *     typeFromPhpDoc: null|string,
     *     typeFromPhpDocSimple: null|string,
     *     typeFromPhpDocExtended: null|string,
     *     typeFromDefaultValue: null|string
     * }>
     */
    public function getPropertiesInfo(
        array $access = ['public', 'protected', 'private'],
        bool $skipMethodsWithLeadingUnderscore = false
    ): array {
        // init
        $allInfo = [];

        foreach ($this->properties as $property) {
            if (!\in_array($property->access, $access, true)) {
                continue;
            }

            if ($skipMethodsWithLeadingUnderscore && \strpos($property->name, '_') === 0) {
                continue;
            }

            $types = [];
            $types['type'] = $property->type;
            $types['typeFromPhpDocMaybeWithComment'] = $property->typeFromPhpDocMaybeWithComment;
            $types['typeFromPhpDoc'] = $property->typeFromPhpDoc;
            $types['typeFromPhpDocSimple'] = $property->typeFromPhpDocSimple;
            $types['typeFromPhpDocExtended'] = $property->typeFromPhpDocExtended;
            $types['typeFromDefaultValue'] = $property->typeFromDefaultValue;

            $allInfo[$property->name] = $types;
        }

        return $allInfo;
    }

    /**
     * @param string[] $access
     * @param bool     $skipDeprecatedMethods
     * @param bool     $skipMethodsWithLeadingUnderscore
     *
     * @return array<mixed>
     *
     * @psalm-return array<string, array{
     *     fullDescription: string,
     *     line: null|int,
     *     file: null|string,
     *     error: string,
     *     is_deprecated: bool,
     *     is_static: null|bool,
     *     is_meta: bool,
     *     is_internal: bool,
     *     is_removed: bool,
     *     paramsTypes: array<string,
     *         array{
     *              type?: null|string,
     *              typeFromPhpDoc?: null|string,
     *              typeFromPhpDocExtended?: null|string,
     *              typeFromPhpDocSimple?: null|string,
     *              typeFromPhpDocMaybeWithComment?: null|string,
     *              typeFromDefaultValue?: null|string
     *         }
     *     >,
     *     returnTypes: array{
     *         type: null|string,
     *         typeFromPhpDoc: null|string,
     *         typeFromPhpDocExtended: null|string,
     *         typeFromPhpDocSimple: null|string,
     *         typeFromPhpDocMaybeWithComment: null|string
     *     },
     *     paramsPhpDocRaw: array<string, null|string>,
     *     returnPhpDocRaw: null|string
     * }>
     */
    public function getMethodsInfo(
        array $access = ['public', 'protected', 'private'],
        bool $skipDeprecatedMethods = false,
        bool $skipMethodsWithLeadingUnderscore = false
    ): array {
        // init
        $allInfo = [];

        foreach ($this->methods as $method) {
            if (!\in_array($method->access, $access, true)) {
                continue;
            }

            if ($skipDeprecatedMethods && $method->hasDeprecatedTag) {
                continue;
            }

            if ($skipMethodsWithLeadingUnderscore && \strpos($method->name, '_') === 0) {
                continue;
            }

            $paramsTypes = [];
            foreach ($method->parameters as $tagParam) {
                $paramsTypes[$tagParam->name]['type'] = $tagParam->type;
                $paramsTypes[$tagParam->name]['typeFromPhpDocMaybeWithComment'] = $tagParam->typeFromPhpDocMaybeWithComment;
                $paramsTypes[$tagParam->name]['typeFromPhpDoc'] = $tagParam->typeFromPhpDoc;
                $paramsTypes[$tagParam->name]['typeFromPhpDocSimple'] = $tagParam->typeFromPhpDocSimple;
                $paramsTypes[$tagParam->name]['typeFromPhpDocExtended'] = $tagParam->typeFromPhpDocExtended;
                $paramsTypes[$tagParam->name]['typeFromDefaultValue'] = $tagParam->typeFromDefaultValue;
            }

            $returnTypes = [];
            $returnTypes['type'] = $method->returnType;
            $returnTypes['typeFromPhpDocMaybeWithComment'] = $method->returnTypeFromPhpDocMaybeWithComment;
            $returnTypes['typeFromPhpDoc'] = $method->returnTypeFromPhpDoc;
            $returnTypes['typeFromPhpDocSimple'] = $method->returnTypeFromPhpDocSimple;
            $returnTypes['typeFromPhpDocExtended'] = $method->returnTypeFromPhpDocExtended;

            $paramsPhpDocRaw = [];
            foreach ($method->parameters as $tagParam) {
                $paramsPhpDocRaw[$tagParam->name] = $tagParam->phpDocRaw;
            }

            $infoTmp = [];
            $infoTmp['fullDescription'] = \trim($method->summary . "\n\n" . $method->description);
            $infoTmp['paramsTypes'] = $paramsTypes;
            $infoTmp['returnTypes'] = $returnTypes;
            $infoTmp['paramsPhpDocRaw'] = $paramsPhpDocRaw;
            $infoTmp['returnPhpDocRaw'] = $method->returnPhpDocRaw;
            $infoTmp['line'] = $method->line ?? $this->line;
            $infoTmp['file'] = $method->file ?? $this->file;
            $infoTmp['error'] = \implode("\n", $method->parseError);
            foreach ($method->parameters as $parameter) {
                $infoTmp['error'] .= ($infoTmp['error'] ? "\n" : '') . \implode("\n", $parameter->parseError);
            }
            $infoTmp['is_deprecated'] = $method->hasDeprecatedTag;
            $infoTmp['is_static'] = $method->is_static;
            $infoTmp['is_meta'] = $method->hasMetaTag;
            $infoTmp['is_internal'] = $method->hasInternalTag;
            $infoTmp['is_removed'] = $method->hasRemovedTag;

            $allInfo[$method->name] = $infoTmp;
        }

        \asort($allInfo);

        return $allInfo;
    }

    /**
     * @param Doc|string $doc
     */
    private function readPhpDocProperties($doc): void
    {
        if ($doc instanceof Doc) {
            $docComment = $doc->getText();
        } else {
            $docComment = $doc;
        }
        if ($docComment === '') {
            return;
        }

        try {
            $phpDoc = DocFactoryProvider::getDocFactory()->create($docComment);

            $parsedPropertyTags = $phpDoc->getTagsByName('property')
                               + $phpDoc->getTagsByName('property-read')
                               + $phpDoc->getTagsByName('property-write');

            if (!empty($parsedPropertyTags)) {
                foreach ($parsedPropertyTags as $parsedPropertyTag) {
                    if (
                        $parsedPropertyTag instanceof \phpDocumentor\Reflection\DocBlock\Tags\PropertyRead
                        ||
                        $parsedPropertyTag instanceof \phpDocumentor\Reflection\DocBlock\Tags\PropertyWrite
                        ||
                        $parsedPropertyTag instanceof \phpDocumentor\Reflection\DocBlock\Tags\Property
                    ) {
                        $propertyPhp = new PHPProperty($this->parserContainer);

                        $nameTmp = $parsedPropertyTag->getVariableName();
                        if (!$nameTmp) {
                            continue;
                        }

                        $propertyPhp->name = $nameTmp;

                        $propertyPhp->access = 'public';

                        $type = $parsedPropertyTag->getType();

                        $propertyPhp->typeFromPhpDoc = Utils::normalizePhpType($type . '');

                        $typeFromPhpDocMaybeWithCommentTmp = \trim((string) $parsedPropertyTag);
                        if (
                            $typeFromPhpDocMaybeWithCommentTmp
                            &&
                            \strpos($typeFromPhpDocMaybeWithCommentTmp, '$') !== 0
                        ) {
                            $propertyPhp->typeFromPhpDocMaybeWithComment = $typeFromPhpDocMaybeWithCommentTmp;
                        }

                        $typeTmp = Utils::parseDocTypeObject($type);
                        if ($typeTmp !== '') {
                            $propertyPhp->typeFromPhpDocSimple = $typeTmp;
                        }

                        if ($propertyPhp->typeFromPhpDoc) {
                            $propertyPhp->typeFromPhpDocExtended = Utils::modernPhpdoc($propertyPhp->typeFromPhpDoc);
                        }

                        $this->properties[$propertyPhp->name] = $propertyPhp;
                    }
                }
            }
        } catch (\Exception $e) {
            $tmpErrorMessage = ($this->name ?: '?') . ':' . ($this->line ?? '?') . ' | ' . \print_r($e->getMessage(), true);
            $this->parseError[\md5($tmpErrorMessage)] = $tmpErrorMessage;
        }
    }

    private function addPromotedPropertiesFromConstructor(Class_ $node): void
    {
        $method = $node->getMethod('__construct');
        if ($method === null) {
            return;
        }

        foreach ($method->params as $parameter) {
            if (!self::isPromotedParameter($parameter)) {
                continue;
            }

            $parameterVar = $parameter->var;
            if (
                !($parameterVar instanceof \PhpParser\Node\Expr\Variable)
                || !\is_string($parameterVar->name)
            ) {
                continue;
            }

            $promotedProperty = (new PHPProperty($this->parserContainer))
                ->readObjectFromPromotedParam($parameter, $this->name);

            $propertyName = $parameterVar->name;
            $existingProperty = $this->properties[$propertyName] ?? null;
            if ($existingProperty !== null) {
                $this->mergePromotedPropertyData($existingProperty, $promotedProperty, $parameter);

                continue;
            }

            $this->properties[$propertyName] = $promotedProperty;
        }
    }

    private function mergePromotedPropertyData(
        PHPProperty $existingProperty,
        PHPProperty $promotedProperty,
        \PhpParser\Node\Param $parameter
    ): void {
        if ($promotedProperty->access !== '') {
            $existingProperty->access = $promotedProperty->access;
        }

        if ($existingProperty->type === null && $promotedProperty->type !== null) {
            $existingProperty->type = $promotedProperty->type;
        }

        if ($existingProperty->is_readonly === null && $promotedProperty->is_readonly !== null) {
            $existingProperty->is_readonly = $promotedProperty->is_readonly;
        }

        if ($existingProperty->is_final === null && $promotedProperty->is_final !== null) {
            $existingProperty->is_final = $promotedProperty->is_final;
        }

        if ($existingProperty->access_set === '' && $promotedProperty->access_set !== '') {
            $existingProperty->access_set = $promotedProperty->access_set;
        }

        // AST is the ground truth for promoted-property hooks; always prefer it
        // when the param node carries hook data. Only fall back to whatever
        // reflection already populated when the AST node has nothing.
        if ($promotedProperty->hooks !== []) {
            $existingProperty->hooks = $promotedProperty->hooks;
        }

        if ($existingProperty->attributes === [] && $promotedProperty->attributes !== []) {
            $existingProperty->attributes = $promotedProperty->attributes;
        }

        if ($parameter->default !== null && $promotedProperty->typeFromDefaultValue !== null) {
            $existingProperty->defaultValue = $promotedProperty->defaultValue;
            $existingProperty->typeFromDefaultValue = $promotedProperty->typeFromDefaultValue;
        }
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	namespace voku\SimplePhpParser\Model;
6
7	use PhpParser\Comment\Doc;
8	use PhpParser\Node\Stmt\Class_;
9	use ReflectionClass;
10	use voku\SimplePhpParser\Parsers\Helper\DocFactoryProvider;
11	use voku\SimplePhpParser\Parsers\Helper\Utils;
12
13	class PHPClass extends BasePHPClass
14	{
15	/**
16	* @phpstan-var class-string
17	*/
18	public string $name;
19
20	/**
21	* @phpstan-var class-string\|null
22	*/
23	public ?string $parentClass = null;
24
25	/**
26	* @var string[]
27	*
28	* @phpstan-var class-string[]
29	*/
30	public array $interfaces = [];
31
32	/**
33	* @param Class_ $node
34	* @param null $dummy
35	*
36	* @return $this
37	*/
38	public function readObjectFromPhpNode($node, $dummy = null): self
39	{
40	$this->prepareNode($node);	551✔
41
42	$this->name = static::getFQN($node);	551✔
43
44	$this->is_final = $node->isFinal();	551✔
45
46	$this->is_abstract = $node->isAbstract();	551✔
47
48	// Keep the guard for cross-version php-parser compatibility when readonly
49	// helpers are restored or backported differently in downstream installs.
50	if (\method_exists($node, 'isReadonly')) {	551✔
51	$this->is_readonly = $node->isReadonly();	551✔
52	}
53
54	$this->is_anonymous = $node->isAnonymous();	551✔
55
56	// Extract PHP 8.0+ attributes
57	if (!empty($node->attrGroups)) {	551✔
58	$this->attributes = Utils::extractAttributesFromAstNode($node->attrGroups);	115✔
59	}
60
61	// Skip autoloading when the current runtime cannot safely compile newer syntax;
62	// AST data is still read from the node below.
63	$canAutoload = self::canAutoloadFromPhpNode($node);	551✔
64	$classExists = false;	551✔
65	if ($canAutoload) {	551✔
66	try {
67	if (\class_exists($this->name, true)) {	541✔
68	$classExists = true;	541✔
69	}
70	} catch (\Throwable $e) {	4✔
71	// nothing
72	}
73	}
74	if ($classExists) {	551✔
75	$reflectionClass = Utils::createClassReflectionInstance($this->name);	271✔
76	$this->readObjectFromReflection($reflectionClass);	271✔
77	}
78
79	$this->collectTags($node);	551✔
80
81	if (!empty($node->extends)) {	551✔
82	$classExtended = $node->extends->toString();	150✔
83	/** @noinspection PhpSillyAssignmentInspection - hack for phpstan */
84	/** @var class-string $classExtended */
85	$classExtended = $classExtended;	150✔
86	$this->parentClass = $classExtended;	150✔
87	}
88
89	$docComment = $node->getDocComment();	551✔
90	if ($docComment) {	551✔
91	$this->readPhpDocProperties($docComment->getText());	305✔
92	}
93
94	foreach ($node->getProperties() as $property) {	551✔
95	$propertyNameTmp = $this->getConstantFQN($property, $property->props[0]->name->name);	274✔
96
97	if (isset($this->properties[$propertyNameTmp])) {	274✔
98	$this->properties[$propertyNameTmp] = $this->properties[$propertyNameTmp]->readObjectFromPhpNode($property, $this->name);	214✔
99	} else {
100	$this->properties[$propertyNameTmp] = (new PHPProperty($this->parserContainer))->readObjectFromPhpNode($property, $this->name);	72✔
101	}
102
103	if ($this->is_readonly) {	274✔
104	$this->properties[$propertyNameTmp]->is_readonly = true;	26✔
105	}
106	}
107
108	foreach ($node->getMethods() as $method) {	551✔
109	$methodNameTmp = $method->name->name;	489✔
110
111	if (isset($this->methods[$methodNameTmp])) {	489✔
112	$this->methods[$methodNameTmp] = $this->methods[$methodNameTmp]->readObjectFromPhpNode($method, $this->name);	251✔
113	} else {
114	$this->methods[$methodNameTmp] = (new PHPMethod($this->parserContainer))->readObjectFromPhpNode($method, $this->name);	268✔
115	}
116
117	if (!$this->methods[$methodNameTmp]->file) {	489✔
118	$this->methods[$methodNameTmp]->file = $this->file;	268✔
119	}
120	}
121
122	$this->addPromotedPropertiesFromConstructor($node);	551✔
123
124	if (!empty($node->implements)) {	551✔
125	foreach ($node->implements as $interfaceObject) {	96✔
126	$interfaceFQN = $interfaceObject->toString();	96✔
127	/** @noinspection PhpSillyAssignmentInspection - hack for phpstan */
128	/** @var class-string $interfaceFQN */
129	$interfaceFQN = $interfaceFQN;	96✔
130	$this->interfaces[$interfaceFQN] = $interfaceFQN;	96✔
131	}
132	}
133
134	return $this;	551✔
135	}
136
137	/**
138	* @param ReflectionClass<object> $clazz
139	*
140	* @return $this
141	*/
142	public function readObjectFromReflection($clazz): self
143	{
144	$this->name = $clazz->getName();	271✔
145
146	if (!$this->line) {	271✔
147	$lineTmp = $clazz->getStartLine();	120✔
148	if ($lineTmp !== false) {	120✔
149	$this->line = $lineTmp;	80✔
150	}
151	}
152
153	$file = $clazz->getFileName();	271✔
154	if ($file) {	271✔
155	$this->file = $file;	271✔
156	}
157
158	$this->is_final = $clazz->isFinal();	271✔
159
160	$this->is_abstract = $clazz->isAbstract();	271✔
161
162	if (method_exists($clazz, 'isReadOnly')) {	271✔
163	$this->is_readonly = $clazz->isReadOnly();	227✔
164	}
165
166	$this->is_anonymous = $clazz->isAnonymous();	271✔
167
168	$this->is_cloneable = $clazz->isCloneable();	271✔
169
170	$this->is_instantiable = $clazz->isInstantiable();	271✔
171
172	$this->is_iterable = $clazz->isIterable();	271✔
173
174	// Extract PHP 8.0+ attributes
175	$this->attributes = Utils::extractAttributesFromReflection($clazz);	271✔
176
177	$parent = $clazz->getParentClass();	271✔
178	if ($parent) {	271✔
179	$this->parentClass = $parent->getName();	120✔
180
181	$classExists = false;	120✔
182	try {
183	if (
184	!$this->parserContainer->getClass($this->parentClass)	120✔
185	&&
186	\class_exists($this->parentClass, true)	120✔
187	) {
188	$classExists = true;	120✔
189	}
190	} catch (\Throwable $e) {	×
191	// nothing
192	}
193	if ($classExists) {	120✔
194	$reflectionClass = Utils::createClassReflectionInstance($this->parentClass);	120✔
195	$class = (new self($this->parserContainer))->readObjectFromReflection($reflectionClass);	120✔
196	$this->parserContainer->addClass($class);	120✔
197	}
198	}
199
200	foreach ($clazz->getProperties() as $property) {	271✔
201	$propertyPhp = (new PHPProperty($this->parserContainer))->readObjectFromReflection($property);	255✔
202	$this->properties[$propertyPhp->name] = $propertyPhp;	255✔
203
204	if ($this->is_readonly) {	255✔
205	$this->properties[$propertyPhp->name]->is_readonly = true;	24✔
206	}
207	}
208
209	foreach ($clazz->getInterfaceNames() as $interfaceName) {	271✔
210	/** @noinspection PhpSillyAssignmentInspection - hack for phpstan */
211	/** @var class-string $interfaceName */
212	$interfaceName = $interfaceName;	122✔
213	$this->interfaces[$interfaceName] = $interfaceName;	122✔
214	}
215
216	foreach ($clazz->getMethods() as $method) {	271✔
217	$methodNameTmp = $method->getName();	261✔
218
219	$this->methods[$methodNameTmp] = (new PHPMethod($this->parserContainer))->readObjectFromReflection($method);	261✔
220
221	if (!$this->methods[$methodNameTmp]->file) {	261✔
222	$this->methods[$methodNameTmp]->file = $this->file;	×
223	}
224	}
225
226	foreach ($clazz->getReflectionConstants() as $constant) {	271✔
227	$constantNameTmp = $constant->getName();	146✔
228
229	$this->constants[$constantNameTmp] = (new PHPConst($this->parserContainer))->readObjectFromReflection($constant);	146✔
230
231	if (!$this->constants[$constantNameTmp]->file) {	146✔
232	$this->constants[$constantNameTmp]->file = $this->file;	×
233	}
234	}
235
236	return $this;	271✔
237	}
238
239	/**
240	* @param string[] $access
241	* @param bool $skipMethodsWithLeadingUnderscore
242	*
243	* @return array
244	*
245	* @psalm-return array<string, array{
246	* type: null\|string,
247	* typeFromPhpDocMaybeWithComment: null\|string,
248	* typeFromPhpDoc: null\|string,
249	* typeFromPhpDocSimple: null\|string,
250	* typeFromPhpDocExtended: null\|string,
251	* typeFromDefaultValue: null\|string
252	* }>
253	*/
254	public function getPropertiesInfo(
255	array $access = ['public', 'protected', 'private'],
256	bool $skipMethodsWithLeadingUnderscore = false
257	): array {
258	// init
259	$allInfo = [];	20✔
260
261	foreach ($this->properties as $property) {	20✔
262	if (!\in_array($property->access, $access, true)) {	20✔
263	continue;	×
264	}
265
266	if ($skipMethodsWithLeadingUnderscore && \strpos($property->name, '_') === 0) {	20✔
267	continue;	×
268	}
269
270	$types = [];	20✔
271	$types['type'] = $property->type;	20✔
272	$types['typeFromPhpDocMaybeWithComment'] = $property->typeFromPhpDocMaybeWithComment;	20✔
273	$types['typeFromPhpDoc'] = $property->typeFromPhpDoc;	20✔
274	$types['typeFromPhpDocSimple'] = $property->typeFromPhpDocSimple;	20✔
275	$types['typeFromPhpDocExtended'] = $property->typeFromPhpDocExtended;	20✔
276	$types['typeFromDefaultValue'] = $property->typeFromDefaultValue;	20✔
277
278	$allInfo[$property->name] = $types;	20✔
279	}
280
281	return $allInfo;	20✔
282	}
283
284	/**
285	* @param string[] $access
286	* @param bool $skipDeprecatedMethods
287	* @param bool $skipMethodsWithLeadingUnderscore
288	*
289	* @return array<mixed>
290	*
291	* @psalm-return array<string, array{
292	* fullDescription: string,
293	* line: null\|int,
294	* file: null\|string,
295	* error: string,
296	* is_deprecated: bool,
297	* is_static: null\|bool,
298	* is_meta: bool,
299	* is_internal: bool,
300	* is_removed: bool,
301	* paramsTypes: array<string,
302	* array{
303	* type?: null\|string,
304	* typeFromPhpDoc?: null\|string,
305	* typeFromPhpDocExtended?: null\|string,
306	* typeFromPhpDocSimple?: null\|string,
307	* typeFromPhpDocMaybeWithComment?: null\|string,
308	* typeFromDefaultValue?: null\|string
309	* }
310	* >,
311	* returnTypes: array{
312	* type: null\|string,
313	* typeFromPhpDoc: null\|string,
314	* typeFromPhpDocExtended: null\|string,
315	* typeFromPhpDocSimple: null\|string,
316	* typeFromPhpDocMaybeWithComment: null\|string
317	* },
318	* paramsPhpDocRaw: array<string, null\|string>,
319	* returnPhpDocRaw: null\|string
320	* }>
321	*/
322	public function getMethodsInfo(
323	array $access = ['public', 'protected', 'private'],
324	bool $skipDeprecatedMethods = false,
325	bool $skipMethodsWithLeadingUnderscore = false
326	): array {
327	// init
328	$allInfo = [];	40✔
329
330	foreach ($this->methods as $method) {	40✔
331	if (!\in_array($method->access, $access, true)) {	40✔
332	continue;	×
333	}
334
335	if ($skipDeprecatedMethods && $method->hasDeprecatedTag) {	40✔
336	continue;	×
337	}
338
339	if ($skipMethodsWithLeadingUnderscore && \strpos($method->name, '_') === 0) {	40✔
340	continue;	×
341	}
342
343	$paramsTypes = [];	40✔
344	foreach ($method->parameters as $tagParam) {	40✔
345	$paramsTypes[$tagParam->name]['type'] = $tagParam->type;	40✔
346	$paramsTypes[$tagParam->name]['typeFromPhpDocMaybeWithComment'] = $tagParam->typeFromPhpDocMaybeWithComment;	40✔
347	$paramsTypes[$tagParam->name]['typeFromPhpDoc'] = $tagParam->typeFromPhpDoc;	40✔
348	$paramsTypes[$tagParam->name]['typeFromPhpDocSimple'] = $tagParam->typeFromPhpDocSimple;	40✔
349	$paramsTypes[$tagParam->name]['typeFromPhpDocExtended'] = $tagParam->typeFromPhpDocExtended;	40✔
350	$paramsTypes[$tagParam->name]['typeFromDefaultValue'] = $tagParam->typeFromDefaultValue;	40✔
351	}
352
353	$returnTypes = [];	40✔
354	$returnTypes['type'] = $method->returnType;	40✔
355	$returnTypes['typeFromPhpDocMaybeWithComment'] = $method->returnTypeFromPhpDocMaybeWithComment;	40✔
356	$returnTypes['typeFromPhpDoc'] = $method->returnTypeFromPhpDoc;	40✔
357	$returnTypes['typeFromPhpDocSimple'] = $method->returnTypeFromPhpDocSimple;	40✔
358	$returnTypes['typeFromPhpDocExtended'] = $method->returnTypeFromPhpDocExtended;	40✔
359
360	$paramsPhpDocRaw = [];	40✔
361	foreach ($method->parameters as $tagParam) {	40✔
362	$paramsPhpDocRaw[$tagParam->name] = $tagParam->phpDocRaw;	40✔
363	}
364
365	$infoTmp = [];	40✔
366	$infoTmp['fullDescription'] = \trim($method->summary . "\n\n" . $method->description);	40✔
367	$infoTmp['paramsTypes'] = $paramsTypes;	40✔
368	$infoTmp['returnTypes'] = $returnTypes;	40✔
369	$infoTmp['paramsPhpDocRaw'] = $paramsPhpDocRaw;	40✔
370	$infoTmp['returnPhpDocRaw'] = $method->returnPhpDocRaw;	40✔
371	$infoTmp['line'] = $method->line ?? $this->line;	40✔
372	$infoTmp['file'] = $method->file ?? $this->file;	40✔
373	$infoTmp['error'] = \implode("\n", $method->parseError);	40✔
374	foreach ($method->parameters as $parameter) {	40✔
375	$infoTmp['error'] .= ($infoTmp['error'] ? "\n" : '') . \implode("\n", $parameter->parseError);	40✔
376	}
377	$infoTmp['is_deprecated'] = $method->hasDeprecatedTag;	40✔
378	$infoTmp['is_static'] = $method->is_static;	40✔
379	$infoTmp['is_meta'] = $method->hasMetaTag;	40✔
380	$infoTmp['is_internal'] = $method->hasInternalTag;	40✔
381	$infoTmp['is_removed'] = $method->hasRemovedTag;	40✔
382
383	$allInfo[$method->name] = $infoTmp;	40✔
384	}
385
386	\asort($allInfo);	40✔
387
388	return $allInfo;	40✔
389	}
390
391	/**
392	* @param Doc\|string $doc
393	*/
394	private function readPhpDocProperties($doc): void
395	{
396	if ($doc instanceof Doc) {	305✔
397	$docComment = $doc->getText();	×
398	} else {
399	$docComment = $doc;	305✔
400	}
401	if ($docComment === '') {	305✔
402	return;	×
403	}
404
405	try {
406	$phpDoc = DocFactoryProvider::getDocFactory()->create($docComment);	305✔
407
408	$parsedPropertyTags = $phpDoc->getTagsByName('property')	305✔
409	+ $phpDoc->getTagsByName('property-read')	305✔
410	+ $phpDoc->getTagsByName('property-write');	305✔
411
412	if (!empty($parsedPropertyTags)) {	305✔
413	foreach ($parsedPropertyTags as $parsedPropertyTag) {	305✔
414	if (
415	$parsedPropertyTag instanceof \phpDocumentor\Reflection\DocBlock\Tags\PropertyRead	90✔
416	\|\|
417	$parsedPropertyTag instanceof \phpDocumentor\Reflection\DocBlock\Tags\PropertyWrite	90✔
418	\|\|
419	$parsedPropertyTag instanceof \phpDocumentor\Reflection\DocBlock\Tags\Property	90✔
420	) {
421	$propertyPhp = new PHPProperty($this->parserContainer);	90✔
422
423	$nameTmp = $parsedPropertyTag->getVariableName();	90✔
424	if (!$nameTmp) {	90✔
425	continue;	×
426	}
427
428	$propertyPhp->name = $nameTmp;	90✔
429
430	$propertyPhp->access = 'public';	90✔
431
432	$type = $parsedPropertyTag->getType();	90✔
433
434	$propertyPhp->typeFromPhpDoc = Utils::normalizePhpType($type . '');	90✔
435
436	$typeFromPhpDocMaybeWithCommentTmp = \trim((string) $parsedPropertyTag);	90✔
437	if (
438	$typeFromPhpDocMaybeWithCommentTmp	90✔
439	&&
440	\strpos($typeFromPhpDocMaybeWithCommentTmp, '$') !== 0	90✔
441	) {
442	$propertyPhp->typeFromPhpDocMaybeWithComment = $typeFromPhpDocMaybeWithCommentTmp;	90✔
443	}
444
445	$typeTmp = Utils::parseDocTypeObject($type);	90✔
446	if ($typeTmp !== '') {	90✔
447	$propertyPhp->typeFromPhpDocSimple = $typeTmp;	90✔
448	}
449
450	if ($propertyPhp->typeFromPhpDoc) {	90✔
451	$propertyPhp->typeFromPhpDocExtended = Utils::modernPhpdoc($propertyPhp->typeFromPhpDoc);	90✔
452	}
453
454	$this->properties[$propertyPhp->name] = $propertyPhp;	90✔
455	}
456	}
457	}
458	} catch (\Exception $e) {	×
459	$tmpErrorMessage = ($this->name ?: '?') . ':' . ($this->line ?? '?') . ' \| ' . \print_r($e->getMessage(), true);	×
460	$this->parseError[\md5($tmpErrorMessage)] = $tmpErrorMessage;	×
461	}
462	}
463
464	private function addPromotedPropertiesFromConstructor(Class_ $node): void
465	{
466	$method = $node->getMethod('__construct');	551✔
467	if ($method === null) {	551✔
468	return;	498✔
469	}
470
471	foreach ($method->params as $parameter) {	153✔
472	if (!self::isPromotedParameter($parameter)) {	153✔
473	continue;	48✔
474	}
475
476	$parameterVar = $parameter->var;	135✔
477	if (
478	!($parameterVar instanceof \PhpParser\Node\Expr\Variable)	135✔
479	\|\| !\is_string($parameterVar->name)	135✔
480	) {
481	continue;	×
482	}
483
484	$promotedProperty = (new PHPProperty($this->parserContainer))	135✔
485	->readObjectFromPromotedParam($parameter, $this->name);	135✔
486
487	$propertyName = $parameterVar->name;	135✔
488	$existingProperty = $this->properties[$propertyName] ?? null;	135✔
489	if ($existingProperty !== null) {	135✔
490	$this->mergePromotedPropertyData($existingProperty, $promotedProperty, $parameter);	111✔
491
492	continue;	111✔
493	}
494
495	$this->properties[$propertyName] = $promotedProperty;	42✔
496	}
497	}
498
499	private function mergePromotedPropertyData(
500	PHPProperty $existingProperty,
501	PHPProperty $promotedProperty,
502	\PhpParser\Node\Param $parameter
503	): void {
504	if ($promotedProperty->access !== '') {	111✔
505	$existingProperty->access = $promotedProperty->access;	111✔
506	}
507
508	if ($existingProperty->type === null && $promotedProperty->type !== null) {	111✔
509	$existingProperty->type = $promotedProperty->type;	10✔
510	}
511
512	if ($existingProperty->is_readonly === null && $promotedProperty->is_readonly !== null) {	111✔
513	$existingProperty->is_readonly = $promotedProperty->is_readonly;	10✔
514	}
515
516	if ($existingProperty->is_final === null && $promotedProperty->is_final !== null) {	111✔
517	$existingProperty->is_final = $promotedProperty->is_final;	70✔
518	}
519
520	if ($existingProperty->access_set === '' && $promotedProperty->access_set !== '') {	111✔
521	$existingProperty->access_set = $promotedProperty->access_set;	×
522	}
523
524	// AST is the ground truth for promoted-property hooks; always prefer it
525	// when the param node carries hook data. Only fall back to whatever
526	// reflection already populated when the AST node has nothing.
527	if ($promotedProperty->hooks !== []) {	111✔
528	$existingProperty->hooks = $promotedProperty->hooks;	4✔
529	}
530
531	if ($existingProperty->attributes === [] && $promotedProperty->attributes !== []) {	111✔
532	$existingProperty->attributes = $promotedProperty->attributes;	×
533	}
534
535	if ($parameter->default !== null && $promotedProperty->typeFromDefaultValue !== null) {	111✔
536	$existingProperty->defaultValue = $promotedProperty->defaultValue;	91✔
537	$existingProperty->typeFromDefaultValue = $promotedProperty->typeFromDefaultValue;	91✔
538	}
539	}
540	}

voku / Simple-PHP-Code-Parser / 24698292519

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous