nystudio107\retour\fields\ShortLink

Complexity

Total Complexity

11

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	afterElementDelete()	0	8	2
A	afterElementSave()	0	12	3
A	getContentColumnType()	0	3	1
A	displayName()	0	3	1
A	getTableAttributeHtml()	0	9	2
A	getInputHtml()	0	9	1
A	getSettingsHtml()	0	5	1

<?php
/**
 * SEOmatic plugin for Craft CMS 3.x
 *
 * @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

 * @license   https://nystudio107.com/license

@license tag must contain a URL and a license name

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

namespace nystudio107\retour\fields;

use Craft;
use craft\base\ElementInterface;
use craft\base\Field;
use craft\base\PreviewableFieldInterface;
use craft\helpers\Json;
use nystudio107\retour\Retour as RetourPlugin;
use yii\db\Schema;

/**

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   Retour

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

 * @since     3.1.74

The tag in position 3 should be the @author tag

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

 *
 * @property-read string $contentColumnType
 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class ShortLink extends Field implements PreviewableFieldInterface
{
    public $redirectSrcMatch = 'pathonly';
    public $redirectHttpCode = 301;

    // Static Methods

    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function displayName(): string
    {
        return Craft::t('retour', 'Short Link');
    }

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getContentColumnType(): string
    {
        return Schema::TYPE_TEXT;
    }

    /**

Missing short description in doc comment

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

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

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getInputHtml($value, ElementInterface $element = null): string
    {
        // Render the input template
        return Craft::$app->getView()->renderTemplate(
            'retour/_components/fields/ShortLink_input',
            [
                'name' => $this->handle,
                'value' => $value,
                'field' => $this,
            ]
        );
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getSettingsHtml()
    {
        return Craft::$app->getView()->renderTemplate('retour/_components/fields/ShortLink_settings',

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

            [
                'field' => $this,
            ]);

This line of the multi-line function call does not seem to be indented correctly. Expected 8 spaces, but found 12.

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

    }

    /**

Missing short description in doc comment

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

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

     * @inheritdoc
     */

Missing @return tag in function comment

    public function afterElementSave(ElementInterface $element, bool $isNew)
    {
        if ($element->getIsDraft()) {
            return;
        }

        $value = $element->{$this->handle};
        RetourPlugin::$plugin->redirects->removeElementRedirect($element);
        if (!empty($value)) {
            RetourPlugin::$plugin->redirects->enableElementRedirect($element, $value, $this->redirectSrcMatch, $this->redirectHttpCode);
        }
        parent::afterElementSave($element, $isNew);
    }

    /**

Missing short description in doc comment

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

     * @inheritdoc
     */

Missing @return tag in function comment

    public function afterElementDelete(ElementInterface $element)
    {
        if ($element->getIsDraft()) {
            return;
        }

        RetourPlugin::$plugin->redirects->removeElementRedirect($element, true);
        parent::afterElementDelete($element);
    }

    /**

Missing short description in doc comment

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

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

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getTableAttributeHtml($value, ElementInterface $element): string
    {
        $decoded = Json::decodeIfJson($value);
        if ($decoded) {
            return $decoded['legacyUrl'] ?? '';
        }

        // Render the input template
        return $value;
    }
}