Skip to content

[6.x] Add default initial option configuration option for Link fieldtype #14698

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

Open
martyf wants to merge 1 commit into
base: 6.x
Choose a base branch
from
+133 −1
Open

[6.x] Add default initial option configuration option for Link fieldtype #14698

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions lang/en/fieldtypes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@
'integer.title' => 'Integer',
'link.config.collections' => 'Entries from these collections will be available. Leaving this empty will make entries from routable collections available.',
'link.config.container' => 'Choose which asset container to use for this field.',
'link.config.default_option' => 'The default Link type option, if available for the fieldtype\'s configuration.',
'link.title' => 'Link',
'list.config.add_row' => 'Customize the label of the "Add Item" button.',
'list.title' => 'List',
Expand Down
28 changes: 27 additions & 1 deletion src/Fieldtypes/Link.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,21 @@ protected function configFieldItems(): array
'type' => 'toggle',
'width' => '50',
],
'default_option' => [
'display' => __('Default Option'),
'instructions' => __('statamic::fieldtypes.link.config.default_option'),
'type' => 'select',
'max_items' => 1,
'width' => '50',
'clearable' => true,
'placeholder' => __('Default'),
'options' => [
'asset' => __('Asset'),
'entry' => __('Entry'),
'first-child' => __('First Child'),
'url' => __('URL'),
],
],
],
],
];
Expand Down Expand Up @@ -131,7 +146,18 @@ public function preload()
private function initialOption($value, $entry, $asset)
{
if (! $value) {
return $this->field->isRequired() ? 'url' : null;
$fallback = $this->field->isRequired() ? 'url' : null;
$option = $this->field->get('default_option', $fallback);

if ($option === 'first-child' && ! $this->showFirstChildOption()) {
return $fallback;
}

if ($option === 'asset' && ! $this->showAssetOption()) {
return $fallback;
}

return $option;
}

if ($value === '@child') {
Expand Down
105 changes: 105 additions & 0 deletions tests/Fieldtypes/LinkTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@
use Statamic\Fields\ArrayableString;
use Statamic\Fields\Field;
use Statamic\Fieldtypes\Link;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;

class LinkTest extends TestCase
{
use PreventSavingStacheItemsToDisk;

#[Test]
public function it_augments_string_to_string()
{
Expand Down Expand Up @@ -261,4 +264,106 @@ public function it_pre_processes_first_child_for_index_when_no_children()

$this->assertNull($fieldtype->preProcessIndex('@child'));
}

#[Test]
public function it_preloads_the_configured_initial_option()
{
tap(Facades\Collection::make('pages')->routes('{slug}'))->sites(['en'])->save();

$field = new Field('test', [
'type' => 'link',
'default_option' => 'entry',
]);

$field->setValue(null);
$fieldtype = (new Link)->setField($field);

$this->assertEquals('entry', $fieldtype->preload()['initialOption']);
}

#[Test]
public function it_preloads_the_url_initial_option_when_required()
{
tap(Facades\Collection::make('pages')->routes('{slug}'))->sites(['en'])->save();

$field = new Field('test', [
'type' => 'link',
'required' => true,
]);

$field->setValue(null);
$fieldtype = (new Link)->setField($field);

$this->assertEquals('url', $fieldtype->preload()['initialOption']);
}

#[Test]
public function it_preloads_the_expected_initial_option_when_default_option_not_set()
{
tap(Facades\Collection::make('pages')->routes('{slug}'))->sites(['en'])->save();

$field = new Field('test', [
'type' => 'link',
]);

$field->setValue(null);

$fieldtype = (new Link)->setField($field);

$this->assertNull($fieldtype->preload()['initialOption']);
}

#[Test]
public function it_preloads_initial_option_of_first_child_only_when_available()
{
tap(Facades\Collection::make('pages')->routes('{slug}'))->sites(['en'])->save();

$field = new Field('test', [
'type' => 'link',
'default_option' => 'first-child',
'required' => true,
]);

$field->setValue(null);
$field->setParent(Mockery::mock());

$fieldtype = (new Link)->setField($field);

$this->assertEquals('url', $fieldtype->preload()['initialOption']);
}

#[Test]
public function it_preloads_initial_option_of_asset_only_when_available()
{
tap(Facades\Collection::make('pages')->routes('{slug}'))->sites(['en'])->save();

$field = new Field('test', [
'type' => 'link',
'default_option' => 'asset',
'required' => true,
]);

$field->setValue(null);

$fieldtype = (new Link)->setField($field);

$this->assertEquals('url', $fieldtype->preload()['initialOption']);
}

#[Test]
public function it_preloads_the_values_initial_option_when_set()
{
tap(Facades\Collection::make('pages')->routes('{slug}'))->sites(['en'])->save();

$field = new Field('test', [
'type' => 'link',
'default_option' => 'entry',
]);

$field->setValue('https://example.com');

$fieldtype = (new Link)->setField($field);

$this->assertEquals('url', $fieldtype->preload()['initialOption']);
}
}
Loading