entity.install

Install, update and uninstall functions for the entity module.

File

drupal/core/modules/entity/entity.install
View source
<?php

/**
 * @file
 * Install, update and uninstall functions for the entity module.
 */
use Drupal\Component\Uuid\Uuid;

/**
 * Returns the raw configuration object for an EntityDisplay entity.
 *
 * The function returns the existing configuration entry if it exists, or
 * creates a fresh structure.
 *
 * @param string $entity_type
 *   The entity type.
 * @param string $bundle
 *   The bundle name.
 * @param string $view_mode
 *   The view mode.
 *
 * @return \Drupal\Core\Config\Config
 *   The configuration object.
 */
function _update_8000_entity_get_display($entity_type, $bundle, $view_mode) {
  $id = $entity_type . '.' . $bundle . '.' . $view_mode;
  $config = config("entity.display.{$id}");
  if ($config
    ->get()) {
    return $config;
  }

  // Initialize a fresh structure.
  $uuid = new Uuid();
  $properties = array(
    'id' => $id,
    'uuid' => $uuid
      ->generate(),
    'targetEntityType' => $entity_type,
    'bundle' => $bundle,
    'mode' => $view_mode,
    'content' => array(),
  );
  foreach ($properties as $key => $value) {
    $config
      ->set($key, $value);
  }
  return $config;
}

/**
 * Returns the raw configuration object for an EntityFormDisplay entity.
 *
 * The function returns the existing configuration entry if it exists, or
 * creates a fresh structure.
 *
 * @param string $entity_type
 *   The entity type.
 * @param string $bundle
 *   The bundle name.
 * @param string $form_mode
 *   The form mode.
 *
 * @return \Drupal\Core\Config\Config
 *   The configuration object.
 */
function _update_8000_entity_get_form_display($entity_type, $bundle, $form_mode) {
  $id = $entity_type . '.' . $bundle . '.' . $form_mode;
  $config = config("entity.form_display.{$id}");
  if ($config
    ->get()) {
    return $config;
  }

  // Initialize a fresh structure.
  $uuid = new Uuid();
  $properties = array(
    'id' => $id,
    'uuid' => $uuid
      ->generate(),
    'targetEntityType' => $entity_type,
    'bundle' => $bundle,
    'mode' => $form_mode,
    'content' => array(),
  );
  foreach ($properties as $key => $value) {
    $config
      ->set($key, $value);
  }
  return $config;
}

Functions

Namesort descending Description
_update_8000_entity_get_display Returns the raw configuration object for an EntityDisplay entity.
_update_8000_entity_get_form_display Returns the raw configuration object for an EntityFormDisplay entity.