];
/**
- * Admin user
+ * Admin user.
*
* @var \Drupal\Core\Session\AccountInterface
*/
*
* @var array
*/
- protected $base_perms = [
+ protected $basePerms = [
'access administration pages',
'administer meta tags',
];
*
* @var array
*/
- protected $entity_perms = [];
+ protected $entityPerms = [];
/**
* The entity type that is being tested.
*
* @var string
*/
- protected $entity_type = '';
+ protected $entityType = '';
/**
* The formal name for this entity type.
*
* @var string
*/
- protected $entity_label = '';
+ protected $entityLabel = '';
/**
* The entity bundle that is being tested.
*
* @var string
*/
- protected $entity_bundle = '';
+ protected $entityBundle = '';
/**
* The path to add an object for this entity type.
*
* @var string
*/
- protected $entity_add_path = '';
+ protected $entityAddPath = '';
/**
* The path to access the field admin for this entity bundle.
+ *
+ * @var string
*/
- protected $entity_field_admin_path = '';
+ protected $entityFieldAdminPath = '';
/**
* Whether or not this entity type supports default meta tag values.
*
* @var bool
*/
- protected $entity_supports_defaults = TRUE;
+ protected $entitySupportsDefaults = TRUE;
/**
* The label used on the entity form for the 'save' action.
*
* @var string
*/
- protected $entity_save_button_label = 'Save';
+ protected $entitySaveButtonLabel = 'Save';
/**
* The name of the primary title or name field for this entity.
*
* @var string
*/
- protected $entity_title_field = 'title';
+ protected $entityTitleField = 'title';
/**
- * {@inheritDoc}
+ * {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
// Merge the base permissions with the custom ones for the entity type and
// create a user with these permissions.
- $all_perms = array_merge($this->base_perms, $this->entity_perms);
+ $all_perms = array_merge($this->basePerms, $this->entityPerms);
$this->adminUser = $this->drupalCreateUser($all_perms);
$this->drupalGet('/user/login');
$this->assertResponse(200);
$this->drupalLogin($this->adminUser);
}
+ /**
+ * {@inheritdoc}
+ */
+ protected function verbose($message, $title = NULL) {
+ // Handle arrays, objects, etc.
+ if (!is_string($message)) {
+ $message = "<pre>\n" . print_r($message, TRUE) . "\n</pre>\n";
+ }
+
+ // Optional title to go before the output.
+ if (!empty($title)) {
+ $title = '<h2>' . Html::escape($title) . "</h2>\n";
+ }
+
+ parent::verbose($title . $message);
+ }
+
/**
* Any additional configuration that's needed for this entity type.
*/
protected function setUpEntityType() {}
/**
- * A list of default values to add to the entity being created. If left empty
- * it will default to "{$entity_title_field}[0][value]" => $title.
+ * A list of default values to add to the entity being created.
+ *
+ * Defaults to "{$entityTitleField}[0][value]" => $title.
*
* @return array
+ * Default values.
*/
- protected function entity_default_values() {}
+ protected function entityDefaultValues() {
+ return [];
+ }
/**
* Add a Metatag field to this entity type.
*/
protected function addField() {
// Add a metatag field to the entity type test_entity.
- $this->drupalGet($this->entity_field_admin_path . '/add-field');
+ $this->drupalGet($this->entityFieldAdminPath . '/add-field');
$this->assertResponse(200);
$edit = [
'label' => 'Metatag',
}
/**
- * Confirm that the global default values work correctly when there are no
- * entity or bundle defaults available.
+ * Confirm that the global default values work correctly.
+ *
+ * Specifically when there are no entity or bundle defaults available.
*/
public function testGlobalDefaultsInheritance() {
// First we set global defaults.
$this->drupalGet('admin/config/search/metatag/global');
$this->assertResponse(200);
$global_values = [
- 'metatag_test' => 'Global description',
+ 'metatag_test_tag' => 'Global description',
];
$this->drupalPostForm(NULL, $global_values, 'Save');
$this->assertText('Saved the Global Metatag defaults.');
// Now when we create an entity, global defaults are used to fill the form
// fields.
- $this->drupalGet($this->entity_add_path);
+ $this->drupalGet($this->entityAddPath);
$this->assertResponse(200);
- $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test'], t('The metatag_test field has the global default as the field default does not define it.'));
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test_tag]', $global_values['metatag_test_tag'], t('The metatag_test_tag field has the global default as the field default does not define it.'));
}
/**
*/
public function testEntityDefaultsInheritance() {
// This test doesn't make sense if the entity doesn't support defaults.
- if (!$this->entity_supports_defaults) {
+ if (!$this->entitySupportsDefaults) {
return;
}
$this->drupalGet('admin/config/search/metatag/global');
$this->assertResponse(200);
$global_values = [
- 'metatag_test' => 'Global description',
+ 'metatag_test_tag' => 'Global description',
];
$this->drupalPostForm(NULL, $global_values, 'Save');
$this->assertText(strip_tags(t('Saved the %label Metatag defaults.', ['%label' => t('Global')])));
// Set an entity default.
- $this->drupalGet('admin/config/search/metatag/' . $this->entity_type);
+ $this->drupalGet('admin/config/search/metatag/' . $this->entityType);
$this->assertResponse(200);
$entity_values = [
- 'metatag_test' => 'Entity description',
+ 'metatag_test_tag' => 'Entity description',
];
$this->drupalPostForm(NULL, $entity_values, 'Save');
- $this->assertText(strip_tags(t('Saved the %label Metatag defaults.', ['%label' => t($this->entity_label)])));
+ $this->assertText(strip_tags(t('Saved the %label Metatag defaults.', ['%label' => t($this->entityLabel)])));
// Add the field to this entity type.
$this->addField();
// Load the entity form for this entity type.
- $this->drupalGet($this->entity_add_path);
+ $this->drupalGet($this->entityAddPath);
$this->assertResponse(200);
$this->assertNoText('Fatal error');
// Allow the fields to be customized if needed.
$title = 'Barfoo';
- $edit = $this->entity_default_values();
+ $edit = $this->entityDefaultValues();
if (empty($edit)) {
$edit = [
- $this->entity_title_field . '[0][value]' => $title,
+ $this->entityTitleField . '[0][value]' => $title,
];
}
// If this entity type supports defaults then verify the global default is
// not present but that the entity default *is* present.
- $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $entity_values['metatag_test']);
- $this->assertNoFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test']);
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test_tag]', $entity_values['metatag_test_tag']);
+ $this->assertNoFieldByName('field_metatag[0][basic][metatag_test_tag]', $global_values['metatag_test_tag']);
}
/**
- * Confirm that the default values for an entity bundle will work correctly
- * when there is no field for overriding the defaults.
+ * Confirm that the default values for an entity bundle work.
+ *
+ * When there is no field for overriding the defaults.
+ *
+ * @todo
*/
- // @todo
- // public function testBundleDefaultsInheritance() {
- // }
+ public function testBundleDefaultsInheritance() {
+ }
/**
* Confirm a field can be added to the entity bundle.
*/
public function testFieldCanBeAdded() {
- $this->drupalGet($this->entity_field_admin_path . '/add-field');
+ $this->drupalGet($this->entityFieldAdminPath . '/add-field');
$this->assertResponse(200);
$this->assertRaw('<option value="metatag">' . t('Meta tags') . '</option>');
}
$this->addField();
// Load the entity's form.
- $this->drupalGet($this->entity_add_path);
+ $this->drupalGet($this->entityAddPath);
$this->assertResponse(200);
$this->assertNoText('Fatal error');
- $this->assertFieldByName('field_metatag[0][basic][metatag_test]');
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test_tag]');
}
/**
- * Confirm that the default values load correctly for an entity created before
- * the custom field is added.
+ * Confirm that the default values load correctly for an entity created.
+ *
+ * Before the custom field is added.
*/
public function testEntityFieldValuesOldEntity() {
// Set a global default.
$this->drupalGet('admin/config/search/metatag/global');
$this->assertResponse(200);
$global_values = [
- 'metatag_test' => 'Global description',
+ 'metatag_test_tag' => 'Global description',
];
$this->drupalPostForm(NULL, $global_values, 'Save');
$this->assertText(strip_tags(t('Saved the %label Metatag defaults.', ['%label' => t('Global')])));
// Set an entity default if it's supported by the entity type.
- if ($this->entity_supports_defaults) {
- $this->drupalGet('admin/config/search/metatag/' . $this->entity_type);
+ if ($this->entitySupportsDefaults) {
+ $this->drupalGet('admin/config/search/metatag/' . $this->entityType);
$this->assertResponse(200);
$entity_values = [
- 'metatag_test' => 'Entity description',
+ 'metatag_test_tag' => 'Entity description',
];
$this->drupalPostForm(NULL, $entity_values, 'Save');
- $this->assertText(strip_tags(t('Saved the %label Metatag defaults.', ['%label' => t($this->entity_label)])));
+ $this->assertText(strip_tags(t('Saved the %label Metatag defaults.', ['%label' => t($this->entityLabel)])));
}
// Load the entity form for this entity type.
$title = 'Barfoo';
- $this->drupalGet($this->entity_add_path);
+ $this->drupalGet($this->entityAddPath);
$this->assertResponse(200);
$this->assertNoText('Fatal error');
// Allow the fields to be customized if needed.
- $edit = $this->entity_default_values();
+ $edit = $this->entityDefaultValues();
if (empty($edit)) {
$edit = [
- $this->entity_title_field . '[0][value]' => $title,
+ $this->entityTitleField . '[0][value]' => $title,
];
}
// Create a new entity object.
- $this->drupalPostForm(NULL, $edit, t($this->entity_save_button_label));
+ $this->drupalPostForm(NULL, $edit, t($this->entitySaveButtonLabel));
$entities = \Drupal::entityTypeManager()
- ->getStorage($this->entity_type)
- ->loadByProperties([$this->entity_title_field => $title]);
+ ->getStorage($this->entityType)
+ ->loadByProperties([$this->entityTitleField => $title]);
$this->assertEqual(1, count($entities), 'Entity was saved');
$entity = reset($entities);
// @todo Confirm the values output correctly.
-
// Add a field to the entity type.
$this->addField();
// If this entity type supports defaults then verify the global default is
// not present but that the entity default *is* present.
- if ($this->entity_supports_defaults) {
- $this->assertNoFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test']);
- $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $entity_values['metatag_test']);
+ if ($this->entitySupportsDefaults) {
+ $this->assertNoFieldByName('field_metatag[0][basic][metatag_test_tag]', $global_values['metatag_test_tag']);
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test_tag]', $entity_values['metatag_test_tag']);
}
else {
- $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test']);
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test_tag]', $global_values['metatag_test_tag']);
}
// @todo Confirm the values output correctly.
}
/**
- * Confirm that the default values load correctly for an entity created after
- * the custom field is added.
+ * Confirm that the default values load correctly.
+ *
+ * For an entity created after the custom field is added.
*/
public function testEntityFieldValuesNewEntity() {
// Set a global default.
$this->drupalGet('admin/config/search/metatag/global');
$this->assertResponse(200);
$global_values = [
- 'metatag_test' => 'Global description',
+ 'metatag_test_tag' => 'Global description',
];
$this->drupalPostForm(NULL, $global_values, 'Save');
$this->assertText(strip_tags(t('Saved the %label Metatag defaults.', ['%label' => t('Global')])));
// Set an entity default if it's supported by the entity type.
- if ($this->entity_supports_defaults) {
- $this->drupalGet('admin/config/search/metatag/' . $this->entity_type);
+ if ($this->entitySupportsDefaults) {
+ $this->drupalGet('admin/config/search/metatag/' . $this->entityType);
$this->assertResponse(200);
$entity_values = [
- 'metatag_test' => 'Entity description',
+ 'metatag_test_tag' => 'Entity description',
];
$this->drupalPostForm(NULL, $entity_values, 'Save');
- $this->assertText(strip_tags(t('Saved the %label Metatag defaults.', ['%label' => t($this->entity_label)])));
+ $this->assertText(strip_tags(t('Saved the %label Metatag defaults.', ['%label' => t($this->entityLabel)])));
}
// Add a field to the entity type.
// Load the entity form for this entity type.
$title = 'Barfoo';
- $this->drupalGet($this->entity_add_path);
+ $this->drupalGet($this->entityAddPath);
$this->assertResponse(200);
$this->assertNoText('Fatal error');
// If this entity type supports defaults then verify the global default is
// not present but that the entity default *is* present.
- if ($this->entity_supports_defaults) {
- $this->assertNoFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test']);
- $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $entity_values['metatag_test']);
+ if ($this->entitySupportsDefaults) {
+ $this->assertNoFieldByName('field_metatag[0][basic][metatag_test_tag]', $global_values['metatag_test_tag']);
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test_tag]', $entity_values['metatag_test_tag']);
}
else {
- $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test']);
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test_tag]', $global_values['metatag_test_tag']);
}
// Allow the fields to be customized if needed.
- $edit = $this->entity_default_values();
+ $edit = $this->entityDefaultValues();
if (empty($edit)) {
$edit = [
- $this->entity_title_field . '[0][value]' => $title,
+ $this->entityTitleField . '[0][value]' => $title,
];
}
// Create a new entity object.
- $this->drupalPostForm(NULL, $edit, t($this->entity_save_button_label));
+ $this->drupalPostForm(NULL, $edit, t($this->entitySaveButtonLabel));
$entities = \Drupal::entityTypeManager()
- ->getStorage($this->entity_type)
- ->loadByProperties([$this->entity_title_field => $title]);
+ ->getStorage($this->entityType)
+ ->loadByProperties([$this->entityTitleField => $title]);
$this->assertEqual(1, count($entities), 'Entity was saved');
$entity = reset($entities);
// @todo Confirm the values output correctly.
-
// Open the 'edit' form for the entity.
$this->drupalGet($entity->toUrl('edit-form'));
$this->assertResponse(200);
// If this entity type supports defaults then verify the global default is
// not present but that the entity default *is* present.
- if ($this->entity_supports_defaults) {
- $this->assertNoFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test']);
- $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $entity_values['metatag_test']);
+ if ($this->entitySupportsDefaults) {
+ $this->assertNoFieldByName('field_metatag[0][basic][metatag_test_tag]', $global_values['metatag_test_tag']);
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test_tag]', $entity_values['metatag_test_tag']);
}
else {
- $this->assertFieldByName('field_metatag[0][basic][metatag_test]', $global_values['metatag_test']);
+ $this->assertFieldByName('field_metatag[0][basic][metatag_test_tag]', $global_values['metatag_test_tag']);
}
// @todo Confirm the values output correctly.
/**
* Tests adding and editing values on a given entity type.
+ *
+ * @todo Finish this.
*/
- public function tofix_testEntityField() {
+ public function tofixTestEntityField() {
// Add a field to the entity type.
$this->addField();
// Create a test entity.
- $this->drupalGet($this->entity_add_path);
+ $this->drupalGet($this->entityAddPath);
$this->assertResponse(200);
$this->assertNoText('Fatal error');
- $edit = $this->entity_default_values($title) + [
- 'field_metatag[0][basic][metatag_test]' => 'Kilimanjaro',
+ $edit = $this->entityDefaultValues($title) + [
+ 'field_metatag[0][basic][metatag_test_tag]' => 'Kilimanjaro',
];
$this->drupalPostForm(NULL, $edit, t('Save'));
$entities = \Drupal::entityTypeManager()
->getStorage('entity_test')
- ->loadByProperties([$this->entity_title_field => 'Barfoo']);
+ ->loadByProperties([$this->entityTitleField => 'Barfoo']);
$this->assertEqual(1, count($entities), 'Entity was saved');
$entity = reset($entities);
// up.
$this->drupalGet($entity->toUrl());
$this->assertResponse(200);
- $elements = $this->cssSelect('meta[name=metatag_test]');
- $this->assertTrue(count($elements) === 1, 'Found keywords metatag_test from defaults');
- $this->assertEqual((string) $elements[0]['content'], 'Kilimanjaro', 'Field value for metatag_test found when no default set.');
+ $elements = $this->cssSelect('meta[name=metatag_test_tag]');
+ $this->assertTrue(count($elements) === 1, 'Found keywords metatag_test_tag from defaults');
+ $this->assertEqual((string) $elements[0]['content'], 'Kilimanjaro', 'Field value for metatag_test_tag found when no default set.');
- // @TODO: This should not be required, but metatags does not invalidate
+ // @todo This should not be required, but meta tags does not invalidate
// cache upon setting globals.
Cache::invalidateTags(['entity_test:' . $entity->id()]);
$this->drupalGet('admin/config/search/metatag/global');
$this->assertResponse(200);
$values = [
- 'metatag_test' => 'Purple monkey dishwasher',
+ 'metatag_test_tag' => 'Purple monkey dishwasher',
];
$this->drupalPostForm(NULL, $values, 'Save');
$this->assertText('Saved the Global Metatag defaults.');
$this->drupalGet($entity->toUrl());
$this->assertResponse(200);
- $elements = $this->cssSelect('meta[name=metatag_test]');
+ $elements = $this->cssSelect('meta[name=metatag_test_tag]');
$this->assertTrue(count($elements) === 1, 'Found test metatag from defaults');
$this->verbose('<pre>' . print_r($elements, TRUE) . '</pre>');
- $this->assertEqual((string) $elements[0]['content'], $values['metatag_test']);//, 'Default metatag_test value found.');
+ $this->assertEqual((string) $elements[0]['content'], $values['metatag_test_tag']);
}
}
projects / yaffs-website / blobdiff