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