CI_Image_lib Class Reference

List of all members.

Public Member Functions
	CI_Image_lib ($props=array())
	Constructor.
	clear ()
	Initialize image properties.
	initialize ($props=array())
	initialize image preferences
	resize ()
	Image Resize.
	crop ()
	Image Crop.
	rotate ()
	Image Rotate.
	image_process_gd ($action= 'resize')
	Image Process Using GD/GD2.
	image_process_imagemagick ($action= 'resize')
	Image Process Using ImageMagick.
	image_process_netpbm ($action= 'resize')
	Image Process Using NetPBM.
	image_rotate_gd ()
	Image Rotate Using GD.
	image_mirror_gd ()
	Create Mirror Image using GD.
	watermark ()
	Image Watermark.
	overlay_watermark ()
	Watermark - Graphic Version.
	text_watermark ()
	Watermark - Text Version.
	image_create_gd ($path= '', $image_type= '')
	Create Image - GD.
	image_save_gd ($resource)
	Write image file to disk - GD.
	image_display_gd ($resource)
	Dynamically outputs an image.
	image_reproportion ()
	Re-proportion Image Width/Height.
	get_image_properties ($path= '', $return=FALSE)
	Get image properties.
	size_calculator ($vals)
	Size calculator.
	explode_name ($source_image)
	Explode source_image.
	gd_loaded ()
	Is GD Installed?
	gd_version ()
	Get GD version.
	set_error ($msg)
	Set error message.
	display_errors ($open= '< p >', $close= '</p >')
	Show error messages.
Public Attributes
	$image_library = 'gd2'
	$library_path = ''
	$dynamic_output = FALSE
	$source_image = ''
	$new_image = ''
	$width = ''
	$height = ''
	$quality = '90'
	$create_thumb = FALSE
	$thumb_marker = '_thumb'
	$maintain_ratio = TRUE
	$master_dim = 'auto'
	$rotation_angle = ''
	$x_axis = ''
	$y_axis = ''
	$wm_text = ''
	$wm_type = 'text'
	$wm_x_transp = 4
	$wm_y_transp = 4
	$wm_overlay_path = ''
	$wm_font_path = ''
	$wm_font_size = 17
	$wm_vrt_alignment = 'B'
	$wm_hor_alignment = 'C'
	$wm_padding = 0
	$wm_hor_offset = 0
	$wm_vrt_offset = 0
	$wm_font_color = '#ffffff'
	$wm_shadow_color = ''
	$wm_shadow_distance = 2
	$wm_opacity = 50
	$source_folder = ''
	$dest_folder = ''
	$mime_type = ''
	$orig_width = ''
	$orig_height = ''
	$image_type = ''
	$size_str = ''
	$full_src_path = ''
	$full_dst_path = ''
	$create_fnc = 'imagecreatetruecolor'
	$copy_fnc = 'imagecopyresampled'
	$error_msg = array()
	$wm_use_drop_shadow = FALSE
	$wm_use_truetype = FALSE

---

Detailed Description

Definition at line 27 of file Image_lib.php.

---

Member Function Documentation

CI_Image_lib::CI_Image_lib

(

$

props = array()

)

Constructor.

public

Parameters:

string

Returns:

void

Definition at line 86 of file Image_lib.php.

References initialize(), and log_message().

        {
                if (count($props) > 0)
                {
                        $this->initialize($props);
                }
                
                log_message('debug', "Image Lib Class Initialized");
        }

Here is the call graph for this function:

CI_Image_lib::clear

(

)

Initialize image properties.

Resets values in case this class is used in a loop

public

Returns:

void

Definition at line 106 of file Image_lib.php.

        {
                $props = array('source_folder', 'dest_folder', 'source_image', 'full_src_path', 'full_dst_path', 'new_image', 'image_type', 'size_str', 'quality', 'orig_width', 'orig_height', 'rotation_angle', 'x_axis', 'y_axis', 'create_fnc', 'copy_fnc', 'wm_overlay_path', 'wm_use_truetype', 'dynamic_output', 'wm_font_size', 'wm_text', 'wm_vrt_alignment', 'wm_hor_alignment', 'wm_padding', 'wm_hor_offset', 'wm_vrt_offset', 'wm_font_color', 'wm_use_drop_shadow', 'wm_shadow_color', 'wm_shadow_distance', 'wm_opacity');
        
                foreach ($props as $val)
                {
                        $this->$val = '';
                }

                // special consideration for master_dim
                $this->master_dim = 'auto';
        }

CI_Image_lib::crop

(

)

Image Crop.

This is a wrapper function that chooses the proper cropping function based on the protocol specified

public

Returns:

bool

Definition at line 372 of file Image_lib.php.

        {
                $protocol = 'image_process_'.$this->image_library;
                
                if (eregi("gd2$", $protocol))
                {
                        $protocol = 'image_process_gd';
                }
                
                return $this->$protocol('crop');
        }

CI_Image_lib::display_errors	(	$	open = '<p>',
		$	close = '</p>'
	)

Show error messages.

public

Parameters:

string

Returns:

string

Definition at line 1531 of file Image_lib.php.

        {       
                $str = '';
                foreach ($this->error_msg as $val)
                {
                        $str .= $open.$val.$close;
                }
        
                return $str;
        }

CI_Image_lib::explode_name

(

$

source_image

)

Explode source_image.

This is a helper function that extracts the extension from the source_image. This function lets us deal with source_images with multiple periods, like: my.cool.jpg It returns an associative array with two elements: $array['ext'] = '.jpg'; $array['name'] = 'my.cool';

public

Parameters:

array

Returns:

array

Definition at line 1424 of file Image_lib.php.

References $source_image.

Referenced by initialize().

        {
                $x = explode('.', $source_image);
                $ret['ext'] = '.'.end($x);
                
                $name = '';
                
                $ct = count($x)-1;
                
                for ($i = 0; $i < $ct; $i++)
                {
                        $name .= $x[$i];
                        
                        if ($i < ($ct - 1))
                        {
                                $name .= '.';
                        }
                }
                
                $ret['name'] = $name;
                
                return $ret;
        }       

Here is the caller graph for this function:

CI_Image_lib::gd_loaded

(

)

Is GD Installed?

public

Returns:

bool

Definition at line 1456 of file Image_lib.php.

        {
                if ( ! extension_loaded('gd'))
                {
                        if ( ! dl('gd.so'))
                        {
                                return FALSE;
                        }
                }
                
                return TRUE;
        }

CI_Image_lib::gd_version

(

)

Get GD version.

public

Returns:

mixed

Definition at line 1477 of file Image_lib.php.

Referenced by image_process_gd().

        {
                if (function_exists('gd_info'))
                {
                        $gd_version = @gd_info();
                        $gd_version = preg_replace("/\D/", "", $gd_version['GD Version']);
                        
                        return $gd_version;
                }
                
                return FALSE;
        }

Here is the caller graph for this function:

CI_Image_lib::get_image_properties	(	$	path = '',
		$	return = FALSE
	)

Get image properties.

A helper function that gets info about the file

public

Parameters:

string

Returns:

mixed

Definition at line 1318 of file Image_lib.php.

References set_error().

Referenced by initialize(), overlay_watermark(), and text_watermark().

        {
                // For now we require GD but we should
                // find a way to determine this using IM or NetPBM
                
                if ($path == '')
                        $path = $this->full_src_path;
                                
                if ( ! file_exists($path))
                {
                        $this->set_error('imglib_invalid_path');                
                        return FALSE;                           
                }
                
                $vals = @getimagesize($path);
                
                $types = array(1 => 'gif', 2 => 'jpeg', 3 => 'png');
                
                $mime = (isset($types[$vals['2']])) ? 'image/'.$types[$vals['2']] : 'image/jpg';
                                
                if ($return == TRUE)
                {
                        $v['width']                     = $vals['0'];
                        $v['height']            = $vals['1'];
                        $v['image_type']        = $vals['2'];
                        $v['size_str']          = $vals['3'];
                        $v['mime_type']         = $mime;
                        
                        return $v;
                }
                
                $this->orig_width       = $vals['0'];
                $this->orig_height      = $vals['1'];
                $this->image_type       = $vals['2'];
                $this->size_str         = $vals['3'];
                $this->mime_type        = $mime;
                
                return TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Image_lib::image_create_gd	(	$	path = '',
		$	image_type = ''
	)

Create Image - GD.

This simply creates an image resource handle based on the type of image being processed

public

Parameters:

string

Returns:

resource

Definition at line 1130 of file Image_lib.php.

References $image_type, and set_error().

Referenced by image_mirror_gd(), image_process_gd(), image_rotate_gd(), overlay_watermark(), and text_watermark().

        {
                if ($path == '')
                        $path = $this->full_src_path;
                        
                if ($image_type == '')
                        $image_type = $this->image_type;
        
                
                switch ($image_type)
                {
                        case     1 :
                                                if ( ! function_exists('imagecreatefromgif'))
                                                {
                                                        $this->set_error(array('imglib_unsupported_imagecreate', 'imglib_gif_not_supported'));
                                                        return FALSE;
                                                }
                                        
                                                return imagecreatefromgif($path);
                                break;
                        case 2 :
                                                if ( ! function_exists('imagecreatefromjpeg'))
                                                {
                                                        $this->set_error(array('imglib_unsupported_imagecreate', 'imglib_jpg_not_supported'));
                                                        return FALSE;
                                                }
                                        
                                                return imagecreatefromjpeg($path);
                                break;
                        case 3 :
                                                if ( ! function_exists('imagecreatefrompng'))
                                                {
                                                        $this->set_error(array('imglib_unsupported_imagecreate', 'imglib_png_not_supported'));                          
                                                        return FALSE;
                                                }
                                        
                                                return imagecreatefrompng($path);
                                break;                  
                
                }
                
                $this->set_error(array('imglib_unsupported_imagecreate'));
                return FALSE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Image_lib::image_display_gd

(

$

resource

)

Dynamically outputs an image.

public

Parameters:

resource

Returns:

void

Definition at line 1241 of file Image_lib.php.

Referenced by image_mirror_gd(), image_process_gd(), image_rotate_gd(), overlay_watermark(), and text_watermark().

        {               
                header("Content-Disposition: filename={$this->source_image};");
                header("Content-Type: {$this->mime_type}");
                header('Content-Transfer-Encoding: binary');
                header('Last-Modified: '.gmdate('D, d M Y H:i:s', time()).' GMT');
        
                switch ($this->image_type)
                {
                        case 1          :       imagegif($resource);
                                break;
                        case 2          :       imagejpeg($resource, '', $this->quality);
                                break;
                        case 3          :       imagepng($resource);
                                break;
                        default         :       echo 'Unable to display the image';
                                break;          
                }                       
        }

Here is the caller graph for this function:

CI_Image_lib::image_mirror_gd

(

)

Create Mirror Image using GD.

This function will flip horizontal or vertical

public

Returns:

bool

Definition at line 767 of file Image_lib.php.

References $height, $width, image_create_gd(), image_display_gd(), and image_save_gd().

Referenced by rotate().

        {               
                if ( ! $src_img = $this->image_create_gd())
                {
                        return FALSE;
                }
                
                $width  = $this->orig_width;
                $height = $this->orig_height;
        
                if ($this->rotation_angle == 'hor')
                {
                        for ($i = 0; $i < $height; $i++)
                        {
                                $left  = 0;
                                $right = $width-1;
        
                                while ($left < $right)
                                {
                                        $cl = imagecolorat($src_img, $left, $i);
                                        $cr = imagecolorat($src_img, $right, $i);
                                        
                                        imagesetpixel($src_img, $left, $i, $cr);
                                        imagesetpixel($src_img, $right, $i, $cl);
                                        
                                        $left++;
                                        $right--;
                                }
                        }
                }
                else
                {
                        for ($i = 0; $i < $width; $i++)
                        {
                                $top = 0;
                                $bot = $height-1;
        
                                while ($top < $bot)
                                {
                                        $ct = imagecolorat($src_img, $i, $top);
                                        $cb = imagecolorat($src_img, $i, $bot);
                                        
                                        imagesetpixel($src_img, $i, $top, $cb);
                                        imagesetpixel($src_img, $i, $bot, $ct);
                                        
                                        $top++;
                                        $bot--;
                                }
                        }               
                }               

                //  Show the image
                if ($this->dynamic_output == TRUE)
                {
                        $this->image_display_gd($src_img);
                }
                else
                {
                        // Or save it
                        if ( ! $this->image_save_gd($src_img))
                        {
                                return FALSE;
                        }
                }
                
                //  Kill the file handles
                imagedestroy($src_img);
                
                // Set the file to 777
                @chmod($this->full_dst_path, DIR_WRITE_MODE);
                
                return TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Image_lib::image_process_gd

(

$

action = 'resize'

)

Image Process Using GD/GD2.

This function will resize or crop

public

Parameters:

string

Returns:

bool

Definition at line 448 of file Image_lib.php.

References gd_version(), image_create_gd(), image_display_gd(), and image_save_gd().

        {       
                $v2_override = FALSE;

                // If the target width/height match the source, AND if the new file name is not equal to the old file name
                // we'll simply make a copy of the original with the new name... assuming dynamic rendering is off.
                if ($this->dynamic_output === FALSE)
                {
                        if ($this->orig_width == $this->width AND $this->orig_height == $this->height)                  
                        {
                                if ($this->source_image != $this->new_image)
                                {
                                        if (@copy($this->full_src_path, $this->full_dst_path))
                                        {
                                                @chmod($this->full_dst_path, DIR_WRITE_MODE);
                                        }
                                }
                                
                                return TRUE;
                        }
                }
                
                // Let's set up our values based on the action
                if ($action == 'crop')
                {
                        //  Reassign the source width/height if cropping
                        $this->orig_width  = $this->width;
                        $this->orig_height = $this->height;     
                                
                        // GD 2.0 has a cropping bug so we'll test for it
                        if ($this->gd_version() !== FALSE)
                        {
                                $gd_version = str_replace('0', '', $this->gd_version());                        
                                $v2_override = ($gd_version == 2) ? TRUE : FALSE;
                        }
                }
                else
                {                       
                        // If resizing the x/y axis must be zero
                        $this->x_axis = 0;
                        $this->y_axis = 0;
                }
                
                //  Create the image handle
                if ( ! ($src_img = $this->image_create_gd()))
                {               
                        return FALSE;
                }

                //  Create The Image
                //
                //  old conditional which users report cause problems with shared GD libs who report themselves as "2.0 or greater"
                //  it appears that this is no longer the issue that it was in 2004, so we've removed it, retaining it in the comment
                //  below should that ever prove inaccurate.
                //
                //  if ($this->image_library == 'gd2' AND function_exists('imagecreatetruecolor') AND $v2_override == FALSE)
                if ($this->image_library == 'gd2' AND function_exists('imagecreatetruecolor'))          
                {
                        $create = 'imagecreatetruecolor';
                        $copy   = 'imagecopyresampled';
                }
                else
                {
                        $create = 'imagecreate';        
                        $copy   = 'imagecopyresized';
                }
                        
                $dst_img = $create($this->width, $this->height);
                $copy($dst_img, $src_img, 0, 0, $this->x_axis, $this->y_axis, $this->width, $this->height, $this->orig_width, $this->orig_height);

                //  Show the image      
                if ($this->dynamic_output == TRUE)
                {
                        $this->image_display_gd($dst_img);
                }
                else
                {
                        // Or save it
                        if ( ! $this->image_save_gd($dst_img))
                        {
                                return FALSE;
                        }
                }

                //  Kill the file handles
                imagedestroy($dst_img);
                imagedestroy($src_img);
                
                // Set the file to 777
                @chmod($this->full_dst_path, DIR_WRITE_MODE);
                
                return TRUE;
        }

Here is the call graph for this function:

CI_Image_lib::image_process_imagemagick

(

$

action = 'resize'

)

Image Process Using ImageMagick.

This function will resize, crop or rotate

public

Parameters:

string

Returns:

bool

Definition at line 553 of file Image_lib.php.

References set_error().

        {
                //  Do we have a vaild library path?
                if ($this->library_path == '')
                {
                        $this->set_error('imglib_libpath_invalid');
                        return FALSE;
                }
                                
                if ( ! eregi("convert$", $this->library_path))
                {
                        if ( ! eregi("/$", $this->library_path)) $this->library_path .= "/";
                
                        $this->library_path .= 'convert';
                }
                
                // Execute the command
                $cmd = $this->library_path." -quality ".$this->quality;
        
                if ($action == 'crop')
                {
                        $cmd .= " -crop ".$this->width."x".$this->height."+".$this->x_axis."+".$this->y_axis." \"$this->full_src_path\" \"$this->full_dst_path\" 2>&1";
                }
                elseif ($action == 'rotate')
                {
                        switch ($this->rotation_angle)
                        {
                                case 'hor'      : $angle = '-flop';
                                        break;
                                case 'vrt'      : $angle = '-flip';
                                        break;
                                default         : $angle = '-rotate '.$this->rotation_angle;
                                        break;
                        }                       
                
                        $cmd .= " ".$angle." \"$this->full_src_path\" \"$this->full_dst_path\" 2>&1";
                }
                else  // Resize
                {
                        $cmd .= " -resize ".$this->width."x".$this->height." \"$this->full_src_path\" \"$this->full_dst_path\" 2>&1";
                }
        
                $retval = 1;
        
                @exec($cmd, $output, $retval);

                //      Did it work?    
                if ($retval > 0)
                {
                        $this->set_error('imglib_image_process_failed');
                        return FALSE;
                }
                
                // Set the file to 777
                @chmod($this->full_dst_path, DIR_WRITE_MODE);
                
                return TRUE;
        }

Here is the call graph for this function:

CI_Image_lib::image_process_netpbm

(

$

action = 'resize'

)

Image Process Using NetPBM.

This function will resize, crop or rotate

public

Parameters:

string

Returns:

bool

Definition at line 623 of file Image_lib.php.

References set_error().

        {
                if ($this->library_path == '')
                {
                        $this->set_error('imglib_libpath_invalid');
                        return FALSE;
                }
                        
                //  Build the resizing command
                switch ($this->image_type)
                {
                        case 1 :
                                                $cmd_in         = 'giftopnm';
                                                $cmd_out        = 'ppmtogif';
                                break;
                        case 2 :
                                                $cmd_in         = 'jpegtopnm';
                                                $cmd_out        = 'ppmtojpeg';                  
                                break;
                        case 3 :
                                                $cmd_in         = 'pngtopnm';
                                                $cmd_out        = 'ppmtopng';
                                break;
                }
                
                if ($action == 'crop')
                {
                        $cmd_inner = 'pnmcut -left '.$this->x_axis.' -top '.$this->y_axis.' -width '.$this->width.' -height '.$this->height;
                }
                elseif ($action == 'rotate')
                {
                        switch ($this->rotation_angle)
                        {
                                case 90         :       $angle = 'r270';
                                        break;
                                case 180        :       $angle = 'r180';
                                        break;
                                case 270        :       $angle = 'r90';
                                        break;
                                case 'vrt'      :       $angle = 'tb';
                                        break;
                                case 'hor'      :       $angle = 'lr';
                                        break;
                        }
                
                        $cmd_inner = 'pnmflip -'.$angle.' ';
                }
                else // Resize
                {
                        $cmd_inner = 'pnmscale -xysize '.$this->width.' '.$this->height;
                }
                                                
                $cmd = $this->library_path.$cmd_in.' '.$this->full_src_path.' | '.$cmd_inner.' | '.$cmd_out.' > '.$this->dest_folder.'netpbm.tmp';
                
                $retval = 1;
                
                @exec($cmd, $output, $retval);
                
                //  Did it work?
                if ($retval > 0)
                {
                        $this->set_error('imglib_image_process_failed');
                        return FALSE;
                }
                
                // With NetPBM we have to create a temporary image.
                // If you try manipulating the original it fails so
                // we have to rename the temp file.
                copy ($this->dest_folder.'netpbm.tmp', $this->full_dst_path);
                unlink ($this->dest_folder.'netpbm.tmp');
                @chmod($this->full_dst_path, DIR_WRITE_MODE);
                
                return TRUE;
        }

Here is the call graph for this function:

CI_Image_lib::image_reproportion

(

)

Re-proportion Image Width/Height.

When creating thumbs, the desired width/height can end up warping the image due to an incorrect ratio between the full-sized image and the thumb.

This function lets us re-proportion the width/height if users choose to maintain the aspect ratio when resizing.

public

Returns:

void

Definition at line 1276 of file Image_lib.php.

Referenced by initialize().

        {
                if ( ! is_numeric($this->width) OR ! is_numeric($this->height) OR $this->width == 0 OR $this->height == 0)
                        return;
                
                if ( ! is_numeric($this->orig_width) OR ! is_numeric($this->orig_height) OR $this->orig_width == 0 OR $this->orig_height == 0)
                        return;
                
                $new_width      = ceil($this->orig_width*$this->height/$this->orig_height);             
                $new_height     = ceil($this->width*$this->orig_height/$this->orig_width);
                
                $ratio = (($this->orig_height/$this->orig_width) - ($this->height/$this->width));
        
                if ($this->master_dim != 'width' AND $this->master_dim != 'height')
                {
                        $this->master_dim = ($ratio < 0) ? 'width' : 'height';
                }
                
                if (($this->width != $new_width) AND ($this->height != $new_height))
                {
                        if ($this->master_dim == 'height')
                        {
                                $this->width = $new_width;
                        }
                        else
                        {
                                $this->height = $new_height;
                        }
                }
        }       

Here is the caller graph for this function:

CI_Image_lib::image_rotate_gd

(

)

Image Rotate Using GD.

public

Returns:

bool

Definition at line 706 of file Image_lib.php.

References image_create_gd(), image_display_gd(), image_save_gd(), and set_error().

Referenced by rotate().

        {       
                // Is Image Rotation Supported?
                // this function is only supported as of PHP 4.3
                if ( ! function_exists('imagerotate'))
                {
                        $this->set_error('imglib_rotate_unsupported');
                        return FALSE;
                }
                
                //  Create the image handle
                if ( ! ($src_img = $this->image_create_gd()))
                {               
                        return FALSE;
                }

                // Set the background color             
                // This won't work with transparent PNG files so we are
                // going to have to figure out how to determine the color
                // of the alpha channel in a future release.
        
                $white  = imagecolorallocate($src_img, 255, 255, 255);

                //  Rotate it!
                $dst_img = imagerotate($src_img, $this->rotation_angle, $white);
        
                //  Save the Image
                if ($this->dynamic_output == TRUE)
                {
                        $this->image_display_gd($dst_img);
                }
                else
                {
                        // Or save it
                        if ( ! $this->image_save_gd($dst_img))
                        {
                                return FALSE;
                        }
                }

                //  Kill the file handles
                imagedestroy($dst_img);
                imagedestroy($src_img);
                
                // Set the file to 777
                
                @chmod($this->full_dst_path, DIR_WRITE_MODE);
                
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Image_lib::image_save_gd

(

$

resource

)

Write image file to disk - GD.

Takes an image resource as input and writes the file to the specified destination

public

Parameters:

resource

Returns:

bool

Definition at line 1187 of file Image_lib.php.

References set_error().

Referenced by image_mirror_gd(), image_process_gd(), image_rotate_gd(), overlay_watermark(), and text_watermark().

        {       
                switch ($this->image_type)
                {
                        case 1 :
                                                if ( ! function_exists('imagegif'))
                                                {
                                                        $this->set_error(array('imglib_unsupported_imagecreate', 'imglib_gif_not_supported'));
                                                        return FALSE;           
                                                }
                                                
                                                @imagegif($resource, $this->full_dst_path);
                                break;
                        case 2  :
                                                if ( ! function_exists('imagejpeg'))
                                                {
                                                        $this->set_error(array('imglib_unsupported_imagecreate', 'imglib_jpg_not_supported'));
                                                        return FALSE;           
                                                }
                                                
                                                if (phpversion() == '4.4.1')
                                                {
                                                        @touch($this->full_dst_path); // PHP 4.4.1 bug #35060 - workaround
                                                }
                                                
                                                @imagejpeg($resource, $this->full_dst_path, $this->quality);
                                break;
                        case 3  :
                                                if ( ! function_exists('imagepng'))
                                                {
                                                        $this->set_error(array('imglib_unsupported_imagecreate', 'imglib_png_not_supported'));
                                                        return FALSE;           
                                                }
                                        
                                                @imagepng($resource, $this->full_dst_path);
                                break;
                        default         :
                                                        $this->set_error(array('imglib_unsupported_imagecreate'));
                                                        return FALSE;           
                                break;          
                }
        
                return TRUE;
        }       

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Image_lib::initialize

(

$

props = array()

)

initialize image preferences

public

Parameters:

array

Returns:

void

Definition at line 128 of file Image_lib.php.

References explode_name(), get_image_properties(), image_reproportion(), and set_error().

Referenced by CI_Image_lib().

        {
                /*
                 * Convert array elements into class variables
                 */
                if (count($props) > 0)
                {
                        foreach ($props as $key => $val)
                        {
                                $this->$key = $val;
                        }
                }

                /*
                 * Is there a source image?
                 *
                 * If not, there's no reason to continue
                 *
                 */
                if ($this->source_image == '')
                {
                        $this->set_error('imglib_source_image_required');
                        return FALSE;           
                }
                
                /*
                 * Is getimagesize() Available?
                 *
                 * We use it to determine the image properties (width/height).
                 * Note:  We need to figure out how to determine image
                 * properties using ImageMagick and NetPBM
                 *
                 */             
                if ( ! function_exists('getimagesize'))
                {
                        $this->set_error('imglib_gd_required_for_props');
                        return FALSE;           
                }
                
                $this->image_library = strtolower($this->image_library);
                
                /*
                 * Set the full server path
                 *
                 * The source image may or may not contain a path.
                 * Either way, we'll try use realpath to generate the
                 * full server path in order to more reliably read it.
                 *
                 */     
                if (function_exists('realpath') AND @realpath($this->source_image) !== FALSE)
                {
                        $full_source_path = str_replace("\\", "/", realpath($this->source_image));
                }
                else
                {
                        $full_source_path = $this->source_image;
                }
                
                $x = explode('/', $full_source_path);
                $this->source_image = end($x);
                $this->source_folder = str_replace($this->source_image, '', $full_source_path);
                                                                
                // Set the Image Properties
                if ( ! $this->get_image_properties($this->source_folder.$this->source_image))
                {
                        return FALSE;           
                }                               

                /*
                 * Assign the "new" image name/path
                 *
                 * If the user has set a "new_image" name it means
                 * we are making a copy of the source image. If not
                 * it means we are altering the original.  We'll
                 * set the destination filename and path accordingly.
                 *
                 */                     
                if ($this->new_image == '')
                {
                        $this->dest_image = $this->source_image;
                        $this->dest_folder = $this->source_folder;
                }
                else
                {
                        if (strpos($this->new_image, '/') === FALSE)
                        {
                                $this->dest_folder = $this->source_folder;
                                $this->dest_image = $this->new_image;
                        }
                        else
                        {
                                if (function_exists('realpath') AND @realpath($this->new_image) !== FALSE)
                                {
                                        $full_dest_path = str_replace("\\", "/", realpath($this->new_image));
                                }
                                else
                                {
                                        $full_dest_path = $this->new_image;
                                }
                                
                                // Is there a file name?
                                if ( ! preg_match("#\.(jpg|jpeg|gif|png)$#i", $full_dest_path))
                                {
                                        $this->dest_folder = $full_dest_path.'/';
                                        $this->dest_image = $this->source_image;
                                }
                                else
                                {
                                        $x = explode('/', $full_dest_path);
                                        $this->dest_image = end($x);
                                        $this->dest_folder = str_replace($this->dest_image, '', $full_dest_path);
                                }
                        }
                }

                /*
                 * Compile the finalized filenames/paths
                 *
                 * We'll create two master strings containing the
                 * full server path to the source image and the
                 * full server path to the destination image.
                 * We'll also split the destination image name
                 * so we can insert the thumbnail marker if needed.
                 *
                 */     
                if ($this->create_thumb === FALSE OR $this->thumb_marker == '')
                {
                        $this->thumb_marker = '';
                }

                $xp     = $this->explode_name($this->dest_image);
        
                $filename = $xp['name'];
                $file_ext = $xp['ext'];
                                
                $this->full_src_path = $this->source_folder.$this->source_image;                
                $this->full_dst_path = $this->dest_folder.$filename.$this->thumb_marker.$file_ext;

                /*
                 * Should we maintain image proportions?
                 *
                 * When creating thumbs or copies, the target width/height
                 * might not be in correct proportion with the source
                 * image's width/height.  We'll recalculate it here.
                 *
                 */     
                if ($this->maintain_ratio === TRUE && ($this->width != '' AND $this->height != ''))
                {
                        $this->image_reproportion();
                }

                /*
                 * Was a width and height specified?
                 *
                 * If the destination width/height was
                 * not submitted we will use the values
                 * from the actual file
                 *
                 */     
                if ($this->width == '')
                        $this->width = $this->orig_width;
        
                if ($this->height == '')
                        $this->height = $this->orig_height;
        
                // Set the quality
                $this->quality = trim(str_replace("%", "", $this->quality));
                
                if ($this->quality == '' OR $this->quality == 0 OR ! is_numeric($this->quality))
                        $this->quality = 90;
        
                // Set the x/y coordinates
                $this->x_axis = ($this->x_axis == '' OR ! is_numeric($this->x_axis)) ? 0 : $this->x_axis;
                $this->y_axis = ($this->y_axis == '' OR ! is_numeric($this->y_axis)) ? 0 : $this->y_axis;
        
                // Watermark-related Stuff...
                if ($this->wm_font_color != '')
                {
                        if (strlen($this->wm_font_color) == 6)
                        {
                                $this->wm_font_color = '#'.$this->wm_font_color;
                        }
                }
                
                if ($this->wm_shadow_color != '')
                {
                        if (strlen($this->wm_shadow_color) == 6)
                        {
                                $this->wm_shadow_color = '#'.$this->wm_shadow_color;
                        }
                }
        
                if ($this->wm_overlay_path != '')
                {
                        $this->wm_overlay_path = str_replace("\\", "/", realpath($this->wm_overlay_path));
                }
        
                if ($this->wm_shadow_color != '')
                {
                        $this->wm_use_drop_shadow = TRUE;
                }

                if ($this->wm_font_path != '')
                {
                        $this->wm_use_truetype = TRUE;
                }

                return TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Image_lib::overlay_watermark

(

)

Watermark - Graphic Version.

public

Returns:

bool

Definition at line 873 of file Image_lib.php.

References $x_axis, $y_axis, get_image_properties(), image_create_gd(), image_display_gd(), image_save_gd(), and set_error().

Referenced by watermark().

        {
                if ( ! function_exists('imagecolortransparent'))
                {
                        $this->set_error('imglib_gd_required');
                        return FALSE;           
                }
        
                //  Fetch source image properties
                $this->get_image_properties();

                //  Fetch watermark image properties
                $props                  = $this->get_image_properties($this->wm_overlay_path, TRUE);    
                $wm_img_type    = $props['image_type'];
                $wm_width               = $props['width'];
                $wm_height              = $props['height'];
        
                //  Create two image resources  
                $wm_img  = $this->image_create_gd($this->wm_overlay_path, $wm_img_type);
                $src_img = $this->image_create_gd($this->full_src_path);
                
                // Reverse the offset if necessary              
                // When the image is positioned at the bottom
                // we don't want the vertical offset to push it
                // further down.  We want the reverse, so we'll
                // invert the offset.  Same with the horizontal
                // offset when the image is at the right
                
                $this->wm_vrt_alignment = strtoupper(substr($this->wm_vrt_alignment, 0, 1));
                $this->wm_hor_alignment = strtoupper(substr($this->wm_hor_alignment, 0, 1));
        
                if ($this->wm_vrt_alignment == 'B')
                        $this->wm_vrt_offset = $this->wm_vrt_offset * -1;
        
                if ($this->wm_hor_alignment == 'R')
                        $this->wm_hor_offset = $this->wm_hor_offset * -1;

                //  Set the base x and y axis values
                $x_axis = $this->wm_hor_offset + $this->wm_padding;
                $y_axis = $this->wm_vrt_offset + $this->wm_padding;

                //  Set the vertical position
                switch ($this->wm_vrt_alignment)
                {
                        case 'T':
                                break;
                        case 'M':       $y_axis += ($this->orig_height / 2) - ($wm_height / 2);
                                break;
                        case 'B':       $y_axis += $this->orig_height - $wm_height;
                                break;
                }

                //  Set the horizontal position
                switch ($this->wm_hor_alignment)
                {
                        case 'L':
                                break;  
                        case 'C':       $x_axis += ($this->orig_width / 2) - ($wm_width / 2);
                                break;
                        case 'R':       $x_axis += $this->orig_width - $wm_width;
                                break;
                }
        
                //  Build the finalized image                   
                if ($wm_img_type == 3 AND function_exists('imagealphablending'))
                {
                        @imagealphablending($src_img, TRUE);
                }               

                // Set RGB values for text and shadow
                $rgba = imagecolorat($wm_img, $this->wm_x_transp, $this->wm_y_transp);
                $alpha = ($rgba & 0x7F000000) >> 24;
                
                // make a best guess as to whether we're dealing with an image with alpha transparency or no/binary transparency
                if ($alpha > 0)
                {
                        // copy the image directly, the image's alpha transparency being the sole determinant of blending
                        imagecopy($src_img, $wm_img, $x_axis, $y_axis, 0, 0, $wm_width, $wm_height);
                }
                else
                {
                        // set our RGB value from above to be transparent and merge the images with the specified opacity
                        imagecolortransparent($wm_img, imagecolorat($wm_img, $this->wm_x_transp, $this->wm_y_transp));
                        imagecopymerge($src_img, $wm_img, $x_axis, $y_axis, 0, 0, $wm_width, $wm_height, $this->wm_opacity);                    
                }
                                
                //  Output the image
                if ($this->dynamic_output == TRUE)
                {
                        $this->image_display_gd($src_img);
                }
                else
                {
                        if ( ! $this->image_save_gd($src_img))
                        {
                                return FALSE;
                        }
                }
                
                imagedestroy($src_img);
                imagedestroy($wm_img);
                                
                return TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Image_lib::resize

(

)

Image Resize.

This is a wrapper function that chooses the proper resize function based on the protocol specified

public

Returns:

bool

Definition at line 349 of file Image_lib.php.

        {
                $protocol = 'image_process_'.$this->image_library;
                
                if (eregi("gd2$", $protocol))
                {
                        $protocol = 'image_process_gd';
                }
                
                return $this->$protocol('resize');
        }

CI_Image_lib::rotate

(

)

Image Rotate.

This is a wrapper function that chooses the proper rotation function based on the protocol specified

public

Returns:

bool

Definition at line 395 of file Image_lib.php.

References image_mirror_gd(), image_rotate_gd(), and set_error().

        {
                // Allowed rotation values              
                $degs = array(90, 180, 270, 'vrt', 'hor');      
        
                if ($this->rotation_angle == '' OR ! in_array($this->rotation_angle, $degs, TRUE))
                {
                        $this->set_error('imglib_rotation_angle_required');
                        return FALSE;           
                }
        
                // Reassign the width and height
                if ($this->rotation_angle == 90 OR $this->rotation_angle == 270)
                {
                        $this->width    = $this->orig_height;
                        $this->height   = $this->orig_width;
                }
                else
                {
                        $this->width    = $this->orig_width;
                        $this->height   = $this->orig_height;
                }
        

                // Choose resizing function
                if ($this->image_library == 'imagemagick' OR $this->image_library == 'netpbm')
                {
                        $protocol = 'image_process_'.$this->image_library;
                
                        return $this->$protocol('rotate');
                }
                
                if ($this->rotation_angle == 'hor' OR $this->rotation_angle == 'vrt')
                {
                        return $this->image_mirror_gd();
                }
                else
                {               
                        return $this->image_rotate_gd();
                }
        }

Here is the call graph for this function:

CI_Image_lib::set_error

(

$

msg

)

Set error message.

public

Parameters:

string

Returns:

void

Definition at line 1499 of file Image_lib.php.

References $CI, get_instance(), and log_message().

Referenced by get_image_properties(), image_create_gd(), image_process_imagemagick(), image_process_netpbm(), image_rotate_gd(), image_save_gd(), initialize(), overlay_watermark(), rotate(), and text_watermark().

        {
                $CI =& get_instance();
                $CI->lang->load('imglib');
                
                if (is_array($msg))
                {
                        foreach ($msg as $val)
                        {
                                
                                $msg = ($CI->lang->line($val) == FALSE) ? $val : $CI->lang->line($val);
                                $this->error_msg[] = $msg;
                                log_message('error', $msg);
                        }               
                }
                else
                {
                        $msg = ($CI->lang->line($msg) == FALSE) ? $msg : $CI->lang->line($msg);
                        $this->error_msg[] = $msg;
                        log_message('error', $msg);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Image_lib::size_calculator

(

$

vals

)

Size calculator.

This function takes a known width x height and recalculates it to a new size. Only one new variable needs to be known

$props = array( 'width' => $width, 'height' => $height, 'new_width' => 40, 'new_height' => '' );

public

Parameters:

array

Returns:

array

Definition at line 1378 of file Image_lib.php.

        {
                if ( ! is_array($vals))
                        return;
                        
                $allowed = array('new_width', 'new_height', 'width', 'height');
        
                foreach ($allowed as $item)
                {
                        if ( ! isset($vals[$item]) OR $vals[$item] == '')
                                $vals[$item] = 0;
                }
                
                if ($vals['width'] == 0 OR $vals['height'] == 0)
                {
                        return $vals;
                }
                        
                if ($vals['new_width'] == 0)
                {
                        $vals['new_width'] = ceil($vals['width']*$vals['new_height']/$vals['height']);
                }
                elseif ($vals['new_height'] == 0)
                {
                        $vals['new_height'] = ceil($vals['new_width']*$vals['height']/$vals['width']);
                }
        
                return $vals;
        }

CI_Image_lib::text_watermark

(

)

Watermark - Text Version.

public

Returns:

bool

Definition at line 986 of file Image_lib.php.

References $x_axis, $y_axis, get_image_properties(), image_create_gd(), image_display_gd(), image_save_gd(), and set_error().

Referenced by watermark().

        {
                if ( ! ($src_img = $this->image_create_gd()))
                {               
                        return FALSE;
                }
                                
                if ($this->wm_use_truetype == TRUE AND ! file_exists($this->wm_font_path))
                {
                        $this->set_error('imglib_missing_font');
                        return FALSE;
                }
                
                //  Fetch source image properties               
                $this->get_image_properties();                          
                
                // Set RGB values for text and shadow           
                $this->wm_font_color    = str_replace('#', '', $this->wm_font_color);
                $this->wm_shadow_color  = str_replace('#', '', $this->wm_shadow_color);
                
                $R1 = hexdec(substr($this->wm_font_color, 0, 2));
                $G1 = hexdec(substr($this->wm_font_color, 2, 2));
                $B1 = hexdec(substr($this->wm_font_color, 4, 2));
        
                $R2 = hexdec(substr($this->wm_shadow_color, 0, 2));
                $G2 = hexdec(substr($this->wm_shadow_color, 2, 2));
                $B2 = hexdec(substr($this->wm_shadow_color, 4, 2));
                
                $txt_color      = imagecolorclosest($src_img, $R1, $G1, $B1);
                $drp_color      = imagecolorclosest($src_img, $R2, $G2, $B2);

                // Reverse the vertical offset
                // When the image is positioned at the bottom
                // we don't want the vertical offset to push it
                // further down.  We want the reverse, so we'll
                // invert the offset.  Note: The horizontal
                // offset flips itself automatically
        
                if ($this->wm_vrt_alignment == 'B')
                        $this->wm_vrt_offset = $this->wm_vrt_offset * -1;
                        
                if ($this->wm_hor_alignment == 'R')
                        $this->wm_hor_offset = $this->wm_hor_offset * -1;

                // Set font width and height
                // These are calculated differently depending on
                // whether we are using the true type font or not
                if ($this->wm_use_truetype == TRUE)
                {
                        if ($this->wm_font_size == '')
                                $this->wm_font_size = '17';
                
                        $fontwidth  = $this->wm_font_size-($this->wm_font_size/4);
                        $fontheight = $this->wm_font_size;
                        $this->wm_vrt_offset += $this->wm_font_size;
                }
                else
                {
                        $fontwidth  = imagefontwidth($this->wm_font_size);
                        $fontheight = imagefontheight($this->wm_font_size);
                }

                // Set base X and Y axis values
                $x_axis = $this->wm_hor_offset + $this->wm_padding;
                $y_axis = $this->wm_vrt_offset + $this->wm_padding;

                // Set verticle alignment
                if ($this->wm_use_drop_shadow == FALSE)
                        $this->wm_shadow_distance = 0;
                        
                $this->wm_vrt_alignment = strtoupper(substr($this->wm_vrt_alignment, 0, 1));
                $this->wm_hor_alignment = strtoupper(substr($this->wm_hor_alignment, 0, 1));
        
                switch ($this->wm_vrt_alignment)
                {
                        case     "T" :
                                break;
                        case "M":       $y_axis += ($this->orig_height/2)+($fontheight/2);
                                break;
                        case "B":       $y_axis += ($this->orig_height - $fontheight - $this->wm_shadow_distance - ($fontheight/2));
                                break;
                }
        
                $x_shad = $x_axis + $this->wm_shadow_distance;
                $y_shad = $y_axis + $this->wm_shadow_distance;
                
                // Set horizontal alignment
                switch ($this->wm_hor_alignment)
                {
                        case "L":
                                break;
                        case "R":
                                                if ($this->wm_use_drop_shadow)
                                                        $x_shad += ($this->orig_width - $fontwidth*strlen($this->wm_text));
                                                        $x_axis += ($this->orig_width - $fontwidth*strlen($this->wm_text));
                                break;
                        case "C":
                                                if ($this->wm_use_drop_shadow)
                                                        $x_shad += floor(($this->orig_width - $fontwidth*strlen($this->wm_text))/2);
                                                        $x_axis += floor(($this->orig_width  -$fontwidth*strlen($this->wm_text))/2);
                                break;
                }
                
                //  Add the text to the source image
                if ($this->wm_use_truetype)
                {       
                        if ($this->wm_use_drop_shadow)
                                imagettftext($src_img, $this->wm_font_size, 0, $x_shad, $y_shad, $drp_color, $this->wm_font_path, $this->wm_text);
                                imagettftext($src_img, $this->wm_font_size, 0, $x_axis, $y_axis, $txt_color, $this->wm_font_path, $this->wm_text);
                }
                else
                {
                        if ($this->wm_use_drop_shadow)
                                imagestring($src_img, $this->wm_font_size, $x_shad, $y_shad, $this->wm_text, $drp_color);
                                imagestring($src_img, $this->wm_font_size, $x_axis, $y_axis, $this->wm_text, $txt_color);
                }
        
                //  Output the final image
                if ($this->dynamic_output == TRUE)
                {
                        $this->image_display_gd($src_img);
                }
                else
                {
                        $this->image_save_gd($src_img);
                }
                
                imagedestroy($src_img);
        
                return TRUE;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

CI_Image_lib::watermark

(

)

Image Watermark.

This is a wrapper function that chooses the type of watermarking based on the specified preference.

public

Parameters:

string

Returns:

bool

Definition at line 853 of file Image_lib.php.

References overlay_watermark(), and text_watermark().

        {
                if ($this->wm_type == 'overlay')
                {
                        return $this->overlay_watermark();
                }
                else
                {
                        return $this->text_watermark();
                }
        }

Here is the call graph for this function:

---

Member Data Documentation

CI_Image_lib::$copy_fnc = 'imagecopyresampled'

Definition at line 74 of file Image_lib.php.

CI_Image_lib::$create_fnc = 'imagecreatetruecolor'

Definition at line 73 of file Image_lib.php.

CI_Image_lib::$create_thumb = FALSE

Definition at line 37 of file Image_lib.php.

CI_Image_lib::$dest_folder = ''

Definition at line 65 of file Image_lib.php.

CI_Image_lib::$dynamic_output = FALSE

Definition at line 31 of file Image_lib.php.

CI_Image_lib::$error_msg = array()

Definition at line 75 of file Image_lib.php.

CI_Image_lib::$full_dst_path = ''

Definition at line 72 of file Image_lib.php.

CI_Image_lib::$full_src_path = ''

Definition at line 71 of file Image_lib.php.

CI_Image_lib::$height = ''

Definition at line 35 of file Image_lib.php.

Referenced by image_mirror_gd().

CI_Image_lib::$image_library = 'gd2'

Definition at line 29 of file Image_lib.php.

CI_Image_lib::$image_type = ''

Definition at line 69 of file Image_lib.php.

Referenced by image_create_gd().

CI_Image_lib::$library_path = ''

Definition at line 30 of file Image_lib.php.

CI_Image_lib::$maintain_ratio = TRUE

Definition at line 39 of file Image_lib.php.

CI_Image_lib::$master_dim = 'auto'

Definition at line 40 of file Image_lib.php.

CI_Image_lib::$mime_type = ''

Definition at line 66 of file Image_lib.php.

CI_Image_lib::$new_image = ''

Definition at line 33 of file Image_lib.php.

CI_Image_lib::$orig_height = ''

Definition at line 68 of file Image_lib.php.

CI_Image_lib::$orig_width = ''

Definition at line 67 of file Image_lib.php.

CI_Image_lib::$quality = '90'

Definition at line 36 of file Image_lib.php.

CI_Image_lib::$rotation_angle = ''

Definition at line 41 of file Image_lib.php.

CI_Image_lib::$size_str = ''

Definition at line 70 of file Image_lib.php.

CI_Image_lib::$source_folder = ''

Definition at line 64 of file Image_lib.php.

CI_Image_lib::$source_image = ''

Definition at line 32 of file Image_lib.php.

Referenced by explode_name().

CI_Image_lib::$thumb_marker = '_thumb'

Definition at line 38 of file Image_lib.php.

CI_Image_lib::$width = ''

Definition at line 34 of file Image_lib.php.

Referenced by image_mirror_gd().

CI_Image_lib::$wm_font_color = '#ffffff'

Definition at line 58 of file Image_lib.php.

CI_Image_lib::$wm_font_path = ''

Definition at line 51 of file Image_lib.php.

CI_Image_lib::$wm_font_size = 17

Definition at line 52 of file Image_lib.php.

CI_Image_lib::$wm_hor_alignment = 'C'

Definition at line 54 of file Image_lib.php.

CI_Image_lib::$wm_hor_offset = 0

Definition at line 56 of file Image_lib.php.

CI_Image_lib::$wm_opacity = 50

Definition at line 61 of file Image_lib.php.

CI_Image_lib::$wm_overlay_path = ''

Definition at line 50 of file Image_lib.php.

CI_Image_lib::$wm_padding = 0

Definition at line 55 of file Image_lib.php.

CI_Image_lib::$wm_shadow_color = ''

Definition at line 59 of file Image_lib.php.

CI_Image_lib::$wm_shadow_distance = 2

Definition at line 60 of file Image_lib.php.

CI_Image_lib::$wm_text = ''

Definition at line 46 of file Image_lib.php.

CI_Image_lib::$wm_type = 'text'

Definition at line 47 of file Image_lib.php.

CI_Image_lib::$wm_use_drop_shadow = FALSE

Definition at line 76 of file Image_lib.php.

CI_Image_lib::$wm_use_truetype = FALSE

Definition at line 77 of file Image_lib.php.

CI_Image_lib::$wm_vrt_alignment = 'B'

Definition at line 53 of file Image_lib.php.

CI_Image_lib::$wm_vrt_offset = 0

Definition at line 57 of file Image_lib.php.

CI_Image_lib::$wm_x_transp = 4

Definition at line 48 of file Image_lib.php.

CI_Image_lib::$wm_y_transp = 4

Definition at line 49 of file Image_lib.php.

CI_Image_lib::$x_axis = ''

Definition at line 42 of file Image_lib.php.

Referenced by overlay_watermark(), and text_watermark().

CI_Image_lib::$y_axis = ''

Definition at line 43 of file Image_lib.php.

Referenced by overlay_watermark(), and text_watermark().

---

The documentation for this class was generated from the following file:

• Image_lib.php