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