abstract class ImageAPIOptimizeProcessorBinaryBase in Image Optimize Binaries 8

Base class for image optimizations that run local binaries.

Hierarchy

• class \Drupal\imageapi_optimize_binaries\ImageAPIOptimizeProcessorBinaryBase extends \Drupal\imageapi_optimize\ConfigurableImageAPIOptimizeProcessorBase

9 files declare their use of ImageAPIOptimizeProcessorBinaryBase

AdvDef.php in src/Plugin/ImageAPIOptimizeProcessor/AdvDef.php

AdvPng.php in src/Plugin/ImageAPIOptimizeProcessor/AdvPng.php

JfifRemove.php in src/Plugin/ImageAPIOptimizeProcessor/JfifRemove.php

JpegOptim.php in src/Plugin/ImageAPIOptimizeProcessor/JpegOptim.php

JpegTran.php in src/Plugin/ImageAPIOptimizeProcessor/JpegTran.php

... See full list

File

src/ImageAPIOptimizeProcessorBinaryBase.php, line 15

Namespace

Drupal\imageapi_optimize_binaries

abstract class ImageAPIOptimizeProcessorBinaryBase extends ConfigurableImageAPIOptimizeProcessorBase {

  /**
   * The file system service.
   *
   * @var \Drupal\core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * The imageapi shell operation service.
   *
   * @var \Drupal\imageapi_optimize_binaries\ImageAPIOptimizeShellOperationsInterface
   */
  protected $shellOperations;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, LoggerInterface $logger, ImageFactory $image_factory, FileSystemInterface $file_system, ImageAPIOptimizeShellOperationsInterface $shell_operations) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $logger, $image_factory);
    $this->fileSystem = $file_system;
    $this->shellOperations = $shell_operations;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('logger.factory')
      ->get('imageapi_optimize'), $container
      ->get('image.factory'), $container
      ->get('file_system'), $container
      ->get('imageapi_optimize_binaries.shell_operations'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'manual_executable_path' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    if (!$this
      ->findExecutablePath()) {
      $form['executable'] = array(
        '#type' => 'item',
        '#title' => $this
          ->t('Executable'),
        '#markup' => $this
          ->t('The %binary binary must be installed, please install or specify the path to the %binary executable directly.', array(
          '%binary' => $this
            ->executableName(),
        )),
      );
    }
    else {
      $form['executable'] = array(
        '#type' => 'item',
        '#title' => $this
          ->t('Executable'),
        '#markup' => $this
          ->t('The @binary executable has been automatically located: @path. To override, set a different executate path below.', array(
          '@path' => $this
            ->findExecutablePath(),
          '@binary' => $this
            ->executableName(),
        )),
      );
    }
    $form['manual_executable_path'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Manually set path'),
      '#description' => $this
        ->t('Specify the full path to the @binary executable.', array(
        '@binary' => $this
          ->executableName(),
      )),
      '#default_value' => $this->configuration['manual_executable_path'],
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['manual_executable_path'] = $form_state
      ->getValue('manual_executable_path');
  }

  /**
   * Search the local system for the given executable binary.
   *
   * @param null $executable
   *   The name of the executable binary to find on the local system. If not
   *   specified the default executeable name for this class will be used.
   *
   * @return string|false
   *   The path to the binary on the local system, or FALSE if it could not be
   *   located.
   */
  protected function findExecutablePath($executable = NULL) {
    if (is_null($executable)) {
      $executable = $this
        ->executableName();
    }
    return $this->shellOperations
      ->findExecutablePath($executable);
  }

  /**
   * Execute a shell command on the local system.
   *
   * @param $command
   *   The command to execute.
   * @param $options
   *   An array of options for the command. This will not be escaped before executing.
   * @param $arguments
   *   An array of arguments for the command. These will be escaped.
   *
   * @return bool
   *   Returns TRUE if the command completed successfully, FALSE otherwise.
   */
  protected function execShellCommand($command, $options, $arguments) {
    return $this->shellOperations
      ->execShellCommand($command, $options, $arguments);
  }

  /**
   * Sanitize the given path for binary processors.
   *
   * @param $drupal_filepath
   *   The file path to sanitize.
   *
   * @return string
   *   The sanitized file path.
   */
  protected function sanitizeFilename($drupal_filepath) {
    return $this->fileSystem
      ->realpath($drupal_filepath);
  }
  protected function saveCommandStdoutToFile($cmd, $dst) {
    return $this->shellOperations
      ->saveCommandStdoutToFile($cmd, $dst);
  }
  public function getFullPathToBinary() {
    if ($this->configuration['manual_executable_path']) {
      return $this->configuration['manual_executable_path'];
    }
    elseif ($this
      ->findExecutablePath()) {
      return $this
        ->findExecutablePath();
    }
  }
  public function getSummary() {
    $description = '';
    if (!$this
      ->getFullPathToBinary()) {
      $description .= $this
        ->t('<strong>Command not found</strong>');
    }
    $summary = array(
      '#markup' => $description,
    );
    $summary += parent::getSummary();
    return $summary;
  }
  protected abstract function executableName();

  /**
   * {@inheritdoc}
   */
  public abstract function applyToImage($image_uri);

}

Members

Name	Modifiers	Type	Description	Overrides
ImageAPIOptimizeProcessorBinaryBase::$fileSystem	protected	property	The file system service.
ImageAPIOptimizeProcessorBinaryBase::$shellOperations	protected	property	The imageapi shell operation service.
ImageAPIOptimizeProcessorBinaryBase::applyToImage	abstract public	function		9
ImageAPIOptimizeProcessorBinaryBase::buildConfigurationForm	public	function		6
ImageAPIOptimizeProcessorBinaryBase::create	public static	function
ImageAPIOptimizeProcessorBinaryBase::defaultConfiguration	public	function		6
ImageAPIOptimizeProcessorBinaryBase::execShellCommand	protected	function	Execute a shell command on the local system.
ImageAPIOptimizeProcessorBinaryBase::executableName	abstract protected	function		9
ImageAPIOptimizeProcessorBinaryBase::findExecutablePath	protected	function	Search the local system for the given executable binary.
ImageAPIOptimizeProcessorBinaryBase::getFullPathToBinary	public	function
ImageAPIOptimizeProcessorBinaryBase::getSummary	public	function
ImageAPIOptimizeProcessorBinaryBase::sanitizeFilename	protected	function	Sanitize the given path for binary processors.
ImageAPIOptimizeProcessorBinaryBase::saveCommandStdoutToFile	protected	function
ImageAPIOptimizeProcessorBinaryBase::submitConfigurationForm	public	function		6
ImageAPIOptimizeProcessorBinaryBase::__construct	public	function