consumers.install in Consumers 8

Install, update and uninstall functions for Consumers.

File

consumers.install

<?php

/**
 * @file
 * Install, update and uninstall functions for Consumers.
 */
use Drupal\consumers\Entity\Consumer;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\StringTranslation\TranslatableMarkup;

/**
 * Implements hook_install().
 */
function consumers_install() {
  Consumer::create([
    'label' => 'Default Consumer',
    'description' => 'This is the default consumer. This was created programmatically when the Consumers module was first installed. Feel free to edit, or delete this.',
    'is_default' => TRUE,
  ])
    ->save();
}

/**
 * Add field 'third_party' when not exist.
 */
function consumers_update_8101() {

  // Replaced by consumers_update_8102().
}

/**
 * Add field 'third_party' using the entity system.
 */
function consumers_update_8102() {
  $field_definition = BaseFieldDefinition::create('boolean')
    ->setLabel(new TranslatableMarkup('Is this consumer 3rd party?'))
    ->setDescription(new TranslatableMarkup('Mark this if the organization behind this consumer is not the same as the one behind the Drupal API.'))
    ->setDisplayOptions('view', [
    'label' => 'inline',
    'type' => 'boolean',
    'weight' => 4,
  ])
    ->setDisplayOptions('form', [
    'weight' => 4,
  ])
    ->setRevisionable(TRUE)
    ->setTranslatable(TRUE)
    ->setDefaultValue(TRUE)
    ->setInitialValue(TRUE);
  \Drupal::entityDefinitionUpdateManager()
    ->installFieldStorageDefinition('third_party', 'consumer', 'consumers', $field_definition);
}

/**
 * Make consumers translatable.
 */
function consumers_update_8103() {

  // Replaced by consumers_post_update_make_consumer_entity_type_translatable().
}

/**
 * Add field 'is_default'.
 */
function consumers_update_8104() {
  $field_definition = BaseFieldDefinition::create('boolean')
    ->setLabel(new TranslatableMarkup('Is this the default consumer?'))
    ->setDescription(new TranslatableMarkup('There can only be one default consumer. Mark this to use this consumer when none other applies.'))
    ->setDisplayOptions('view', [
    'label' => 'inline',
    'type' => 'boolean',
    'weight' => 4,
  ])
    ->setDisplayOptions('form', [
    'weight' => 4,
  ])
    ->setRevisionable(TRUE)
    ->setTranslatable(TRUE)
    ->setDefaultValue(FALSE)
    ->setInitialValue(FALSE);
  \Drupal::entityDefinitionUpdateManager()
    ->installFieldStorageDefinition('is_default', 'consumer', 'consumers', $field_definition);
}

/**
 * Create a default consumer.
 */
function consumers_update_8105() {
  Consumer::create([
    'label' => 'Default Consumer',
    'description' => 'This is the default consumer. This was created programmatically when the Consumers module was first installed. Feel free to edit, or delete this.',
    'is_default' => TRUE,
  ])
    ->save();
}

/**
 * Update entity definition to add the "owner" key and adapt the field.
 */
function consumers_update_8106() {
  $edum = \Drupal::entityDefinitionUpdateManager();
  $entity_type = $edum
    ->getEntityType('consumer');
  $keys = $entity_type
    ->getKeys();
  $owner_key = 'owner_id';
  $entity_type
    ->set('entity_keys', $keys + [
    'owner' => $owner_key,
  ]);
  $edum
    ->updateEntityType($entity_type);
  $field_definition = BaseFieldDefinition::create('entity_reference')
    ->setLabel(new TranslatableMarkup('User ID'))
    ->setSetting('target_type', 'user')
    ->setTranslatable($entity_type
    ->isTranslatable())
    ->setDefaultValueCallback(Consumer::class . '::getDefaultEntityOwner');
  $field_storage_definition = $field_definition
    ->getFieldStorageDefinition();
  $has_original = (bool) $edum
    ->getFieldStorageDefinition($owner_key, $field_storage_definition
    ->getTargetEntityTypeId());
  $has_original ? $edum
    ->updateFieldStorageDefinition($field_storage_definition) : $edum
    ->installFieldStorageDefinition('owner_id', 'consumer', 'consumers', $field_definition);
}

/**
 * Fix image field widget plugin ID. Was image, should be image_image.
 *
 * https://www.drupal.org/project/consumers/issues/3105435
 */
function consumers_update_8107() {
  $definition_update_manager = \Drupal::entityDefinitionUpdateManager();
  $image_field = $definition_update_manager
    ->getFieldStorageDefinition('image', 'consumer');
  $options = $image_field
    ->getDisplayOptions('form');
  if ($options['type'] === 'image') {
    $options['type'] = 'image_image';
    $image_field
      ->setDisplayOptions('form', $options);
    $definition_update_manager
      ->installFieldStorageDefinition('image', 'consumer', 'consumer', $image_field);
  }
}

Functions

Name	Description
consumers_install	Implements hook_install().
consumers_update_8101	Add field 'third_party' when not exist.
consumers_update_8102	Add field 'third_party' using the entity system.
consumers_update_8103	Make consumers translatable.
consumers_update_8104	Add field 'is_default'.
consumers_update_8105	Create a default consumer.
consumers_update_8106	Update entity definition to add the "owner" key and adapt the field.
consumers_update_8107	Fix image field widget plugin ID. Was image, should be image_image.