sunnysideup / silverstripe-externalurlfield

src/ExternalURLField.php

<?php

namespace Sunnysideup\ExternalURLField;

use SilverStripe\Forms\TextField;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBHTMLText;

/**
 * ExternalURLField.
 *
 * Form field for entering, saving, validating external urls.
 */
class ExternalURLField extends TextField
{
    /**
     * @var array
     */
    protected $config = [];

    /**
     * Default configuration.
     *
     * URL validation regular expression was sourced from
     *
     * @see https://gist.github.com/dperini/729294
     *
     * @var array
     */
    private static $default_config = [
        'defaultparts' => [
            'scheme' => 'https',
        ],
        'removeparts' => [
            'scheme' => false,
            'user' => true,
            'pass' => true,
            'host' => false,
            'port' => false,
            'path' => false,
            'query' => false,
            'fragment' => false,
        ],
        'html5validation' => true,
        'validregex' => '%^(?:(?:https?|ftp)://)(?:\S+(?::\S*)'
            . '?@|\d{1,3}(?:\.\d{1,3}){3}|(?:(?:[a-z\d\x{00a1}-\x{ffff}]+-?)*[a-z\d\x{00a1}-\x{ffff}]+)'
            . '(?:\.(?:[a-z\d\x{00a1}-\x{ffff}]+-?)*[a-z\d\x{00a1}-\x{ffff}]+)*(?:\.[a-z\x{00a1}-\x{ffff}]{2,6}))'
            . '(?::\d+)?(?:[^\s]*)?$%iu',
    ];

    public function __construct($name, $title = null, $value = null)
    {
        $this->config = $this->config()->default_config;

        parent::__construct($name, $title, $value);
    }

    public function Type()
    {
        return 'url text';
    }

    /**
     * @param string $name
     * @param mixed  $val
     */
    public function setConfig($name, $val = null)
    {
        if (is_array($name) && null === $val) {
            foreach ($name as $n => $value) {
                $this->setConfig($n, $value);
            }

            return $this;
        }

        if (is_array($this->config[$name])) {
            if (! is_array($val)) {
                user_error("The value for {$name} must be an array");
            }

            $this->config[$name] = array_merge($this->config[$name], $val);

It seems like $val can also be of type null; however, parameter $arrays of array_merge() does only seem to accept array, maybe add an additional type check?

        } elseif (isset($this->config[$name])) {
            $this->config[$name] = $val;
        }

        return $this;
    }

    /**
     * @param string $name Optional, returns the whole configuration array if empty
     *
     * @return array|mixed
     */
    public function getConfig($name = null)
    {
        if ($name) {
            return isset($this->config[$name]) ? $this->config[$name] : null;
        }

        return $this->config;
    }

    /**
     * Set additional attributes.
     *
     * @return array Attributes
     */
    public function getAttributes()
    {
        $parentAttributes = parent::getAttributes();
        $attributes = [];

        if (! isset($parentAttributes['placeholder'])) {
            $attributes['placeholder'] = $this->config['defaultparts']['scheme'] . '://example.com'; //example url
        }

        if ($this->config['html5validation']) {
            $attributes += [
                'type' => 'url', //html5 field type
                'pattern' => 'https?://.+', //valid urls only
            ];
        }

        return array_merge(
            $parentAttributes,
            $attributes
        );
    }

    /**
     * Rebuild url on save.
     *
     * @param string           $url
     * @param array|DataObject $data {@see Form::loadDataFrom}
     *
     * @return $this
     */
    public function setValue($url, $data = null)
    {
        if ($url) {
            $url = $this->rebuildURL($url);
        }

        return parent::setValue($url, $data);
    }

    /**
     * Server side validation, using a regular expression.
     *
     * @param mixed $validator
     */
    public function validate($validator)
    {
        $this->value = trim(string: (string) $this->value);
        $regex = $this->config['validregex'];
        if ($this->value && $regex && ! preg_match($regex, $this->value)) {
            $validator->validationError(
                $this->name,
                _t('ExternalURLField.VALIDATION', 'Please enter a valid URL'),
                'validation'
            );

            return false;
        }

        return true;
    }

    public function RightTitle()
    {
        if ($this->value) {
            return DBHTMLText::create_field(DBHTMLText::class, parent::RightTitle() . '<a href="' . $this->value . '" target="_blank" onclick="event.stopPropagation();"rel="noreferrer noopener">open ↗</a>');
        }

        return parent::RightTitle();
    }

    /**
     * Add config scheme, if missing.
     * Remove the parts of the url we don't want.
     * Set any defaults, if missing.
     * Remove any trailing slash, and rebuild.
     *
     * @param mixed $url
     *
     * @return string
     */
    protected function rebuildURL($url)
    {
        $defaults = $this->config['defaultparts'];
        if (! preg_match('#^[a-zA-Z]+://#', $url)) {
            $url = $defaults['scheme'] . '://' . $url;
        }

        $parts = parse_url($url);
        if (! $parts) {
            //can't parse url, abort
            return '';
        }

        foreach (array_keys($parts) as $part) {
            if (true === $this->config['removeparts'][$part]) {
                unset($parts[$part]);
            }
        }

        // this causes errors!
        // $parts = array_filter($defaults, fn ($default) => ! isset($parts[$part]));

        return rtrim(http_build_url($defaults, $parts), '/');
    }
}