class_ImageTemplateEngine.php

Go to the documentation of this file.

<?php
class ImageTemplateEngine extends BaseTemplateEngine implements CompileableTemplate {
        private $mainNodes = array("base", "type", "resolution", "background-color", "foreground-color", "image-string");

        private $subNodes = array("name", "string-name", "x", "y", "font-size", "width", "height", "red", "green", "blue", "text");

        private $imageInstance = null;

        private $currMainNode = "";

        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
        }

        public final static function createImageTemplateEngine ($basePath, ManageableLanguage  $langInstance, FileIoHandler $ioInstance) {
                // Get a new instance
                $tplInstance = new ImageTemplateEngine();

                // Is the base path valid?
                if (empty($basePath)) {
                        // Base path is empty
                        throw new BasePathIsEmptyException($tplInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
                } elseif (!is_string($basePath)) {
                        // Is not a string
                        throw new InvalidBasePathStringException(array($tplInstance, $basePath), self::EXCEPTION_INVALID_STRING);
                } elseif (!is_dir($basePath)) {
                        // Is not a path
                        throw new BasePathIsNoDirectoryException(array($tplInstance, $basePath), self::EXCEPTION_INVALID_PATH_NAME);
                } elseif (!is_readable($basePath)) {
                        // Is not readable
                        throw new BasePathReadProtectedException(array($tplInstance, $basePath), self::EXCEPTION_READ_PROTECED_PATH);
                }

                // Get configuration instance
                $cfgInstance = FrameworkConfiguration::getInstance();

                // Set the base path
                $tplInstance->setBasePath($basePath);

                // Set the language and IO instances
                $tplInstance->setLanguageInstance($langInstance);
                $tplInstance->setFileIoInstance($ioInstance);

                // Set template extensions
                $tplInstance->setRawTemplateExtension($cfgInstance->readConfig('raw_template_extension'));
                $tplInstance->setCodeTemplateExtension($cfgInstance->readConfig('code_template_extension'));

                // Absolute output path for compiled templates
                $tplInstance->setCompileOutputPath($cfgInstance->readConfig('base_path') . $cfgInstance->readConfig('compile_output_path'));

                // Return the prepared instance
                return $tplInstance;
        }

        public final function getCurrMainNode () {
                return $this->currMainNode;
        }

        public final function getMainNodes () {
                return $this->mainNodes;
        }

        public final function getSubNodes () {
                return $this->subNodes;
        }

        public function startElement ($resource, $element, array $attributes) {
                // Initial method name which will never be called...
                $methodName = 'initImage';

                // Make the element name lower-case
                $element = strtolower($element);

                // Is the element a main node?
                //* DEBUG: */ echo "START: &gt;".$element."&lt;<br />\n";
                if (in_array($element, $this->mainNodes)) {
                        // Okay, main node found!
                        $methodName = 'setImage' . $this->convertToClassName($element);
                } elseif (in_array($element, $this->subNodes)) {
                        // Sub node found
                        $methodName = 'setImageProperty' . $this->convertToClassName($element);
                } elseif ($element != 'image') {
                        // Invalid node name found
                        throw new InvalidXmlNodeException(array($this, $element, $attributes), BaseHelper::EXCEPTION_XML_NODE_UNKNOWN);
                }

                // Call method
                //* DEBUG: */ echo "call: ".$methodName."<br />\n";
                call_user_func_array(array($this, $methodName), $attributes);
        }

        protected function endElement ($resource, $nodeName) {
                // Make all lower-case
                $nodeName = strtolower($nodeName);

                // Does this match with current main node?
                //* DEBUG: */ echo "END: &gt;".$nodeName."&lt;<br />\n";
                if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
                        // Did not match!
                        throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), BaseHelper::EXCEPTION_XML_NODE_MISMATCH);
                } elseif (in_array($nodeName, $this->getSubNodes())) {
                        // Silently ignore sub nodes
                        return;
                }

                // Construct method name
                $methodName = 'finish' . $this->convertToClassName($nodeName);

                // Call the corresponding method
                call_user_func_array(array($this->imageInstance, $methodName), array());
        }

        protected function characterHandler ($resource, $characters) {
                // Trim all spaces away
                $characters = trim($characters);

                // Is this string empty?
                if (empty($characters)) {
                        // Then skip it silently
                        return false;
                } // END - if

                // Unfinished work!
                $this->partialStub("Handling extra characters is not yet supported!");
        }

        private function initImage () {
                // Unfinished work!
        }

        private function setImageType ($imageType) {
                // Set group to general
                $this->setVariableGroup('general');

                // Try to compile it first to get the value from variable stack
                $imageType = $this->compileRawCode($imageType);

                // Now make a class name of it
                $className = $this->convertToClassName($imageType.'_image');

                // And try to initiate it
                $this->imageInstance = ObjectFactory::createObjectByName($className, array($this));

                // Set current main node to type
                $this->currMainNode = 'type';
        }

        private function setImageResolution () {
                // Call the image class
                $this->imageInstance->initResolution();

                // Current main node is resolution
                $this->currMainNode = 'resolution';
        }

        private function setImageBase () {
                // Call the image class
                $this->imageInstance->initBase();

                // Current main node is resolution
                $this->currMainNode = 'base';
        }

        private function setImageBackgroundColor () {
                // Call the image class
                $this->imageInstance->initBackgroundColor();

                // Current main node is background-color
                $this->currMainNode = 'background-color';
        }

        private function setImageForegroundColor () {
                // Call the image class
                $this->imageInstance->initForegroundColor();

                // Current main node is foreground-color
                $this->currMainNode = 'foreground-color';
        }

        private function setImageImageString ($groupable = 'single') {
                // Call the image class
                $this->imageInstance->initImageString($groupable);

                // Current main node is foreground-color
                $this->currMainNode = 'image-string';
        }

        private function setImagePropertyName ($imageName) {
                // Call the image class
                $this->imageInstance->setImageName($imageName);
        }

        private function setImagePropertyWidth ($width) {
                // Call the image class
                $this->imageInstance->setWidth($width);
        }

        private function setImagePropertyHeight ($height) {
                // Call the image class
                $this->imageInstance->setHeight($height);
        }

        private function setImagePropertyRed ($red) {
                // Call the image class
                $this->imageInstance->setRed($red);
        }

        private function setImagePropertyGreen ($green) {
                // Call the image class
                $this->imageInstance->setGreen($green);
        }

        private function setImagePropertyBlue ($blue) {
                // Call the image class
                $this->imageInstance->setBlue($blue);
        }

        private function setImagePropertyStringName ($stringName) {
                // Call the image class
                $this->imageInstance->setStringName($stringName);
        }

        private function setImagePropertyFontSize ($fontSize) {
                // Call the image class
                $this->imageInstance->setFontSize($fontSize);
        }

        private function setImagePropertyText ($imageString) {
                // Call the image class
                $this->imageInstance->setString($imageString);
        }

        private function setImagePropertyX ($x) {
                // Call the image class
                $this->imageInstance->setX($x);
        }

        private function setImagePropertyY ($y) {
                // Call the image class
                $this->imageInstance->setY($y);
        }

        public function getImageCacheFqfn () {
                // Get the FQFN ready
                $fqfn = $this->getBasePath().'_cache/' . md5($this->imageInstance->getImageName().":".$this->__toString().":".$this->imageInstance->__toString()) . "." . $this->imageInstance->getImageType();

                // Return it
                return $fqfn;
        }

        public function transferToResponse (Responseable $responseInstance) {
                // Set the image instance
                $responseInstance->setImageInstance($this->imageInstance);
        }
}

// [EOF]
?>