PhileCMS / Phile

lib/Phile/Exception/AbstractException.php

Indentation +5 added lines, -5 removed lines

@@ -1,10 +1,10 @@
 <?php
 /**
- * Created by PhpStorm.
- * User: franae
- * Date: 30/10/13
- * Time: 14:47
- */
+     * Created by PhpStorm.
+     * User: franae
+     * Date: 30/10/13
+     * Time: 14:47
+     */
 
 namespace Phile\Exception;
 

lib/Phile/Event.php

Indentation +2 added lines, -2 removed lines

@@ -1,7 +1,7 @@
 <?php
 /**
- * The Event class
- */
+     * The Event class
+     */
 namespace Phile;
 
 /**

plugins/phile/parserMeta/config.php

Indentation +2 added lines, -2 removed lines

@@ -1,7 +1,7 @@
 <?php
 /**
- * config file
- */
+     * config file
+     */
 return [
     'setting-example' => 'I love Phile!'
 ];

lib/Phile/ServiceLocator.php

Indentation +2 added lines, -2 removed lines

@@ -1,7 +1,7 @@
 <?php
 /**
- * The SerciveLocator class
- */
+     * The SerciveLocator class
+     */
 namespace Phile\Core;
 
 use Phile\Exception\ServiceLocatorException;

lib/Phile/Core/Utility.php

Doc Comments +5 added lines, -5 removed lines

@@ -51,7 +51,7 @@ 
 	/**
 	 * resolve a file path by replace the mod: prefix
 	 *
-	 * @param $path
+	 * @param string $path
 	 *
 	 * @return string|null the full filepath or null if file does not exists
 	 */
@@ -71,7 +71,7 @@ 
 	/**
 	 * load files e.g. config files
 	 *
-	 * @param $file
+	 * @param string $file
 	 *
 	 * @return mixed|null
 	 */
@@ -99,7 +99,7 @@ 
 	/**
 	 * static method to get files by directory and file filter
 	 *
-	 * @param        $directory
+	 * @param        string $directory
 	 * @param string $filter
 	 *
 	 * @return array
@@ -179,8 +179,8 @@ 
 	 * method to get a more secure random value
 	 * code from http://stackoverflow.com/questions/1846202/php-how-to-generate-a-random-unique-alphanumeric-string/13733588#13733588
 	 *
-	 * @param $min
-	 * @param $max
+	 * @param integer $min
+	 * @param integer $max
 	 *
 	 * @return mixed
 	 */

Indentation +186 added lines, -186 removed lines

@@ -14,190 +14,190 @@
  */
 class Utility {
 
-	/**
-	 * method to get the current http protocol
-	 *
-	 * @return string the current protocol
-	 * @deprecated since 1.5 will be removed
-	 */
-	public static function getProtocol() {
-		return (new Router)->getProtocol();
-	}
-
-	/**
-	 * detect base url
-	 *
-	 * @return string
-	 * @deprecated since 1.5 will be removed
-	 */
-	public static function getBaseUrl() {
-		return (new Router)->getBaseUrl();
-	}
-
-	/**
-	 * detect install path
-	 *
-	 * @return string
-	 * @deprecated since 1.5 will be removed
-	 */
-	public static function getInstallPath() {
-		$path = self::getBaseUrl();
-		$path = substr($path, strpos($path, '://') + 3);
-		$path = substr($path, strpos($path, '/') + 1);
-
-		return $path;
-	}
-
-	/**
-	 * resolve a file path by replace the mod: prefix
-	 *
-	 * @param $path
-	 *
-	 * @return string|null the full filepath or null if file does not exists
-	 */
-	public static function resolveFilePath($path) {
-		// resolve MOD: prefix
-		if (strtoupper(substr($path, 0, 3)) === 'MOD') {
-			$path = str_ireplace('mod:', PLUGINS_DIR, $path);
-		}
-		// check if file exists
-		if (file_exists($path)) {
-			return $path;
-		}
-
-		return null;
-	}
-
-	/**
-	 * load files e.g. config files
-	 *
-	 * @param $file
-	 *
-	 * @return mixed|null
-	 */
-	public static function load($file) {
-		if (file_exists($file)) {
-			return include $file;
-		}
-
-		return null;
-	}
-
-	/**
-	 * check if a plugin is loaded
-	 *
-	 * @param $plugin
-	 * @return bool
-	 * @deprecated since 1.5 will be removed
-	 * @use 'plugins_loaded' event
-	 */
-	public static function isPluginLoaded($plugin) {
-		$config = Registry::get('Phile_Settings');
-		return (isset($config['plugins'][$plugin]) && isset($config['plugins'][$plugin]['active']) && $config['plugins'][$plugin]['active'] === true);
-	}
-
-	/**
-	 * static method to get files by directory and file filter
-	 *
-	 * @param        $directory
-	 * @param string $filter
-	 *
-	 * @return array
-	 */
-	public static function getFiles($directory, $filter = '\Phile\FilterIterator\GeneralFileFilterIterator') {
-		$files = new $filter(
-			new \RecursiveIteratorIterator(
-				new \RecursiveDirectoryIterator(
-					$directory,
-					\RecursiveDirectoryIterator::FOLLOW_SYMLINKS
-				)
-			)
-		);
-		$result = array();
-		foreach ($files as $file) {
-			/** @var \SplFileInfo $file */
-			$result[] = $file->getPathname();
-		}
-
-		return $result;
-	}
-
-	/**
-	 * redirect to an url
-	 *
-	 * @param     $url        the url to redirect to
-	 * @param int $statusCode the http status code
-	 * @deprecated since 1.5 will be removed
-	 */
-	public static function redirect($url, $statusCode = 302) {
-		(new Response)->redirect($url, $statusCode);
-	}
-
-	/**
-	 * generate secure md5 hash
-	 *
-	 * @param $value
-	 *
-	 * @return string
-	 */
-	public static function getSecureMD5Hash($value) {
-		$config = Registry::get('Phile_Settings');
-
-		return md5($config['encryptionKey'] . $value);
-	}
-
-	/**
-	 * method to generate a secure token
-	 * code from http://stackoverflow.com/questions/1846202/php-how-to-generate-a-random-unique-alphanumeric-string/13733588#13733588
-	 * modified by Frank Nägler
-	 *
-	 * @param int  $length
-	 * @param bool $widthSpecialChars
-	 * @param null $additionalChars
-	 *
-	 * @return string
-	 */
-	public static function generateSecureToken($length = 32, $widthSpecialChars = true, $additionalChars = null) {
-		$token        = "";
-		$codeAlphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
-		$codeAlphabet .= "abcdefghijklmnopqrstuvwxyz";
-		$codeAlphabet .= "0123456789";
-		if ($widthSpecialChars) {
-			$codeAlphabet .= "!/()=?[]|{}";
-		}
-		if ($additionalChars !== null) {
-			$codeAlphabet .= $additionalChars;
-		}
-		for ($i = 0; $i < $length; $i++) {
-			$token .= $codeAlphabet[Utility::crypto_rand_secure(0, strlen($codeAlphabet))];
-		}
-
-		return $token;
-	}
-
-	/**
-	 * method to get a more secure random value
-	 * code from http://stackoverflow.com/questions/1846202/php-how-to-generate-a-random-unique-alphanumeric-string/13733588#13733588
-	 *
-	 * @param $min
-	 * @param $max
-	 *
-	 * @return mixed
-	 */
-	public static function crypto_rand_secure($min, $max) {
-		$range = $max - $min;
-		if ($range < 0) {
-			return $min;
-		} // not so random...
-		$log    = log($range, 2);
-		$bytes  = (int)($log / 8) + 1; // length in bytes
-		$bits   = (int)$log + 1; // length in bits
-		$filter = (int)(1 << $bits) - 1; // set all lower bits to 1
-		do {
-			$rnd = hexdec(bin2hex(openssl_random_pseudo_bytes($bytes)));
-			$rnd = $rnd & $filter; // discard irrelevant bits
-		} while ($rnd >= $range);
-
-		return $min + $rnd;
-	}
+    /**
+     * method to get the current http protocol
+     *
+     * @return string the current protocol
+     * @deprecated since 1.5 will be removed
+     */
+    public static function getProtocol() {
+        return (new Router)->getProtocol();
+    }
+
+    /**
+     * detect base url
+     *
+     * @return string
+     * @deprecated since 1.5 will be removed
+     */
+    public static function getBaseUrl() {
+        return (new Router)->getBaseUrl();
+    }
+
+    /**
+     * detect install path
+     *
+     * @return string
+     * @deprecated since 1.5 will be removed
+     */
+    public static function getInstallPath() {
+        $path = self::getBaseUrl();
+        $path = substr($path, strpos($path, '://') + 3);
+        $path = substr($path, strpos($path, '/') + 1);
+
+        return $path;
+    }
+
+    /**
+     * resolve a file path by replace the mod: prefix
+     *
+     * @param $path
+     *
+     * @return string|null the full filepath or null if file does not exists
+     */
+    public static function resolveFilePath($path) {
+        // resolve MOD: prefix
+        if (strtoupper(substr($path, 0, 3)) === 'MOD') {
+            $path = str_ireplace('mod:', PLUGINS_DIR, $path);
+        }
+        // check if file exists
+        if (file_exists($path)) {
+            return $path;
+        }
+
+        return null;
+    }
+
+    /**
+     * load files e.g. config files
+     *
+     * @param $file
+     *
+     * @return mixed|null
+     */
+    public static function load($file) {
+        if (file_exists($file)) {
+            return include $file;
+        }
+
+        return null;
+    }
+
+    /**
+     * check if a plugin is loaded
+     *
+     * @param $plugin
+     * @return bool
+     * @deprecated since 1.5 will be removed
+     * @use 'plugins_loaded' event
+     */
+    public static function isPluginLoaded($plugin) {
+        $config = Registry::get('Phile_Settings');
+        return (isset($config['plugins'][$plugin]) && isset($config['plugins'][$plugin]['active']) && $config['plugins'][$plugin]['active'] === true);
+    }
+
+    /**
+     * static method to get files by directory and file filter
+     *
+     * @param        $directory
+     * @param string $filter
+     *
+     * @return array
+     */
+    public static function getFiles($directory, $filter = '\Phile\FilterIterator\GeneralFileFilterIterator') {
+        $files = new $filter(
+            new \RecursiveIteratorIterator(
+                new \RecursiveDirectoryIterator(
+                    $directory,
+                    \RecursiveDirectoryIterator::FOLLOW_SYMLINKS
+                )
+            )
+        );
+        $result = array();
+        foreach ($files as $file) {
+            /** @var \SplFileInfo $file */
+            $result[] = $file->getPathname();
+        }
+
+        return $result;
+    }
+
+    /**
+     * redirect to an url
+     *
+     * @param     $url        the url to redirect to
+     * @param int $statusCode the http status code
+     * @deprecated since 1.5 will be removed
+     */
+    public static function redirect($url, $statusCode = 302) {
+        (new Response)->redirect($url, $statusCode);
+    }
+
+    /**
+     * generate secure md5 hash
+     *
+     * @param $value
+     *
+     * @return string
+     */
+    public static function getSecureMD5Hash($value) {
+        $config = Registry::get('Phile_Settings');
+
+        return md5($config['encryptionKey'] . $value);
+    }
+
+    /**
+     * method to generate a secure token
+     * code from http://stackoverflow.com/questions/1846202/php-how-to-generate-a-random-unique-alphanumeric-string/13733588#13733588
+     * modified by Frank Nägler
+     *
+     * @param int  $length
+     * @param bool $widthSpecialChars
+     * @param null $additionalChars
+     *
+     * @return string
+     */
+    public static function generateSecureToken($length = 32, $widthSpecialChars = true, $additionalChars = null) {
+        $token        = "";
+        $codeAlphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
+        $codeAlphabet .= "abcdefghijklmnopqrstuvwxyz";
+        $codeAlphabet .= "0123456789";
+        if ($widthSpecialChars) {
+            $codeAlphabet .= "!/()=?[]|{}";
+        }
+        if ($additionalChars !== null) {
+            $codeAlphabet .= $additionalChars;
+        }
+        for ($i = 0; $i < $length; $i++) {
+            $token .= $codeAlphabet[Utility::crypto_rand_secure(0, strlen($codeAlphabet))];
+        }
+
+        return $token;
+    }
+
+    /**
+     * method to get a more secure random value
+     * code from http://stackoverflow.com/questions/1846202/php-how-to-generate-a-random-unique-alphanumeric-string/13733588#13733588
+     *
+     * @param $min
+     * @param $max
+     *
+     * @return mixed
+     */
+    public static function crypto_rand_secure($min, $max) {
+        $range = $max - $min;
+        if ($range < 0) {
+            return $min;
+        } // not so random...
+        $log    = log($range, 2);
+        $bytes  = (int)($log / 8) + 1; // length in bytes
+        $bits   = (int)$log + 1; // length in bits
+        $filter = (int)(1 << $bits) - 1; // set all lower bits to 1
+        do {
+            $rnd = hexdec(bin2hex(openssl_random_pseudo_bytes($bytes)));
+            $rnd = $rnd & $filter; // discard irrelevant bits
+        } while ($rnd >= $range);
+
+        return $min + $rnd;
+    }
 }

lib/Phile/Model/Page.php

Doc Comments +1 added lines, -1 removed lines

@@ -123,7 +123,7 @@
 	/**
 	 * set content of page
 	 *
-	 * @param $content
+	 * @param string $content
 	 */
 	public function setContent($content) {
 		$this->content = $content;

Indentation +235 added lines, -235 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 /**
- * The page model
- */
+     * The page model
+     */
 namespace Phile\Model;
 
 use Phile\Core\Router;
@@ -17,237 +17,237 @@ 
  * @package Phile\Model
  */
 class Page {
-	/**
-	 * @var \Phile\Model\Meta the meta model
-	 */
-	protected $meta;
-
-	/**
-	 * @var string the content
-	 */
-	protected $content;
-
-	/**
-	 * @var string the path to the original file
-	 */
-	protected $filePath;
-
-	/**
-	 * @var string the raw file
-	 */
-	protected $rawData;
-
-	/**
-	 * @var \Phile\ServiceLocator\ParserInterface the parser
-	 */
-	protected $parser;
-
-	/**
-	 * @var string the pageId of the page
-	 */
-	protected $pageId;
-
-	/**
-	 * @var \Phile\Model\Page the previous page if one exist
-	 */
-	protected $previousPage;
-
-	/**
-	 * @var \Phile\Model\Page the next page if one exist
-	 */
-	protected $nextPage;
-
-	/**
-	 * @var string The content folder, as passed to the class constructor when initiating the object.
-	 */
-	protected $contentFolder = CONTENT_DIR;
-
-	/**
-	 * the constructor
-	 *
-	 * @param        $filePath
-	 * @param string $folder
-	 */
-	public function __construct($filePath, $folder = CONTENT_DIR) {
-		$this->contentFolder = $folder;
-		$this->setFilePath($filePath);
-
-		/**
-		 * @triggerEvent before_load_content this event is triggered before the content is loaded
-		 *
-		 * @param            string filePath the path to the file
-		 * @param \Phile\Model\Page page     the page model
-		 */
-		Event::triggerEvent('before_load_content', array('filePath' => &$this->filePath, 'page' => &$this));
-		if (file_exists($this->filePath)) {
-			$this->rawData = file_get_contents($this->filePath);
-			$this->parseRawData();
-		}
-		/**
-		 * @triggerEvent after_load_content this event is triggered after the content is loaded
-		 *
-		 * @param            string filePath the path to the file
-		 * @param            string rawData  the raw data
-		 * @param \Phile\Model\Page page     the page model
-		 */
-		Event::triggerEvent('after_load_content', array('filePath' => &$this->filePath, 'rawData' => $this->rawData, 'page' => &$this));
-
-		$this->parser = ServiceLocator::getService('Phile_Parser');
-	}
-
-	/**
-	 * method to get content of page, this method returned the parsed content
-	 *
-	 * @return mixed
-	 */
-	public function getContent() {
-		/**
-		 * @triggerEvent before_parse_content this event is triggered before the content is parsed
-		 *
-		 * @param            string content the raw data
-		 * @param \Phile\Model\Page page    the page model
-		 */
-		Event::triggerEvent('before_parse_content', array('content' => $this->content, 'page' => &$this));
-		$content = $this->parser->parse($this->content);
-		/**
-		 * @triggerEvent after_parse_content this event is triggered after the content is parsed
-		 *
-		 * @param            string content the parsed content
-		 * @param \Phile\Model\Page page    the page model
-		 */
-		Event::triggerEvent('after_parse_content', array('content' => &$content, 'page' => &$this));
-
-		return $content;
-	}
-
-	/**
-	 * set content of page
-	 *
-	 * @param $content
-	 */
-	public function setContent($content) {
-		$this->content = $content;
-	}
-
-	/**
-	 * get raw (un-parsed) page content
-	 *
-	 * @return string
-	 */
-	public function getRawContent() {
-		return $this->content;
-	}
-
-	/**
-	 * get the meta model
-	 *
-	 * @return Meta
-	 */
-	public function getMeta() {
-		return $this->meta;
-	}
-
-	/**
-	 * parse the raw content
-	 */
-	protected function parseRawData() {
-		$this->meta = new Meta($this->rawData);
-		// Remove only the optional, leading meta-block comment
-		$rawData = trim($this->rawData);
-		if (strncmp('<!--', $rawData, 4) === 0) {
-			// leading meta-block comment uses the <!-- --> style
-			$this->content = substr($rawData, max(4, strpos($rawData, '-->') + 3));
-		} elseif (strncmp('/*', $rawData, 2) === 0) {
-			// leading meta-block comment uses the /* */ style
-			$this->content = substr($rawData, strpos($rawData, '*/') + 2);
-		} else {
-			// no leading meta-block comment
-			$this->content = $rawData;
-		}
-	}
-
-	/**
-	 * get the title of page from meta information
-	 *
-	 * @return string|null
-	 */
-	public function getTitle() {
-		return $this->getMeta()->get('title');
-	}
-
-	/**
-	 * get Phile $pageId
-	 *
-	 * @param string $filePath
-	 * @return string
-	 */
-	protected function buildPageId($filePath) {
-		$pageId = str_replace($this->contentFolder, '', $filePath);
-		$pageId = str_replace(CONTENT_EXT, '', $pageId);
-		$pageId = str_replace(DIRECTORY_SEPARATOR, '/', $pageId);
-		$pageId = ltrim($pageId, '/');
-		$pageId = preg_replace('/(?<=^|\/)index$/', '', $pageId);
-		return $pageId;
-	}
-
-	/**
-	 * get the url of page
-	 *
-	 * @return string
-	 */
-	public function getUrl() {
-		return (new Router)->urlForPage($this->pageId, false);
-	}
-
-	/**
-	 * set the filepath of the page
-	 *
-	 * @param string $filePath
-	 */
-	public function setFilePath($filePath) {
-		$this->filePath = $filePath;
-		$this->pageId = $this->buildPageId($this->filePath);
-	}
-
-	/**
-	 * get the filepath of the page
-	 *
-	 * @return string
-	 */
-	public function getFilePath() {
-		return $this->filePath;
-	}
-
-	/**
-	 * get the folder name
-	 *
-	 * @return string
-	 */
-	public function getFolder() {
-		return basename(dirname($this->getFilePath()));
-	}
-
-	public function getPageId() {
-		return $this->pageId;
-	}
-
-	/**
-	 * get the previous page if one exist
-	 *
-	 * @return null|\Phile\Model\Page
-	 */
-	public function getPreviousPage() {
-		$pageRepository = new \Phile\Repository\Page();
-		return $pageRepository->getPageOffset($this, -1);
-	}
-
-	/**
-	 * get the next page if one exist
-	 *
-	 * @return null|\Phile\Model\Page
-	 */
-	public function getNextPage() {
-		$pageRepository = new \Phile\Repository\Page();
-		return $pageRepository->getPageOffset($this, 1);
-	}
+    /**
+     * @var \Phile\Model\Meta the meta model
+     */
+    protected $meta;
+
+    /**
+     * @var string the content
+     */
+    protected $content;
+
+    /**
+     * @var string the path to the original file
+     */
+    protected $filePath;
+
+    /**
+     * @var string the raw file
+     */
+    protected $rawData;
+
+    /**
+     * @var \Phile\ServiceLocator\ParserInterface the parser
+     */
+    protected $parser;
+
+    /**
+     * @var string the pageId of the page
+     */
+    protected $pageId;
+
+    /**
+     * @var \Phile\Model\Page the previous page if one exist
+     */
+    protected $previousPage;
+
+    /**
+     * @var \Phile\Model\Page the next page if one exist
+     */
+    protected $nextPage;
+
+    /**
+     * @var string The content folder, as passed to the class constructor when initiating the object.
+     */
+    protected $contentFolder = CONTENT_DIR;
+
+    /**
+     * the constructor
+     *
+     * @param        $filePath
+     * @param string $folder
+     */
+    public function __construct($filePath, $folder = CONTENT_DIR) {
+        $this->contentFolder = $folder;
+        $this->setFilePath($filePath);
+
+        /**
+         * @triggerEvent before_load_content this event is triggered before the content is loaded
+         *
+         * @param            string filePath the path to the file
+         * @param \Phile\Model\Page page     the page model
+         */
+        Event::triggerEvent('before_load_content', array('filePath' => &$this->filePath, 'page' => &$this));
+        if (file_exists($this->filePath)) {
+            $this->rawData = file_get_contents($this->filePath);
+            $this->parseRawData();
+        }
+        /**
+         * @triggerEvent after_load_content this event is triggered after the content is loaded
+         *
+         * @param            string filePath the path to the file
+         * @param            string rawData  the raw data
+         * @param \Phile\Model\Page page     the page model
+         */
+        Event::triggerEvent('after_load_content', array('filePath' => &$this->filePath, 'rawData' => $this->rawData, 'page' => &$this));
+
+        $this->parser = ServiceLocator::getService('Phile_Parser');
+    }
+
+    /**
+     * method to get content of page, this method returned the parsed content
+     *
+     * @return mixed
+     */
+    public function getContent() {
+        /**
+         * @triggerEvent before_parse_content this event is triggered before the content is parsed
+         *
+         * @param            string content the raw data
+         * @param \Phile\Model\Page page    the page model
+         */
+        Event::triggerEvent('before_parse_content', array('content' => $this->content, 'page' => &$this));
+        $content = $this->parser->parse($this->content);
+        /**
+         * @triggerEvent after_parse_content this event is triggered after the content is parsed
+         *
+         * @param            string content the parsed content
+         * @param \Phile\Model\Page page    the page model
+         */
+        Event::triggerEvent('after_parse_content', array('content' => &$content, 'page' => &$this));
+
+        return $content;
+    }
+
+    /**
+     * set content of page
+     *
+     * @param $content
+     */
+    public function setContent($content) {
+        $this->content = $content;
+    }
+
+    /**
+     * get raw (un-parsed) page content
+     *
+     * @return string
+     */
+    public function getRawContent() {
+        return $this->content;
+    }
+
+    /**
+     * get the meta model
+     *
+     * @return Meta
+     */
+    public function getMeta() {
+        return $this->meta;
+    }
+
+    /**
+     * parse the raw content
+     */
+    protected function parseRawData() {
+        $this->meta = new Meta($this->rawData);
+        // Remove only the optional, leading meta-block comment
+        $rawData = trim($this->rawData);
+        if (strncmp('<!--', $rawData, 4) === 0) {
+            // leading meta-block comment uses the <!-- --> style
+            $this->content = substr($rawData, max(4, strpos($rawData, '-->') + 3));
+        } elseif (strncmp('/*', $rawData, 2) === 0) {
+            // leading meta-block comment uses the /* */ style
+            $this->content = substr($rawData, strpos($rawData, '*/') + 2);
+        } else {
+            // no leading meta-block comment
+            $this->content = $rawData;
+        }
+    }
+
+    /**
+     * get the title of page from meta information
+     *
+     * @return string|null
+     */
+    public function getTitle() {
+        return $this->getMeta()->get('title');
+    }
+
+    /**
+     * get Phile $pageId
+     *
+     * @param string $filePath
+     * @return string
+     */
+    protected function buildPageId($filePath) {
+        $pageId = str_replace($this->contentFolder, '', $filePath);
+        $pageId = str_replace(CONTENT_EXT, '', $pageId);
+        $pageId = str_replace(DIRECTORY_SEPARATOR, '/', $pageId);
+        $pageId = ltrim($pageId, '/');
+        $pageId = preg_replace('/(?<=^|\/)index$/', '', $pageId);
+        return $pageId;
+    }
+
+    /**
+     * get the url of page
+     *
+     * @return string
+     */
+    public function getUrl() {
+        return (new Router)->urlForPage($this->pageId, false);
+    }
+
+    /**
+     * set the filepath of the page
+     *
+     * @param string $filePath
+     */
+    public function setFilePath($filePath) {
+        $this->filePath = $filePath;
+        $this->pageId = $this->buildPageId($this->filePath);
+    }
+
+    /**
+     * get the filepath of the page
+     *
+     * @return string
+     */
+    public function getFilePath() {
+        return $this->filePath;
+    }
+
+    /**
+     * get the folder name
+     *
+     * @return string
+     */
+    public function getFolder() {
+        return basename(dirname($this->getFilePath()));
+    }
+
+    public function getPageId() {
+        return $this->pageId;
+    }
+
+    /**
+     * get the previous page if one exist
+     *
+     * @return null|\Phile\Model\Page
+     */
+    public function getPreviousPage() {
+        $pageRepository = new \Phile\Repository\Page();
+        return $pageRepository->getPageOffset($this, -1);
+    }
+
+    /**
+     * get the next page if one exist
+     *
+     * @return null|\Phile\Model\Page
+     */
+    public function getNextPage() {
+        $pageRepository = new \Phile\Repository\Page();
+        return $pageRepository->getPageOffset($this, 1);
+    }
 }

lib/Phile/Plugin/AbstractPlugin.php

Doc Comments +1 added lines, -1 removed lines

@@ -118,7 +118,7 @@
 	 * get file path to plugin root (trailing slash) or to a sub-item
 	 *
 	 * @param string $subPath
-	 * @return null|string null if item does not exist
+	 * @return string null if item does not exist
 	 */
 	protected function getPluginPath($subPath = '') {
 		return $this->plugin['dir'] . ltrim($subPath, DIRECTORY_SEPARATOR);

Indentation +104 added lines, -104 removed lines

@@ -19,109 +19,109 @@
  */
 abstract class AbstractPlugin implements EventObserverInterface {
 
-	/** @var string plugin attributes */
-	protected $plugin = [];
-
-	 /** @var array subscribed Phile events ['eventName' => 'classMethodToCall'] */
-	protected $events = [];
-
-	/** @var array the plugin settings */
-	protected $settings = [];
-
-	/**
-	 * initialize plugin
-	 *
-	 * try to keep all initialization in one method to have a clean class
-	 * for the plugin-user
-	 *
-	 * @param string $pluginKey
-	 * @deprecated since 1.5.1 will be declared 'final'
-	 */
-	public function initializePlugin($pluginKey) {
-		/**
-		 * init $plugin property
-		 */
-		$this->plugin['key'] = $pluginKey;
-		list($vendor, $name) = explode('\\', $this->plugin['key']);
-		$DS = DIRECTORY_SEPARATOR;
-		$this->plugin['dir'] = PLUGINS_DIR . $vendor . $DS . $name . $DS;
-
-		/**
-		 * init events
-		 */
-		foreach ($this->events as $event => $method) {
-			Event::registerEvent($event, $this);
-		}
-
-		/**
-		 * init plugin settings
-		 */
-		$defaults = Utility::load($this->getPluginPath('config.php'));
-		if (empty($defaults) || !is_array($defaults)) {
-			$defaults = [];
-		}
-
-		$globals = Registry::get('Phile_Settings');
-		if (!isset($globals['plugins'][$pluginKey])) {
-			$globals['plugins'][$pluginKey] = [];
-		}
-
-		// settings precedence: global > default > class
-		$this->settings = array_replace_recursive(
-			$this->settings,
-			$defaults,
-			$globals['plugins'][$pluginKey]
-		);
-
-		// backwards compatibility to Phile 1.4
-		$this->injectSettings($this->settings);
-
-		$globals['plugins'][$pluginKey]['settings'] = $this->settings;
-		Registry::set('Phile_Settings', $globals);
-
-	}
-
-	/**
-	 * inject settings
-	 *
-	 * backwards compatibility to Phile 1.4
-	 *
-	 * @param array $settings
-	 * @deprecated since 1.5.1 will be removed
-	 */
-	public function injectSettings(array $settings = null) {
-	}
-
-	/**
-	 * implements EventObserverInterface
-	 *
-	 * @param string $eventKey
-	 * @param null $data
-	 * @return void
-	 */
-	public function on($eventKey, $data = null) {
-		if (!isset($this->events[$eventKey])) {
-			return;
-		}
-		$method = $this->events[$eventKey];
-		if (!is_callable([$this, $method])) {
-			$class = get_class($this);
-			throw new \RuntimeException(
-				"Event $eventKey can't invoke $class::$method(). Not callable.",
-				1428564865
-			);
-		}
-		$this->{$this->events[$eventKey]}($data);
-	}
-
-	/**
-	 * get file path to plugin root (trailing slash) or to a sub-item
-	 *
-	 * @param string $subPath
-	 * @return null|string null if item does not exist
-	 */
-	protected function getPluginPath($subPath = '') {
-		return $this->plugin['dir'] . ltrim($subPath, DIRECTORY_SEPARATOR);
-	}
+    /** @var string plugin attributes */
+    protected $plugin = [];
+
+        /** @var array subscribed Phile events ['eventName' => 'classMethodToCall'] */
+    protected $events = [];
+
+    /** @var array the plugin settings */
+    protected $settings = [];
+
+    /**
+     * initialize plugin
+     *
+     * try to keep all initialization in one method to have a clean class
+     * for the plugin-user
+     *
+     * @param string $pluginKey
+     * @deprecated since 1.5.1 will be declared 'final'
+     */
+    public function initializePlugin($pluginKey) {
+        /**
+         * init $plugin property
+         */
+        $this->plugin['key'] = $pluginKey;
+        list($vendor, $name) = explode('\\', $this->plugin['key']);
+        $DS = DIRECTORY_SEPARATOR;
+        $this->plugin['dir'] = PLUGINS_DIR . $vendor . $DS . $name . $DS;
+
+        /**
+         * init events
+         */
+        foreach ($this->events as $event => $method) {
+            Event::registerEvent($event, $this);
+        }
+
+        /**
+         * init plugin settings
+         */
+        $defaults = Utility::load($this->getPluginPath('config.php'));
+        if (empty($defaults) || !is_array($defaults)) {
+            $defaults = [];
+        }
+
+        $globals = Registry::get('Phile_Settings');
+        if (!isset($globals['plugins'][$pluginKey])) {
+            $globals['plugins'][$pluginKey] = [];
+        }
+
+        // settings precedence: global > default > class
+        $this->settings = array_replace_recursive(
+            $this->settings,
+            $defaults,
+            $globals['plugins'][$pluginKey]
+        );
+
+        // backwards compatibility to Phile 1.4
+        $this->injectSettings($this->settings);
+
+        $globals['plugins'][$pluginKey]['settings'] = $this->settings;
+        Registry::set('Phile_Settings', $globals);
+
+    }
+
+    /**
+     * inject settings
+     *
+     * backwards compatibility to Phile 1.4
+     *
+     * @param array $settings
+     * @deprecated since 1.5.1 will be removed
+     */
+    public function injectSettings(array $settings = null) {
+    }
+
+    /**
+     * implements EventObserverInterface
+     *
+     * @param string $eventKey
+     * @param null $data
+     * @return void
+     */
+    public function on($eventKey, $data = null) {
+        if (!isset($this->events[$eventKey])) {
+            return;
+        }
+        $method = $this->events[$eventKey];
+        if (!is_callable([$this, $method])) {
+            $class = get_class($this);
+            throw new \RuntimeException(
+                "Event $eventKey can't invoke $class::$method(). Not callable.",
+                1428564865
+            );
+        }
+        $this->{$this->events[$eventKey]}($data);
+    }
+
+    /**
+     * get file path to plugin root (trailing slash) or to a sub-item
+     *
+     * @param string $subPath
+     * @return null|string null if item does not exist
+     */
+    protected function getPluginPath($subPath = '') {
+        return $this->plugin['dir'] . ltrim($subPath, DIRECTORY_SEPARATOR);
+    }
 
 }

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -107,7 +107,7 @@
 		if (!is_callable([$this, $method])) {
 			$class = get_class($this);
 			throw new \RuntimeException(
-				"Event $eventKey can't invoke $class::$method(). Not callable.",
+				"event $eventKey can't invoke $class::$method(). Not callable.",
 				1428564865
 			);
 		}

plugins/phile/templateTwig/Classes/Template/Twig.php

Doc Comments +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
 	/**
 	 * wrapper to call the render engine
 	 *
-	 * @param $engine
+	 * @param \Twig_Environment $engine
 	 * @param $vars
 	 * @return mixed
 	 */

Indentation +154 added lines, -154 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 /**
- * Template engine class
- */
+     * Template engine class
+     */
 namespace Phile\Plugin\Phile\TemplateTwig\Template;
 
 use Phile\Core\Event;
@@ -19,157 +19,157 @@ 
  * @package Phile\Plugin\Phile\TemplateTwig\Template
  */
 class Twig implements TemplateInterface {
-	/**
-	 * @var array the complete phile config
-	 */
-	protected $settings;
-
-	/**
-	 * @var array the config for twig
-	 */
-	protected $config;
-
-	/**
-	 * @var Page the page model
-	 */
-	protected $page;
-
-	/**
-	 * the constructor
-	 *
-	 * @param array $config the configuration
-	 */
-	public function __construct($config = []) {
-		$this->config = $config;
-		$this->settings = Registry::get('Phile_Settings');
-	}
-
-	/**
-	 * method to set the current page
-	 *
-	 * @param Page $page the page model
-	 *
-	 * @return mixed|void
-	 */
-	public function setCurrentPage(Page $page) {
-		$this->page = $page;
-	}
-
-	/**
-	 * method to render the page/template
-	 *
-	 * @return mixed|string
-	 */
-	public function render() {
-		$engine = $this->getEngine();
-		$vars = $this->getTemplateVars();
-
-		Event::triggerEvent(
-			'template_engine_registered',
-			['engine' => &$engine, 'data' => &$vars]
-		);
-
-		return $this->_render($engine, $vars);
-	}
-
-	/**
-	 * wrapper to call the render engine
-	 *
-	 * @param $engine
-	 * @param $vars
-	 * @return mixed
-	 */
-	protected function _render($engine, $vars) {
-		try {
-			$template = $this->getTemplateFileName();
-		} catch (\RuntimeException $e) {
-			return $e->getMessage();
-		}
-		return $engine->render($template, $vars);
-	}
-
-	/**
-	 * get template engine
-	 *
-	 * @return \Twig_Environment
-	 */
-	protected function getEngine() {
-		$loader = new \Twig_Loader_Filesystem($this->getTemplatePath());
-		$twig = new \Twig_Environment($loader, $this->config);
-
-		// load the twig debug extension if required
-		if (!empty($this->config['debug'])) {
-			$twig->addExtension(new \Twig_Extension_Debug());
-		}
-		return $twig;
-	}
-
-	/**
-	 * get template file name
-	 *
-	 * @return string
-	 * @throws \RuntimeException
-	 */
-	protected function getTemplateFileName() {
-		$template = $this->page->getMeta()->get('template');
-		if (empty($template)) {
-			$template = 'index';
-		}
-		if (!empty($this->config['template-extension'])) {
-			$template .= '.' . $this->config['template-extension'];
-		}
-		$templatePath = $this->getTemplatePath($template);
-		if (!file_exists($templatePath)) {
-			throw new \RuntimeException(
-				"Template file '{$templatePath}' not found.",
-				1427990135
-			);
-		}
-		return $template;
-	}
-
-	/**
-	 * get file path to (sub-path) in theme-path
-	 *
-	 * @param string $sub
-	 * @return string
-	 */
-	protected function getTemplatePath($sub = '') {
-		$themePath = THEMES_DIR . $this->settings['theme'];
-		if (!empty($sub)) {
-			$themePath .= '/' . ltrim($sub, DIRECTORY_SEPARATOR);
-		}
-		return $themePath;
-	}
-
-	/**
-	 * get template vars
-	 *
-	 * @return array|mixed
-	 * @throws \Exception
-	 */
-	protected function getTemplateVars() {
-		$repository = new Repository($this->settings);
-		$defaults = [
-			'content' => $this->page->getContent(),
-			'meta' => $this->page->getMeta(),
-			'current_page' => $this->page,
-			'base_dir' => rtrim(ROOT_DIR, '/'),
-			'base_url' => $this->settings['base_url'],
-			'config' => $this->settings,
-			'content_dir' => CONTENT_DIR,
-			'content_url' => $this->settings['base_url'] . '/' . basename(CONTENT_DIR),
-			'pages' => $repository->findAll(),
-			'site_title' => $this->settings['site_title'],
-			'theme_dir' => THEMES_DIR . $this->settings['theme'],
-			'theme_url' => $this->settings['base_url'] . '/' . basename(THEMES_DIR) . '/' . $this->settings['theme'],
-		];
-
-		/** @var array $templateVars */
-		$templateVars = Registry::get('templateVars');
-		$templateVars += $defaults;
-
-		return $templateVars;
-	}
+    /**
+     * @var array the complete phile config
+     */
+    protected $settings;
+
+    /**
+     * @var array the config for twig
+     */
+    protected $config;
+
+    /**
+     * @var Page the page model
+     */
+    protected $page;
+
+    /**
+     * the constructor
+     *
+     * @param array $config the configuration
+     */
+    public function __construct($config = []) {
+        $this->config = $config;
+        $this->settings = Registry::get('Phile_Settings');
+    }
+
+    /**
+     * method to set the current page
+     *
+     * @param Page $page the page model
+     *
+     * @return mixed|void
+     */
+    public function setCurrentPage(Page $page) {
+        $this->page = $page;
+    }
+
+    /**
+     * method to render the page/template
+     *
+     * @return mixed|string
+     */
+    public function render() {
+        $engine = $this->getEngine();
+        $vars = $this->getTemplateVars();
+
+        Event::triggerEvent(
+            'template_engine_registered',
+            ['engine' => &$engine, 'data' => &$vars]
+        );
+
+        return $this->_render($engine, $vars);
+    }
+
+    /**
+     * wrapper to call the render engine
+     *
+     * @param $engine
+     * @param $vars
+     * @return mixed
+     */
+    protected function _render($engine, $vars) {
+        try {
+            $template = $this->getTemplateFileName();
+        } catch (\RuntimeException $e) {
+            return $e->getMessage();
+        }
+        return $engine->render($template, $vars);
+    }
+
+    /**
+     * get template engine
+     *
+     * @return \Twig_Environment
+     */
+    protected function getEngine() {
+        $loader = new \Twig_Loader_Filesystem($this->getTemplatePath());
+        $twig = new \Twig_Environment($loader, $this->config);
+
+        // load the twig debug extension if required
+        if (!empty($this->config['debug'])) {
+            $twig->addExtension(new \Twig_Extension_Debug());
+        }
+        return $twig;
+    }
+
+    /**
+     * get template file name
+     *
+     * @return string
+     * @throws \RuntimeException
+     */
+    protected function getTemplateFileName() {
+        $template = $this->page->getMeta()->get('template');
+        if (empty($template)) {
+            $template = 'index';
+        }
+        if (!empty($this->config['template-extension'])) {
+            $template .= '.' . $this->config['template-extension'];
+        }
+        $templatePath = $this->getTemplatePath($template);
+        if (!file_exists($templatePath)) {
+            throw new \RuntimeException(
+                "Template file '{$templatePath}' not found.",
+                1427990135
+            );
+        }
+        return $template;
+    }
+
+    /**
+     * get file path to (sub-path) in theme-path
+     *
+     * @param string $sub
+     * @return string
+     */
+    protected function getTemplatePath($sub = '') {
+        $themePath = THEMES_DIR . $this->settings['theme'];
+        if (!empty($sub)) {
+            $themePath .= '/' . ltrim($sub, DIRECTORY_SEPARATOR);
+        }
+        return $themePath;
+    }
+
+    /**
+     * get template vars
+     *
+     * @return array|mixed
+     * @throws \Exception
+     */
+    protected function getTemplateVars() {
+        $repository = new Repository($this->settings);
+        $defaults = [
+            'content' => $this->page->getContent(),
+            'meta' => $this->page->getMeta(),
+            'current_page' => $this->page,
+            'base_dir' => rtrim(ROOT_DIR, '/'),
+            'base_url' => $this->settings['base_url'],
+            'config' => $this->settings,
+            'content_dir' => CONTENT_DIR,
+            'content_url' => $this->settings['base_url'] . '/' . basename(CONTENT_DIR),
+            'pages' => $repository->findAll(),
+            'site_title' => $this->settings['site_title'],
+            'theme_dir' => THEMES_DIR . $this->settings['theme'],
+            'theme_url' => $this->settings['base_url'] . '/' . basename(THEMES_DIR) . '/' . $this->settings['theme'],
+        ];
+
+        /** @var array $templateVars */
+        $templateVars = Registry::get('templateVars');
+        $templateVars += $defaults;
+
+        return $templateVars;
+    }
 
 }

index.php

Indentation +17 added lines, -17 removed lines

@@ -11,25 +11,25 @@
 ob_start();
 
 try {
-	\Phile\Bootstrap::getInstance()->initializeBasics();
-	$router = new \Phile\Core\Router();
-	$response = new \Phile\Core\Response();
-	$phileCore = new \Phile\Core($router, $response);
-	$phileCore->render();
+    \Phile\Bootstrap::getInstance()->initializeBasics();
+    $router = new \Phile\Core\Router();
+    $response = new \Phile\Core\Response();
+    $phileCore = new \Phile\Core($router, $response);
+    $phileCore->render();
 } catch (\Phile\Exception\AbstractException $e) {
-	if (\Phile\Core\ServiceLocator::hasService('Phile_ErrorHandler')) {
-		ob_end_clean();
+    if (\Phile\Core\ServiceLocator::hasService('Phile_ErrorHandler')) {
+        ob_end_clean();
 
-		/** @var \Phile\ServiceLocator\ErrorHandlerInterface $errorHandler */
-		$errorHandler = \Phile\Core\ServiceLocator::getService('Phile_ErrorHandler');
-		$errorHandler->handleException($e);
-	}
+        /** @var \Phile\ServiceLocator\ErrorHandlerInterface $errorHandler */
+        $errorHandler = \Phile\Core\ServiceLocator::getService('Phile_ErrorHandler');
+        $errorHandler->handleException($e);
+    }
 } catch (\Exception $e) {
-	if (\Phile\Core\ServiceLocator::hasService('Phile_ErrorHandler')) {
-		ob_end_clean();
+    if (\Phile\Core\ServiceLocator::hasService('Phile_ErrorHandler')) {
+        ob_end_clean();
 
-		/** @var \Phile\ServiceLocator\ErrorHandlerInterface $errorHandler */
-		$errorHandler = \Phile\Core\ServiceLocator::getService('Phile_ErrorHandler');
-		$errorHandler->handleException($e);
-	}
+        /** @var \Phile\ServiceLocator\ErrorHandlerInterface $errorHandler */
+        $errorHandler = \Phile\Core\ServiceLocator::getService('Phile_ErrorHandler');
+        $errorHandler->handleException($e);
+    }
 }