* WideImage::registerCustomMapper('WideImage_Mapper_TGA', 'image/tga', 'tga'); * * * @param string $mapper_class_name * @param string $mime_type * @param string $extension */ public static function registerCustomMapper($mapper_class_name, $mime_type, $extension) { WideImage_MapperFactory::registerMapper($mapper_class_name, $mime_type, strtoupper($extension)); } /** * Loads an image from a file, URL, HTML input file field, binary string, or a valid image handle. * The image format is auto-detected. * * Currently supported formats: PNG, GIF, JPG, BMP, TGA, GD, GD2. * * This function analyzes the input and decides whether to use WideImage::loadFromHandle(), * WideImage::loadFromFile(), WideImage::loadFromUpload() or WideImage::loadFromString(), * all of which you can also call directly to spare WideImage some guessing. * * Arrays are supported for upload fields; it returns an array of loaded images. * To load only a single image from an array field, use WideImage::loadFromUpload('img', $i), * where $i is the index of the image you want to load. * * * $img = WideImage::load('http://url/image.png'); // image URL * $img = WideImage::load('/path/to/image.png'); // local file path * $img = WideImage::load('img'); // upload field name * $img = WideImage::load(imagecreatetruecolor(10, 10)); // a GD resource * $img = WideImage::load($image_data); // binary string containing image data * * * @param mixed $source File name, url, HTML file input field name, binary string, or a GD image resource * @return WideImage_Image WideImage_PaletteImage or WideImage_TrueColorImage instance */ public static function load($source) { $predictedSourceType = ''; if ($source == '') { $predictedSourceType = 'String'; } // Creating image via a valid resource if (!$predictedSourceType && self::isValidImageHandle($source)) { $predictedSourceType = 'Handle'; } // Check for binary string if (!$predictedSourceType) { // search first $binLength bytes (at a maximum) for ord<32 characters (binary image data) $binLength = 64; $sourceLength = strlen($source); $maxlen = ($sourceLength > $binLength) ? $binLength : $sourceLength; for ($i = 0; $i < $maxlen; $i++) { if (ord($source[$i]) < 32) { $predictedSourceType = 'String'; break; } } } // Uploaded image (array uploads not supported) if (isset($_FILES[$source]) && isset($_FILES[$source]['tmp_name'])) { $predictedSourceType = 'Upload'; } // Otherwise, must be a file or an URL if (!$predictedSourceType) { $predictedSourceType = 'File'; } return call_user_func(array('WideImage', 'loadFrom' . $predictedSourceType), $source); } /** * Create and load an image from a file or URL. The image format is auto-detected. * * @param string $uri File or url * @return WideImage_Image WideImage_PaletteImage or WideImage_TrueColorImage instance */ public static function loadFromFile($uri) { $data = file_get_contents($uri); $handle = @imagecreatefromstring($data); if (!self::isValidImageHandle($handle)) { try { // try to find a mapper first $mapper = WideImage_MapperFactory::selectMapper($uri); if ($mapper) { $handle = $mapper->load($uri); } } catch (WideImage_UnsupportedFormatException $e) { // mapper not found } // try all custom mappers if (!self::isValidImageHandle($handle)) { $custom_mappers = WideImage_MapperFactory::getCustomMappers(); foreach ($custom_mappers as $mime_type => $mapper_class) { $mapper = WideImage_MapperFactory::selectMapper(null, $mime_type); $handle = $mapper->loadFromString($data); if (self::isValidImageHandle($handle)) { break; } } } } if (!self::isValidImageHandle($handle)) { throw new WideImage_InvalidImageSourceException("File '{$uri}' appears to be an invalid image source."); } return self::loadFromHandle($handle); } /** * Create and load an image from a string. Format is auto-detected. * * @param string $string Binary data, i.e. from BLOB field in the database * @return WideImage_Image WideImage_PaletteImage or WideImage_TrueColorImage instance */ public static function loadFromString($string) { if (strlen($string) < 128) { throw new WideImage_InvalidImageSourceException("String doesn't contain image data."); } $handle = @imagecreatefromstring($string); if (!self::isValidImageHandle($handle)) { $custom_mappers = WideImage_MapperFactory::getCustomMappers(); foreach ($custom_mappers as $mime_type => $mapper_class) { $mapper = WideImage_MapperFactory::selectMapper(null, $mime_type); $handle = $mapper->loadFromString($string); if (self::isValidImageHandle($handle)) { break; } } } if (!self::isValidImageHandle($handle)) { throw new WideImage_InvalidImageSourceException("String doesn't contain valid image data."); } return self::loadFromHandle($handle); } /** * Create and load an image from an image handle. * * Note: the resulting image object takes ownership of the passed * handle. When the newly-created image object is destroyed, the handle is * destroyed too, so it's not a valid image handle anymore. In order to * preserve the handle for use after object destruction, you have to call * WideImage_Image::releaseHandle() on the created image instance prior to its * destruction. * * * $handle = imagecreatefrompng('file.png'); * $image = WideImage::loadFromHandle($handle); * * * @param resource $handle A valid GD image resource * @return WideImage_Image WideImage_PaletteImage or WideImage_TrueColorImage instance */ public static function loadFromHandle($handle) { if (!self::isValidImageHandle($handle)) { throw new WideImage_InvalidImageSourceException("Handle is not a valid GD image resource."); } if (imageistruecolor($handle)) { return new WideImage_TrueColorImage($handle); } else { return new WideImage_PaletteImage($handle); } } /** * This method loads a file from the $_FILES array. The image format is auto-detected. * * You only have to pass the field name as the parameter. For array fields, this function will * return an array of image objects, unless you specify the $index parameter, which will * load the desired image. * * @param $field_name Name of the key in $_FILES array * @param int $index The index of the file to load (if the input field is an array) * @return WideImage_Image The loaded image */ public static function loadFromUpload($field_name, $index = null) { if (!array_key_exists($field_name, $_FILES)) { throw new WideImage_InvalidImageSourceException("Upload field '{$field_name}' doesn't exist."); } if (is_array($_FILES[$field_name]['tmp_name'])) { if (isset($_FILES[$field_name]['tmp_name'][$index])) { $filename = $_FILES[$field_name]['tmp_name'][$index]; } else { $result = array(); foreach ($_FILES[$field_name]['tmp_name'] as $idx => $tmp_name) { $result[$idx] = self::loadFromFile($tmp_name); } return $result; } } else { $filename = $_FILES[$field_name]['tmp_name']; } if (!file_exists($filename)) { throw new WideImage_InvalidImageSourceException("Uploaded file doesn't exist."); } return self::loadFromFile($filename); } /** * Factory method for creating a palette image * * @param int $width * @param int $height * @return WideImage_PaletteImage */ public static function createPaletteImage($width, $height) { return WideImage_PaletteImage::create($width, $height); } /** * Factory method for creating a true-color image * * @param int $width * @param int $height * @return WideImage_TrueColorImage */ public static function createTrueColorImage($width, $height) { return WideImage_TrueColorImage::create($width, $height); } /** * Check whether the given handle is a valid GD resource * * @param mixed $handle The variable to check * @return bool */ public static function isValidImageHandle($handle) { return (is_resource($handle) && get_resource_type($handle) == 'gd'); } /** * Throws exception if the handle isn't a valid GD resource * * @param mixed $handle The variable to check */ public static function assertValidImageHandle($handle) { if (!self::isValidImageHandle($handle)) { throw new WideImage_InvalidImageHandleException("{$handle} is not a valid image handle."); } } } WideImage::checkGD(); WideImage::registerCustomMapper('WideImage_Mapper_BMP', 'image/bmp', 'bmp'); WideImage::registerCustomMapper('WideImage_Mapper_TGA', 'image/tga', 'tga');