class_ImageHelper.php

Go to the documentation of this file.

<?php
class ImageHelper extends BaseCaptcha implements HelpableTemplate {
        private $imageType = "png";

        private $imageName = "";

        private $width = 0;

        private $height = 0;

        private $backgroundColor = array(
                'red'   => 0,
                'green' => 0,
                'blue'  => 0
        );

        private $foregroundColor = array(
                'red'   => 0,
                'green' => 0,
                'blue'  => 0
        );

        private $imageStrings = array();

        private $currString = "";

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

        public final static function createImageHelper (CompileableTemplate $templateInstance, $imageType) {
                // Get new instance
                $helperInstance = new ImageHelper();

                // Set template instance
                $helperInstance->setTemplateInstance($templateInstance);

                // Set image type (blindly)
                $helperInstance->setImageType($imageType);

                // Initialize RNG
                $helperInstance->initializeRandomNumberGenerator($templateInstance);

                // Return the prepared instance
                return $helperInstance;
        }

        protected final function setImageType ($imageType) {
                $this->imageType = (string) $imageType;
        }

        public final function getImageType () {
                return $this->imageType;
        }

        public final function setBaseImage ($baseImage) {
                $this->baseImage = (string) $baseImage;
        }

        public final function getBaseImage () {
                return $this->baseImage;
        }

        public final function setImageName ($imageName) {
                $this->imageName = (string) $imageName;
        }

        protected final function getImageName () {
                return $this->imageName;
        }

        public final function setWidth ($width) {
                $this->width = (int) $width;
        }

        public final function getWidth () {
                return $this->width;
        }

        public final function setHeight ($height) {
                $this->height = (int) $height;
        }

        public final function getHeight () {
                return $this->height;
        }

        public final function setBackgroundColorRedGreenBlue ($red, $green, $blue) {
                // Random numbers?
                if ($red === "rand") {
                        $red = $this->getRngInstance()->randomNumber(0, 255);
                } // END - if
                if ($green === "rand") {
                        $green = $this->getRngInstance()->randomNumber(0, 255);
                } // END - if
                if ($blue === "rand") {
                        $blue = $this->getRngInstance()->randomNumber(0, 255);
                } // END - if

                $this->backgroundColor['red']   = (int) $red;
                $this->backgroundColor['green'] = (int) $green;
                $this->backgroundColor['blue']  = (int) $blue;
        }

        public final function setForegroundColorRedGreenBlue ($red, $green, $blue) {
                // Random numbers?
                if ($red === "rand") {
                        $red = $this->getRngInstance()->randomNumber(0, 255);
                } // END - if
                if ($green === "rand") {
                        $green = $this->getRngInstance()->randomNumber(0, 255);
                } // END - if
                if ($blue === "rand") {
                        $blue = $this->getRngInstance()->randomNumber(0, 255);
                } // END - if

                $this->foregroundColor['red']   = (int) $red;
                $this->foregroundColor['green'] = (int) $green;
                $this->foregroundColor['blue']  = (int) $blue;
        }

        public function addTextLine ($stringName) {
                // Create the image string
                $this->imageStrings[$stringName] = array(
                        'x'      => "",
                        'y'      => "",
                        'size'   => "",
                        'string' => ""
                );

                // Set current string name
                $this->currString = $stringName;
        }

        public final function setImageString ($imageString) {
                $this->imageStrings[$this->currString]['string'] = (string) $imageString;
        }

        public final function getImageString () {
                return $this->imageStrings[$this->currString]['string'];
        }

        public final function setCoord ($x, $y) {
                $this->imageStrings[$this->currString]['x'] = (int) $x;
                $this->imageStrings[$this->currString]['y'] = (int) $y;
        }

        public final function getX () {
                return $this->imageStrings[$this->currString]['x'];
        }

        public final function getY () {
                return $this->imageStrings[$this->currString]['y'];
        }

        public final function setFontSize ($fontSize) {
                // Random font size?
                if ($fontSize === "rand") {
                        $fontSize = $this->getRngInstance()->randomNumber(4, 9);
                } // END - if

                $this->imageStrings[$this->currString]['size'] = (int) $fontSize;
        }

        public final function getFontSize () {
                return $this->imageStrings[$this->currString]['size'];
        }

        public function flushContent () {
                // Get a template instance
                $templateInstance = $this->getTemplateInstance();

                // Get the base image
                $templateInstance->loadCodeTemplate($this->getBaseImage());

                // Assign all the image values with the template
                $templateInstance->assignVariable('image_name'    , $this->getImageName());
                $templateInstance->assignVariable('image_type'    , $this->getImageType());
                $templateInstance->assignVariable('image_width'   , $this->getWidth());
                $templateInstance->assignVariable('image_height'  , $this->getHeight());
                $templateInstance->assignVariable('image_bg_red'  , $this->backgroundColor['red']);
                $templateInstance->assignVariable('image_bg_green', $this->backgroundColor['green']);
                $templateInstance->assignVariable('image_bg_blue' , $this->backgroundColor['blue']);
                $templateInstance->assignVariable('image_fg_red'  , $this->foregroundColor['red']);
                $templateInstance->assignVariable('image_fg_green', $this->foregroundColor['green']);
                $templateInstance->assignVariable('image_fg_blue' , $this->foregroundColor['blue']);

                // Add all strings
                foreach ($this->imageStrings as $id => $imageString) {
                        // Set current string id to keep this helper in sync with template engine
                        $this->currString = $id;

                        // Set variable group
                        $templateInstance->setVariableGroup($id);

                        // Add group variables
                        $templateInstance->addGroupVariable('image_x'     , $this->getX());
                        $templateInstance->addGroupVariable('image_y'     , $this->getY());
                        $templateInstance->addGroupVariable('image_size'  , $this->getFontSize());
                        $templateInstance->addGroupVariable('image_string', $this->getImageString());
                } // END - foreach

                // Get the raw content
                $imageContent = $templateInstance->getRawTemplateData();

                // Transfer all to the template engine
                $templateInstance->renderXmlContent($imageContent);
        }
}

// [EOF]
?>