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;

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

use craft\base\Field;
use craft\base\InlineEditableFieldInterface;
use craft\base\PreviewableFieldInterface;
use craft\helpers\ElementHelper;
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     4.1.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, InlineEditableFieldInterface
{
    protected static bool $allowShortLinkUpdates = true;
    public string $redirectSrcMatch = 'pathonly';
    public int $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');
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function icon(): string
    {
        return '@nystudio107/retour/icon-mask.svg';
    }

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

Missing @return tag in function comment

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

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

Missing @return tag in function comment

    public static function allowShortLinkUpdates(): void
    {
        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
    {
        // 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(): string
    {
        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 $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 getPreviewHtml($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

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

        $value = $element->getFieldValue($this->handle);
        // Return for propagating elements
        if ($this->redirectSrcMatch === 'pathonly') {
            $parentElement = ElementHelper::rootElement($element);

The function craft\helpers\ElementHelper::rootElement() has been deprecated: in 5.4.0. Use [[ElementInterface::getRootOwner()]] instead.

            if ($this->translationMethod === Field::TRANSLATION_METHOD_NONE && ($element->propagating || $parentElement->propagating)) {
                return;
            }
        } elseif (!empty($value) && !StringHelper::startsWith($value, 'http')) {
            $value = UrlHelper::siteUrl($value, null, null, $element->siteId);
        }

        $parentElement = ElementHelper::rootElement($element);

The function craft\helpers\ElementHelper::rootElement() has been deprecated: in 5.4.0. Use [[ElementInterface::getRootOwner()]] instead.

        RetourPlugin::$plugin->redirects->removeElementRedirect($parentElement, false);

The method removeElementRedirect() does not exist on null.

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

            if ($this->translationMethod !== Field::TRANSLATION_METHOD_NONE) {
                if (!UrlHelper::isAbsoluteUrl($value)) {
                    $value = UrlHelper::siteUrl($value, null, null, $parentElement->siteId);
                    $redirectSrcMatch = 'fullurl';
                }
            }

            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): void
    {
        if (!$element->getIsCanonical()) {
            return;
        }

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