solcre / columnis-express

module/Columnis/src/Columnis/Controller/PageController.php

Doc Comments +10 added lines

@@ -37,6 +37,9 @@ 
         $this->getResponse()->setStatusCode(404);
     }
 
+    /**
+     * @param integer $pageId
+     */
     protected function fetchPage($pageId, Array $params = null, $withBreakpoints = false) {
         $page = new Page();
         $page->setId($pageId);
@@ -94,6 +97,10 @@ 
         }
         return $ret;
     }
+
+    /**
+     * @return string
+     */
     private function getPublicPath() {
         $ret = array();
         $config = $this->getServiceLocator()->get('Config');
@@ -121,6 +128,9 @@ 
         return array();
     }
 
+    /**
+     * @param string $extension
+     */
     private function searchAssets($path, $extension, Array $excludes = null) {
         $assets = array();
         $assetPath = realpath($path.DIRECTORY_SEPARATOR.'fixed');

module/Columnis/src/Columnis/Model/TemplateAssetsResolver.php

Doc Comments +1 added lines, -1 removed lines

@@ -239,7 +239,7 @@
      * Returns the template name if the requested asset belongs to a template
      *
      * @param string $alias
-     * @return boolean|array
+     * @return string|false
      */
     public function matchTemplateName($alias)
     {

module/Columnis/src/Columnis/Service/PageBreakpointService.php

Doc Comments +1 added lines, -1 removed lines

@@ -154,7 +154,7 @@
      * 
      * @param int $idPage
      * @param PageBreakpoint $pageBreakpoint
-     * @return boolean
+     * @return string|false
      */
     protected function getCurrentBreakpointFilename($idPage, PageBreakpoint $pageBreakpoint) {
         $breakpointFiles = glob($pageBreakpoint->getFullPath().$idPage."-*.css");

module/ExpressApi/src/ExpressApi/Apis/xmlapi.php

Doc Comments +14 added lines, -5 removed lines

@@ -251,7 +251,7 @@ 
      * the queries made, the response XML/JSON and other such pertinent information.
      * Calling this function without any parameters will enable debug mode.
      *
-     * @param bool $debug turn on or off debug mode
+     * @param integer $debug turn on or off debug mode
      * @see get_debug()
      */
     public function set_debug($debug = 1) {
@@ -284,7 +284,7 @@ 
      * Get the port to connect to
      *
      * This will return which port the class is connecting to
-     * @return int $port
+     * @return string $port
      * @see set_port()
      */
     public function get_port() {
@@ -680,6 +680,11 @@ 
         return $response;
     }
 
+    /**
+     * @param string $url
+     * @param string $postdata
+     * @param string $authstr
+     */
     private function curl_query($url, $postdata, $authstr) {
         $curl = curl_init();
         curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
@@ -709,6 +714,11 @@ 
         return $result;
     }
 
+    /**
+     * @param string $url
+     * @param string $postdata
+     * @param string $authstr
+     */
     private function fopen_query($url, $postdata, $authstr) {
         if (!(ini_get('allow_url_fopen') )) {
             throw new Exception('fopen_query called on system without allow_url_fopen enabled in php.ini');
@@ -765,7 +775,7 @@ 
      * @param string $module The module of the API1 call to use
      * @param string $function The function of the API1 call
      * @param array $args The arguments for the API1 function, this should be a non-associative array
-     * @return mixed
+     * @return string
      * @link http://docs.cpanel.net/twiki/bin/view/AllDocumentation/AutomationIntegration/CallingAPIFunctions XML API Call documentation
      * @link http://docs.cpanel.net/twiki/bin/view/DeveloperResources/ApiRef/WebHome API1 & API2 Call documentation
      * @link http://docs.cpanel.net/twiki/bin/view/DeveloperResources/ApiBasics/CallingApiOne API1 Documentation
@@ -883,7 +893,7 @@ 
      * documentation are allowed parameters for this call.
      * 
      * @param array $acctconf
-     * @return mixed
+     * @return string
      * @link http://docs.cpanel.net/twiki/bin/view/AllDocumentation/AutomationIntegration/CreateAccount XML API Call documentation
      */
     public function createacct($acctconf) {
@@ -1878,7 +1888,6 @@ 
      * @param string $nameserver1 The IP of the first nameserver to use
      * @param string $nameserver2 The IP of the second namesever to use
      * @param string $nameserver3 The IP of the third nameserver to use
-     * @param string $nameserver4 The IP of the forth nameserver to use
      * @return mixed
      * @link http://docs.cpanel.net/twiki/bin/view/AllDocumentation/AutomationIntegration/SetResolvers XML API Call documentation
      */

module/ExpressApi/src/ExpressApi/V1/Rpc/ClearCache/ClearCacheController.php

Doc Comments +9 added lines

@@ -53,15 +53,24 @@
         return true;
     }
 
+    /**
+     * @param string $path
+     */
     private function canDeleteCacheFolder($path, $nodeCache) {
         return (is_dir($path.'/'.$nodeCache) && $nodeCache !== '.' && $nodeCache !== '..');
     }
 
+    /**
+     * @param string $path
+     */
     private function canDeleteCacheFile($path, $nodeCache) {
         $ext = pathinfo($nodeCache, PATHINFO_EXTENSION);
         return ($ext === 'php');
     }
 
+    /**
+     * @param string $dir
+     */
     public static function delTree($dir) {
         $files = array_diff(scandir($dir), array('.', '..'));
         foreach($files as $file) {

module/ExpressApi/src/ExpressApi/V1/Rpc/FinishSetup/FinishSetupController.php

Doc Comments +3 added lines

@@ -45,6 +45,9 @@
         return __DIR__.'/../../../../../../../config/autoload/';
     }
 
+    /**
+     * @param string $key
+     */
     private function getParam(Array $params, $key) {
         if(array_key_exists($key, $params)) {
             return $params[$key];

module/ExpressApi/src/ExpressApi/V1/Rpc/FinishSetup/GenerateConfig.php

Doc Comments +3 added lines

@@ -8,6 +8,9 @@
     private $sourceFile;
     private $replaces;
 
+    /**
+     * @param string $destinationFile
+     */
     function __construct($destinationFile, $replaces, $sourceFile = null) {
         $this->destinationFile = $destinationFile;
         $this->replaces = $replaces;

module/ExpressApi/src/ExpressApi/V1/Rpc/Statistics/SystemStatus.php

Doc Comments +5 added lines, -2 removed lines

@@ -22,8 +22,8 @@ 
 

     /**

      * Retorna si esta correctamente configurado el htaccess para que levante el php.ini correspondiente.

-     * @param type $file Ruta hacia el .htaccess

-     * @return type

+     * @param string $file Ruta hacia el .htaccess

+     * @return boolean

      */

     public static function right_env($file) {

         $retorno = true;

@@ -54,6 +54,9 @@ 
         return min(self::let_to_num(ini_get('post_max_size')), self::let_to_num(ini_get('upload_max_filesize')));

     }

 

+    /**
+     * @param string $v
+     */
     public static function let_to_num($v) {

         $l = substr($v, -1);

         $ret = substr($v, 0, -1);