public function SkinPluginManager::processDefinition in Skinr 8.2

Performs extra processing on plugin definitions.

By default we add defaults for the type to the definition. If a type has additional processing logic they can do that by replacing or extending the method.

Overrides DefaultPluginManager::processDefinition

File

src/SkinPluginManager.php, line 123

Contains \Drupal\skinr\SkinPluginManager.

Class

SkinPluginManager

Manages plugins for configuration translation mappers.

Namespace

Drupal\skinr

Code

public function processDefinition(&$definition, $plugin_id) {
  parent::processDefinition($definition, $plugin_id);
  if (!isset($definition['skins']) && !isset($definition['groups'])) {
    throw new InvalidPluginDefinitionException($plugin_id, "The plugin definition of the mapper '{$plugin_id}' does not contain any groups or skins.");
  }

  // Set defaults for groups.
  if (!empty($definition['groups'])) {
    foreach ($definition['groups'] as &$group) {
      $group += [
        'title' => t('Untitled'),
        'description' => '',
        'weight' => 0,
      ];
    }
  }

  // Set defaults for skins.
  if (!empty($definition['skins'])) {

    /** @var \Drupal\Core\Extension\Extension $extension */
    $extension = $this->moduleHandler
      ->getModule($definition['provider']);
    $extension_info = system_get_info($extension
      ->getType(), $extension
      ->getName());
    foreach ($definition['skins'] as $skin_name => &$skin) {
      $skin += [
        'name' => $skin_name,
        'type' => 'checkboxes',
        'group' => 'general',
        'title' => $skin_name,
        'description' => '',
        'theme hooks' => [],
        'attached' => [],
        'options' => [],
        'default status' => 0,
        'status' => [],
        'weight' => 0,
        'source' => [],
      ];

      // Add source information.
      $skin['source'] = [
        'type' => 'module',
        'name' => $extension
          ->getName(),
        'path' => dirname($definition['path']),
        'pathname' => $definition['path'],
        'version' => $extension_info['version'],
      ];

      /* @todo
         if ($extension->getType() == 'theme') {
           $skin['source'] += [
             'base themes' => $this->themeHandler->getBaseThemes($this->themeHandler->listInfo(), $extension->getName()),
             'sub themes' => isset($sub_themes[$name]) ? $sub_themes[$name] : array(),
           ];
         }
         */

      // Merge in default status for all themes.
      $skin['status'] = $this
        ->addStatusDefaults($skin);

      // Validate skin options.
      foreach ($skin['options'] as $option_name => $option) {

        // Validate class by running it through Html::getClass().
        if (!is_array($skin['options'][$option_name]['class'])) {

          // Raise an error.
          \Drupal::logger('skinr')
            ->warning('The class for option %option in skin %skin needs to be an array.', array(
            '%option' => $option_name,
            '%skin' => $skin_name,
          ));

          // Reset to array to prevent errors.
          $skin['options'][$option_name]['class'] = array();
        }
        foreach ($skin['options'][$option_name]['class'] as $key => $class) {
          $skin['options'][$option_name]['class'][$key] = Html::getClass($class);
        }
      }
    }
  }
}