Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Link field type #15251

Merged
merged 22 commits into from
Jul 1, 2024
Merged

Link field type #15251

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
c82ae1d
Link field type
brandonkelly Jun 24, 2024
f606065
Fix PHP error
brandonkelly Jun 26, 2024
d6526f3
Merge branch '5.3' into feature/cms-1279-link-field
brandonkelly Jun 26, 2024
7c910ff
Preserve the site the element was selected in
brandonkelly Jun 26, 2024
a0a9218
parent::__construct()
brandonkelly Jun 26, 2024
bc8c307
Make link type classes not abstract
brandonkelly Jun 26, 2024
1161723
New LinkData methods
brandonkelly Jun 26, 2024
f44daad
Drop the `element-` type ID prefix
brandonkelly Jun 26, 2024
826cc09
Telephone → Phone
brandonkelly Jun 26, 2024
3d252c3
Merge branch '5.3' into feature/cms-1279-link-field
brandonkelly Jun 27, 2024
85c7e00
Stick with `tel` as the type ID
brandonkelly Jun 28, 2024
70398cb
Switch to instances
brandonkelly Jun 28, 2024
0112b02
Merge branch '5.3' into feature/cms-1279-link-field
brandonkelly Jun 29, 2024
3730419
Link type settings + customizable sources for element link types
brandonkelly Jun 29, 2024
9df3520
Add an HR between link type settings
brandonkelly Jun 30, 2024
412e6be
Cleanup
brandonkelly Jun 30, 2024
e37d8b8
Asset link type
brandonkelly Jun 30, 2024
46a51a4
Fixed aria-label
brandonkelly Jun 30, 2024
820c0a7
Better URL pattern
brandonkelly Jun 30, 2024
b09e43b
Merge branch '5.3' into feature/cms-1279-link-field
brandonkelly Jul 1, 2024
5e3c2e4
UI improvements
brandonkelly Jul 1, 2024
15dfd97
Release notes
brandonkelly Jul 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
417 changes: 417 additions & 0 deletions src/fields/Link.php
View file
Open in desktop

Large diffs are not rendered by default.

373 changes: 7 additions & 366 deletions src/fields/Url.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,374 +7,15 @@

namespace craft\fields;

use Craft;
use craft\base\ElementInterface;
use craft\base\Field;
use craft\base\InlineEditableFieldInterface;
use craft\fields\conditions\TextFieldConditionRule;
use craft\helpers\Cp;
use craft\helpers\Html;
use craft\helpers\StringHelper;
use craft\helpers\UrlHelper;
use craft\validators\ArrayValidator;
use craft\validators\UrlValidator;
use yii\base\InvalidConfigException;
use yii\base\InvalidValueException;
use yii\db\Schema;
use yii\validators\EmailValidator;

/**
* Url represents a URL field.
*
* @author Pixel & Tonic, Inc. <[email protected]>
* @since 3.0.0
*/
class Url extends Field implements InlineEditableFieldInterface
{
/**
* @since 3.6.0
*/
public const TYPE_URL = 'url';
/**
* @since 3.6.0
*/
public const TYPE_TEL = 'tel';
/**
* @since 3.6.0
*/
public const TYPE_EMAIL = 'email';

/**
* @inheritdoc
*/
public static function displayName(): string
{
return Craft::t('app', 'URL');
}

/**
* @inheritdoc
*/
public static function icon(): string
{
return 'link';
}

/**
* @inheritdoc
*/
public static function phpType(): string
{
return 'string|null';
}

/**
* @inheritdoc
*/
public static function dbType(): string
{
return Schema::TYPE_STRING;
}

/**
* @var string[] Allowed URL types
* @since 3.6.0
*/
public array $types = [
self::TYPE_URL,
];

/**
* @var int The maximum length (in bytes) the field can hold
*/
public int $maxLength = 255;

/**
* @inheritdoc
*/
public function __construct($config = [])
{
if (array_key_exists('placeholder', $config)) {
unset($config['placeholder']);
}

parent::__construct($config);
}

/**
* @inheritdoc
*/
public function fields(): array
{
$fields = parent::fields();
unset($fields['placeholder']);
return $fields;
}

/**
* @inheritdoc
*/
protected function defineRules(): array
{
$rules = parent::defineRules();
$rules[] = [['types'], ArrayValidator::class];
$rules[] = [['types', 'maxLength'], 'required'];
$rules[] = [['maxLength'], 'number', 'integerOnly' => true, 'min' => 10];
return $rules;
}

/**
* @inheritdoc
*/
public function getSettingsHtml(): ?string
{
return
Cp::checkboxSelectFieldHtml([
'label' => Craft::t('app', 'Allowed URL Types'),
'id' => 'types',
'name' => 'types',
'options' => [
['label' => Craft::t('app', 'Web page'), 'value' => self::TYPE_URL],
['label' => Craft::t('app', 'Telephone'), 'value' => self::TYPE_TEL],
['label' => Craft::t('app', 'Email'), 'value' => self::TYPE_EMAIL],
],
'values' => $this->types,
'required' => true,
]) .
Cp::textFieldHtml([
'label' => Craft::t('app', 'Max Length'),
'instructions' => Craft::t('app', 'The maximum length (in bytes) the field can hold.'),
'id' => 'maxLength',
'name' => 'maxLength',
'type' => 'number',
'min' => '10',
'step' => '10',
'value' => $this->maxLength,
'errors' => $this->getErrors('maxLength'),
'data' => ['error-key' => 'maxLength'],
]);
}

/**
* @inheritdoc
*/
public function normalizeValue(mixed $value, ?ElementInterface $element): mixed
{
if (is_array($value) && isset($value['value'])) {
$type = $value['type'] ?? self::TYPE_URL;
$value = trim($value['value']);

if ($value) {
switch ($type) {
case self::TYPE_TEL:
$value = str_replace(' ', '-', $value);
$value = StringHelper::ensureLeft($value, 'tel:');
break;
case self::TYPE_EMAIL:
$value = StringHelper::ensureLeft($value, 'mailto:');
break;
case self::TYPE_URL:
if (!UrlHelper::isFullUrl($value)) {
$value = StringHelper::ensureLeft($value, 'http://');
}
break;
default:
throw new InvalidValueException("Invalid URL type: $type");
}
}
}

if (!$value) {
return null;
}

return str_replace(' ', '+', $value);
}

/** @phpstan-ignore-next-line */
if (false) {
/**
* @inheritdoc
* @since 3.0.0
* @deprecated in 5.3.0
*/
public function useFieldset(): bool
class Url
{
return count($this->types) > 1;
}

/**
* @inheritdoc
*/
protected function inputHtml(mixed $value, ?ElementInterface $element, bool $inline): string
{
if (is_string($value)) {
$valueType = $this->_urlType($value);
} else {
$valueType = self::TYPE_URL;
}

if (!in_array($valueType, $this->types, true)) {
$valueType = reset($this->types);
}

$id = $this->getInputId();
$typeOptions = [];

foreach ($this->types as $type) {
switch ($type) {
case self::TYPE_URL:
$label = Craft::t('app', 'Web page');
$prefix = null;
break;
case self::TYPE_TEL:
$label = Craft::t('app', 'Telephone');
$prefix = 'tel:';
break;
case self::TYPE_EMAIL:
$label = Craft::t('app', 'Email');
$prefix = 'mailto:';
break;
default:
throw new InvalidConfigException("Invalid URL type: $type");
}

$typeOptions[] = ['label' => $label, 'value' => $type];

if (is_string($value) && $type === $valueType && $prefix) {
$value = StringHelper::removeLeft($value, $prefix);
}
}

$input = Craft::$app->getView()->renderTemplate('_includes/forms/text.twig', [
'id' => $id,
'describedBy' => $this->describedBy,
'class' => ['flex-grow', 'fullwidth'],
'type' => $valueType,
'name' => "$this->handle[value]",
'inputmode' => $valueType,
'value' => $value,
'inputAttributes' => [
'aria' => [
'label' => Craft::t('site', $this->name),
],
],
]);

$view = Craft::$app->getView();

if ($value === null) {
// Override the initial value being set to null by CustomField::inputHtml()
$view->setInitialDeltaValue($this->handle, [
'type' => $valueType,
'value' => '',
]);
}

if (count($this->types) === 1) {
return
Html::hiddenInput("$this->handle[type]", $valueType) .
$input;
}

$namespacedId = $view->namespaceInputId($id);
$js = <<<JS
$('#$namespacedId-type').on('change', e => {
const type = $('#$namespacedId-type').val();
$('#$namespacedId')
.attr('type', type)
.attr('inputmode', type);
});
JS;
$view->registerJs($js);

return Html::tag(
'div',
Cp::selectHtml([
'id' => "$id-type",
'describedBy' => $this->describedBy,
'name' => "$this->handle[type]",
'options' => $typeOptions,
'value' => $valueType,
'inputAttributes' => [
'aria' => [
'label' => Craft::t('app', 'URL type'),
],
],
]) .
$input,
[
'class' => ['flex', 'flex-nowrap'],
]
);
}

/**
* @inheritdoc
*/
public function getElementValidationRules(): array
{
$patterns = [];

foreach ($this->types as $type) {
switch ($type) {
case self::TYPE_URL:
$patterns[] = UrlValidator::URL_PATTERN;
break;
case self::TYPE_TEL:
// * and # characters are not allowed by iOS
// see https://developer.apple.com/library/archive/featuredarticles/iPhoneURLScheme_Reference/PhoneLinks/PhoneLinks.html
$patterns[] = '^tel:[\d\+\(\)\-,;]+$';
break;
case self::TYPE_EMAIL:
$emailPattern = trim((new EmailValidator())->pattern, '/^$');
$patterns[] = "^mailto:$emailPattern(\?.*)?$";
break;
}
}

return [
['trim'],
[
UrlValidator::class,
'pattern' => '/' . implode('|', $patterns) . '/i',
],
['string', 'max' => $this->maxLength],
];
}

/**
* @inheritdoc
*/
public function getElementConditionRuleType(): array|string|null
{
return TextFieldConditionRule::class;
}

/**
* @inheritdoc
*/
public function getPreviewHtml(mixed $value, ElementInterface $element): string
{
if (!$value) {
return '';
}
$value = Html::encode($value);
return "<a href=\"$value\" target=\"_blank\">$value</a>";
}

/**
* Returns what type of URL a given value is.
*
* @param string $value
* @return string
*/
private function _urlType(string $value): string
{
if (str_starts_with($value, 'tel:')) {
return self::TYPE_TEL;
}

if (str_starts_with($value, 'mailto:')) {
return self::TYPE_EMAIL;
}

return self::TYPE_URL;
}
}

class_alias(Link::class, Url::class);
Loading
Loading