What does this do?

This plugin generates a bunch of different favicon files from a given source file and returns html code embedding these images as favicons links and apple touch icons links.

The generates icons from myfaviconsrc.jpg are put in a subfolder /favicons/myfaviconsrc in your images folder. If you update myfaviconsrc.jpg, you need to delete the folder myfaviconsrc or at least the containing images in order to force the icons to be regenerated.

How do I use it?

Just insert this tag into the header of your page like: {favicon src='myfaviconsrc.jpg'}

You can place it either in the '); ?> section of your template or in global meta data (Site preferences)

What parameters does it take?

• (required) src - image file within you images folder which should the source to generate icons
• icon_size - a list of width in pixels for the different png icon sizes to be linked. Default is "16, 32, 96, 160, 196", which generates and links png icons width 16x16, 32x32, 96x96, 160x160, 196x196.
• apple_icon_size - same as icon_size but for the apple touch icons, which have differenz width by default: 57, 60, 72, 76, 114, 120, 144, 152 pixels.
• only - generates and links only listet in this parameter (multiple values seperated by space):
  • ico - only .ico-file
  • png - only .png-files, which are linked with rel="icon"
  • apple - only .png-files, which are linked with rel="apple-touch-icon"
  Use this parameter to use different source images for apple and normal icons or generated sizes.
• assign - smarty variable name to assign the returned content of this plugin

Additional Infos

• Your source file should be square width at least 196px width and height in order to generate the biggest apple icon
• You should only use A-Za-z0-9_- within the filename. (No spaces or non-ASCII-characters!). Remember that path and filenames are case-sensitive!
• Valid src image formats are: JPEG, PNG, GIF, WBMP, and GD2 if your build of PHP supports them.

Thanks to

Thanks to chrisbliss18 and his php-ico class found at https://github.com/chrisbliss18/php-ico

Author: Georg Wallisch (mail@phpco.de);

Version: 1.1

Change History:

• 1.0 - Initial release (03.04.2015)
• 1.1 - Refactored. Added more parameters (04.04.2015)
0) ? 'type="'.$type.'" ' : ''; if(!is_array($icon_sizes)) return false; foreach($icon_sizes as $icon_size) { $icon_size_txt = "{$icon_size}x{$icon_size}"; $faviconfile = "{$iconname}-{$icon_size_txt}.png"; $faviconpath = $icondir.'/'.$faviconfile; $faviconurl = $iconurl.'/'.$faviconfile; if(file_exists($faviconpath) or _function_favicon_create_png_icon($srcfilepath, $faviconpath, $icon_size)) { $output .= "\n".''; } else { $output .= "\n"; } } return $output; } function _function_favicon_create_png_icon($srcfile, $dstfile, $dstwidth) { $srcsize = @getimagesize($srcfile); if(!is_array($srcsize)) { //$errors[] = 'Cannot read sourcefile'; return false; } $srcwidth = $srcsize[0]; $srcheight = $srcsize[1]; $dstheight = $dstwidth; if($srcwidth <= $dstwidth and $srcheight <= $dstheight) { //$errors[] = 'Source image smaller than destinated image'; return false; } $src_image = @imagecreatefromstring(@file_get_contents($srcfile)); $dst_image = @imagecreatetruecolor($dstwidth, $dstheight); if($src_image == false or $dst_image == false) { return false; } // Initialise the destination image to transparent instead of // the default solid black, to support PNG and GIF transparency nicely $background = imagecolorallocate($dst_image, 0, 0, 0); imagecolortransparent($dst_image, $background); imagealphablending($dst_image, false); if($colorStyle == 'palette') { // Don't resample for paletted GIF images. // It may just uglify them, and completely breaks transparency. imagecopyresized($dst_image, $src_image, 0,0,0,0, $dstwidth, $dstheight, imagesx($src_image), imagesy($src_image)); } else { imagecopyresampled($dst_image, $src_image, 0,0,0,0, $dstwidth, $dstheight, imagesx($src_image), imagesy($src_image)); } imagesavealpha($dst_image, true); imagepng($dst_image, $dstfile); imagedestroy($dst_image); imagedestroy($src_image); //chmod($dstfile,0777); if(file_exists($dstfile) and is_readable($dstfile)) { return true; } //$errors[] = "{$dstfile} does not exists or is not readable."; return false; } /* Copyright 2011-2013 Chris Jean & iThemes Licensed under GPLv2 or above Version 1.0.2 src: https://raw.githubusercontent.com/chrisbliss18/php-ico/ */ class PHP_ICO { /** * Images in the BMP format. * * @var array * @access private */ var $_images = array(); /** * Flag to tell if the required functions exist. * * @var boolean * @access private */ var $_has_requirements = false; /** * Constructor - Create a new ICO generator. * * If the constructor is not passed a file, a file will need to be supplied using the {@link PHP_ICO::add_image} * function in order to generate an ICO file. * * @param string $file Optional. Path to the source image file. * @param array $sizes Optional. An array of sizes (each size is an array with a width and height) that the source image should be rendered at in the generated ICO file. If sizes are not supplied, the size of the source image will be used. */ function PHP_ICO( $file = false, $sizes = array() ) { $required_functions = array( 'getimagesize', 'imagecreatefromstring', 'imagecreatetruecolor', 'imagecolortransparent', 'imagecolorallocatealpha', 'imagealphablending', 'imagesavealpha', 'imagesx', 'imagesy', 'imagecopyresampled', ); foreach ( $required_functions as $function ) { if ( ! function_exists( $function ) ) { trigger_error( "The PHP_ICO class was unable to find the $function function, which is part of the GD library. Ensure that the system has the GD library installed and that PHP has access to it through a PHP interface, such as PHP's GD module. Since this function was not found, the library will be unable to create ICO files." ); return; } } $this->_has_requirements = true; if ( false != $file ) $this->add_image( $file, $sizes ); } /** * Add an image to the generator. * * This function adds a source image to the generator. It serves two main purposes: add a source image if one was * not supplied to the constructor and to add additional source images so that different images can be supplied for * different sized images in the resulting ICO file. For instance, a small source image can be used for the small * resolutions while a larger source image can be used for large resolutions. * * @param string $file Path to the source image file. * @param array $sizes Optional. An array of sizes (each size is an array with a width and height) that the source image should be rendered at in the generated ICO file. If sizes are not supplied, the size of the source image will be used. * @return boolean true on success and false on failure. */ function add_image( $file, $sizes = array() ) { if ( ! $this->_has_requirements ) return false; if ( false === ( $im = $this->_load_image_file( $file ) ) ) return false; if ( empty( $sizes ) ) $sizes = array( imagesx( $im ), imagesy( $im ) ); // If just a single size was passed, put it in array. if ( ! is_array( $sizes[0] ) ) $sizes = array( $sizes ); foreach ( (array) $sizes as $size ) { list( $width, $height ) = $size; $new_im = imagecreatetruecolor( $width, $height ); imagecolortransparent( $new_im, imagecolorallocatealpha( $new_im, 0, 0, 0, 127 ) ); imagealphablending( $new_im, false ); imagesavealpha( $new_im, true ); $source_width = imagesx( $im ); $source_height = imagesy( $im ); if ( false === imagecopyresampled( $new_im, $im, 0, 0, 0, 0, $width, $height, $source_width, $source_height ) ) continue; $this->_add_image_data( $new_im ); } return true; } /** * Write the ICO file data to a file path. * * @param string $file Path to save the ICO file data into. * @return boolean true on success and false on failure. */ function save_ico( $file ) { if ( ! $this->_has_requirements ) return false; if ( false === ( $data = $this->_get_ico_data() ) ) return false; if ( false === ( $fh = fopen( $file, 'w' ) ) ) return false; if ( false === ( fwrite( $fh, $data ) ) ) { fclose( $fh ); return false; } fclose( $fh ); return true; } /** * Generate the final ICO data by creating a file header and adding the image data. * * @access private */ function _get_ico_data() { if ( ! is_array( $this->_images ) || empty( $this->_images ) ) return false; $data = pack( 'vvv', 0, 1, count( $this->_images ) ); $pixel_data = ''; $icon_dir_entry_size = 16; $offset = 6 + ( $icon_dir_entry_size * count( $this->_images ) ); foreach ( $this->_images as $image ) { $data .= pack( 'CCCCvvVV', $image['width'], $image['height'], $image['color_palette_colors'], 0, 1, $image['bits_per_pixel'], $image['size'], $offset ); $pixel_data .= $image['data']; $offset += $image['size']; } $data .= $pixel_data; unset( $pixel_data ); return $data; } /** * Take a GD image resource and change it into a raw BMP format. * * @access private */ function _add_image_data( $im ) { $width = imagesx( $im ); $height = imagesy( $im ); $pixel_data = array(); $opacity_data = array(); $current_opacity_val = 0; for ( $y = $height - 1; $y >= 0; $y-- ) { for ( $x = 0; $x < $width; $x++ ) { $color = imagecolorat( $im, $x, $y ); $alpha = ( $color & 0x7F000000 ) >> 24; $alpha = ( 1 - ( $alpha / 127 ) ) * 255; $color &= 0xFFFFFF; $color |= 0xFF000000 & ( $alpha << 24 ); $pixel_data[] = $color; $opacity = ( $alpha <= 127 ) ? 1 : 0; $current_opacity_val = ( $current_opacity_val << 1 ) | $opacity; if ( ( ( $x + 1 ) % 32 ) == 0 ) { $opacity_data[] = $current_opacity_val; $current_opacity_val = 0; } } if ( ( $x % 32 ) > 0 ) { while ( ( $x++ % 32 ) > 0 ) $current_opacity_val = $current_opacity_val << 1; $opacity_data[] = $current_opacity_val; $current_opacity_val = 0; } } $image_header_size = 40; $color_mask_size = $width * $height * 4; $opacity_mask_size = ( ceil( $width / 32 ) * 4 ) * $height; $data = pack( 'VVVvvVVVVVV', 40, $width, ( $height * 2 ), 1, 32, 0, 0, 0, 0, 0, 0 ); foreach ( $pixel_data as $color ) $data .= pack( 'V', $color ); foreach ( $opacity_data as $opacity ) $data .= pack( 'N', $opacity ); $image = array( 'width' => $width, 'height' => $height, 'color_palette_colors' => 0, 'bits_per_pixel' => 32, 'size' => $image_header_size + $color_mask_size + $opacity_mask_size, 'data' => $data, ); $this->_images[] = $image; } /** * Read in the source image file and convert it into a GD image resource. * * @access private */ function _load_image_file( $file ) { // Run a cheap check to verify that it is an image file. if ( false === ( $size = getimagesize( $file ) ) ) return false; if ( false === ( $file_data = file_get_contents( $file ) ) ) return false; if ( false === ( $im = imagecreatefromstring( $file_data ) ) ) return false; unset( $file_data ); return $im; } } ?>