ShortLink::getElementValidationRules() - Code Metrics - Inspection of "Merge branch 'release/3.2.26' into v3" - nystudio107/craft-retour - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — v3 ( 9905e0...d51017 )

by Andrew
created 2025-04-22 17:42 UTC
ShortLink::getElementValidationRules() A

↳ Parent: ShortLink
Complexity

Conditions	6
Paths	1
Size

Total Lines	17
Code Lines	11
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	42
Importance

Changes	2
Bugs	1	Features	0
Metric	Value
eloc	11
c	2
b	1
f	0
dl	0
loc	17
ccs	0
cts	14
cp	0
rs	9.2222
cc	6
nc	1
nop	0
crap	42
<?php
/**
 * Retour plugin for Craft CMS
 *
 * @link      https://nystudio107.com/

 * @copyright Copyright (c) 2022 nystudio107

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

 */


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;

/**

 * @author    nystudio107

 * @package   Retour

 * @since     3.2.0

 *
 * @property-read string $contentColumnType
 */

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

    // Static Methods

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

    /**

     * @inheritdoc
     */

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

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

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

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

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

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

    /**

     * @inheritdoc
     */

    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);
            $id = Html::id(/** @scrutinizer ignore-type */ $this->handle);
        } 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,
            ]
        );
    }

    /**

     * @inheritdoc
     */

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

            [
                'field' => $this,
            ]);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
    }

    /**

     * @inheritdoc
     */

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

    /**

     * @inheritdoc
     */

    public function afterElementSave(ElementInterface $element, bool $isNew)
    {
        if (!self::$allowShortLinkUpdates || $element->getIsDraft() || !$element->getSite()->hasUrls) {
            return;
        }

        $value = $element->getFieldValue($this->handle);
        $value = $element->getFieldValue(/** @scrutinizer ignore-type */ $this->handle);

        // Return for propagating elements
        if ($this->redirectSrcMatch === 'pathonly') {
            $parentElement = ElementHelper::rootElement($element);
            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);
        RetourPlugin::$plugin->redirects->removeElementRedirect($parentElement, false);

        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);
    }

    /**

     * @inheritdoc
     */

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

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

    /**

     * @inheritdoc
     */

    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,
            ]
        );
    }

    /**

     * @inheritdoc
     */

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

                function($element) {

                    $value = $element->getFieldValue($this->handle);
                    $value = $element->getFieldValue(/** @scrutinizer ignore-type */ $this->handle);
                    $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) {

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

nystudio107 / craft-retour

Push — v3 ( 9905e0...d51017 )

ShortLink::getElementValidationRules() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
