nystudio107 / craft-routemap

src/helpers/Field.php

<?php
/**
 * Route Map plugin for Craft CMS
 *
 * Returns a list of public routes for elements with URLs
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

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

use craft\base\Component;
use craft\base\ElementInterface;

The type craft\base\ElementInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\base\Field as BaseField;
use craft\elements\Entry;
use craft\models\FieldLayout;
use yii\base\InvalidConfigException;

/**

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   RouteMap

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

 * @since     1.0.0

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 Field extends Component
{
    // Static Methods
    // =========================================================================
    /**
     * Return all the fields in the $element of the type $fieldType class
     *
     * @param ElementInterface $element

Missing parameter comment

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

     * @param string $fieldType

Missing parameter comment

Expected 11 spaces after parameter type; 1 found

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

     * @return array

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

     */
    public static function fieldsOfType(ElementInterface $element, string $fieldType): array
    {
        $foundFields = [];

        $layout = $element->getFieldLayout();
        if (!$layout instanceof FieldLayout) {
            return [];
        }

        $fields = $layout->getCustomFields();
        /** @var BaseField $field */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        foreach ($fields as $field) {
            if ($field instanceof $fieldType) {
                $foundFields[] = $field->handle;
            }
        }

        return $foundFields;
    }

    /**
     * Return all the fields in the $matrixBlock of the type $fieldType class
     *
     * @param Entry $matrixEntry

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

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

     * @param string $fieldType

Missing parameter comment

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

     * @return ?array

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

     */
    public static function matrixFieldsOfType(Entry $matrixEntry, string $fieldType): ?array
    {
        $foundFields = [];

        try {
            $matrixEntryTypeModel = $matrixEntry->getType();
        } catch (InvalidConfigException $e) {
            $matrixEntryTypeModel = null;
        }
        if ($matrixEntryTypeModel) {
            $fields = $matrixEntryTypeModel->getCustomFields();
            /** @var BaseField $field */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            foreach ($fields as $field) {
                if ($field instanceof $fieldType) {
                    $foundFields[$field->handle] = $field->name;
                }
            }
        }

        return $foundFields;
    }
}