You are here

Home » API reference » Configuration Management 7.2 » ImageStyleConfiguration.php

class ImageStyleConfiguration in Configuration Management 7.2

Hierarchy

Expanded class hierarchy of ImageStyleConfiguration

File

lib/Drupal/configuration/Config/ImageStyleConfiguration.php, line 13
Definition of Drupal\configuration\Config\ImageStyleConfiguration.

Namespace

Drupal\configuration\Config
View source 
class ImageStyleConfiguration extends Configuration {

  /**
   * Overrides Drupal\configuration\Config\Configuration::getComponentHumanName().
   */
  public static function getComponentHumanName($component, $plural = FALSE) {
    return $plural ? t('Image styles') : t('Image style');
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::getComponent().
   */
  public function getComponent() {
    return 'image_style';
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::supportedComponents().
   */
  public static function supportedComponents() {
    return array(
      'image_style',
    );
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::isActive().
   */
  public static function isActive() {
    return module_exists('image');
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::getAllIdentifiers().
   */
  public static function getAllIdentifiers($component) {
    $identifiers = array();
    foreach (image_styles() as $key => $image_style) {
      $identifiers[$key] = $image_style['name'];
    }
    return $identifiers;
  }

  /**
   * Remove unnecessary keys for export.
   */
  protected function style_sanitize(&$style, $child = FALSE) {
    $omit = $child ? array(
      'isid',
      'ieid',
    ) : array(
      'isid',
      'ieid',
      'module',
    );
    if (is_array($style)) {
      foreach ($style as $k => $v) {
        if (in_array($k, $omit, TRUE)) {
          unset($style[$k]);
        }
        elseif (is_array($v)) {
          $this
            ->style_sanitize($style[$k], TRUE);
        }
      }
    }
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::alterDependencies().
   */
  public static function alterDependencies(Configuration $config) {
    if ($config
      ->getComponent() == 'field') {

      // Check if the field is using a image style
      $field = $config->data['field_instance'];
      if (!empty($field['display'])) {
        foreach ($field['display'] as $display) {
          if (!empty($display['settings']) && !empty($display['settings']['image_style'])) {
            $identifier = $display['settings']['image_style'];
            $image_style = new ImageStyleConfiguration($identifier);
            $image_style
              ->build();
            $config
              ->addToDependencies($image_style);
          }
        }
      }
    }
  }

  /**
   * Overrides Drupal\configuration\Config\Configuration::findRequiredModules().
   */
  public function findRequiredModules() {
    foreach ($this->data['effects'] as $effect) {
      $this
        ->addToModules($effect['module']);
    }
  }

  /**
   * Implements Drupal\configuration\Config\Configuration::prepareBuild().
   */
  protected function prepareBuild() {
    $style = image_style_load($this
      ->getIdentifier());
    $this
      ->style_sanitize($style);
    $this->data = $style;

    // Reset the order of effects, this will help to generate always the same
    // hash for image styles that have been reverted.
    $this->data['effects'] = array();
    if (!empty($style['effects'])) {
      foreach ($style['effects'] as $effect) {
        $this->data['effects'][] = $effect;
      }
    }
    return $this;
  }

  /**
   * Implements Drupal\configuration\Config\Configuration::saveToActiveStore().
   */
  public function saveToActiveStore(ConfigIteratorSettings &$settings) {
    $style = $this
      ->getData();

    // Does an image style with the same name already exist?
    if ($existing_style = image_style_load($this
      ->getIdentifier())) {
      $isExistingEditable = (bool) ($existing_style['storage'] & IMAGE_STORAGE_EDITABLE);
      $isNewEditable = (bool) ($style['storage'] & IMAGE_STORAGE_EDITABLE);

      // New style is using defaults -> revert existing.
      if (!$isNewEditable && $isExistingEditable) {
        image_default_style_revert($this
          ->getIdentifier());
      }
      elseif ($isExistingEditable && $isNewEditable) {
        $style['isid'] = $existing_style['isid'];
        $style = image_style_save($style);
        if (!empty($existing_style['effects'])) {
          foreach ($existing_style['effects'] as $effect) {
            image_effect_delete($effect);
          }
        }
        if (!empty($style['effects'])) {
          foreach ($style['effects'] as $effect) {
            $effect['isid'] = $style['isid'];
            image_effect_save($effect);
          }
        }
      }
      elseif ($isNewEditable && !$isExistingEditable) {
        if (!empty($existing_style['isid'])) {
          $style['isid'] = $existing_style['isid'];
        }
        $style = image_style_save($style);
        if (!empty($style['effects'])) {
          foreach ($style['effects'] as $effect) {
            $effect['isid'] = $style['isid'];
            image_effect_save($effect);
          }
        }
      }
      else {
      }
    }
    else {
      $style = image_style_save($style);
      if (!empty($style['effects'])) {
        foreach ($style['effects'] as $effect) {
          $effect['isid'] = $style['isid'];
          image_effect_save($effect);
        }
      }
      image_style_flush($style);
    }
    $settings
      ->addInfo('imported', $this
      ->getUniqueId());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Configuration::$broken protected property A boolean flag to indicate if the configuration object couldn't be loaded from it source.
Configuration::$built protected property A boolean flag to indicate if the configuration object was already populated from the ActiveStore, or from the DataStore.
Configuration::$context protected property The ConfigIteratorSettings instance used by iterate.
Configuration::$data protected property The data of this configuration.
Configuration::$dependencies protected property An array of configuration objects required to use this configuration.
Configuration::$hash protected property A hash that represent that sumarizes the configuration and can be used to copare configurations.
Configuration::$identifier protected property The identifier that identifies to the component, usually the machine name.
Configuration::$keys_to_export protected property An array of keys names to export. If the array is empty, all the keys of the configuration will be exported.
Configuration::$optional_configurations protected property An array of configuration objects that are parts of this configurations but are not required to use this configuration.
Configuration::$required_modules protected property The required modules to load this configuration.
Configuration::$storage protected property An object to save and load the data from a persistent medium.
Configuration::addToDependencies public function Add a new dependency for this configuration.
Configuration::addToModules public function Add a new dependency for this configuration.
Configuration::addToOptionalConfigurations public function Add a new child configuration for this configuration.
Configuration::build public function Build the configuration object based on the component name and in the identifier.
Configuration::buildHash public function Create a unique hash for this configuration based on the data, dependencies, optional configurations and modules required to use this configuration. Use getHash() after call this function.
Configuration::checkDependencies public function Returns TRUE if all the dependencies of this configurations are met. Returns FALSE if a module or a dependency is required by this configuration is not enabled.
Configuration::configFileExists public function Returns TRUE if the file that represents this configuration exists in the datastore.
Configuration::configForEntity public function Return TRUE if this is the configuration for an entity. 3
Configuration::discoverModules protected function Internal function to discover what modules are required for the current being proccessed configurations.
Configuration::export public function
Configuration::findDependencies public function Ask to each configuration handler to add its dependencies to the current configuration that is being exported. 2
Configuration::getAllIdentifiersCached public static function Cache wrapper for getAllIdentifiers().
Configuration::getAvailableModules protected static function Helper for retrieving info from system table.
Configuration::getData public function Return the data for this configuration.
Configuration::getDependencies public function Returns the list of dependencies of this configuration
Configuration::getDependentModules public static function Determine the status of the given module and of its dependencies.
Configuration::getFileName public function Returns the filename that contains the content of the current configuration.
Configuration::getHash public function Returns the hash of the configuration object.
Configuration::getIdentifier public function Returns the identifier of the configuration object.
Configuration::getKeysToExport public function Returns an array of keys names to export. If the array is empty, all the keys of the configuration will be exported.
Configuration::getModules public function Returns the name of the required_modules that provide this configuration.
Configuration::getOptionalConfigurations public function Returns the list of optional_configurations of this configuration
Configuration::getRequiredModules public function Returns a list of modules that are required to run this configuration.
Configuration::getStatus public function Return the current status of the configuration.
Configuration::getStorageInstance protected static function Returns a Storage Object ready to load or write configurations from the disk. 2
Configuration::getStorageSystem protected static function Returns a class with its namespace to save data to the disk. 2
Configuration::getUniqueId public function Returns an unique identifier for this configuration. Usually something like 'content_type.article' where content_type is the component of the configuration and 'article' is the identifier of the configuration for the given component.
Configuration::import public function Load a configuration from the DataStore and save it into the ActiveStore. This function is called from iterator().
Configuration::inSync constant A bit flag used to let us know if a configuration is the same in both the activestore and the datastore.
Configuration::isBroken public function Return TRUE if something went wrong with the load of the configuration.
Configuration::iterate public function This function will exectute a callback function over all the configurations objects that it process.
Configuration::loadFromActiveStore public function Load a configurations from the database.
Configuration::loadFromStorage public function Load the Configuration data from the disk.
Configuration::moduleInstalled constant A bit flag used to let us know if a module for the configuration is already installed.
Configuration::moduleMissing constant A bit flag used to let us know if a module for the configuration is not available to install in the site.
Configuration::moduleToInstall constant A bit flag used to let us know if a module for the configuration is disabled but can be enabled.
Configuration::notTracked constant A bit flag used to let us know if a configuration is not currently being tracked.
Configuration::overridden constant A bit flag used to let us know if a configuration was overridden as a result of changing the activestore directly. (config changes via the UI)
Configuration::printRaw protected function Print the configuration as plain text formatted to use in a tar file.
Configuration::raw public function Print the configuration as plain text formatted to use in a tar file.
Configuration::removeConfiguration public function Removes the configuration record from the configuration_tracked table for the current configuration.
Configuration::removeFromDataStore public function Removes the configuration file from the dataStore folder.
Configuration::scanDataStore public static function Returns the list of components available in the DataStore.
Configuration::setContext public function Set the context where a function is executed.
Configuration::setData public function Set the data for this configuration.
Configuration::setDependencies public function Returns the list of dependencies of this configuration
Configuration::setHash public function Set the hash for this configuration.
Configuration::setIdentifier public function Set the component identifier of this configuration
Configuration::setKeysToExport public function Set an array of keys names to export. If the array is empty, all the keys of the configuration will be exported.
Configuration::setModules public function Set the name of the required_modules that provide this configuration.
Configuration::setOptionalConfigurations public function Returns the list of optional_configurations of this configuration
Configuration::startTracking public function Save a configuration object into the configuration_tracked table.
Configuration::stopTracking public function Removes the configuration record from the configuration_tracked table for the current configuration.
Configuration::__construct public function Constructor. 5
ImageStyleConfiguration::alterDependencies public static function Overrides Drupal\configuration\Config\Configuration::alterDependencies(). Overrides Configuration::alterDependencies
ImageStyleConfiguration::findRequiredModules public function Overrides Drupal\configuration\Config\Configuration::findRequiredModules(). Overrides Configuration::findRequiredModules
ImageStyleConfiguration::getAllIdentifiers public static function Overrides Drupal\configuration\Config\Configuration::getAllIdentifiers(). Overrides Configuration::getAllIdentifiers
ImageStyleConfiguration::getComponent public function Overrides Drupal\configuration\Config\Configuration::getComponent(). Overrides Configuration::getComponent
ImageStyleConfiguration::getComponentHumanName public static function Overrides Drupal\configuration\Config\Configuration::getComponentHumanName(). Overrides Configuration::getComponentHumanName
ImageStyleConfiguration::isActive public static function Overrides Drupal\configuration\Config\Configuration::isActive(). Overrides Configuration::isActive
ImageStyleConfiguration::prepareBuild protected function Implements Drupal\configuration\Config\Configuration::prepareBuild(). Overrides Configuration::prepareBuild
ImageStyleConfiguration::saveToActiveStore public function Implements Drupal\configuration\Config\Configuration::saveToActiveStore(). Overrides Configuration::saveToActiveStore
ImageStyleConfiguration::style_sanitize protected function Remove unnecessary keys for export.
ImageStyleConfiguration::supportedComponents public static function Overrides Drupal\configuration\Config\Configuration::supportedComponents(). Overrides Configuration::supportedComponents