class JpegOptim in Image Optimize Binaries 8

Uses the JpegOptim binary to optimize images.

Plugin annotation

@ImageAPIOptimizeProcessor(
  id = "jpegoptim",
  label = @Translation("JpegOptim"),
  description = @Translation("Uses the JpegOptim binary to optimize images.")
)

Hierarchy

• class \Drupal\imageapi_optimize_binaries\ImageAPIOptimizeProcessorBinaryBase extends \Drupal\imageapi_optimize\ConfigurableImageAPIOptimizeProcessorBase
  • class \Drupal\imageapi_optimize_binaries\Plugin\ImageAPIOptimizeProcessor\JpegOptim

File

src/Plugin/ImageAPIOptimizeProcessor/JpegOptim.php, line 17

Namespace

Drupal\imageapi_optimize_binaries\Plugin\ImageAPIOptimizeProcessor

class JpegOptim extends ImageAPIOptimizeProcessorBinaryBase {

  /**
   * {@inheritdoc}
   */
  protected function executableName() {
    return 'jpegoptim';
  }
  public function applyToImage($image_uri) {
    if ($cmd = $this
      ->getFullPathToBinary()) {
      $dst = $this
        ->sanitizeFilename($image_uri);
      if ($this
        ->getMimeType($image_uri) == 'image/jpeg') {
        $options = array(
          '--quiet',
          '--strip-all',
        );
        $arguments = array(
          $dst,
        );
        if (is_numeric($this->configuration['progressive'])) {
          switch ($this->configuration['progressive']) {
            case 0:
              $options[] = '--all-normal';
              break;
            case 1:
              $options[] = '--all-progressive';
              break;
          }
        }
        if (is_numeric($this->configuration['quality'])) {
          $options[] = '--max=' . escapeshellarg($this->configuration['quality']);
        }
        if (is_numeric($this->configuration['size'])) {
          $options[] = '--size=' . escapeshellarg($this->configuration['size'] . '%');
        }
        return $this
          ->execShellCommand($cmd, $options, $arguments);
      }
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'progressive' => '',
      'quality' => '',
      'size' => '',
    ];
  }
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['progressive'] = array(
      '#title' => $this
        ->t('Progressive'),
      '#type' => 'select',
      '#options' => array(
        '' => $this
          ->t('No change'),
        0 => $this
          ->t('Non-progressive'),
        1 => $this
          ->t('Progressive'),
      ),
      '#default_value' => $this->configuration['progressive'],
      '#description' => $this
        ->t('If "No change" is selected, the output will have the same as the input.'),
    );
    $form['quality'] = array(
      '#title' => $this
        ->t('Quality'),
      '#type' => 'number',
      '#min' => 0,
      '#max' => 100,
      '#description' => $this
        ->t('Optionally enter a JPEG quality setting to use, 0 - 100. WARNING: LOSSY'),
      '#default_value' => $this->configuration['quality'],
    );
    $form['size'] = array(
      '#title' => $this
        ->t('Target size'),
      '#type' => 'number',
      '#min' => 1,
      '#max' => 100,
      '#field_suffix' => '%',
      '#description' => $this
        ->t('Optionally enter a target percentage of filesize for optimisation. WARNING: LOSSY'),
      '#default_value' => $this->configuration['size'],
    );
    return $form;
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
ImageAPIOptimizeProcessorBinaryBase::$fileSystem	protected	property	The file system service.
ImageAPIOptimizeProcessorBinaryBase::$shellOperations	protected	property	The imageapi shell operation service.
ImageAPIOptimizeProcessorBinaryBase::create	public static	function
ImageAPIOptimizeProcessorBinaryBase::execShellCommand	protected	function	Execute a shell command on the local system.
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::__construct	public	function
JpegOptim::applyToImage	public	function	Overrides ImageAPIOptimizeProcessorBinaryBase::applyToImage
JpegOptim::buildConfigurationForm	public	function	Overrides ImageAPIOptimizeProcessorBinaryBase::buildConfigurationForm
JpegOptim::defaultConfiguration	public	function	Overrides ImageAPIOptimizeProcessorBinaryBase::defaultConfiguration
JpegOptim::executableName	protected	function	Overrides ImageAPIOptimizeProcessorBinaryBase::executableName
JpegOptim::submitConfigurationForm	public	function	Overrides ImageAPIOptimizeProcessorBinaryBase::submitConfigurationForm