nystudio107 / craft-retour

src/fields/ShortLink.php

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

 * @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\ElementHelper;
use craft\helpers\Html;
use craft\helpers\Json;
use craft\helpers\UrlHelper;
use nystudio107\retour\Retour as RetourPlugin;
use yii\helpers\StringHelper;

/**

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.2.0

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
{
    protected static $allowShortLinkUpdates = true;
    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');
    }

    /**
     * Prevent element updates from updating the short link redirects.
     */

Missing @return tag in function comment

    public static function preventShortLinkUpdates()
    {
        self::$allowShortLinkUpdates = false;
    }

    /**
     * Allow element updates to update the short link redirects.
     */

Missing @return tag in function comment

    public static function allowShortLinkUpdates()
    {
        self::$allowShortLinkUpdates = true;
    }

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

    /**

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
    {
        // Get our id & namespaceId
        $craft35 = version_compare(Craft::$app->getVersion(), '3.5', '>=');
        if ($craft35) {
            $id = Html::id($this->handle);

It seems like $this->handle can also be of type null; however, parameter $id of craft\helpers\Html::id() does only seem to accept string, maybe add an additional type check?

        } else {
            $id = Craft::$app->getView()->formatInputId($this->handle);
        }
        $namespacedId = Craft::$app->getView()->namespaceInputId($id);

        // Render the input template
        return Craft::$app->getView()->renderTemplate(
            'retour/_components/fields/ShortLink_input',
            [
                'name' => $this->handle,
                'value' => $value,
                'field' => $this,
                'id' => $id,
                'namespacedId' => $namespacedId,
            ]
        );
    }

    /**

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.

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getIsTranslatable(ElementInterface $element = null): bool
    {
        return false;
    }

    /**

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 (!self::$allowShortLinkUpdates || $element->getIsDraft() || !$element->getSite()->hasUrls) {
            return;
        }

        $value = $element->getFieldValue($this->handle);

It seems like $this->handle can also be of type null; however, parameter $fieldHandle of craft\base\ElementInterface::getFieldValue() does only seem to accept string, maybe add an additional type check?

        // Return for propagating elements
        if ($this->redirectSrcMatch === 'pathonly') {
            $parentElement = ElementHelper::rootElement($element);
            if ($this->translationMethod === Field::TRANSLATION_METHOD_NONE && ($element->propagating || $parentElement->propagating)) {

Accessing propagating on the interface craft\base\ElementInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

                return;
            }
        } elseif (!empty($value) && !StringHelper::startsWith($value, 'http')) {
            $value = UrlHelper::siteUrl($value, null, null, $element->siteId);

Accessing siteId on the interface craft\base\ElementInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

        }

        $parentElement = ElementHelper::rootElement($element);
        RetourPlugin::$plugin->redirects->removeElementRedirect($parentElement, false);

        if (!empty($value)) {
            $redirectSrcMatch = $this->redirectSrcMatch;

            RetourPlugin::$plugin->redirects->enableElementRedirect($parentElement, $value, $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() || $element->getIsRevision()) {
            return;
        }

        RetourPlugin::$plugin->redirects->removeElementRedirect($element, true, 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 (is_array($decoded)) {
            $value = $decoded['legacyUrl'] ?? '';
        }
        // Render the preview template
        return Craft::$app->getView()->renderTemplate(
            'retour/_components/fields/ShortLink_preview',
            [
                'name' => $this->handle,
                'value' => $value,
                'field' => $this,
            ]
        );
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getElementValidationRules(): array
    {
        return [
            [
                /** @var ElementInterface $element */

Missing short description in doc comment

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

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

                function($element) {

Expected 1 space after FUNCTION keyword; 0 found

                    $value = $element->getFieldValue($this->handle);

It seems like $this->handle can also be of type null; however, parameter $fieldHandle of craft\base\ElementInterface::getFieldValue() does only seem to accept string, maybe add an additional type check?

                    $redirect = RetourPlugin::$plugin->getRedirects()->getRedirectByRedirectSrcUrl($value);
                    if (method_exists($element, 'getCanonical')) {
                        // Handle drafts
                        $element = $element->getCanonical();
                    }
                    if ($redirect && isset($redirect['associatedElementId'])) {
                        if ($redirect['associatedElementId'] == 0) {
                            $element->addError($this->handle, Craft::t('retour', 'A Retour redirect with this Legacy URL already exists.'));
                        } elseif ($redirect['associatedElementId'] !== $element->id) {

Accessing id on the interface craft\base\ElementInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

                            $element->addError($this->handle, Craft::t('retour', 'A Short Link with this URL already exists.'));
                        }
                    }
                },
            ],
        ];
    }
}