Docs For Class Base

constructor __construct [line 48]

Base_Imagemagick __construct(
string
$convert_bin)

Constructor

Please use Base_Imagemagick::instance() to get an instance of this class.

Tags:

throws:	Base_ImagemagickException
access:	protected

Parameters:

string

$convert_bin

Path to convert binary

[ Top ]

method convert [line 97]

string convert(
string
$old_file, string
$new_file, [bool
$overwrite = true])

Convert image

Converts image old_file from one format to another and saves the result to new_file. Takes the source file name as first argument and the target file name as second argument. If the target file already exists it will be overwritten unless overwrite is set to false.

Used ImageMagick command

$ /usr/bin/convert source.tiff image.jpg

Tags:

return:	Path to target file
throws:	Base_ImagemagickException
access:	public

Parameters:

string	$old_file	Source file
string	$new_file	Target file
bool	$overwrite	Overwrite target file yes/no

[ Top ]

method fontFileCheck [line 396]

$file fontFileCheck(
string
$file)

Check font file

Verifies that $file does exist and is readable by the webserver.

Tags:

throws:	Base_ImagemagickException
access:	protected

Parameters:

string

$file

target file

[ Top ]

method instance [line 70]

object instance(
string
$convert_bin)

Singleton

Tags:

access:

public

Parameters:

string

$convert_bin

path to convert binary

[ Top ]

method rotate [line 205]

string rotate(
string
$old_file, string
$new_file, string
$degrees, [bool
$overwrite = true])

Rotate image

Rotate image $old_file into a new position and save the result top $new_file. $degrees could be either a negative or a positive number.

CLI command

$ /usr/bin/convert -rotate <size> source.tiff image.jpg

Tags:

return:	returns $new_file
throws:	Base_ImagemagickException
access:	public

Parameters:

string	$old_file	image to rotate
string	$new_file	file to save result to
string	$degrees	degrees to rotate
bool	$overwrite	overwrite $new_file if $new_file already exists

[ Top ]

method scale [line 146]

string scale(
string
$old_file, string
$new_file, string
$size, [bool
$overwrite = true])

Scale image

Scales $old_file to the desired $size and saves the result to $new_file.

CLI command

$ /usr/bin/convert -scale <size> source.tiff image.jpg

For further details regarding the possible values for $size see http://www.imagemagick.org/www/ImageMagick.html#details-scale

Tags:

return:	returns $new_file
throws:	Base_ImagemagickException
access:	public

Parameters:

string	$old_file	file to scale
string	$new_file	file to save result to
string	$size	desired size
bool	$overwrite	overwrite $new_file if $new_file already exists

[ Top ]

method sourceFileCheck [line 322]

string sourceFileCheck(
string
$file)

Check source files

Verifies that $file does exist and is an image. If one of these conditions isn't true, an exception will be thrown.

Tags:

return:	returns $file
throws:	Base_ImagemagickException
access:	protected

Parameters:

string

$file

path to source file

[ Top ]

method targetFileCheck [line 360]

$file targetFileCheck(
string
$file, [bool
$overwrite = true])

Check target files

Verifies that $file doesn't exist (if $overwrite = false) and that the target directory is writeable by the webserver.

Tags:

throws:	Base_ImagemagickException
access:	protected

Parameters:

string	$file	target file
bool	$overwrite	overwrite $file if $file already exists

[ Top ]

method watermark [line 271]

string watermark(
string
$old_file, string
$new_file, array
$conf, [bool
$overwrite = true])

Create watermarks

Creates a watermark on $old_files and saves the result to $new_file. $conf is an array of configuration settings.

Contents of $conf:

font: Path to the TTF file
pointsize: Font size in points
color: Font color
position: Start position of the text (x, y)
text: Text to draw

A list of allowed values for color could be found on http://imagemagick.org/www/ImageMagick.html#details-fill.

CLI command

$ /usr/bin/convert -font euron.ttf -fill white -pointsize 16 \
> -draw 'text 10,160 "This is a watermark"' \
> keira_knightley.jpg keira_watermark.jpg

Tags:

return:	returns $new_file
throws:	Base_ImagemagickException
access:	public

Parameters:

string	$old_file	file to manipulate
string	$new_file	file to safe result to
array	$conf	config array
bool	$overwrite	overwrite $new_file if $new_file already exists

[ Top ]

method watermarkConfCheck [line 425]

void watermarkConfCheck(
array
&$conf)

Check watermark configuration

See watermark() for allowed values

Tags:

throws:	Base_ImagemagickException
access:	protected

Parameters:

array

&$conf

array of configuration values

[ Top ]

Class: Base_Imagemagick

Class Overview

Author(s):

Copyright:

Variables

Methods

Class Details

Tags:

Class Variables

static $instance = null

Class Methods

constructor __construct [line 48]

Tags:

Parameters:

method convert [line 97]

Tags:

Parameters:

method fontFileCheck [line 396]

Tags:

Parameters:

method instance [line 70]

Tags:

Parameters:

method rotate [line 205]

Tags:

Parameters:

method scale [line 146]

Tags:

Parameters:

method sourceFileCheck [line 322]

Tags:

Parameters:

method targetFileCheck [line 360]

Tags:

Parameters:

method watermark [line 271]

Tags:

Parameters:

method watermarkConfCheck [line 425]

Tags:

Parameters: