nystudio107\templatecomments\helpers\Reflection

Complexity

Total Complexity

6

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Importance

Changes	1
Bugs	1	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	getReflectionProperty()	0	26	6

<?php
/**
 * Template Comments plugin for Craft CMS
 *
 * Adds a HTML comment to demarcate each Twig template that is included or extended.
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c)  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\templatecomments\helpers;

use ReflectionException;
use ReflectionObject;
use ReflectionProperty;

/**

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   TemplateComments

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

 * @since     4.0.2

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

class Reflection
{
    // Public static Methods
    // =========================================================================
    /**

Missing short description in doc comment

     * @param object $object

Missing parameter comment

     * @param string $propertyName

Missing parameter comment

     *
     * @return ReflectionProperty
     * @throws ReflectionException
     */
    public static function getReflectionProperty(object $object, string $propertyName): ReflectionProperty
    {
        $reflectionObject = new ReflectionObject($object);

        $reflectionProperty = null;

        if ($reflectionObject->hasProperty($propertyName)) {
            $reflectionProperty = $reflectionObject->getProperty($propertyName);
        } else {

            // This is needed for private parent properties only.
            $parent = $reflectionObject->getParentClass();
            while ($reflectionProperty === null && $parent !== false) {
                if ($parent->hasProperty($propertyName)) {
                    $reflectionProperty = $parent->getProperty($propertyName);
                }

                $parent = $parent->getParentClass();
            }
        }

        if (!$reflectionProperty) {
            throw new ReflectionException("Property not found: " . $propertyName);
        }

        return $reflectionProperty;
    }
}