framework/main/classes/images/extended/class_PngImage.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Image;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
   7 use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
   8
   9 // Import SPL stuff
  10 use \SplFileInfo;
  11
  12 /**
  13  * A PNG image generator
  14  *
  15  * @author              Roland Haeder <webmaster@shipsimu.org>
  16  * @version             0.0.0
  17 <<<<<<< HEAD:framework/main/classes/images/extended/class_PngImage.php
  18  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  19 =======
  20  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  21 >>>>>>> Some updates::inc/main/classes/images/extended/class_PngImage.php
  22  * @license             GNU GPL 3.0 or any newer version
  23  * @link                http://www.shipsimu.org
  24  *
  25  * This program is free software: you can redistribute it and/or modify
  26  * it under the terms of the GNU General Public License as published by
  27  * the Free Software Foundation, either version 3 of the License, or
  28  * (at your option) any later version.
  29  *
  30  * This program is distributed in the hope that it will be useful,
  31  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  32  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  33  * GNU General Public License for more details.
  34  *
  35  * You should have received a copy of the GNU General Public License
  36  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  37  */
  38 class PngImage extends BaseImage {
  39         /**
  40          * Protected constructor
  41          *
  42          * @return      void
  43          */
  44         protected function __construct () {
  45                 // Call parent constructor
  46                 parent::__construct(__CLASS__);
  47         }
  48
  49         /**
  50          * Creates an instance of this image class
  51          *
  52          * @param       $templateInstance       A template instance
  53          * @return      $imageInstance          An instance of this image class
  54          */
  55         public static final function createPngImage(CompileableTemplate $templateInstance) {
  56                 // Get a new instance
  57                 $imageInstance = new PngImage();
  58
  59                 // Set template instance
  60                 $imageInstance->setTemplateInstance($templateInstance);
  61
  62                 // Set image type
  63                 $imageInstance->setImageType('png');
  64
  65                 // Return the instance
  66                 return $imageInstance;
  67         }
  68
  69         /**
  70          * Finish this image by producing it
  71          *
  72          * @return      void
  73          * @todo Rewrite this to SplFileInfo/Object
  74          */
  75         public function finishImage () {
  76                 $this->partialStub('Unfinished method.');
  77                 return;
  78
  79                 // Call parent method
  80                 parent::finishImage();
  81
  82                 // Get a file name for our image
  83                 $cacheFile = $this->getTemplateInstance()->getImageCacheFile();
  84
  85                 // Does it exist?
  86                 if (FrameworkBootstrap::isReadableFile($cacheFile)) {
  87                         // Remove it
  88                         unlink($cacheFile->getPathname());
  89                 } // END - if
  90
  91                 // Finish the image and send it to a cache file
  92                 imagepng($this->getImageResource(), $cacheFile->getPathname(), 9, PNG_ALL_FILTERS);
  93         }
  94
  95 }