nystudio107 / craft-twigfield

src/base/ObjectParserAutocomplete.php

<?php
/**
 * Twigfield for Craft CMS
 *
 * Provides a twig editor field with Twig & Craft API autocomplete
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2022 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\twigfield\base;

use craft\base\Element;
use nystudio107\twigfield\models\CompleteItem;
use nystudio107\twigfield\types\CompleteItemKind;
use phpDocumentor\Reflection\DocBlockFactory;
use ReflectionClass;
use ReflectionException;
use ReflectionMethod;
use ReflectionUnionType;
use yii\base\Behavior;
use yii\base\InvalidConfigException;
use yii\di\ServiceLocator;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   twigfield

Package name "twigfield" is not valid; consider "Twigfield" instead

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.12

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

abstract class ObjectParserAutocomplete extends Autocomplete implements ObjectParserInterface
{
    // Constants
    // =========================================================================

    const EXCLUDED_PROPERTY_NAMES = [
        'controller',
        'Controller',
        'CraftEdition',
        'CraftSolo',
        'CraftPro',
    ];
    const EXCLUDED_BEHAVIOR_NAMES = [
        'fieldHandles',
        'hasMethods',
        'owner',
    ];
    const EXCLUDED_PROPERTY_REGEXES = [
        '^_',
    ];
    const EXCLUDED_METHOD_REGEXES = [
        '^_',
    ];
    const RECURSION_DEPTH_LIMIT = 10;

    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var bool If the class itself should be parsed for complete items
     */
    public $parseClass = true;

    /**

Missing short description in doc comment

     * @var bool If any ServiceLocator components should be parsed for complete items
     */
    public $parseComponents = true;

    /**

Missing short description in doc comment

     * @var bool If the class properties should be parsed for complete items
     */
    public $parseProperties = true;

    /**

Missing short description in doc comment

     * @var bool If the class methods should be parsed for complete items
     */
    public $parseMethods = true;

    /**

Missing short description in doc comment

     * @var bool If the class behaviors should be parsed for complete items
     */
    public $parseBehaviors = true;

    /**

Missing short description in doc comment

     * @var string Prefix for custom (behavior) properties, for the complete items sort
     */
    public $customPropertySortPrefix = '~';

    /**

Missing short description in doc comment

     * @var string Prefix for properties, for the complete items sort
     */
    public $propertySortPrefix = '~~';

    /**

Missing short description in doc comment

     * @var string Prefix for methods, for the complete items sort
     */
    public $methodSortPrefix = '~~~';

    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

Parameter $name should have a doc-comment as per coding-style.

Parameter $object should have a doc-comment as per coding-style.

Parameter $recursionDepth should have a doc-comment as per coding-style.

Parameter $path should have a doc-comment as per coding-style.

     * @inerhitdoc
     */

Missing @return tag in function comment

    public function parseObject(string $name, $object, int $recursionDepth, string $path = ''): void
    {
        // Only recurse `RECURSION_DEPTH_LIMIT` deep
        if ($recursionDepth > self::RECURSION_DEPTH_LIMIT) {
            return;
        }
        $recursionDepth++;
        // Create the docblock factory
        $factory = DocBlockFactory::createInstance();

        $path = trim(implode('.', [$path, $name]), '.');
        // The class itself
        if ($this->parseClass) {
            $this->getClassCompletion($object, $factory, $name, $path);
        }
        // ServiceLocator Components
        if ($this->parseComponents) {
            $this->getComponentCompletion($object, $recursionDepth, $path);
        }
        // Class properties
        if ($this->parseProperties) {
            $this->getPropertyCompletion($object, $factory, $recursionDepth, $path);
        }
        // Class methods
        if ($this->parseMethods) {
            $this->getMethodCompletion($object, $factory, $path);
        }
        // Behavior properties
        if ($this->parseBehaviors) {
            $this->getBehaviorCompletion($object, $factory, $recursionDepth, $path);
        }
    }

    // Protected Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @param $object

Missing parameter comment

     * @param DocBlockFactory $factory

Missing parameter comment

     * @param string $name

Expected 10 spaces after parameter type; 1 found

Missing parameter comment

     * @param $path

Missing parameter comment

     */

Missing @return tag in function comment

    protected function getClassCompletion($object, DocBlockFactory $factory, string $name, $path): void
    {
        try {
            $reflectionClass = new ReflectionClass($object);
        } catch (ReflectionException $e) {
            return;
        }
        // Information on the class itself
        $className = $reflectionClass->getName();
        $docs = $this->getDocs($reflectionClass, $factory);
        CompleteItem::create()
            ->detail((string)$className)
            ->documentation((string)$docs)
            ->kind(CompleteItemKind::ClassKind)
            ->label((string)$name)
            ->insertText((string)$name)
            ->add($this, $path);
    }

    /**

Missing short description in doc comment

     * @param $object

Missing parameter comment

     * @param $recursionDepth

Missing parameter comment

     * @param $path

Missing parameter comment

     */

Missing @return tag in function comment

    protected function getComponentCompletion($object, $recursionDepth, $path): void
    {
        if ($object instanceof ServiceLocator) {
            foreach ($object->getComponents() as $key => $value) {
                $componentObject = null;

The assignment to $componentObject is dead and can be removed.

                try {
                    $componentObject = $object->get($key);
                } catch (InvalidConfigException $e) {
                    // That's okay
                }
                if ($componentObject) {
                    $this->parseObject($key, $componentObject, $recursionDepth, $path);
                }
            }
        }
    }

    /**

Missing short description in doc comment

     * @param $object

Missing parameter comment

     * @param DocBlockFactory $factory

Missing parameter comment

     * @param $recursionDepth

Missing parameter comment

     * @param string $path

Expected 10 spaces after parameter type; 1 found

Missing parameter comment

     */

Missing @return tag in function comment

    protected function getPropertyCompletion($object, DocBlockFactory $factory, $recursionDepth, string $path): void
    {
        try {
            $reflectionClass = new ReflectionClass($object);
        } catch (ReflectionException $e) {
            return;
        }
        $reflectionProperties = $reflectionClass->getProperties();
        $customField = false;
        if ($object instanceof Behavior) {
            $customField = true;
        }
        $sortPrefix = $customField ? $this->customPropertySortPrefix : $this->propertySortPrefix;
        foreach ($reflectionProperties as $reflectionProperty) {
            $propertyName = $reflectionProperty->getName();
            // Exclude some properties
            $propertyAllowed = true;
            foreach (self::EXCLUDED_PROPERTY_REGEXES as $excludePattern) {
                $pattern = '`' . $excludePattern . '`i';
                if (preg_match($pattern, $propertyName) === 1) {
                    $propertyAllowed = false;
                }
            }
            if (in_array($propertyName, self::EXCLUDED_PROPERTY_NAMES, true)) {
                $propertyAllowed = false;
            }
            if ($customField && in_array($propertyName, self::EXCLUDED_BEHAVIOR_NAMES, true)) {
                $propertyAllowed = false;
            }
            // Process the property
            if ($propertyAllowed && $reflectionProperty->isPublic()) {
                $detail = "Property";
                $docblock = null;
                $docs = $reflectionProperty->getDocComment();
                if ($docs) {
                    $docblock = $factory->create($docs);
                    $docs = '';
                    $summary = $docblock->getSummary();
                    if (!empty($summary)) {
                        $docs = $summary;
                    }
                    $description = $docblock->getDescription()->render();
                    if (!empty($description)) {
                        $docs = $description;
                    }
                }
                // Figure out the type
                if ($docblock) {
                    $tag = $docblock->getTagsByName('var');
                    if ($tag && isset($tag[0])) {
                        $docs = $tag[0];
                    }
                }
                if (preg_match('/@var\s+([^\s]+)/', $docs, $matches)) {
                    list(, $type) = $matches;
                    $detail = $type;
                }
                if ($detail === "Property") {
                    if ((PHP_MAJOR_VERSION >= 7 && PHP_MINOR_VERSION >= 4) || (PHP_MAJOR_VERSION >= 8)) {
                        if ($reflectionProperty->hasType()) {
                            $reflectionType = $reflectionProperty->getType();
                            if ($reflectionType instanceof ReflectionNamedType) {

The type nystudio107\twigfield\base\ReflectionNamedType was not found. Did you mean ReflectionNamedType? If so, make sure to prefix the type with \.

                                $type = $reflectionType->getName();

The method getName() does not exist on ReflectionType. It seems like you code against a sub-type of ReflectionType such as ReflectionNamedType.

                                $detail = $type;
                            }
                        }
                        if ((PHP_MAJOR_VERSION >= 8) && $reflectionProperty->hasDefaultValue()) {
                            $value = $reflectionProperty->getDefaultValue();
                            if (is_array($value)) {
                                $value = json_encode($value);
                            }
                            if (!empty($value)) {
                                $detail = (string)$value;
                            }
                        }
                    }
                }
                $thisPath = trim(implode('.', [$path, $propertyName]), '.');
                $label = $propertyName;
                CompleteItem::create()
                    ->detail((string)$detail)
                    ->documentation((string)$docs)
                    ->kind($customField ? CompleteItemKind::FieldKind : CompleteItemKind::PropertyKind)
                    ->label((string)$label)
                    ->insertText((string)$label)
                    ->sortText((string)$sortPrefix . (string)$label)
                    ->add($this, $thisPath);
                // Recurse through if this is an object
                if (isset($object->$propertyName) && is_object($object->$propertyName)) {
                    if (!$customField && !in_array($propertyName, self::EXCLUDED_PROPERTY_NAMES, true)) {
                        $this->parseObject($propertyName, $object->$propertyName, $recursionDepth, $path);
                    }
                }
            }
        }
    }

    /**

Missing short description in doc comment

     * @param $object

Missing parameter comment

     * @param DocBlockFactory $factory

Missing parameter comment

     * @param string $path

Missing parameter comment

Expected 10 spaces after parameter type; 1 found

     */

Missing @return tag in function comment

    protected function getMethodCompletion($object, DocBlockFactory $factory, string $path): void
    {
        try {
            $reflectionClass = new ReflectionClass($object);
        } catch (ReflectionException $e) {
            return;
        }
        $reflectionMethods = $reflectionClass->getMethods();
        foreach ($reflectionMethods as $reflectionMethod) {
            $methodName = $reflectionMethod->getName();
            // Exclude some properties
            $methodAllowed = true;
            foreach (self::EXCLUDED_METHOD_REGEXES as $excludePattern) {
                $pattern = '`' . $excludePattern . '`i';
                if (preg_match($pattern, $methodName) === 1) {
                    $methodAllowed = false;
                }
            }
            // Process the method
            if ($methodAllowed && $reflectionMethod->isPublic()) {
                $docblock = null;
                $docs = $this->getDocs($reflectionMethod, $factory);
                $detail = $methodName . '(';
                $params = $reflectionMethod->getParameters();
                $paramList = [];
                foreach ($params as $param) {
                    if ($param->hasType()) {
                        $reflectionType = $param->getType();
                        if ($reflectionType instanceof ReflectionUnionType) {
                            $unionTypes = $reflectionType->getTypes();
                            $typeName = '';
                            foreach ($unionTypes as $unionType) {
                                $typeName .= '|' . $unionType->getName();
                            }
                            $typeName = trim($typeName, '|');
                            $paramList[] = $typeName . ': ' . '$' . $param->getName();
                        } else {
                            $paramList[] = $param->getType()->getName() . ': ' . '$' . $param->getName();
                        }
                    } else {
                        $paramList[] = '$' . $param->getName();
                    }
                }
                $detail .= implode(', ', $paramList) . ')';
                $thisPath = trim(implode('.', [$path, $methodName]), '.');
                $label = $methodName . '()';
                $docsPreamble = '';
                // Figure out the type
                if ($docblock) {
                    $tags = $docblock->getTagsByName('param');
                    if ($tags) {
                        $docsPreamble = "Parameters:\n\n";
                        foreach ($tags as $tag) {
                            $docsPreamble .= $tag . "\n";
                        }
                        $docsPreamble .= "\n";
                    }
                }
                CompleteItem::create()
                    ->detail((string)$detail)
                    ->documentation((string)$docsPreamble . (string)$docs)
                    ->kind(CompleteItemKind::MethodKind)
                    ->label((string)$label)
                    ->insertText((string)$label)
                    ->sortText($this->methodSortPrefix . (string)$label)
                    ->add($this, $thisPath);
            }
        }
    }

    /**

Missing short description in doc comment

     * @param $object

Missing parameter comment

     * @param DocBlockFactory $factory

Missing parameter comment

     * @param $recursionDepth

Missing parameter comment

     * @param string $path

Missing parameter comment

Expected 10 spaces after parameter type; 1 found

     */

Missing @return tag in function comment

    protected function getBehaviorCompletion($object, DocBlockFactory $factory, $recursionDepth, string $path): void
    {
        if ($object instanceof Element) {
            $behaviorClass = $object->getBehavior('customFields');
            if ($behaviorClass) {
                $this->getPropertyCompletion($behaviorClass, $factory, $recursionDepth, $path);
            }
        }
    }

    /**
     * Try to get the best documentation block we can
     *
     * @param ReflectionClass|ReflectionMethod $reflection

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param DocBlockFactory $factory

Missing parameter comment

Expected 18 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function getDocs($reflection, DocBlockFactory $factory): string
    {
        $docs = $reflection->getDocComment();
        if ($docs) {
            $docblock = $factory->create($docs);
            $summary = $docblock->getSummary();
            if (!empty($summary)) {
                $docs = $summary;
            }
            $description = $docblock->getDescription()->render();
            if (!empty($description)) {
                $docs = $description;
            }
        }

        return $docs ?: '';
    }
}