Merge af9d950 into ae9d95f

dist/twist/Classes/Autoload.class.php

@@ -35,7 +35,7 @@ class Autoload{
 
 	/**
 	 * Initialise the AutoLoader and register the class as an AutoLoader
-	 * @param $strBaseDir Base directory of the framework
+	 * @param string $strBaseDir Base directory of the framework
 	 */
 	public static function init($strBaseDir){
 		self::$strBaseDir = $strBaseDir;
@@ -44,7 +44,7 @@ public static function init($strBaseDir){
 
 	/**
 	 * Handler for each individual request, the path for the required file will be worked out here
-	 * @param $strRequest The full class and namespace of the file to be loaded
+	 * @param string $strRequest The full class and namespace of the file to be loaded
 	 * @throws \Exception
 	 */
 	public static function load($strRequest){

dist/twist/Classes/Error.class.php

@@ -38,10 +38,10 @@ function __construct(){
 
 		/**
 		 * Get an array of the Apache request headers.
-		 * @todo Needs to be re-written/optimised
+		 *
 		 * @return array
 		 */
-		public static function apacheRequestHeaders(){
+		public static function apacheRequestHeaders(){ //TODO: Needs to be re-written/optimised
 
             $arrOut = array();
             $regxHTTP = '/\AHTTP_/';
@@ -242,10 +242,10 @@ protected static function debugDataOutput($arrData){
 
 		/**
 		 * PHP Error handler to capture all PHP errors so that they can be logged to a file or output into the debug window later.
-		 * @param $intErrorNo
-		 * @param $strError
-		 * @param $strErrorFile
-		 * @param $intErrorLine
+		 * @param integer $intErrorNo
+		 * @param string $strError
+		 * @param string $strErrorFile
+		 * @param integer $intErrorLine
 		 */
 		public static function handleError($intErrorNo, $strError, $strErrorFile, $intErrorLine){
 
@@ -727,7 +727,7 @@ public static function outputLog(){
 
 		/**
 		 * Detect the error type as a string based on an error number.
-		 * @param $intErrorNo
+		 * @param integer $intErrorNo
 		 * @return string
 		 */
 		public static function getType($intErrorNo){

dist/twist/Classes/Instance.class.php

@@ -61,7 +61,7 @@ public static function retrieveObject($strObjectKey){
 
 		/**
 		 * Removes the object from the instance holder and destroys the object.
-		 * @param $strObjectKey
+		 * @param string $strObjectKey
 		 */
 		public static function removeObject($strObjectKey){
 			unset(self::$arrFrameworkObjects[$strObjectKey]);

dist/twist/Classes/Shutdown.class.php

@@ -102,7 +102,7 @@ public static function callEvents(){
 
 		/**
 		 * Remove a registered even from the event list
-		 * @param $strEventKey
+		 * @param string $strEventKey
 		 */
 		public static function cancelEvent($strEventKey){
 			unset(self::$arrCallbackEvents[$strEventKey]);

dist/twist/Core/Controllers/Base.controller.php

@@ -46,7 +46,7 @@ class Base{
          * A function that is called by Routes both to ensure that the controller has been extended and so that we can pass in resources and information required by the controller.
          *
          * @param \Twist\Core\Utilities\Route $resRoute
-         * @param $arrRouteData
+         * @param array $arrRouteData
          * @return bool
          */
 		final public function _extended($resRoute,$arrRouteData){
@@ -102,6 +102,7 @@ public function _fallback(){
         /**
          * Over-ride the base view for the current page only.
          *
+         * @param null $mxdBaseView
          * @return null|string
          */
 		public function _baseView($mxdBaseView = null){
@@ -181,7 +182,7 @@ public function _getReplacements(){
 		/**
 		 * Function to call any controller response with the correct method prefix if any has been setup. If the response function is not found a 404 page will be output.
 		 *
-		 * @param $strCallFunctionName Name of the function to be called
+		 * @param string $strCallFunctionName Name of the function to be called
 		 * @return bool
 		 */
         final protected function _callFunction($strCallFunctionName){
@@ -224,7 +225,7 @@ public function _upload($strFileKey,$strType = 'file'){
 			$arrOut = array();
 
 			if(count($_FILES) && array_key_exists($strFileKey,$_FILES)){
-				$resUpload = new \Twist\Core\Controllers\Upload();
+				$resUpload = new Upload();
 
 				if(is_array($_FILES[$strFileKey]['name'])){
 					foreach($_FILES[$strFileKey]['name'] as $intKey => $mxdValue){
@@ -265,7 +266,7 @@ final public function _error($intError){
 		 * @return bool
 		 */
 		final public function _response($intError,$strCustomDescription = null){
-			Error::errorPage($intError,$strCustomDescription);
+			Error::response($intError,$strCustomDescription);
 			return false;
 		}
 
@@ -344,7 +345,7 @@ protected function _var($strVarKey = null){
 
 		/**
 		 * Process a view template file and return the output.
-		 * @param $dirView
+		 * @param string $dirView
 		 * @param null $arrViewTags
 		 * @param bool $blRemoveUnusedTags
 		 * @return string
@@ -355,6 +356,10 @@ protected function _view($dirView,$arrViewTags = null,$blRemoveUnusedTags = fals
 
 		/**
 		 * @alias _view
+		 * @param string $dirView
+		 * @param null $arrViewTags
+		 * @param bool $blRemoveUnusedTags
+		 * @return string
 		 */
         protected function _render($dirView,$arrViewTags = null,$blRemoveUnusedTags = false){
 			return $this->_view($dirView,$arrViewTags,$blRemoveUnusedTags);

dist/twist/Core/Controllers/BaseAJAX.controller.php

@@ -40,7 +40,7 @@ public function _baseCalls(){
 	/**
 	 * Set the status for the Ajax response, true by default
 	 *
-	 * @param $blStatus
+	 * @param bool $blStatus
 	 */
 	public function _ajaxStatus($blStatus){
 		$this->blAjaxResponse = ($blStatus !== false);
@@ -62,7 +62,7 @@ public function _ajaxFail(){
 
 	/**
 	 * Set a message to be returned to the Ajax call, can be used for an error message
-	 * @param $strMessage
+	 * @param string $strMessage
 	 */
 	public function _ajaxMessage($strMessage=''){
 		$this->strAjaxResponseMessage = $strMessage;
@@ -71,6 +71,7 @@ public function _ajaxMessage($strMessage=''){
 	/**
 	 * Encode the response of the AJAX output
 	 * @param array $mxdData
+	 * @param bool  $blDebug
 	 * @return string
 	 */
 	public function _ajaxRespond($mxdData=array(), $blDebug = false){

dist/twist/Core/Controllers/InstallWizard.controller.php

@@ -314,7 +314,6 @@ public function user(){
 	/**
 	 * Pre-install some packages and setup some systems like the manager
 	 * Currently skips this step in initial release of V3
-	 * @return string
 	 */
 	public function package(){
 
@@ -354,7 +353,7 @@ public function package(){
 		}
 
 		if($arrSession['user']['status']){
-			//@todo Skip the interfaces step for the time being, it will become packages when ready
+			//TODO: Skip the interfaces step for the time being, it will become packages when ready
 			header('Location: finish');
 		}else{
 			header('Location: user');

dist/twist/Core/Controllers/Manager.controller.php

@@ -135,7 +135,7 @@ public function cache(){
 
 	/**
 	 * Run through all the cache files and build up a list of what has been cached
-	 * @param $strCacheFolder
+	 * @param string $strCacheFolder
 	 */
 	protected function parseCache($strCacheFolder){
 

dist/twist/Core/Controllers/Placeholder.controller.php

@@ -57,8 +57,8 @@ public function _index(){
 		$intPadding = 10;
 		$intThickness = 5;
 
-		$intStartX = $intPadding;
-		$intStartY = $intPadding;
+		//$intStartX = $intPadding;
+		//$intStartY = $intPadding;
 		$intEndX = $intWidth - $intPadding;
 		$intEndY = $intHeight - $intPadding;
 

dist/twist/Core/Controllers/Upload.controller.php

@@ -131,7 +131,7 @@ public function asset($strFileKey = null,$intIndex = null){
 	protected function storeFile($strFileKey = null,$intIndex = null){
 
 		if(is_array($_FILES) && count($_FILES)){
-			$arrOut = \Twist::File()->upload($strFileKey,null,$intIndex);
+			$arrOut = \Twist::File()->upload($strFileKey,null,$intIndex); //TODO: Is $intIndex used?
 		}else{
 			$arrOut = \Twist::File()->uploadPUT();
 		}

dist/twist/Core/Models/Archive/Native.model.php

@@ -30,7 +30,7 @@ class Native{
 
 		/**
 		 * Create an archive resource ready to accept files and folders
-		 * @param $strZipArchive
+		 * @param string $strZipArchive
 		 * @return boolean
 		 */
 		public function create($strZipArchive){
@@ -41,7 +41,7 @@ public function create($strZipArchive){
 
 		/**
 		 * Load in an existing archive and store it as a resource ready to be manipulated/extracted.
-		 * @param $strZipArchive
+		 * @param string $strZipArchive
 		 * @return boolean
 		 */
 		public function load($strZipArchive){
@@ -52,40 +52,40 @@ public function load($strZipArchive){
 
 		/**
 		 * Add a file to the archive resource
-		 * @param $strLocalFile
-		 * @param $strZipPath
+		 * @param string $strLocalFile
+		 * @param string $strZipPath
 		 */
 		public function addFile($strLocalFile,$strZipPath){
 			$this->resZip->addFile($strLocalFile,$strZipPath);
 		}
 
 		/**
 		 * Extract the files from the archive resource
-		 * @param $strExtractPath
+		 * @param string $strExtractPath
 		 */
 		public function extract($strExtractPath){
 			$this->resZip->extractTo($strExtractPath);
 		}
 
 		/**
 		 * Add an empty folder to the archive resource
-		 * @param $strDirectoryPath
+		 * @param string $strDirectoryPath
 		 */
 		public function addEmptyDir($strDirectoryPath){
 			$this->resZip->addEmptyDir($strDirectoryPath);
 		}
 
 		/**
 		 * Set a comment in the archive comment field, the comment can be seen when extracting the archive on commandline or using certain GUI tools.
-		 * @param $strComment
+		 * @param string $strComment
 		 */
 		public function setArchiveComment($strComment){
 			$this->resZip->setArchiveComment($strComment);
 		}
 
 		/**
 		 * Delete a file or folder form the archive by its path.
-		 * @param $strDirectoryPath
+		 * @param string $strDirectoryPath
 		 */
 		public function deleteName($strDirectoryPath){
 			$this->resZip->deleteName($strDirectoryPath);

dist/twist/Core/Models/Archive/PclZip.model.php

@@ -37,7 +37,7 @@ public function __construct(){
 
 		/**
 		 * Create an archive resource using the PclZip Third party package ready to accept files and folders
-		 * @param $strZipArchive
+		 * @param string $strZipArchive
 		 * @return mixed
 		 */
 		public function create($strZipArchive){
@@ -46,7 +46,7 @@ public function create($strZipArchive){
 
 		/**
 		 * Load in an existing archive using the PclZip Third party package and store it as a resource ready to be manipulated/extracted.
-		 * @param $strZipArchive
+		 * @param string $strZipArchive
 		 * @return boolean
 		 */
 		public function load($strZipArchive){
@@ -55,8 +55,8 @@ public function load($strZipArchive){
 
 		/**
 		 * Add a file to the archive resource using the PclZip Third party package.
-		 * @param $strLocalFile
-		 * @param $strZipPath
+		 * @param string $strLocalFile
+		 * @param string $strZipPath
 		 */
 		public function addFile($strLocalFile,$strZipPath){
 
@@ -68,31 +68,31 @@ public function addFile($strLocalFile,$strZipPath){
 
 		/**
 		 * Extract the files from the archive resource using the PclZip Third party package.
-		 * @param $strExtractPath
+		 * @param string $strExtractPath
 		 */
 		public function extract($strExtractPath){
 			return ($this->resZip->extract(PCLZIP_OPT_PATH, $strExtractPath) == 0) ? false : true;
 		}
 
 		/**
 		 * Add an empty folder to the archive resource using the PclZip Third party package.
-		 * @param $strDirectoryPath
+		 * @param string $strDirectoryPath
 		 */
 		public function addEmptyDir($strDirectoryPath){
 			$this->resZip->addEmptyDir($strDirectoryPath);
 		}
 
 		/**
 		 * Set a comment in the archive comment field using the PclZip Third party package, the comment can be seen when extracting the archive on commandline or using certain GUI tools.
-		 * @param $strComment
+		 * @param string $strComment
 		 */
 		public function setArchiveComment($strComment){
 			$this->resZip->setArchiveComment($strComment);
 		}
 
 		/**
 		 * Delete a file or folder form the archive by its path using the PclZip Third party package.
-		 * @param $strDirectoryPath
+		 * @param string $strDirectoryPath
 		 */
 		public function deleteName($strDirectoryPath){
 			$this->resZip->deleteName($strDirectoryPath);