Commit b66af73c authored by larowlan's avatar larowlan

Issue #2918500 by tim.plunkett, EclipseGc, tedbow, larowlan, jibran, Wim...

Issue #2918500 by tim.plunkett, EclipseGc, tedbow, larowlan, jibran, Wim Leers, phenaproxima, amateescu, borisson_, samuel.mortenson, gaurav.kapoor, KarlShea, hctom, mroycroft, neerajsingh, DamienMcKenna, dsnopek, Xano, TravisCarden, Tim Bozeman: Create a block which can render entity fields
parent 81b76763
...@@ -55,29 +55,7 @@ core.entity_view_display.*.*.*: ...@@ -55,29 +55,7 @@ core.entity_view_display.*.*.*:
type: sequence type: sequence
label: 'Field formatters' label: 'Field formatters'
sequence: sequence:
type: mapping type: field_formatter.entity_view_display
label: 'Field formatter'
mapping:
type:
type: string
label: 'Format type machine name'
weight:
type: integer
label: 'Weight'
region:
type: string
label: 'Region'
label:
type: string
label: 'Label setting machine name'
settings:
type: field.formatter.settings.[%parent.type]
label: 'Settings'
third_party_settings:
type: sequence
label: 'Third party settings'
sequence:
type: field.formatter.third_party.[%key]
hidden: hidden:
type: sequence type: sequence
label: 'Field display setting' label: 'Field display setting'
...@@ -85,6 +63,35 @@ core.entity_view_display.*.*.*: ...@@ -85,6 +63,35 @@ core.entity_view_display.*.*.*:
type: boolean type: boolean
label: 'Value' label: 'Value'
field_formatter:
type: mapping
label: 'Field formatter'
mapping:
type:
type: string
label: 'Format type machine name'
label:
type: string
label: 'Label setting machine name'
settings:
type: field.formatter.settings.[%parent.type]
label: 'Settings'
third_party_settings:
type: sequence
label: 'Third party settings'
sequence:
type: field.formatter.third_party.[%key]
field_formatter.entity_view_display:
type: field_formatter
mapping:
weight:
type: integer
label: 'Weight'
region:
type: string
label: 'Region'
# Overview configuration information for form mode displays. # Overview configuration information for form mode displays.
core.entity_form_display.*.*.*: core.entity_form_display.*.*.*:
type: config_entity type: config_entity
...@@ -362,3 +369,8 @@ field.formatter.settings.entity_reference_label: ...@@ -362,3 +369,8 @@ field.formatter.settings.entity_reference_label:
type: boolean type: boolean
label: 'Link label to the referenced entity' label: 'Link label to the referenced entity'
block.settings.field_block:*:*:
type: block_settings
mapping:
formatter:
type: field_formatter
...@@ -105,6 +105,10 @@ public function listBlocks(Request $request, $theme) { ...@@ -105,6 +105,10 @@ public function listBlocks(Request $request, $theme) {
$definitions = $this->blockManager->getDefinitionsForContexts($this->contextRepository->getAvailableContexts()); $definitions = $this->blockManager->getDefinitionsForContexts($this->contextRepository->getAvailableContexts());
// Order by category, and then by admin label. // Order by category, and then by admin label.
$definitions = $this->blockManager->getSortedDefinitions($definitions); $definitions = $this->blockManager->getSortedDefinitions($definitions);
// Filter out definitions that are not intended to be placed by the UI.
$definitions = array_filter($definitions, function (array $definition) {
return empty($definition['_block_ui_hidden']);
});
$region = $request->query->get('region'); $region = $request->query->get('region');
$weight = $request->query->get('weight'); $weight = $request->query->get('weight');
......
This diff is collapsed.
<?php
namespace Drupal\layout_builder\Plugin\Derivative;
use Drupal\Component\Plugin\Derivative\DeriverBase;
use Drupal\Component\Plugin\PluginBase;
use Drupal\Core\Entity\EntityFieldManagerInterface;
use Drupal\Core\Entity\EntityTypeRepositoryInterface;
use Drupal\Core\Field\FieldTypePluginManagerInterface;
use Drupal\Core\Field\FormatterPluginManager;
use Drupal\Core\Plugin\Context\ContextDefinition;
use Drupal\Core\Plugin\Discovery\ContainerDeriverInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Provides entity field block definitions for every field.
*
* @internal
*/
class FieldBlockDeriver extends DeriverBase implements ContainerDeriverInterface {
use StringTranslationTrait;
/**
* The entity type repository.
*
* @var \Drupal\Core\Entity\EntityTypeRepositoryInterface
*/
protected $entityTypeRepository;
/**
* The entity field manager.
*
* @var \Drupal\Core\Entity\EntityFieldManagerInterface
*/
protected $entityFieldManager;
/**
* The field type manager.
*
* @var \Drupal\Core\Field\FieldTypePluginManagerInterface
*/
protected $fieldTypeManager;
/**
* The formatter manager.
*
* @var \Drupal\Core\Field\FormatterPluginManager
*/
protected $formatterManager;
/**
* Constructs new FieldBlockDeriver.
*
* @param \Drupal\Core\Entity\EntityTypeRepositoryInterface $entity_type_repository
* The entity type repository.
* @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
* The entity field manager.
* @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager
* The field type manager.
* @param \Drupal\Core\Field\FormatterPluginManager $formatter_manager
* The formatter manager.
*/
public function __construct(EntityTypeRepositoryInterface $entity_type_repository, EntityFieldManagerInterface $entity_field_manager, FieldTypePluginManagerInterface $field_type_manager, FormatterPluginManager $formatter_manager) {
$this->entityTypeRepository = $entity_type_repository;
$this->entityFieldManager = $entity_field_manager;
$this->fieldTypeManager = $field_type_manager;
$this->formatterManager = $formatter_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, $base_plugin_id) {
return new static(
$container->get('entity_type.repository'),
$container->get('entity_field.manager'),
$container->get('plugin.manager.field.field_type'),
$container->get('plugin.manager.field.formatter')
);
}
/**
* {@inheritdoc}
*/
public function getDerivativeDefinitions($base_plugin_definition) {
$entity_type_labels = $this->entityTypeRepository->getEntityTypeLabels();
foreach ($this->entityFieldManager->getFieldMap() as $entity_type_id => $entity_field_map) {
foreach ($this->entityFieldManager->getFieldStorageDefinitions($entity_type_id) as $field_storage_definition) {
$derivative = $base_plugin_definition;
$field_name = $field_storage_definition->getName();
// The blocks are based on fields. However, we are looping through field
// storages for which no fields may exist. If that is the case, skip
// this field storage.
if (!isset($entity_field_map[$field_name])) {
continue;
}
$field_info = $entity_field_map[$field_name];
// Skip fields without any formatters.
$options = $this->formatterManager->getOptions($field_storage_definition->getType());
if (empty($options)) {
continue;
}
// Store the default formatter on the definition.
$derivative['default_formatter'] = '';
$field_type_definition = $this->fieldTypeManager->getDefinition($field_storage_definition->getType());
if (isset($field_type_definition['default_formatter'])) {
$derivative['default_formatter'] = $field_type_definition['default_formatter'];
}
// Get the admin label for both base and configurable fields.
if ($field_storage_definition->isBaseField()) {
$admin_label = $field_storage_definition->getLabel();
}
else {
// We take the field label used on the first bundle.
$first_bundle = reset($field_info['bundles']);
$bundle_field_definitions = $this->entityFieldManager->getFieldDefinitions($entity_type_id, $first_bundle);
// The field storage config may exist, but it's possible that no
// fields are actually using it. If that's the case, skip to the next
// field.
if (empty($bundle_field_definitions[$field_name])) {
continue;
}
$admin_label = $bundle_field_definitions[$field_name]->getLabel();
}
// Set plugin definition for derivative.
$derivative['category'] = $this->t('@entity', ['@entity' => $entity_type_labels[$entity_type_id]]);
$derivative['admin_label'] = $admin_label;
$bundles = array_keys($field_info['bundles']);
// For any field that is not display configurable, mark it as
// unavailable to place in the block UI.
$block_ui_hidden = TRUE;
foreach ($bundles as $bundle) {
$field_definition = $this->entityFieldManager->getFieldDefinitions($entity_type_id, $bundle)[$field_name];
if ($field_definition->isDisplayConfigurable('view')) {
$block_ui_hidden = FALSE;
break;
}
}
$derivative['_block_ui_hidden'] = $block_ui_hidden;
$derivative['bundles'] = $bundles;
$context_definition = new ContextDefinition('entity:' . $entity_type_id, $entity_type_labels[$entity_type_id], TRUE);
// Limit available blocks by bundles to which the field is attached.
// @todo To workaround https://www.drupal.org/node/2671964 this only
// adds a bundle constraint if the entity type has bundles. When an
// entity type has no bundles, the entity type ID itself is used.
if (count($bundles) > 1 || !isset($field_info['bundles'][$entity_type_id])) {
$context_definition->addConstraint('Bundle', $bundles);
}
$derivative['context'] = [
'entity' => $context_definition,
];
$derivative_id = $entity_type_id . PluginBase::DERIVATIVE_SEPARATOR . $field_name;
$this->derivatives[$derivative_id] = $derivative;
}
}
return $this->derivatives;
}
}
<?php
namespace Drupal\Tests\layout_builder\FunctionalJavascript;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\FunctionalJavascriptTests\JavascriptTestBase;
/**
* @coversDefaultClass \Drupal\layout_builder\Plugin\Block\FieldBlock
*
* @group field
*/
class FieldBlockTest extends JavascriptTestBase {
/**
* {@inheritdoc}
*/
public static $modules = ['block', 'datetime', 'layout_builder', 'user'];
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
$field_storage = FieldStorageConfig::create([
'field_name' => 'field_date',
'entity_type' => 'user',
'type' => 'datetime',
]);
$field_storage->save();
$field = FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'user',
'label' => 'Date field',
]);
$field->save();
$user = $this->drupalCreateUser([
'administer blocks',
'access administration pages',
]);
$user->field_date = '1978-11-19T05:00:00';
$user->save();
$this->drupalLogin($user);
}
/**
* Tests configuring a field block for a user field.
*/
public function testFieldBlock() {
$page = $this->getSession()->getPage();
$assert_session = $this->assertSession();
// Assert that the field value is not displayed.
$this->drupalGet('admin');
$assert_session->pageTextNotContains('Sunday, November 19, 1978 - 16:00');
$this->drupalGet('admin/structure/block');
$this->clickLink('Place block');
$assert_session->assertWaitOnAjaxRequest();
// Ensure that fields without any formatters are not available.
$assert_session->pageTextNotContains('Password');
// Ensure that non-display-configurable fields are not available.
$assert_session->pageTextNotContains('Initial email');
$assert_session->pageTextContains('Date field');
$block_url = 'admin/structure/block/add/field_block%3Auser%3Afield_date/classy';
$assert_session->linkByHrefExists($block_url);
$this->drupalGet($block_url);
$page->fillField('region', 'content');
// Assert the default formatter configuration.
$assert_session->fieldValueEquals('settings[formatter][type]', 'datetime_default');
$assert_session->fieldValueEquals('settings[formatter][settings][format_type]', 'medium');
// Change the formatter.
$page->selectFieldOption('settings[formatter][type]', 'datetime_time_ago');
$assert_session->assertWaitOnAjaxRequest();
// Changing the formatter removes the old settings and introduces new ones.
$assert_session->fieldNotExists('settings[formatter][settings][format_type]');
$assert_session->fieldExists('settings[formatter][settings][granularity]');
$page->pressButton('Save block');
$assert_session->pageTextContains('The block configuration has been saved.');
// Configure the block and change the formatter again.
$this->clickLink('Configure');
$page->selectFieldOption('settings[formatter][type]', 'datetime_default');
$assert_session->assertWaitOnAjaxRequest();
$assert_session->fieldValueEquals('settings[formatter][settings][format_type]', 'medium');
$page->selectFieldOption('settings[formatter][settings][format_type]', 'long');
$page->pressButton('Save block');
$assert_session->pageTextContains('The block configuration has been saved.');
// Assert that the field value is updated.
$this->clickLink('Configure');
$assert_session->fieldValueEquals('settings[formatter][settings][format_type]', 'long');
// Assert that the field block is configured as expected.
$expected = [
'label' => 'above',
'type' => 'datetime_default',
'settings' => [
'format_type' => 'long',
'timezone_override' => '',
],
'third_party_settings' => [],
];
$config = $this->container->get('config.factory')->get('block.block.datefield');
$this->assertEquals($expected, $config->get('settings.formatter'));
// Assert that the block is displaying the user field.
$this->drupalGet('admin');
$assert_session->pageTextContains('Sunday, November 19, 1978 - 16:00');
}
}
<?php
namespace Drupal\Tests\layout_builder\Kernel;
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Entity\EntityFieldManagerInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\FieldableEntityInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\FormatterPluginManager;
use Drupal\Core\Plugin\Context\ContextDefinition;
use Drupal\Core\Session\AccountInterface;
use Drupal\KernelTests\Core\Entity\EntityKernelTestBase;
use Drupal\layout_builder\Plugin\Block\FieldBlock;
use Prophecy\Prophecy\ProphecyInterface;
/**
* @coversDefaultClass \Drupal\layout_builder\Plugin\Block\FieldBlock
* @group Field
*/
class FieldBlockTest extends EntityKernelTestBase {
/**
* Tests entity access.
*
* @covers ::blockAccess
* @dataProvider providerTestBlockAccessNotAllowed
*/
public function testBlockAccessEntityNotAllowed($expected, $entity_access) {
$entity = $this->prophesize(FieldableEntityInterface::class);
$block = $this->getTestBlock($entity);
$account = $this->prophesize(AccountInterface::class);
$entity->access('view', $account->reveal(), TRUE)->willReturn($entity_access);
$entity->hasField()->shouldNotBeCalled();
$access = $block->access($account->reveal(), TRUE);
$this->assertSame($expected, $access->isAllowed());
}
/**
* Provides test data for ::testBlockAccessEntityNotAllowed().
*/
public function providerTestBlockAccessNotAllowed() {
$data = [];
$data['entity_forbidden'] = [
FALSE,
AccessResult::forbidden(),
];
$data['entity_neutral'] = [
FALSE,
AccessResult::neutral(),
];
return $data;
}
/**
* Tests unfieldable entity.
*
* @covers ::blockAccess
*/
public function testBlockAccessEntityAllowedNotFieldable() {
$entity = $this->prophesize(EntityInterface::class);
$block = $this->getTestBlock($entity);
$account = $this->prophesize(AccountInterface::class);
$entity->access('view', $account->reveal(), TRUE)->willReturn(AccessResult::allowed());
$access = $block->access($account->reveal(), TRUE);
$this->assertSame(FALSE, $access->isAllowed());
}
/**
* Tests fieldable entity without a particular field.
*
* @covers ::blockAccess
*/
public function testBlockAccessEntityAllowedNoField() {
$entity = $this->prophesize(FieldableEntityInterface::class);
$block = $this->getTestBlock($entity);
$account = $this->prophesize(AccountInterface::class);
$entity->access('view', $account->reveal(), TRUE)->willReturn(AccessResult::allowed());
$entity->hasField('the_field_name')->willReturn(FALSE);
$entity->get('the_field_name')->shouldNotBeCalled();
$access = $block->access($account->reveal(), TRUE);
$this->assertSame(FALSE, $access->isAllowed());
}
/**
* Tests field access.
*
* @covers ::blockAccess
* @dataProvider providerTestBlockAccessNotAllowed
*/
public function testBlockAccessEntityAllowedFieldNotAllowed($expected, $field_access) {
$entity = $this->prophesize(FieldableEntityInterface::class);
$block = $this->getTestBlock($entity);
$account = $this->prophesize(AccountInterface::class);
$entity->access('view', $account->reveal(), TRUE)->willReturn(AccessResult::allowed());
$entity->hasField('the_field_name')->willReturn(TRUE);
$field = $this->prophesize(FieldItemListInterface::class);
$entity->get('the_field_name')->willReturn($field->reveal());
$field->access('view', $account->reveal(), TRUE)->willReturn($field_access);
$field->isEmpty()->shouldNotBeCalled();
$access = $block->access($account->reveal(), TRUE);
$this->assertSame($expected, $access->isAllowed());
}
/**
* Tests populated vs empty build.
*
* @covers ::blockAccess
* @covers ::build
* @dataProvider providerTestBlockAccessEntityAllowedFieldHasValue
*/
public function testBlockAccessEntityAllowedFieldHasValue($expected, $is_empty) {
$entity = $this->prophesize(FieldableEntityInterface::class);
$block = $this->getTestBlock($entity);
$account = $this->prophesize(AccountInterface::class);
$entity->access('view', $account->reveal(), TRUE)->willReturn(AccessResult::allowed());
$entity->hasField('the_field_name')->willReturn(TRUE);
$field = $this->prophesize(FieldItemListInterface::class);
$entity->get('the_field_name')->willReturn($field->reveal());
$field->access('view', $account->reveal(), TRUE)->willReturn(AccessResult::allowed());
$field->isEmpty()->willReturn($is_empty)->shouldBeCalled();
$access = $block->access($account->reveal(), TRUE);
$this->assertSame($expected, $access->isAllowed());
}
/**
* Provides test data for ::testBlockAccessEntityAllowedFieldHasValue().
*/
public function providerTestBlockAccessEntityAllowedFieldHasValue() {
$data = [];
$data['empty'] = [
FALSE,
TRUE,
];
$data['populated'] = [
TRUE,
FALSE,
];
return $data;
}
/**
* Instantiates a block for testing.
*
* @param \Prophecy\Prophecy\ProphecyInterface $entity_prophecy
* An entity prophecy for use as an entity context value.
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param array $plugin_definition
* The plugin implementation definition.
*
* @return \Drupal\layout_builder\Plugin\Block\FieldBlock
* The block to test.
*/
protected function getTestBlock(ProphecyInterface $entity_prophecy, array $configuration = [], array $plugin_definition = []) {
$entity_prophecy->getCacheContexts()->willReturn([]);
$entity_prophecy->getCacheTags()->willReturn([]);
$entity_prophecy->getCacheMaxAge()->willReturn(0);
$plugin_definition += [
'provider' => 'test',
'default_formatter' => '',
'category' => 'Test',
'admin_label' => 'Test Block',
'bundles' => ['entity_test'],
'context' => [
'entity' => new ContextDefinition('entity:entity_test', 'Test', TRUE),
],
];
$entity_field_manager = $this->prophesize(EntityFieldManagerInterface::class);
$formatter_manager = $this->prophesize(FormatterPluginManager::class);
$module_handler = $this->prophesize(ModuleHandlerInterface::class);
$block = new FieldBlock(
$configuration,
'field_block:entity_test:the_field_name',
$plugin_definition,
$entity_field_manager->reveal(),
$formatter_manager->reveal(),
$module_handler->reveal()
);
$block->setContextValue('entity', $entity_prophecy->reveal());
return $block;
}
}
...@@ -81,3 +81,10 @@ function system_post_update_classy_message_library() { ...@@ -81,3 +81,10 @@ function system_post_update_classy_message_library() {
function system_post_update_field_type_plugins() { function system_post_update_field_type_plugins() {
// Empty post-update hook. // Empty post-update hook.
} }
/**
* Clear caches due to schema changes in core.entity.schema.yml.
*/
function system_post_update_field_formatter_entity_schema() {
// Empty post-update hook.
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment