class ViewModesInventoryFactory in View Modes Inventory - Bootstrap Ready 8.2

View Modes Inventory Factory.

Hierarchy

• class \Drupal\vmi\ViewModesInventoryFactory implements ContainerInjectionInterface uses StringTranslationTrait

1 file declares its use of ViewModesInventoryFactory

vmi.module in ./vmi.module

Display Suite core functions.

1 string reference to 'ViewModesInventoryFactory'

vmi.services.yml in ./vmi.services.yml

vmi.services.yml

1 service uses ViewModesInventoryFactory

vmi.factory in ./vmi.services.yml

Drupal\vmi\ViewModesInventoryFactory

File

src/ViewModesInventoryFactory.php, line 16

Namespace

Drupal\vmi

class ViewModesInventoryFactory implements ContainerInjectionInterface {
  use StringTranslationTrait;

  /**
   * The config factory service.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Constructs the View Modes Inventory Factory object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
   *   The translation service. for form alters.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, TranslationInterface $translation, ModuleHandlerInterface $module_handler) {
    $this->configFactory = $config_factory;
    $this->stringTranslation = $translation;
    $this->moduleHandler = $module_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('string_translation'), $container
      ->get('module_handler'));
  }

  /**
   * Get data from view_modes.list.yml file.
   *
   * @return array
   *   Data array for the list of default view modes.
   *
   * @throws Exception
   */
  public function getViewModesList() {
    $module_path = $this->moduleHandler
      ->getModule('vmi')
      ->getPath();
    $vmi_filename = DRUPAL_ROOT . '/' . $module_path . '/src/assets/view_modes.list.vmi.yml';
    if (is_file($vmi_filename)) {
      $vmi_list = (array) Yaml::parse(file_get_contents($vmi_filename));
      return $vmi_list;
    }
    else {
      $lookup_message = $this
        ->t('View modes inventory layouts list file does not exist!');
      throw new \Exception($lookup_message);
    }
  }

  /**
   * Get get data from layouts.mapping.yml file.
   *
   * @return array
   *   Data array for the default mapping layouts with view modes.
   *
   * @throws Exception
   */
  public function getLayoutsMapping() {
    $module_path = $this->moduleHandler
      ->getModule('vmi')
      ->getPath();
    $vmi_layout_filename = DRUPAL_ROOT . '/' . $module_path . '/src/assets/layouts.mapping.vmi.yml';
    if (is_file($vmi_layout_filename)) {
      $vmi_layout_list = (array) Yaml::parse(file_get_contents($vmi_layout_filename));
      return $vmi_layout_list;
    }
    else {
      $lookup_message = $this
        ->t('View modes inventory layouts list file does not exist!');
      throw new \Exception($lookup_message);
    }
  }

  /**
   * Map a view mode with a layout and default configuration template.
   *
   * @param string $selected_view_mode
   *   Selected view mode in the custom display settings form.
   * @param string $default_mapped_layout
   *   Default mapped layout.
   * @param string $entity_type
   *   Entity type like node, block, user.
   * @param string $bundle_name
   *   Bundle name.
   * @param string $config_template_file
   *   Config template file name.
   * @param string $config_name
   *   Config name to map to.
   */
  public function mapViewModeWithLayout($selected_view_mode, $default_mapped_layout, $entity_type, $bundle_name, $config_template_file, $config_name) {

    // Replace CONTENT_TYPE_NAME with the bundle name for the config name.
    $real_config_name = str_replace('CONTENT_TYPE_NAME', $bundle_name, $config_name);
    $view_mode_config = $this->configFactory
      ->getEditable($real_config_name);

    // Load the config template.
    $module_path = $this->moduleHandler
      ->getModule('vmi')
      ->getPath();
    $full_config_template_file = DRUPAL_ROOT . '/' . $module_path . $config_template_file;
    $config_template_content = file_get_contents($full_config_template_file);

    // Replace CONTENT_TYPE_NAME with the bundle name in the config template.
    $real_config_template_content = str_replace('CONTENT_TYPE_NAME', $bundle_name, $config_template_content);

    // Parse real config template conten to data.
    $real_config_template_content_data = (array) Yaml::parse($real_config_template_content);

    // Set and save new message value.
    $view_mode_config
      ->setData($real_config_template_content_data)
      ->save();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
ViewModesInventoryFactory::$configFactory	protected	property	The config factory service.
ViewModesInventoryFactory::$moduleHandler	protected	property	The module handler service.
ViewModesInventoryFactory::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
ViewModesInventoryFactory::getLayoutsMapping	public	function	Get get data from layouts.mapping.yml file.
ViewModesInventoryFactory::getViewModesList	public	function	Get data from view_modes.list.yml file.
ViewModesInventoryFactory::mapViewModeWithLayout	public	function	Map a view mode with a layout and default configuration template.
ViewModesInventoryFactory::__construct	public	function	Constructs the View Modes Inventory Factory object.