nystudio107 / craft-instantanalytics-ga4

src/helpers/Field.php

<?php
/**
 * Instant Analytics plugin for Craft CMS
 *
 * @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>"

 * @copyright Copyright (c) 2017 nystudio107

The tag in position 2 should be the @author tag

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

 * @link      http://nystudio107.com

The tag in position 3 should be the @copyright tag

 * @package   InstantAnalytics

The tag in position 4 should be the @link tag

 * @since     1.0.0
 */

PHP version not specified

Missing @category tag in file comment

Missing @license tag in file comment

namespace nystudio107\instantanalyticsGa4\helpers;

use Craft;
use craft\base\Element;
use craft\base\Field as BaseField;
use craft\ckeditor\Field as CKEditorField;
use craft\elements\Entry;
use craft\elements\User;
use craft\fields\Assets as AssetsField;
use craft\fields\Categories as CategoriesField;
use craft\fields\Entries as EntriesField;
use craft\fields\Matrix as MatrixField;
use craft\fields\PlainText as PlainTextField;
use craft\fields\Tags as TagsField;
use craft\models\FieldLayout;
use craft\models\Volume;
use craft\redactor\Field as RedactorField;
use Exception;
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   InstantAnalytics

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
{
    // Constants
    // =========================================================================

    public const TEXT_FIELD_CLASS_KEY = 'text';
    public const ASSET_FIELD_CLASS_KEY = 'asset';
    public const BLOCK_FIELD_CLASS_KEY = 'block';

    protected const FIELD_CLASSES = [
        self::TEXT_FIELD_CLASS_KEY => [
            CKEditorField::class,
            PlainTextField::class,
            RedactorField::class,
            TagsField::class,
            CategoriesField::class,
            EntriesField::class,
        ],
        self::ASSET_FIELD_CLASS_KEY => [
            AssetsField::class,
        ],
        self::BLOCK_FIELD_CLASS_KEY => [
            MatrixField::class,
        ],
    ];

    // Static Methods
    // =========================================================================

    /**
     * Return all the fields from the $layout that are of the type
     * $fieldClassKey
     *
     * @param string $fieldClassKey

Missing parameter comment

Expected 6 spaces after parameter type; 1 found

     * @param FieldLayout $layout

Missing parameter comment

     * @param bool $keysOnly

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

     *
     * @return array
     */
    public static function fieldsOfTypeFromLayout(
        string      $fieldClassKey,
        FieldLayout $layout,
        bool        $keysOnly = true,
    ): array {
        $foundFields = [];
        if (!empty(self::FIELD_CLASSES[$fieldClassKey])) {
            $fieldClasses = self::FIELD_CLASSES[$fieldClassKey];
            $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) {
                /** @var array $fieldClasses */

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 ($fieldClasses as $fieldClass) {
                    if ($field instanceof $fieldClass) {
                        $foundFields[$field->handle] = $field->name;
                    }
                }
            }
        }

        // Return only the keys if asked
        if ($keysOnly) {
            $foundFields = array_keys($foundFields);
        }

        return $foundFields;
    }

    /**
     * Return all of the fields in the $element of the type $fieldClassKey
     *
     * @param Element $element

Missing parameter comment

     * @param string $fieldClassKey

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param bool $keysOnly

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     *
     * @return array
     */
    public static function fieldsOfTypeFromElement(
        Element $element,
        string  $fieldClassKey,
        bool    $keysOnly = true,
    ): array {
        $foundFields = [];
        $layout = $element->getFieldLayout();
        if ($layout !== null) {
            $foundFields = self::fieldsOfTypeFromLayout($fieldClassKey, $layout, $keysOnly);
        }

        return $foundFields;
    }

    /**
     * Return all of the fields from Users layout of the type $fieldClassKey
     *
     * @param string $fieldClassKey

Missing parameter comment

     * @param bool $keysOnly

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     *
     * @return array
     */
    public static function fieldsOfTypeFromUsers(string $fieldClassKey, bool $keysOnly = true): array
    {
        $layout = Craft::$app->getFields()->getLayoutByType(User::class);

        return self::fieldsOfTypeFromLayout($fieldClassKey, $layout, $keysOnly);
    }

    /**
     * Return all the fields from all Asset Volume layouts of the type
     * $fieldClassKey
     *
     * @param string $fieldClassKey

Missing parameter comment

     * @param bool $keysOnly

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     *
     * @return array
     */
    public static function fieldsOfTypeFromAssetVolumes(string $fieldClassKey, bool $keysOnly = true): array
    {
        $foundFields = [];
        $volumes = Craft::$app->getVolumes()->getAllVolumes();
        foreach ($volumes as $volume) {
            /** @var Volume $volume */

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

            try {
                $layout = $volume->getFieldLayout();
            } catch (Exception $e) {
                $layout = null;
            }
            if ($layout) {
                /** @noinspection SlowArrayOperationsInLoopInspection */

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

                $foundFields = array_merge(
                    $foundFields,
                    self::fieldsOfTypeFromLayout($fieldClassKey, $layout, $keysOnly)
                );
            }
        }

        return $foundFields;
    }

    /**
     * Return all the fields from all Global Set layouts of the type
     * $fieldClassKey
     *
     * @param string $fieldClassKey

Missing parameter comment

     * @param bool $keysOnly

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     *
     * @return array
     */
    public static function fieldsOfTypeFromGlobals(string $fieldClassKey, bool $keysOnly = true): array
    {
        $foundFields = [];
        $globals = Craft::$app->getGlobals()->getAllSets();
        foreach ($globals as $global) {
            $layout = $global->getFieldLayout();
            /** @phpstan-ignore-next-line */

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

            if ($layout) {
                $fields = self::fieldsOfTypeFromLayout($fieldClassKey, $layout, $keysOnly);
                // Prefix the keys with the global set name
                $prefix = $global->handle;
                $fields = array_combine(
                    array_map(static function($key) use ($prefix) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

                        return $prefix . '.' . $key;
                    }, array_keys($fields)),

For multi-line function calls, the closing parenthesis should be on a new line.

                    $fields
                );
                // Merge with any fields we've already found
                /** @noinspection SlowArrayOperationsInLoopInspection */

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

                $foundFields = array_merge(
                    $foundFields,
                    $fields
                );
            }
        }

        return $foundFields;
    }

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

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param string $fieldType

Missing parameter comment

     * @param bool $keysOnly

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     *
     * @return array
     */
    public static function matrixFieldsOfType(Entry $matrixEntry, string $fieldType, bool $keysOnly = true): 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 only the keys if asked
            if ($keysOnly) {
                $foundFields = array_keys($foundFields);
            }
        }

        return $foundFields;
    }
}