File Manipulation Code
  Home arrow File Manipulation Code arrow PHP Class: Image Snapshot 1.3
Codewalker Forums 
  Tutorials  
Database Articles  
Miscellaneous  
Navigation Usability  
PEAR Articles  
Programming Basics  
Server Administration  
XML Tutorials  
  Reviews  
Database Book Reviews  
Linux Book Reviews  
Miscellaneous Reviews  
PHP Book Reviews  
PHP Software Reviews  
Server Admin Reviews  
SQL Tool Reviews  
  Code Gallery  
Content Management Code  
Contest Code  
Counters Code  
Database Code  
Date Time Code  
Discussion Board Code  
Email Code  
File Manipulation Code  
GUI Code  
Link Farm Code  
Miscellaneous Code  
Search Code  
Site Navigation Code  
User Management Code  
Mobile Linux 
Case Studies 
iPad Development 
Download TestComplete 
Forums Sitemap 
Weekly Newsletter 
 
Developer Updates  
Free Website Content 
 RSS  Articles
 RSS  Forums
 RSS  All Feeds
Write For Us Get Paid 
Request Media Kit
Contact Us 
Site Map 
Privacy Policy 
Support 
 USERNAME
 
 PASSWORD
 
 
  >>> SIGN UP!  
  Lost Password? 
FILE MANIPULATION CODE

PHP Class: Image Snapshot 1.3
By: Codewalkers
  • Search For More Articles!
  • Disclaimer
  • Author Terms
  • Rating: 5 stars5 stars5 stars5 stars5 stars / 4
    2006-08-28

    Table of Contents:

    Rate this Article: Poor Best 
      ADD THIS ARTICLE TO:
      Del.ici.ous Digg
      Blink Simpy
      Google Spurl
      Y! MyWeb Furl
    Email Me Similar Content When Posted
    Add Developer Shed Article Feed To Your Site
    Email Article To Friend
    Print Version Of Article
    PDF Version Of Article
     
     
    ADVERTISEMENT


    Inspired by Backpackit.com’s image management, Image Snapshot can take a portion of an image (crop) to specific dimensions, from different areas of the original image.

    This class has been created for the purpose of manipulating an uploaded image, and creating a Thumbnail image that does not alter the aspect ratio, and yet represents the contents of the original image. I’m sure other uses can be found for the Image Snapshot class, but I’ll leave that to you. I use it for Photo Galleries, and Shopping Cart systems.

    This class supports:

    * Jpg, Gif, Png files
    * Output to Jpg
    * Can resize images before applying the crop
    * Can crop from any part of the image

    An online manual exists for more customizations: http://blog.jc21.com/files/snapshot_manual.pdf

    By : jc21com

    <?php
    /*
    IMAGE SNAPSHOT CLASS - www.jc21.com
    VERSION 1.3 ------------------------------------------------------

    Can accept JPG, GIF and PNG files.
    Refer to manual if you're confused:
    http://blog.jc21.com/files/snapshot_manual.pdf

    WARNING
    ------------------------------------------------------

    Will save all images as JPG.

    USAGE: ------------------------------------------------------

    include('snapshot.class.php'); //this file
    $myimage = new ImageSnapshot; //new instance
    //if using this as an action to a form:
    $myimage->ImageField = $_FILES['userfile']; //uploaded file array
    //OR if you have the contents of the image as a variable:
    $myimage->ImageContents = $the_image_contents; //image data
    //OR if you want to use an image that is already saved:
    $myimage->ImageFile = $_SERVER['DOCUMENT_ROOT'] . '/images/myimage.jpg'; //image file, as an example. Path can be relative or absolute.

    $myimage->Width = 100; //width of output image
    $myimage->Height = 100; //height of output image
    $myimage->Resize = true; //resize image before crop
    $myimage->ResizeScale = 50; //between 1 and 100, 0 for no resizing before crop, 100 to shrink image completely before crop
    $myimage->Position = 'center'; //can be 'center' (default), 'random', 'topleft', 'topcenter', 'topright', 'bottomleft', 'bottomcenter', 'bottomright','custom'
    $myimage->CustomPositionX = 25; //0 to 100. Only needed it Position is 'custom'. This specifies the position of the Snapshot along the X axis, in percentage. 25, is 25% from the left.
    $myimage->CustomPositiony = 35; //0 to 100. Only needed it Position is 'custom'. This specifies the position of the Snapshot along the Y axis, in percentage. 35, is 35% from the top.
    $myimage->Compression = 80; //jpg compression level

    //if you want to save as a file:
    if ($myimage->SaveImageAs('temp.jpg')) {
    echo '<img src="temp.jpg" border="0" width="' . $myimage->ReturnedWidth . '" height="' . $myimage->ReturnedHeight . '" alt="test" />';
    } else {
    echo $myimage->Err;
    }

    //OR if you want to get the contents into a variable:
    if ($myimage->ProcessImage() !== false) {
    $img = $myimage->GetImageContents();
    } else {
    echo $myimage->Err;
    }




    CHANGE LOG:
    ------------------------------------------------------
    05-12-2005 1.3 Release
    05-12-2005 Added: ImageFile field, can now load image from saved file.
    05-12-2005 Added: custom position type, specify by percentages. Read updated manual for help with this.
    28-11-2005 1.2 Release
    28-11-2005 Added: ReturnedWidth and ReturnedHeight variables, for more feedback.
    28-11-2005 Fixed: if crop area was bigger than original image, mixed results occured.
    28-11-2005 1.1 Release
    28-11-2005 Added: support for Image input with a variable
    27-11-2005 1.0 Release

    */




    class ImageSnapshot {

    var $ImageField; // should be: $_FILES['imagefield'] array, OR set the next var.
    var $ImageFile; // location of an image file saved on the server.
    var $ImageContents; // Contents of an image in a variable.
    var $Compression; // JPG compression. Default is 75%

    var $Resize; //either true or false. wether to resize image, if true the uses the next 3 vars
    var $ResizeScale; //scale to resize the image to. 100 is as small as possible, 0 is effectively no resizing at all.

    var $Position; //position of the snapshot: random, center (default), topleft, topright, bottomleft, bottomright

    var $Width; // width (or max width) of image to output
    var $Height; // height (or max height) of image to output

    var $Err; // error if (and when) they occur

    var $InternalImage; // Internal variable for working with the image

    var $ReturnedWidth; //New in 1.2: this is the actual width of the image returned, will only differ to Width if the original image was smaller.
    var $ReturnedHeight; //New in 1.2: this is the actual height of the image returned, will only differ to Height if the original image was smaller.

    var $CustomPositionX; //New in 1.3: 0 to 100, this is the percentage of the custom position along the X scale. $Position must be 'custom' for this to apply.
    var $CustomPositionY; //New in 1.3: 0 to 100, this is the percentage of the custom position along the Y scale. $Position must be 'custom' for this to apply.


    function ImageSnapshot() {
    //set up some defaults
    $this->Width = '800';
    $this->Height = '600';
    $this->Resize = true;
    $this->ResizeScale = 100;
    $this->Position = 'center';
    $this->Err = '';
    $this->Compression = 75;
    $this->InternalImage = '';
    $this->ImageContents = '';
    $this->ReturnedWidth = 0; // New in 1.2
    $this->ReturnedHeight = 0; // New in 1.2
    $this->CustomPositionX = 50; // New in 1.3
    $this->CustomPositionY = 50; // New in 1.3
    }



    function SaveImageAs($destination) {
    //Saves the image to the desination. Returns true if successful, or false with Err specifying the error.
    //example: $myimage->SaveImageAs("/docroot/images/newimage.jpg
    if ($this->ProcessImage()) {

    if (!$handle = fopen($destination, 'w')) {
    $this->Err = 'Cannot open file (' . $destination . ')';
    return false;
    } else {
    if (fwrite($handle, $this->InternalImage) === FALSE) {
    $this->Err = 'Cannot write to file (' . $destination . ')';
    return false;
    } else {
    return true;
    }
    fclose($handle);
    }
    } else {
    return false;
    }
    }

    function GetImageContents() {
    // If not already processed, calls process image, and returns the contents for other manipulations or database entry.
    if (strlen($this->InternalImage) == 0) {
    $this->ProcessImage();
    }
    //return the contents of the variable.
    return $this->InternalImage;
    }

    function ProcessImage() {
    //Processes the image. Resize if needed. fills the internal image with the contents of the changed image.
    //Internal function

    if (strlen($this->ImageContents) > 0) {
    //LOAD FROM STRING!
    $tmp_image = @imagecreatefromstring($this->ImageContents);
    //END LOAD FROM STRING

    } elseif (strlen($this->ImageFile) > 0) {
    //LOAD FROM FILE
    //check that file exists
    if (file_exists($this->ImageFile)) {
    //load it!
    $data = getimagesize($this->ImageFile); //[0] = w, [1] = h, [2] = type, [3] = attr
    switch ($data[2]) {
    case 1:
    $tmp_image = @imagecreatefromgif($this->ImageFile);
    break;
    case 2:
    $tmp_image = @imagecreatefromjpeg($this->ImageFile);
    break;
    case 3:
    $tmp_image = @imagecreatefrompng($this->ImageFile);
    break;
    default:
    $this->Err = 'File is not a valid image type';
    return false;
    exit;
    break;
    }
    } else {
    $this->Err = 'File "' . $this->ImageFile . '" does not exist!';
    return false;
    }
    //END LOAD FROM FILE

    } elseif (count($this->ImageField) > 0) {
    //LOAD FROM FIELD FILE
    //check that file exists
    if (file_exists($this->ImageField['tmp_name'])) {
    //load it!
    $data = getimagesize($this->ImageField['tmp_name']); //[0] = w, [1] = h, [2] = type, [3] = attr
    switch ($data[2]) {
    case 1:
    $tmp_image = @imagecreatefromgif($this->ImageField['tmp_name']);
    break;
    case 2:
    $tmp_image = @imagecreatefromjpeg($this->ImageField['tmp_name']);
    break;
    case 3:
    $tmp_image = @imagecreatefrompng($this->ImageField['tmp_name']);
    break;
    default:
    $this->Err = 'File is not a valid image type';
    return false;
    exit;
    break;
    }
    } else {
    $this->Err = 'File "' . $this->ImageField['tmp_name'] . '" does not exist!';
    return false;
    }
    //END LOAD FROM FILE

    } else {
    $this->Err = 'No image was loaded, use ImageFile, ImageContents or ImageField before output';
    return false;
    exit;
    }

    $image_width = imagesx($tmp_image);
    $image_height = imagesy($tmp_image);

    //check a div by zero error.
    if ($this->Resize == true && $this->ResizeScale == 0) {
    //there is no point resizing, when the scale doesn't change the size anyway.
    $this->Resize = false;
    }


    //check if image is meant to be resized...
    if ($this->Resize == 'true' || $this->Resize == 1) {
    //Yes resize
    if ($image_width > $this->Width && $image_height > $this->Height) {
    //have to resize..
    //get the proportional dimensions, while allowing room for a snapshot, and according to the resizescale
    $w_ratio = $this->Width / ($image_width * ($this->ResizeScale / 100)); //width ratio.. ie: 0.1 = 80 / 800
    $h_ratio = $this->Height / ($image_height * ($this->ResizeScale / 100)); //height ratio. ie: 0.075 = 60 / 800
    $maxwidth = $this->Width; //maxwidth is the max width of the final snapshot
    $maxheight = $this->Height; //maxheight is the max height of the final snapshot
    if ($w_ratio < $h_ratio) {
    $maxheight = ceil($image_height * $h_ratio);
    $maxwidth = ceil($image_width * $h_ratio);
    } else {
    $maxwidth = ceil($image_width * $w_ratio);
    $maxheight = ceil($image_height * $w_ratio);
    }

    //now we either have a correctly sized image (compared to the thumb) or an oversized image, that has been shrink and waiting to be snaopshot'd

    $final_width = $maxwidth;
    $final_height = $maxheight;
    //end maintain aspect

    imagecopyresampled($tmp_image, $tmp_image,0,0,0,0, $final_width, $final_height, $image_width, $image_height);

    $image_width = $final_width;
    $image_height = $final_height;

    }

    // end resize
    }

    //SNAPSHOT
    //at this stage, $tmp_image should contain the image ready for snapshot.

    if ($image_width < $this->Width) {
    $this->Width = $image_width;
    }
    if ($image_height < $this->Height) {
    $this->Height = $image_height;
    }

    //create canvas
    $new_photo = imagecreatetruecolor($this->Width,$this->Height);
    //set return values.
    $this->ReturnedWidth = $this->Width;
    $this->ReturnedHeight = $this->Height;

    $source_y = 0;
    $source_x = 0;

    //we shall compare the snapshot dimensions to the image dimensions

    switch ($this->Position) {
    case 'random':
    //my favourite, random place on the image.
    if ($image_height > $this->Height) {
    // height is larger.
    //get the min and max room to play with
    $min = 0;
    $max = $image_height - $this->Height;
    $source_y = rand($min,$max);
    }
    if ($image_width > $this->Width) {
    // width is larger.
    $min = 0;
    $max = $image_width - $this->Width;
    $source_x = rand($min,$max);
    }
    break;

    case 'topright':
    //topright of the image
    $source_y = 0;
    if ($image_width > $this->Width) {
    // width is larger.
    $source_x = $image_width - $this->Width;
    }
    break;

    case 'topleft':
    //topleft of the image
    $source_y = 0;
    $source_x = 0;
    break;

    case 'topcenter':
    //topleft of the image
    $source_y = 0;
    if ($image_width > $this->Width) {
    // width is larger.
    $source_x = (($image_width - $this->Width) / 2);
    }
    break;

    case 'bottomright':
    //bottomright of the image
    if ($image_height > $this->Height) {
    // height is larger.
    $source_y = $image_height - $this->Height;
    }
    if ($image_width > $this->Width) {
    // width is larger.
    $source_x = $image_width - $this->Width;
    }
    break;

    case 'bottomleft':
    //bottom left of the image
    if ($image_height > $this->Height) {
    // height is larger.
    $source_y = $image_height - $this->Height;
    }
    $source_x = 0;
    break;

    case 'bottomcenter':
    //bottom left of the image
    if ($image_height > $this->Height) {
    // height is larger.
    $source_y = $image_height - $this->Height;
    }
    if ($image_width > $this->Width) {
    // width is larger.
    $source_x = (($image_width - $this->Width) / 2);
    }
    break;

    case 'custom':
    //new in 1.3
    //use custom positions as percentages to get the position.
    if (round($this->CustomPositionX) < 0 || round($this->CustomPositionX) > 100) {
    //x not a valid number. Reset:
    $this->CustomPositionX = 50;
    }
    if (round($this->CustomPositionY) < 0 || round($this->CustomPositionY) > 100) {
    //y not a valid number. Reset:
    $this->CustomPositionY = 50;
    }

    //get the digits!
    if (round($this->CustomPositionY) == 0 || $image_height <= $this->Height) {
    //does not meet credentials
    $source_y = 0;
    } else {
    //ok
    $source_y = (($image_height - $this->Height) * (round($this->CustomPositionY) / 100)) ;
    }
    if (round($this->CustomPositionX) == 0 || $image_width <= $this->Width) {
    //does not meet credentials
    $source_x = 0;
    } else {
    //ok
    $source_x = (($image_width - $this->Width) * (round($this->CustomPositionX) / 100)) ;
    }
    break;

    default:
    //center of the image
    if ($image_height > $this->Height) {
    // height is larger.
    $source_y = (($image_height - $this->Height) / 2);
    }
    if ($image_width > $this->Width) {
    // width is larger.
    $source_x = (($image_width - $this->Width) / 2);
    }
    break;
    }

    //copy specific portions of the image
    imagecopyresampled($new_photo, $tmp_image,0,0,$source_x,$source_y, $this->Width, $this->Height, $this->Width, $this->Height);
    ob_start();
    imagejpeg($new_photo,null,$this->Compression);
    $this->InternalImage = ob_get_contents();
    ob_end_clean();
    return true;
    //END SNAPSHOT

    }
    }
    ?>
    DISCLAIMER: The content provided in this article is not warranted or guaranteed by Developer Shed, Inc. The content provided is intended for entertainment and/or educational purposes in order to introduce to the reader key ideas, concepts, and/or product reviews. As such it is incumbent upon the reader to employ real-world tactics for security and implementation of best practices. We are not liable for any negative consequences that may result from implementing any information covered in our articles or tutorials. If this is a hardware review, it is not recommended to open and/or modify your hardware.

    More File Manipulation Code Articles
    More By Codewalkers

     

    IBM® developerWorks developerWorks - FREE Tools!


    Build Forge Express demo: Enabling software delivery excellence for small and midsized businesses

    This demonstration gives you an overview of IBM® Rational® Build Forge Express Edition, a global offering that provides a framework to automate and execute software processes. Rational Build Forge provides a software assembly line that can support all of your tools, technologies, and platforms so you can achieve a repeatable, reliable, and traceable build and release process.
    FREE! Go There Now!


    Check out the new Jazz space on developerWorks

    <a href="http://zeus.developershed.com/shonuff.php?blackbird=3853&zoneid=442&source=&dest=http%3A%2F%2Fwww.ibm.com%2Fdeveloperworks%2Fspaces%2Fjazz%3FS_TACT%3D105AGY31%26S_CMP%3DDEVSHED&ismap="><img src="http://images.devshed.com/corp/img/news/jazz01.gif" alt="developerWorks Jazz space" align="left"></a>You've heard the buzz about Jazz... want to know more about it from a developer's perspective? Check out the Jazz space on developerWorks. This space is an up-to-date resource for developers, including technical information about Jazz and products built on Jazz, like Rational Team Concert Express. The Jazz space includes content from a wide variety of sources, including links, feeds, and comments from experts.
    FREE! Go There Now!


    NEW! Addressing software-as-a-service challenges using Tivoli security and WebSphere solutions

    Building a software-as-a-service solution requires addressing a few key technical challenges. In this webcast, we'll focus on the role of IBM Tivoli Directory Server and WebSphere Portlet Factory in creating a Software as a Service solution. We will demonstrate how to use Tivoli Directory Server to prevent the user population of one tenant from accessing the virtual portal and portlet components of another tenant. We will also use the dynamic profile capability of WebSphere Portlet Factory to create multiple highly customized applications from one code base.
    FREE! Go There Now!


    NEW! Discovering the value of WebSphere Process Server

    WebSphere Process Server delivers a unique integration framework that simplifies existing IT resources. Often, as IT assets grow to support business demand, so too does their complexity and manageability. In this webcast, we’ll discuss how WebSphere Process Server helps deliver an SOA infrastructure that provides a common model to orchestrate, mediate, connect, map, and execute the underlying IT functions. Discover how WebSphere Process Server simplifies integration of business processes by leveraging existing IT assets as reusable services without the complexities of traditional integration methodologies.
    FREE! Go There Now!


    NEW! Download IBM Data Studio V1.1

    Visit IBM developerWorks to download the latest trial version of IBM Data Studio V1.1 at no cost. IBM Data Studio is a comprehensive data management solution that helps you effectively design, develop, deploy and manage your data, databases, and database applications throughout the data management life cycle utilizing a consistent and integrated user interface. Unlike other client-side data management solutions that focus on only one aspect of the application lifecycle or database administration, Data Studio complements the Rational Software Delivery platform, providing unparalleled flexibility for a heterogeneous data server environment across platforms.
    FREE! Go There Now!


    NEW! Evaluate IBM Lotus Sametime Standard V8.0

    Visit IBM developerWorks to download a free trial of the latest release of IBM Lotus Sametime Standard V8.0. Lotus Sametime Standard V8.0 is a platform for unified communications and collaboration that combines security features with an extensible, open solution including integrated Voice over IP, geographic location awareness, mobile clients, and a robust Business Partner community offering telephony and video integration.
    FREE! Go There Now!


    NEW! Evaluate IBM Rational Software Analyzer V7.0

    Download a free trial version of IBM Rational Software Analyzer Developer Edition V7.0 to identify bug defects earlier in the software development cycle. Rational Software Analyzer is an extensible software development solution that reduces the expense of bug-fixes by enabling static analysis code reviews and bug identification very early in the development cycle.
    FREE! Go There Now!


    NEW! Rational Testing eKits

    Discover how Rational tools and best practices for testing can make your job easier. The new Rational Testing eKits provide you with valuable resources – including demos, webcasts, tutorials, and articles – that help you address your specific testing needs across the software lifecycle. Five new eKits are available covering the topics of Requirements and Test Management, Functional Testing, Performance Testing, Code Quality and Embedded Systems, and SOA and Web Services Testing.
    FREE! Go There Now!


    NEW! Trial download: IBM Rational Manual Tester V7.0.1

    Try the latest version of IBM Rational Manual Tester V7.0.1 by downloading a free trial from IBM developerWorks. This manual test authoring and execution tool promotes test step reuse to reduce the impact of software change on testers and business analysts and addresses the needs of teams performing at least a portion of their testing manually.
    FREE! Go There Now!


    NEW! Webcast: Introducing the new Information Server and Solutions community: LeverageInformation

    User communities play an important role in communication and collaboration around products, solutions and other areas of special interest to members. Successful communities are able to provide the right mix of content and services to deliver a value proposition that resonates with each audience. Join Tom Inman, VP of Marketing for Information and Platform Solutions as he introduces the new LeverageINFORMATION community. During this webcast, learn about the value provided by the community and how customers and partners derive value from the community in addressing their own technical and business challenges.
    FREE! Go There Now!



    All FREE IBM® developerWorks Tools!

    FILE MANIPULATION CODE ARTICLES

    - Bandwidth Control with pure PHP
    - Eazy Gallery
    - file_get_contents for PHP < 4.3.0
    - PHP Class: Image Snapshot 1.3
    - Universal downloader
    - Image Gallery v2.0
    - Free/Used Disk Space
    - Directory Lister
    - Directory image view, with selective hidden
    - Move or Copy a Directory (and files and sub ...
    - Ensure_Sub_Directory_Exists
    - Wedit
    - Form Examples Text Boxes to Drop Downs
    - myFiles
    - List files in a directory, no subdirectories





    © 2003-2010 by Developer Shed. All rights reserved. DS Cluster 6 Hosted by Hostway
    For more Enterprise Application Development news, visit eWeek