Core/Action.php

Show: inherited
Table of Contents

\phMagick\Core\Action

Package: phmagick\core

Base class for phMagick Action

Children
\phMagick\Action\Resize\Base
\phMagick\Action\Watermark
Author
nuno  

Properties

Propertyprivate  $destination= ''
Details
Type
n/a
Propertyprotected\phMagick\Core\array[string]  $gravityValues= 'array( 'northwest''

holds valid values for imagemagick gravity

Default valuearray( 'northwest'Details
Type
\phMagick\Core\array[string]
Propertyprivate  $source= ''
Details
Type
n/a

Methods

methodpublic__construct( String $source, String $destination ) : void

created the class and set the source and destination file paths

Parameters
Name Type Description
$source String
$destination String
methodpublicgetDestination( ) : void

Gets the file path of the file transformed file (new file) return String

methodpublicgetShellCommand( ) : \phMagick\Core\Command
abstract

to be overwritten from Action classes

this method should return the phMagick shell command to be executed

Returns
Type Description
\phMagick\Core\Command
methodpublicgetSource( ) : void

Gets the file path of the file to be transformed return String

methodprotectedisValidGravity( String $gravity ) : Boolean

checks if gravity is an allowed value

Parameters
Name Type Description
$gravity String
Returns
Type Description
Boolean
methodpublicsetDestination( String $file ) : void

Sets the file path of the file transformed file (new file)

Parameters
Name Type Description
$file String
methodpublicsetSource( String $file ) : void

Sets the file path of the file to be transformed

Parameters
Name Type Description
$file String
Documentation was generated by DocBlox 0.17.2.