first commit

modules/leoslideshow/libs/phpthumb/ThumbBase.inc.php

@@ -0,0 +1,304 @@
+<?php
+/**
+ * 2007-2015 Leotheme
+ *
+ * NOTICE OF LICENSE
+ *
+ * Adds image, text or video to your homepage.
+ *
+ * DISCLAIMER
+ *
+ *  @author    leotheme <leotheme@gmail.com>
+ *  @copyright 2007-2015 Leotheme
+ *  @license   http://leotheme.com - prestashop template provider
+ */
+
+/**
+ * ThumbBase Class Definition
+ *
+ * This is the base class that all implementations must extend.  It contains the
+ * core variables and functionality common to all implementations, as well as the functions that
+ * allow plugins to augment those classes.
+ *
+ * @package PhpThumb
+ * @subpackage Core
+ */
+abstract class ThumbBase
+{
+    /**
+     * All imported objects
+     *
+     * An array of imported plugin objects
+     *
+     * @var array
+     */
+    protected $imported;
+    /**
+     * All imported object functions
+     *
+     * An array of all methods added to this class by imported plugin objects
+     *
+     * @var array
+     */
+    protected $importedFunctions;
+    /**
+     * The last error message raised
+     *
+     * @var string
+     */
+    protected $errorMessage;
+    /**
+     * Whether or not the current instance has any errors
+     *
+     * @var bool
+     */
+    protected $hasError;
+    /**
+     * The name of the file we're manipulating
+     *
+     * This must include the path to the file (absolute paths recommended)
+     *
+     * @var string
+     */
+    protected $fileName;
+    /**
+     * What the file format is (mime-type)
+     *
+     * @var string
+     */
+    protected $format;
+    /**
+     * Whether or not the image is hosted remotely
+     *
+     * @var bool
+     */
+    protected $remoteImage;
+    /**
+     * Whether or not the current image is an actual file, or the raw file data
+     *
+     * By "raw file data" it's meant that we're actually passing the result of something
+     * like file_get_contents() or perhaps from a database blob
+     *
+     * @var bool
+     */
+    protected $isDataStream;
+
+    /**
+     * Class constructor
+     *
+     * @return ThumbBase
+     */
+    public function __construct($fileName, $isDataStream = false)
+    {
+        $this->imported = array();
+        $this->importedFunctions = array();
+        $this->errorMessage = null;
+        $this->hasError = false;
+        $this->fileName = $fileName;
+        $this->remoteImage = false;
+        $this->isDataStream = $isDataStream;
+
+        $this->fileExistsAndReadable();
+    }
+
+    /**
+     * Imports plugins in $registry to the class
+     *
+     * @param array $registry
+     */
+    public function importPlugins($registry)
+    {
+        foreach ($registry as $plugin => $meta) {
+            $this->imports($plugin);
+        }
+    }
+
+    /**
+     * Imports a plugin
+     *
+     * This is where all the plugins magic happens!  This function "loads" the plugin functions, making them available as
+     * methods on the class.
+     *
+     * @param string $object The name of the object to import / "load"
+     */
+    protected function imports($object)
+    {
+        // the new object to import
+        $newImport = new $object();
+        // the name of the new object (class name)
+        $importName = get_class($newImport);
+        // the new functions to import
+        $importFunctions = get_class_methods($newImport);
+
+        // add the object to the registry
+        array_push($this->imported, array($importName, $newImport));
+
+        // add the methods to the registry
+        foreach ($importFunctions as $key => $functionName) {
+            $this->importedFunctions[$functionName] = &$newImport;
+        }
+    }
+
+    /**
+     * Checks to see if $this->fileName exists and is readable
+     *
+     */
+    protected function fileExistsAndReadable()
+    {
+        if ($this->isDataStream === true) {
+            return;
+        }
+
+        if (stristr($this->fileName, 'http://') !== false) {
+            $this->remoteImage = true;
+            return;
+        }
+
+        if (!file_exists($this->fileName)) {
+            $this->triggerError('Image file not found: '.$this->fileName);
+        } elseif (!is_readable($this->fileName)) {
+            $this->triggerError('Image file not readable: '.$this->fileName);
+        }
+    }
+
+    /**
+     * Sets $this->errorMessage to $errorMessage and throws an exception
+     *
+     * Also sets $this->hasError to true, so even if the exceptions are caught, we don't
+     * attempt to proceed with any other functions
+     *
+     * @param string $errorMessage
+     */
+    protected function triggerError($errorMessage)
+    {
+        $this->hasError = true;
+        $this->errorMessage = $errorMessage;
+
+        throw new Exception($errorMessage);
+    }
+
+    /**
+     * Calls plugin / imported functions
+     *
+     * This is also where a fair amount of plugins magaic happens.  This magic method is called whenever an "undefined" class
+     * method is called in code, and we use that to call an imported function.
+     *
+     * You should NEVER EVER EVER invoke this function manually.  The universe will implode if you do... seriously ;)
+     *
+     * @param string $method
+     * @param array $args
+     */
+    public function __call($method, $args)
+    {
+        if (array_key_exists($method, $this->importedFunctions)) {
+            $args[] = $this;
+            return call_user_func_array(array($this->importedFunctions[$method], $method), $args);
+        }
+
+        throw new BadMethodCallException('Call to undefined method/class function: '.$method);
+    }
+
+    /**
+     * Returns $imported.
+     * @see ThumbBase::$imported
+     * @return array
+     */
+    public function getImported()
+    {
+        return $this->imported;
+    }
+
+    /**
+     * Returns $importedFunctions.
+     * @see ThumbBase::$importedFunctions
+     * @return array
+     */
+    public function getImportedFunctions()
+    {
+        return $this->importedFunctions;
+    }
+
+    /**
+     * Returns $errorMessage.
+     *
+     * @see ThumbBase::$errorMessage
+     */
+    public function getErrorMessage()
+    {
+        return $this->errorMessage;
+    }
+
+    /**
+     * Sets $errorMessage.
+     *
+     * @param object $errorMessage
+     * @see ThumbBase::$errorMessage
+     */
+    public function setErrorMessage($errorMessage)
+    {
+        $this->errorMessage = $errorMessage;
+    }
+
+    /**
+     * Returns $fileName.
+     *
+     * @see ThumbBase::$fileName
+     */
+    public function getFileName()
+    {
+        return $this->fileName;
+    }
+
+    /**
+     * Sets $fileName.
+     *
+     * @param object $fileName
+     * @see ThumbBase::$fileName
+     */
+    public function setFileName($fileName)
+    {
+        $this->fileName = $fileName;
+    }
+
+    /**
+     * Returns $format.
+     *
+     * @see ThumbBase::$format
+     */
+    public function getFormat()
+    {
+        return $this->format;
+    }
+
+    /**
+     * Sets $format.
+     *
+     * @param object $format
+     * @see ThumbBase::$format
+     */
+    public function setFormat($format)
+    {
+        $this->format = $format;
+    }
+
+    /**
+     * Returns $hasError.
+     *
+     * @see ThumbBase::$hasError
+     */
+    public function getHasError()
+    {
+        return $this->hasError;
+    }
+
+    /**
+     * Sets $hasError.
+     *
+     * @param object $hasError
+     * @see ThumbBase::$hasError
+     */
+    public function setHasError($hasError)
+    {
+        $this->hasError = $hasError;
+    }
+}