jenskooij / cloudcontrol

cloudcontrol/library/storage/JsonStorage.php

Doc Comments +4 added lines, -1 removed lines

@@ -17,7 +17,7 @@ 
 		/**
 		 * JsonStorage constructor.
 		 *
-		 * @param $storagePath
+		 * @param string $storagePath
 		 */
 		public function __construct($storagePath)
 		{
@@ -837,6 +837,9 @@ 
 			}
 		}
 
+		/**
+		 * @param string $path
+		 */
 		private function validateFilename($filename, $path)
 		{
 			$fileParts = explode('.', $filename);

Indentation +3 added lines, -3 removed lines

@@ -786,7 +786,7 @@ 
 		/**
 		 * @param $filename
 		 * @return null
-         */
+		 */
 		public function getImageByName($filename)
 		{
 			$images = $this->getImages();
@@ -876,7 +876,7 @@ 
 		/**
 		 * @param $filename
 		 * @return null
-         */
+		 */
 		public function getFileByName($filename)
 		{
 			$files = $this->getFiles();
@@ -891,7 +891,7 @@ 
 		/**
 		 * @param $filename
 		 * @throws \Exception
-         */
+		 */
 		public function deleteFileByName($filename)
 		{
 			$destinationPath = realpath(__DIR__ . '/../../www/files/');

cloudcontrol/library/images/methods/SmartCrop.php

Indentation +2 added lines, -2 removed lines

@@ -62,8 +62,8 @@
 
 			// Preserve transparency
 			imagecolortransparent($new, imagecolorallocatealpha($new, 0, 0, 0, 127));
-            imagealphablending($new, false);
-            imagesavealpha($new, true);
+			imagealphablending($new, false);
+			imagesavealpha($new, true);
 			
 			imagecopyresampled($new, $imageResource, $this->_destX, $this->_destY, $this->_x, $this->_y, $this->_destWidth, $this->_destHeight, $originalWidth, $originalHeight);
 			

cloudcontrol/library/images/methods/Crop.php

Indentation +2 added lines, -2 removed lines

@@ -62,8 +62,8 @@
 
 			// Preserve transparency
 			imagecolortransparent($new, imagecolorallocatealpha($new, 0, 0, 0, 127));
-            imagealphablending($new, false);
-            imagesavealpha($new, true);
+			imagealphablending($new, false);
+			imagesavealpha($new, true);
 			
 			imagecopyresampled($new, $imageResource, $this->_destX, $this->_destY, $this->_x, $this->_y, $this->_destWidth, $this->_destHeight, $originalWidth, $originalHeight);
 			

cloudcontrol/library/images/Image.php

Doc Comments +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
 		 * @see http://www.php.net/manual/en/function.image-type-to-mime-type.php
 		 * @param string $imagePath
 		 * @param bool $getExtension
-		 * @return bool|int|string
+		 * @return integer
 		 */
 		public function GetImageMimeType($imagePath, $getExtension = false)
 		{

cloudcontrol/library/images/methods/BoxCrop.php

Indentation +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
 		/**
 		 * @param resource $imageResource
 		 * @return resource
-         */
+		 */
 		public function Execute($imageResource)
 		{
 			// Define the origial width and height

cloudcontrol/library/components/LanguageComponent.php

Doc Comments +1 added lines, -1 removed lines

@@ -105,7 +105,7 @@
     /**
      * Detect if the language is switched manually
      *
-     * @param $request
+     * @param Request $request
      */
     private function checkLanguageSwitch($request)
     {

Indentation +112 added lines, -112 removed lines

@@ -7,118 +7,118 @@
 
 class LanguageComponent implements Component
 {
-    protected $request;
-    protected $parameters;
-
-    protected $defaultLanguage = 'en';
-    protected $acceptedLanguages = null;
-    protected $languageParameterName = 'language';
-    protected $forceRedirect = false;
-    protected $sessionValues;
-
-    /**
-     * Component constructor.
-     *
-     * @param                     $template
-     * @param Request $request
-     * @param                     $parameters
-     * @param                     $matchedSitemapItem
-     */
-    public function __construct($template, Request $request, $parameters, $matchedSitemapItem)
-    {
-        $this->parameters = (array) $parameters;
-        $this->checkParameters();
-
-        $lang = substr(isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : $this->defaultLanguage, 0, 2);
-        $_SESSION['LanguageComponent']['detectedLanguage'] = $lang;
-
-        $this->checkLanguageSwitch($request);
-
-        if (!isset($_SESSION['LanguageComponent'][$this->languageParameterName])) {
-            $this->detectLanguage($lang, $request);
-        }
-
-        $this->parameters[$this->languageParameterName] = $_SESSION['LanguageComponent'][$this->languageParameterName];
-    }
-
-    /**
-     * Checks to see if any parameters are given from the configuration in the CMS
-     */
-    private function checkParameters()
-    {
-        if (isset($this->parameters['defaultLanguage'])) {
-            $this->defaultLanguage = $this->parameters['defaultLanguage'];
-            unset($this->parameters['defaultLanguage']);
-        }
-        if (isset($this->parameters['acceptedLanguages'])) {
-            $this->acceptedLanguages = explode(',', $this->parameters['acceptedLanguages']);
-            unset($this->parameters['acceptedLanguages']);
-        }
-        if (isset($this->parameters['languageParameterName'])) {
-            $this->languageParameterName = $this->parameters['languageParameterName'];
-            unset($this->parameters['languageParameterName']);
-        }
-        if (isset($this->parameters['forceRedirect'])) {
-            $this->forceRedirect = (bool) $this->parameters['forceRedirect'];
-            unset($this->parameters['forceRedirect']);
-        }
-    }
-
-    /**
-     * @return array
-     */
-    public function getParameters()
-    {
-        return $this->parameters;
-    }
-
-
-    /**
-     * Check if the found language is allowed and
-     * if an action is to be taken.
-     *
-     * @param $lang
-     * @param $request
-     */
-    private function detectLanguage($lang, $request)
-    {
-        $_SESSION['LanguageComponent'][$this->languageParameterName] = $this->defaultLanguage;
-
-        if ($this->acceptedLanguages === null) {
-            $_SESSION['LanguageComponent'][$this->languageParameterName] = $lang;
-        } else if (in_array($lang, $this->acceptedLanguages)) {
-            $_SESSION['LanguageComponent'][$this->languageParameterName] = $lang;
-        } else {
-            $lang = $this->defaultLanguage;
-        }
-
-        $this->sessionValues = $_SESSION['LanguageComponent'];
-
-        if ($this->forceRedirect === true) {
-            if (substr($request::$relativeUri, 0, 2) !== $lang && $lang !== $this->defaultLanguage) { // if default language detected, no redirect
-                header('Location: ' . $request::$subfolders . $lang . '/' . $request::$relativeUri);
-                exit;
-            }
-        }
-    }
-
-    /**
-     * Detect if the language is switched manually
-     *
-     * @param $request
-     */
-    private function checkLanguageSwitch($request)
-    {
-        if (isset($request::$get['langSwitch'])) {
-            $this->forceRedirect = true;
-            $this->detectLanguage($request::$get['langSwitch'], $request);
-        }
-    }
-
-    /*
+	protected $request;
+	protected $parameters;
+
+	protected $defaultLanguage = 'en';
+	protected $acceptedLanguages = null;
+	protected $languageParameterName = 'language';
+	protected $forceRedirect = false;
+	protected $sessionValues;
+
+	/**
+	 * Component constructor.
+	 *
+	 * @param                     $template
+	 * @param Request $request
+	 * @param                     $parameters
+	 * @param                     $matchedSitemapItem
+	 */
+	public function __construct($template, Request $request, $parameters, $matchedSitemapItem)
+	{
+		$this->parameters = (array) $parameters;
+		$this->checkParameters();
+
+		$lang = substr(isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : $this->defaultLanguage, 0, 2);
+		$_SESSION['LanguageComponent']['detectedLanguage'] = $lang;
+
+		$this->checkLanguageSwitch($request);
+
+		if (!isset($_SESSION['LanguageComponent'][$this->languageParameterName])) {
+			$this->detectLanguage($lang, $request);
+		}
+
+		$this->parameters[$this->languageParameterName] = $_SESSION['LanguageComponent'][$this->languageParameterName];
+	}
+
+	/**
+	 * Checks to see if any parameters are given from the configuration in the CMS
+	 */
+	private function checkParameters()
+	{
+		if (isset($this->parameters['defaultLanguage'])) {
+			$this->defaultLanguage = $this->parameters['defaultLanguage'];
+			unset($this->parameters['defaultLanguage']);
+		}
+		if (isset($this->parameters['acceptedLanguages'])) {
+			$this->acceptedLanguages = explode(',', $this->parameters['acceptedLanguages']);
+			unset($this->parameters['acceptedLanguages']);
+		}
+		if (isset($this->parameters['languageParameterName'])) {
+			$this->languageParameterName = $this->parameters['languageParameterName'];
+			unset($this->parameters['languageParameterName']);
+		}
+		if (isset($this->parameters['forceRedirect'])) {
+			$this->forceRedirect = (bool) $this->parameters['forceRedirect'];
+			unset($this->parameters['forceRedirect']);
+		}
+	}
+
+	/**
+	 * @return array
+	 */
+	public function getParameters()
+	{
+		return $this->parameters;
+	}
+
+
+	/**
+	 * Check if the found language is allowed and
+	 * if an action is to be taken.
+	 *
+	 * @param $lang
+	 * @param $request
+	 */
+	private function detectLanguage($lang, $request)
+	{
+		$_SESSION['LanguageComponent'][$this->languageParameterName] = $this->defaultLanguage;
+
+		if ($this->acceptedLanguages === null) {
+			$_SESSION['LanguageComponent'][$this->languageParameterName] = $lang;
+		} else if (in_array($lang, $this->acceptedLanguages)) {
+			$_SESSION['LanguageComponent'][$this->languageParameterName] = $lang;
+		} else {
+			$lang = $this->defaultLanguage;
+		}
+
+		$this->sessionValues = $_SESSION['LanguageComponent'];
+
+		if ($this->forceRedirect === true) {
+			if (substr($request::$relativeUri, 0, 2) !== $lang && $lang !== $this->defaultLanguage) { // if default language detected, no redirect
+				header('Location: ' . $request::$subfolders . $lang . '/' . $request::$relativeUri);
+				exit;
+			}
+		}
+	}
+
+	/**
+	 * Detect if the language is switched manually
+	 *
+	 * @param $request
+	 */
+	private function checkLanguageSwitch($request)
+	{
+		if (isset($request::$get['langSwitch'])) {
+			$this->forceRedirect = true;
+			$this->detectLanguage($request::$get['langSwitch'], $request);
+		}
+	}
+
+	/*
      * These functions are required by the interface, but not for the functionality
      */
-    public function run(Storage $storage) {}
-    public function render() {}
-    public function get() {}
+	public function run(Storage $storage) {}
+	public function render() {}
+	public function get() {}
 }
\ No newline at end of file

cloudcontrol/library/components/CmsComponent.php

Indentation +18 added lines, -18 removed lines

@@ -18,7 +18,7 @@ 
 
 		/**
 		 * @var null
-         */
+		 */
 		protected $subTemplate = null;
 
 		/**
@@ -139,7 +139,7 @@ 
 		/**
 		 * @param $remoteAddress
 		 * @throws \Exception
-         */
+		 */
 		private function checkWhiteList($remoteAddress)
 		{
 			if (isset($this->parameters['whitelistIps'])) {
@@ -154,7 +154,7 @@ 
 		/**
 		 * @param $remoteAddress
 		 * @throws \Exception
-         */
+		 */
 		private function checkBlackList($remoteAddress)
 		{
 			if (isset($this->parameters['blacklistIps'])) {
@@ -169,7 +169,7 @@ 
 		/**
 		 * @param $request
 		 * @return mixed|string
-         */
+		 */
 		private function getRelativeCmsUri($request)
 		{
 			// TODO Use regex match parameter instead of calculating relative uri
@@ -184,7 +184,7 @@ 
 		/**
 		 * @param $request
 		 * @param $relativeCmsUri
-         */
+		 */
 		private function documentsRouting($request, $relativeCmsUri)
 		{
 			if ($relativeCmsUri == '/documents') {
@@ -199,7 +199,7 @@ 
 		/**
 		 * @param $request
 		 * @param $relativeCmsUri
-         */
+		 */
 		private function sitemapRouting($request, $relativeCmsUri)
 		{
 			if ($relativeCmsUri == '/sitemap') {
@@ -237,7 +237,7 @@ 
 		/**
 		 * @param $request
 		 * @param $relativeCmsUri
-         */
+		 */
 		private function imagesRouting($request, $relativeCmsUri)
 		{
 			if ($relativeCmsUri == '/images') {
@@ -269,7 +269,7 @@ 
 
 		/**
 		 * @param $relativeCmsUri
-         */
+		 */
 		private function apiRouting($relativeCmsUri)
 		{
 			if ($relativeCmsUri == '/images.json') {
@@ -287,7 +287,7 @@ 
 		/**
 		 * @param $request
 		 * @param $relativeCmsUri
-         */
+		 */
 		private function filesRouting($request, $relativeCmsUri)
 		{
 			if ($relativeCmsUri == '/files') {
@@ -313,7 +313,7 @@ 
 
 		/**
 		 * @param $slug
-         */
+		 */
 		private function downloadFile($slug)
 		{
 			$file = $this->storage->getFileByName($slug);
@@ -338,7 +338,7 @@ 
 		/**
 		 * @param $request
 		 * @param $relativeCmsUri
-         */
+		 */
 		private function configurationRouting($request, $relativeCmsUri)
 		{
 			if ($relativeCmsUri == '/configuration') {
@@ -357,7 +357,7 @@ 
 		 * @param $request
 		 * @param $relativeCmsUri
 		 * @throws \Exception
-         */
+		 */
 		private function documentRouting($request, $relativeCmsUri)
 		{
 			if ($relativeCmsUri == '/documents/new-document' && isset($request::$get['path'])) {
@@ -412,7 +412,7 @@ 
 		/**
 		 * @param $request
 		 * @param $relativeCmsUri
-         */
+		 */
 		private function folderRouting($request, $relativeCmsUri)
 		{
 			if ($relativeCmsUri == '/documents/new-folder' && isset($request::$get['path'])) {
@@ -453,7 +453,7 @@ 
 		/**
 		 * @param $request
 		 * @param $relativeCmsUri
-         */
+		 */
 		private function usersRouting($request, $relativeCmsUri)
 		{
 			if ($relativeCmsUri == '/configuration/users') {
@@ -487,7 +487,7 @@ 
 		/**
 		 * @param $request
 		 * @param $relativeCmsUri
-         */
+		 */
 		private function documentTypesRouting($request, $relativeCmsUri)
 		{
 			if ($relativeCmsUri == '/configuration/document-types') {
@@ -526,7 +526,7 @@ 
 		/**
 		 * @param $request
 		 * @param $relativeCmsUri
-         */
+		 */
 		private function bricksRouting($request, $relativeCmsUri)
 		{
 			if ($relativeCmsUri == '/configuration/bricks') {
@@ -565,7 +565,7 @@ 
 		/**
 		 * @param $request
 		 * @param $relativeCmsUri
-         */
+		 */
 		private function imageSetRouting($request, $relativeCmsUri)
 		{
 			if ($relativeCmsUri == '/configuration/image-set') {
@@ -600,7 +600,7 @@ 
 		/**
 		 * @param $request
 		 * @param $relativeCmsUri
-         */
+		 */
 		private function applicationComponentRouting($request, $relativeCmsUri)
 		{
 			if ($relativeCmsUri == '/configuration/application-components') {

cloudcontrol/library/components/FormComponent.php

Doc Comments +4 added lines, -4 removed lines

@@ -132,7 +132,7 @@ 
 
     /**
      * Sets variables needed for rendering the form template
-     * @param $storage
+     * @param Storage $storage
      */
     private function initialize($storage)
     {
@@ -168,7 +168,7 @@ 
      * submitting the form
      *
      * @param $postValues
-     * @param $storage
+     * @param Storage $storage
      */
     protected function postSubmit($postValues, $storage)
     {}
@@ -191,7 +191,7 @@ 
     /**
      * Checks if this form has been submitted
      *
-     * @param $request
+     * @param \library\cc\Request $request
      * @return bool
      */
     private function isFormSubmitted($request)
@@ -202,7 +202,7 @@ 
     /**
      *
      *
-     * @param $request
+     * @param \library\cc\Request $request
      */
     private function getPostValues($request)
     {

Indentation +244 added lines, -244 removed lines

@@ -7,248 +7,248 @@
 
 class FormComponent Extends BaseComponent
 {
-    /**
-     * @var null|string
-     */
-    protected $documentType = null;
-    /**
-     * @var null|string
-     */
-    protected $responseFolder = null;
-    /**
-     * @var string
-     */
-    protected $subTemplate = 'cms/documents/document-form-form';
-    /**
-     * @var string
-     */
-    protected $formParameterName = 'form';
-    /**
-     * @var string
-     */
-    protected $thankYouMessage = 'Thank you for sending us your response.';
-
-    /**
-     * @var bool
-     */
-    protected $submitOncePerSession = false;
-
-    /**
-     * @var string
-     */
-    private $formId;
-    /**
-     * @var null|string
-     */
-    private $getPathBackup = null;
-
-    /**
-     * @var null|\stdClass
-     */
-    private $userSessionBackup = null;
-
-    /**
-     * @param Storage $storage
-     * @return void
-     * @throws \Exception
-     */
-    public function run(Storage $storage)
-    {
-        parent::run($storage);
-
-        $this->checkParameters();
-
-        if ($this->documentType === null || $this->responseFolder === null) {
-            throw new \Exception('Parameters `documentType` and `responseFolder` are required for usage with this form');
-        }
-
-        $this->setFormId();
-        $this->initialize($storage);
-        $this->checkSubmit($storage);
-    }
-
-    /**
-     * @param null|Application $application
-     * @throws \Exception
-     */
-    public function render($application = null)
-    {
-        $request = $this->request;
-        if (isset($request::$get['path'])) {
-            $this->getPathBackup = $request::$get['path'];
-        }
-        $request::$get['path'] = $this->responseFolder;
-        $form = $this->renderTemplate($this->subTemplate);
-        if ($this->getPathBackup !== null) {
-            $request::$get['path'] = $this->getPathBackup;
-        } else {
-            unset($request::$get['path']);
-        }
-        if ($this->isFormSubmitted($this->request) || $this->isSubmitAllowed() === false) {
-            $this->parameters[$this->formParameterName] = '<a name="' . $this->formId . '"></a>' . $this->thankYouMessage;
-        } else {
-            $this->parameters[$this->formParameterName] = $form;
-        }
-
-        parent::render($application);
-    }
-
-    /**
-     * Checks if parameters were given in the CMS configuration and
-     * sets them to their respective fields
-     */
-    private function checkParameters()
-    {
-        if (isset($this->parameters['documentType'])) {
-            $this->documentType = $this->parameters['documentType'];
-            unset($this->parameters['documentType']);
-        }
-
-        if (isset($this->parameters['responseFolder'])) {
-            $this->responseFolder = $this->parameters['responseFolder'];
-            unset($this->parameters['responseFolder']);
-        }
-
-        if (isset($this->parameters['subTemplate'])) {
-            $this->subTemplate = $this->parameters['subTemplate'];
-            unset($this->parameters['subTemplate']);
-        }
-
-        if (isset($this->parameters['formParameterName'])) {
-            $this->formParameterName = $this->parameters['formParameterName'];
-            unset($this->parameters['formParameterName']);
-        }
-
-        if (isset($this->parameters['thankYouMessage'])) {
-            $this->thankYouMessage = $this->parameters['thankYouMessage'];
-            unset($this->parameters['thankYouMessage']);
-        }
-
-        if (isset($this->parameters['submitOncePerSession'])) {
-            $this->submitOncePerSession = $this->parameters['submitOncePerSession'] === 'true' ? true : false;
-            unset($this->parameters['submitOncePerSession']);
-        }
-    }
-
-    /**
-     * Sets variables needed for rendering the form template
-     * @param $storage
-     */
-    private function initialize($storage)
-    {
-        $this->parameters['smallestImage'] = $storage->getSmallestImageSet()->slug;
-        $this->parameters['cmsPrefix'] = '';
-
-        $this->parameters['documentType'] = $this->storage->getDocumentTypeBySlug($this->documentType, true);
-        $this->parameters['documentTypes'] = $this->storage->getDocumentTypes();
-        $this->parameters['hideTitleAndState'] = true;
-        $this->parameters['formId'] = $this->formId;
-    }
-
-    /**
-     * If the form has been submitted, save the document
-     * Calls $this->postSubmit() afterwards
-     *
-     * @param Storage $storage
-     */
-    private function checkSubmit($storage)
-    {
-        if ($this->isFormSubmitted($this->request) && $this->isSubmitAllowed()) {
-            $postValues = $this->getPostValues($this->request);
-            $this->setUserSessionBackup();
-            $storage->addDocument($postValues);
-            $this->restoreUserSessionBackup();
-            $this->setSubmitToSession();
-            $this->postSubmit($postValues, $storage);
-        }
-    }
-
-    /**
-     * Hook for derived classes to take actions after
-     * submitting the form
-     *
-     * @param $postValues
-     * @param $storage
-     */
-    protected function postSubmit($postValues, $storage)
-    {}
-
-    /**
-     * Sets a unique id for this particular form, so it can recognize
-     * it when a submit occurs
-     */
-    private function setFormId()
-    {
-        if (isset($_SESSION['FormComponent'][$this->formParameterName]['formId'])) {
-            $this->formId = $_SESSION['FormComponent'][$this->formParameterName]['formId'];
-        } else {
-            $_SESSION['FormComponent'][$this->formParameterName]['formId'] = (string) microtime(true);
-            $_SESSION['FormComponent'][$this->formParameterName]['submitted'] = false;
-            $this->formId = $_SESSION['FormComponent'][$this->formParameterName]['formId'];
-        }
-    }
-
-    /**
-     * Checks if this form has been submitted
-     *
-     * @param $request
-     * @return bool
-     */
-    private function isFormSubmitted($request)
-    {
-        return !empty($request::$post) && isset($request::$post['formId']) && $request::$post['formId'] === $this->formId && isset($_SESSION['FormComponent'][$this->formParameterName]['formId']) && $_SESSION['FormComponent'][$this->formParameterName]['formId'] === $this->formId;
-    }
-
-    /**
-     *
-     *
-     * @param $request
-     */
-    private function getPostValues($request)
-    {
-        $postValues = $request::$post;
-        $postValues['documentType'] = $this->documentType;
-        $postValues['path'] = $this->responseFolder;
-        $postValues['title'] = date('r') . ' - From: ' . $request::$requestUri;
-        return $postValues;
-    }
-
-    /**
-     * Temporarily stores the current user session in a backup variable
-     * and sets a fake user instead
-     */
-    private function setUserSessionBackup()
-    {
-        $this->userSessionBackup = isset($_SESSION['cloudcontrol']) ? $_SESSION['cloudcontrol'] : null;
-        $fakeUser = new \stdClass();
-        $fakeUser->username = 'FormComponent';
-        $_SESSION['cloudcontrol'] = $fakeUser;
-    }
-
-    /**
-     * Removes the fake user and restores the existing user
-     * session if it was there
-     */
-    private function restoreUserSessionBackup()
-    {
-        if ($this->userSessionBackup === null) {
-            unset($_SESSION['cloudcontrol']);
-        } else {
-            $_SESSION['cloudcontrol'] = $this->userSessionBackup;
-        }
-    }
-
-    private function setSubmitToSession()
-    {
-        $_SESSION['FormComponent'][$this->formParameterName]['submitted'] = true;
-    }
-
-    private function isSubmitAllowed()
-    {
-        if ($this->submitOncePerSession === true && $_SESSION['FormComponent'][$this->formParameterName]['submitted'] === true) {
-            return false;
-        } else {
-            return true;
-        }
-    }
+	/**
+	 * @var null|string
+	 */
+	protected $documentType = null;
+	/**
+	 * @var null|string
+	 */
+	protected $responseFolder = null;
+	/**
+	 * @var string
+	 */
+	protected $subTemplate = 'cms/documents/document-form-form';
+	/**
+	 * @var string
+	 */
+	protected $formParameterName = 'form';
+	/**
+	 * @var string
+	 */
+	protected $thankYouMessage = 'Thank you for sending us your response.';
+
+	/**
+	 * @var bool
+	 */
+	protected $submitOncePerSession = false;
+
+	/**
+	 * @var string
+	 */
+	private $formId;
+	/**
+	 * @var null|string
+	 */
+	private $getPathBackup = null;
+
+	/**
+	 * @var null|\stdClass
+	 */
+	private $userSessionBackup = null;
+
+	/**
+	 * @param Storage $storage
+	 * @return void
+	 * @throws \Exception
+	 */
+	public function run(Storage $storage)
+	{
+		parent::run($storage);
+
+		$this->checkParameters();
+
+		if ($this->documentType === null || $this->responseFolder === null) {
+			throw new \Exception('Parameters `documentType` and `responseFolder` are required for usage with this form');
+		}
+
+		$this->setFormId();
+		$this->initialize($storage);
+		$this->checkSubmit($storage);
+	}
+
+	/**
+	 * @param null|Application $application
+	 * @throws \Exception
+	 */
+	public function render($application = null)
+	{
+		$request = $this->request;
+		if (isset($request::$get['path'])) {
+			$this->getPathBackup = $request::$get['path'];
+		}
+		$request::$get['path'] = $this->responseFolder;
+		$form = $this->renderTemplate($this->subTemplate);
+		if ($this->getPathBackup !== null) {
+			$request::$get['path'] = $this->getPathBackup;
+		} else {
+			unset($request::$get['path']);
+		}
+		if ($this->isFormSubmitted($this->request) || $this->isSubmitAllowed() === false) {
+			$this->parameters[$this->formParameterName] = '<a name="' . $this->formId . '"></a>' . $this->thankYouMessage;
+		} else {
+			$this->parameters[$this->formParameterName] = $form;
+		}
+
+		parent::render($application);
+	}
+
+	/**
+	 * Checks if parameters were given in the CMS configuration and
+	 * sets them to their respective fields
+	 */
+	private function checkParameters()
+	{
+		if (isset($this->parameters['documentType'])) {
+			$this->documentType = $this->parameters['documentType'];
+			unset($this->parameters['documentType']);
+		}
+
+		if (isset($this->parameters['responseFolder'])) {
+			$this->responseFolder = $this->parameters['responseFolder'];
+			unset($this->parameters['responseFolder']);
+		}
+
+		if (isset($this->parameters['subTemplate'])) {
+			$this->subTemplate = $this->parameters['subTemplate'];
+			unset($this->parameters['subTemplate']);
+		}
+
+		if (isset($this->parameters['formParameterName'])) {
+			$this->formParameterName = $this->parameters['formParameterName'];
+			unset($this->parameters['formParameterName']);
+		}
+
+		if (isset($this->parameters['thankYouMessage'])) {
+			$this->thankYouMessage = $this->parameters['thankYouMessage'];
+			unset($this->parameters['thankYouMessage']);
+		}
+
+		if (isset($this->parameters['submitOncePerSession'])) {
+			$this->submitOncePerSession = $this->parameters['submitOncePerSession'] === 'true' ? true : false;
+			unset($this->parameters['submitOncePerSession']);
+		}
+	}
+
+	/**
+	 * Sets variables needed for rendering the form template
+	 * @param $storage
+	 */
+	private function initialize($storage)
+	{
+		$this->parameters['smallestImage'] = $storage->getSmallestImageSet()->slug;
+		$this->parameters['cmsPrefix'] = '';
+
+		$this->parameters['documentType'] = $this->storage->getDocumentTypeBySlug($this->documentType, true);
+		$this->parameters['documentTypes'] = $this->storage->getDocumentTypes();
+		$this->parameters['hideTitleAndState'] = true;
+		$this->parameters['formId'] = $this->formId;
+	}
+
+	/**
+	 * If the form has been submitted, save the document
+	 * Calls $this->postSubmit() afterwards
+	 *
+	 * @param Storage $storage
+	 */
+	private function checkSubmit($storage)
+	{
+		if ($this->isFormSubmitted($this->request) && $this->isSubmitAllowed()) {
+			$postValues = $this->getPostValues($this->request);
+			$this->setUserSessionBackup();
+			$storage->addDocument($postValues);
+			$this->restoreUserSessionBackup();
+			$this->setSubmitToSession();
+			$this->postSubmit($postValues, $storage);
+		}
+	}
+
+	/**
+	 * Hook for derived classes to take actions after
+	 * submitting the form
+	 *
+	 * @param $postValues
+	 * @param $storage
+	 */
+	protected function postSubmit($postValues, $storage)
+	{}
+
+	/**
+	 * Sets a unique id for this particular form, so it can recognize
+	 * it when a submit occurs
+	 */
+	private function setFormId()
+	{
+		if (isset($_SESSION['FormComponent'][$this->formParameterName]['formId'])) {
+			$this->formId = $_SESSION['FormComponent'][$this->formParameterName]['formId'];
+		} else {
+			$_SESSION['FormComponent'][$this->formParameterName]['formId'] = (string) microtime(true);
+			$_SESSION['FormComponent'][$this->formParameterName]['submitted'] = false;
+			$this->formId = $_SESSION['FormComponent'][$this->formParameterName]['formId'];
+		}
+	}
+
+	/**
+	 * Checks if this form has been submitted
+	 *
+	 * @param $request
+	 * @return bool
+	 */
+	private function isFormSubmitted($request)
+	{
+		return !empty($request::$post) && isset($request::$post['formId']) && $request::$post['formId'] === $this->formId && isset($_SESSION['FormComponent'][$this->formParameterName]['formId']) && $_SESSION['FormComponent'][$this->formParameterName]['formId'] === $this->formId;
+	}
+
+	/**
+	 *
+	 *
+	 * @param $request
+	 */
+	private function getPostValues($request)
+	{
+		$postValues = $request::$post;
+		$postValues['documentType'] = $this->documentType;
+		$postValues['path'] = $this->responseFolder;
+		$postValues['title'] = date('r') . ' - From: ' . $request::$requestUri;
+		return $postValues;
+	}
+
+	/**
+	 * Temporarily stores the current user session in a backup variable
+	 * and sets a fake user instead
+	 */
+	private function setUserSessionBackup()
+	{
+		$this->userSessionBackup = isset($_SESSION['cloudcontrol']) ? $_SESSION['cloudcontrol'] : null;
+		$fakeUser = new \stdClass();
+		$fakeUser->username = 'FormComponent';
+		$_SESSION['cloudcontrol'] = $fakeUser;
+	}
+
+	/**
+	 * Removes the fake user and restores the existing user
+	 * session if it was there
+	 */
+	private function restoreUserSessionBackup()
+	{
+		if ($this->userSessionBackup === null) {
+			unset($_SESSION['cloudcontrol']);
+		} else {
+			$_SESSION['cloudcontrol'] = $this->userSessionBackup;
+		}
+	}
+
+	private function setSubmitToSession()
+	{
+		$_SESSION['FormComponent'][$this->formParameterName]['submitted'] = true;
+	}
+
+	private function isSubmitAllowed()
+	{
+		if ($this->submitOncePerSession === true && $_SESSION['FormComponent'][$this->formParameterName]['submitted'] === true) {
+			return false;
+		} else {
+			return true;
+		}
+	}
 }
\ No newline at end of file

cloudcontrol/library/cc/cc.php

Doc Comments +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
  * @param array  $replace
  * @param string $delimiter
  *
- * @return mixed|string
+ * @return string
  */
 function slugify($str, $replace=array(), $delimiter='-') {
 	if( !empty($replace) ) {