public function ImageToolkitBase::setSource in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 core/lib/Drupal/Core/ImageToolkit/ImageToolkitBase.php \Drupal\Core\ImageToolkit\ImageToolkitBase::setSource()

Sets the source path of the image file.

Parameters

string $source: The source path of the image file.

Return value

\Drupal\Core\ImageToolkit\ImageToolkitInterface An instance of the current toolkit object.

Throws

\BadMethodCallException After being set initially, the source image cannot be changed.

Overrides ImageToolkitInterface::setSource

File

core/lib/Drupal/Core/ImageToolkit/ImageToolkitBase.php, line 86

Contains \Drupal\Core\ImageToolkit\ImageToolkitBase.

Class

ImageToolkitBase

Provides a base class for image toolkit plugins.

Namespace

Drupal\Core\ImageToolkit

Code

public function setSource($source) {

  // If a previous image has been loaded, there is no way to know if the
  // toolkit implementation needs to perform any additional actions like
  // freeing memory. Therefore, the source image cannot be changed once set.
  if ($this->source) {
    throw new \BadMethodCallException(__METHOD__ . '() may only be called once');
  }
  $this->source = $source;
  return $this;
}