ImagemagickExecArguments.php in ImageMagick 8.2
Same filename and directory in other branches
Namespace
Drupal\imagemagickFile
src/ImagemagickExecArguments.phpView source
<?php
namespace Drupal\imagemagick;
/**
* Stores arguments for execution of ImageMagick/GraphicsMagick commands.
*/
class ImagemagickExecArguments {
/**
* An identifier to be used for arguments internal to the toolkit.
*
* @deprecated in 8.x-2.3, will be removed in 8.x-3.0. Do not prefix arguments
* to mark them internal, add them with ImageMagickExecArguments::INTERNAL
* instead.
*
* @see https://www.drupal.org/project/imagemagick/issues/2925780
*/
const INTERNAL_ARGUMENT_IDENTIFIER = '>!>';
/**
* Default index for adding arguments.
*/
const APPEND = -1;
/**
* Mode for arguments to be placed before the source path.
*/
const PRE_SOURCE = 0;
/**
* Mode for arguments to be placed after the source path.
*/
const POST_SOURCE = 1;
/**
* Mode for arguments not to be placed on the command line.
*/
const INTERNAL = 2;
/**
* The ImageMagick execution manager service.
*
* @var \Drupal\imagemagick\ImagemagickExecManagerInterface
*/
protected $execManager;
/**
* The array of command line arguments to be used by 'convert'.
*
* @var string[]
*/
protected $arguments = [];
/**
* Path of the image file.
*
* @var string
*/
protected $source = '';
/**
* The local filesystem path to the source image file.
*
* @var string
*/
protected $sourceLocalPath = '';
/**
* The source image format.
*
* @var string
*/
protected $sourceFormat = '';
/**
* The source image frames to access.
*
* @var string
*/
protected $sourceFrames;
/**
* The image destination URI/path on saving.
*
* @var string
*/
protected $destination = NULL;
/**
* The local filesystem path to the image destination.
*
* @var string
*/
protected $destinationLocalPath = '';
/**
* The image destination format on saving.
*
* @var string
*/
protected $destinationFormat = '';
/**
* Constructs an ImagemagickExecArguments object.
*
* @param \Drupal\imagemagick\ImagemagickExecManagerInterface $exec_manager
* The ImageMagick execution manager service.
*/
public function __construct(ImagemagickExecManagerInterface $exec_manager) {
$this->execManager = $exec_manager;
}
/**
* Gets the command line arguments for the binary.
*
* @return string[]
* The array of command line arguments.
*
* @deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use
* ImagemagickExecArguments methods to manipulate arguments directly.
*
* @see https://www.drupal.org/project/imagemagick/issues/2925780
*/
public function getArguments() {
@trigger_error('getArguments() is deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ImagemagickExecArguments methods to manipulate arguments directly. See https://www.drupal.org/project/imagemagick/issues/2925780.', E_USER_DEPRECATED);
$ret = [];
foreach ($this->arguments as $i => $a) {
if (in_array($a['mode'], [
self::POST_SOURCE,
self::INTERNAL,
])) {
$ret[$i] = ($a['mode'] === self::INTERNAL ? self::INTERNAL_ARGUMENT_IDENTIFIER : '') . $a['argument'];
}
}
return $ret;
}
/**
* Gets the command line arguments string for the binary.
*
* Removes any argument used internally within the toolkit.
*
* @return string
* The sring of command line arguments.
*
* @deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::toString()
* instead.
*
* @see https://www.drupal.org/project/imagemagick/issues/2925780
*/
public function getStringForBinary() {
@trigger_error('getStringForBinary() is deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::toString() instead. See https://www.drupal.org/project/imagemagick/issues/2925780.', E_USER_DEPRECATED);
return $this
->toString(self::POST_SOURCE);
}
/**
* Gets a portion of the command line arguments string.
*
* @param int $mode
* The mode of the string on the command line. Can be self::PRE_SOURCE or
* self::POST_SOURCE.
*
* @return string
* The sring of command line arguments.
*/
public function toString($mode) {
if (!$this->arguments) {
return '';
}
$ret = [];
foreach ($this->arguments as $a) {
if ($a['mode'] === $mode) {
$ret[] = $a['argument'];
}
}
return implode(' ', $ret);
}
/**
* Adds a command line argument.
*
* @param string $arg
* The command line argument to be added.
*
* @return $this
*
* @deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::add() instead.
*
* @see https://www.drupal.org/project/imagemagick/issues/2925780
*/
public function addArgument($arg) {
@trigger_error('addArgument() is deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::add() instead. See https://www.drupal.org/project/imagemagick/issues/2925780.', E_USER_DEPRECATED);
if (strpos($arg, self::INTERNAL_ARGUMENT_IDENTIFIER) === 0) {
@trigger_error('Adding internal arguments prefixing them with ImagemagickExecArguments::INTERNAL_ARGUMENT_IDENTIFIER is deprecated in 8.x-2.3, will be removed in 8.x-3.0. ::add() them with ImageMagickExecArguments::INTERNAL instead. See https://www.drupal.org/project/imagemagick/issues/2925780.', E_USER_DEPRECATED);
return $this
->add(substr($arg, strlen(self::INTERNAL_ARGUMENT_IDENTIFIER)), self::INTERNAL);
}
return $this
->add($arg);
}
/**
* Prepends a command line argument.
*
* @param string $arg
* The command line argument to be prepended.
*
* @return $this
*
* @deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::add() instead.
*
* @see https://www.drupal.org/project/imagemagick/issues/2925780
*/
public function prependArgument($arg) {
@trigger_error('prependArgument() is deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::add() instead. See https://www.drupal.org/project/imagemagick/issues/2925780.', E_USER_DEPRECATED);
if (strpos($arg, self::INTERNAL_ARGUMENT_IDENTIFIER) === 0) {
@trigger_error('Adding internal arguments prefixing them with ImagemagickExecArguments::INTERNAL_ARGUMENT_IDENTIFIER is deprecated in 8.x-2.3, will be removed in 8.x-3.0. ::add() them with ImageMagickExecArguments::INTERNAL instead. See https://www.drupal.org/project/imagemagick/issues/2925780.', E_USER_DEPRECATED);
return $this
->add(substr($arg, strlen(self::INTERNAL_ARGUMENT_IDENTIFIER)), self::INTERNAL, 0);
}
return $this
->add($arg, self::POST_SOURCE, 0);
}
/**
* Adds a command line argument.
*
* @param string $argument
* The command line argument to be added.
* @param int $mode
* (optional) The mode of the argument in the command line. Determines if
* the argument should be placed before or after the source image file path.
* Defaults to self::POST_SOURCE.
* @param int $index
* (optional) The position of the argument in the arguments array.
* Reflects the sequence of arguments in the command line. Defaults to
* self::APPEND.
* @param array $info
* (optional) An optional array with information about the argument.
* Defaults to an empty array.
*
* @return $this
*/
public function add($argument, $mode = self::POST_SOURCE, $index = self::APPEND, array $info = []) {
$argument = [
'argument' => $argument,
'mode' => $mode,
'info' => $info,
];
if ($index === self::APPEND) {
$this->arguments[] = $argument;
}
elseif ($index === 0) {
array_unshift($this->arguments, $argument);
}
else {
array_splice($this->arguments, $index, 0, [
$argument,
]);
}
return $this;
}
/**
* Finds if a command line argument exists.
*
* @param string $arg
* The command line argument to be found.
*
* @return bool
* Returns the array key for the argument if it is found in the array,
* FALSE otherwise.
*
* @deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::find() instead.
*
* @see https://www.drupal.org/project/imagemagick/issues/2925780
*/
public function findArgument($arg) {
@trigger_error('findArgument() is deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::find() instead. See https://www.drupal.org/project/imagemagick/issues/2925780.', E_USER_DEPRECATED);
if (strpos($arg, self::INTERNAL_ARGUMENT_IDENTIFIER) === 0) {
@trigger_error('Adding internal arguments prefixing them with ImagemagickExecArguments::INTERNAL_ARGUMENT_IDENTIFIER is deprecated in 8.x-2.3, will be removed in 8.x-3.0. ::add() them with ImageMagickExecArguments::INTERNAL instead. See https://www.drupal.org/project/imagemagick/issues/2925780.', E_USER_DEPRECATED);
foreach ($this
->getArguments() as $i => $a) {
if (strpos($a, $arg) === 0) {
return $i;
}
}
return FALSE;
}
$matches = $this
->find('/^' . preg_quote($arg, '/') . '/', self::POST_SOURCE);
if (!empty($matches)) {
$keys = array_keys($matches);
return $keys[0];
}
return FALSE;
}
/**
* Returns an array of the indexes of arguments matching specific criteria.
*
* @param string $regex
* The regular expression pattern to be matched in the argument.
* @param int $mode
* (optional) If set, limits the search to the mode of the argument.
* Defaults to NULL.
* @param array $info
* (optional) If set, limits the search to the arguments whose $info array
* key/values match the key/values specified. Defaults to an empty array.
*
* @return array
* Returns an array with the matching arguments.
*/
public function find($regex, $mode = NULL, array $info = []) {
$ret = [];
foreach ($this->arguments as $i => $a) {
if ($mode !== NULL && $a['mode'] !== $mode) {
continue;
}
if (!empty($info)) {
$intersect = array_intersect($info, $a['info']);
if ($intersect != $info) {
continue;
}
}
if (preg_match($regex, $a['argument']) === 1) {
$ret[$i] = $a;
}
}
return $ret;
}
/**
* Removes a command line argument.
*
* @param int $index
* The index of the command line argument to be removed.
*
* @return $this
*
* @deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::remove() instead.
*
* @see https://www.drupal.org/project/imagemagick/issues/2936615
*/
public function removeArgument($index) {
@trigger_error('removeArgument() is deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::remove() instead. See https://www.drupal.org/project/imagemagick/issues/2936615.', E_USER_DEPRECATED);
return $this
->remove($index);
}
/**
* Removes a command line argument.
*
* @param int $index
* The index of the command line argument to be removed.
*
* @return $this
*/
public function remove($index) {
if (isset($this->arguments[$index])) {
unset($this->arguments[$index]);
}
return $this;
}
/**
* Resets the command line arguments.
*
* @return $this
*
* @deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::reset() instead.
*
* @see https://www.drupal.org/project/imagemagick/issues/2936615
*/
public function resetArguments() {
@trigger_error('resetArguments() is deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::reset() instead. See https://www.drupal.org/project/imagemagick/issues/2936615.', E_USER_DEPRECATED);
return $this
->reset();
}
/**
* Resets the command line arguments.
*
* @return $this
*/
public function reset() {
$this->arguments = [];
return $this;
}
/**
* Returns the count of command line arguments.
*
* @return $this
*
* @deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::find() instead,
* then count the result.
*
* @see https://www.drupal.org/project/imagemagick/issues/2936615
*/
public function countArguments() {
@trigger_error('countArguments() is deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::find() instead, then count the result. See https://www.drupal.org/project/imagemagick/issues/2936615.', E_USER_DEPRECATED);
return count($this->arguments);
}
/**
* Sets the path of the source image file.
*
* @param string $source
* The source path of the image file.
*
* @return $this
*/
public function setSource($source) {
$this->source = $source;
return $this;
}
/**
* Gets the path of the source image file.
*
* @return string
* The source path of the image file, or an empty string if the source is
* not set.
*/
public function getSource() {
return $this->source;
}
/**
* Sets the local filesystem path to the image file.
*
* @param string $path
* A filesystem path.
*
* @return $this
*/
public function setSourceLocalPath($path) {
$this->sourceLocalPath = $path;
return $this;
}
/**
* Gets the local filesystem path to the image file.
*
* @return string
* A filesystem path.
*/
public function getSourceLocalPath() {
return $this->sourceLocalPath;
}
/**
* Sets the source image format.
*
* @param string $format
* The image format.
*
* @return $this
*/
public function setSourceFormat($format) {
$this->sourceFormat = $this->execManager
->getFormatMapper()
->isFormatEnabled($format) ? $format : '';
return $this;
}
/**
* Sets the source image format from an image file extension.
*
* @param string $extension
* The image file extension.
*
* @return $this
*/
public function setSourceFormatFromExtension($extension) {
$this->sourceFormat = $this->execManager
->getFormatMapper()
->getFormatFromExtension($extension) ?: '';
return $this;
}
/**
* Gets the source image format.
*
* @return string
* The source image format.
*/
public function getSourceFormat() {
return $this->sourceFormat;
}
/**
* Sets the source image frames to access.
*
* @param string $frames
* The frames in '[n]' string format.
*
* @return $this
*
* @see http://www.imagemagick.org/script/command-line-processing.php
*/
public function setSourceFrames($frames) {
$this->sourceFrames = $frames;
return $this;
}
/**
* Gets the source image frames to access.
*
* @return string
* The frames in '[n]' string format.
*
* @see http://www.imagemagick.org/script/command-line-processing.php
*/
public function getSourceFrames() {
return $this->sourceFrames;
}
/**
* Sets the image destination URI/path on saving.
*
* @param string $destination
* The image destination URI/path.
*
* @return $this
*/
public function setDestination($destination) {
$this->destination = $destination;
return $this;
}
/**
* Gets the image destination URI/path on saving.
*
* @return string
* The image destination URI/path.
*/
public function getDestination() {
return $this->destination;
}
/**
* Sets the local filesystem path to the destination image file.
*
* @param string $path
* A filesystem path.
*
* @return $this
*/
public function setDestinationLocalPath($path) {
$this->destinationLocalPath = $path;
return $this;
}
/**
* Gets the local filesystem path to the destination image file.
*
* @return string
* A filesystem path.
*/
public function getDestinationLocalPath() {
return $this->destinationLocalPath;
}
/**
* Sets the image destination format.
*
* When set, it is passed to the convert binary in the syntax
* "[format]:[destination]", where [format] is a string denoting an
* ImageMagick's image format.
*
* @param string $format
* The image destination format.
*
* @return $this
*/
public function setDestinationFormat($format) {
$this->destinationFormat = $format;
return $this;
}
/**
* Sets the image destination format from an image file extension.
*
* When set, it is passed to the convert binary in the syntax
* "[format]:[destination]", where [format] is a string denoting an
* ImageMagick's image format.
*
* @param string $extension
* The destination image file extension.
*
* @return $this
*/
public function setDestinationFormatFromExtension($extension) {
$this->destinationFormat = $this->execManager
->getFormatMapper()
->getFormatFromExtension($extension) ?: '';
return $this;
}
/**
* Gets the image destination format.
*
* When set, it is passed to the convert binary in the syntax
* "[format]:[destination]", where [format] is a string denoting an
* ImageMagick's image format.
*
* @return string
* The image destination format.
*/
public function getDestinationFormat() {
return $this->destinationFormat;
}
/**
* Escapes a string.
*
* @param string $arg
* The string to escape.
*
* @return string
* An escaped string for use in the
* ImagemagickExecManagerInterface::execute method.
*
* @deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::escape()
* instead.
*
* @see https://www.drupal.org/project/imagemagick/issues/2936680
*/
public function escapeShellArg($arg) {
@trigger_error('escapeShellArg() is deprecated in 8.x-2.3, will be removed in 8.x-3.0. Use ::escape() instead. See https://www.drupal.org/project/imagemagick/issues/2936680.', E_USER_DEPRECATED);
return $this
->escape($arg);
}
/**
* Escapes a string.
*
* @param string $argument
* The string to escape.
*
* @return string
* An escaped string for use in the
* ImagemagickExecManagerInterface::execute method.
*/
public function escape($argument) {
return $this->execManager
->escapeShellArg($argument);
}
}Classes
Name |
Description |
|---|---|
| ImagemagickExecArguments | Stores arguments for execution of ImageMagick/GraphicsMagick commands. |