luyadev / luya

core/base/Boot.php

Doc Comments +2 added lines, -2 removed lines

@@ -100,7 +100,7 @@ 
     /**
      * Run the application based on the Sapi Name.
      *
-     * @return luya\web\Application|luya\cli\Application Application objected based on the sapi name.
+     * @return null|integer Application objected based on the sapi name.
      */
     public function run()
     {
@@ -133,7 +133,7 @@ 
     /**
      * Run Web-Application based on the provided config file.
      * 
-     * @return string|void Returns the Yii Application run() method if mock is disabled. Otherwise returns void
+     * @return integer|null Returns the Yii Application run() method if mock is disabled. Otherwise returns void
      */
     public function applicationWeb()
     {

core/base/Module.php

Doc Comments +1 added lines, -1 removed lines

@@ -196,7 +196,7 @@
     /**
      * The import method will be called from exec/import command.
      *
-     * @return void|string
+     * @return boolean
      */
     public function import(\luya\console\interfaces\ImportController $exec)
     {

core/console/commands/BlockController.php

Doc Comments +16 added lines, -2 removed lines

@@ -56,6 +56,11 @@ 
         ];
     }
     
+    /**
+     * @param string $type
+     * @param string $varName
+     * @param string $func
+     */
     private function getExtraVarDef($type, $varName, $func)
     {
         $info = [
@@ -72,6 +77,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $type
+     */
     private function getVariableTypeOption($type)
     {
         $types = $this->getVariableTypesOptions();
@@ -79,6 +87,9 @@ 
         return $types[$type];
     }
 
+    /**
+     * @param string $type
+     */
     private function hasVariableTypeOption($type)
     {
         return array_key_exists($type, $this->getVariableTypesOptions());
@@ -292,6 +303,9 @@ 
         return $this->outputError("Error while creating file '$file'");
     }
 
+    /**
+     * @param string $prefix
+     */
     private function placeholderCreator($prefix)
     {
         $this->output(PHP_EOL.'-> Create new '.$prefix, Console::FG_YELLOW);
@@ -310,8 +324,8 @@ 
 
     /**
      * 
-     * @param unknown $prefix
-     * @param string $type 'var', 'cfg'
+     * @param string $prefix
+     * @param string $typeCast
      * @return multitype:string Ambigous <string, array>
      */
     private function varCreator($prefix, $typeCast)

Spacing +7 added lines, -7 removed lines

@@ -59,10 +59,10 @@ 
     private function getExtraVarDef($type, $varName, $func)
     {
         $info = [
-            'image-upload' => function ($varName) use ($func) { return '$this->zaaImageUpload($this->'.$func.'(\''.$varName.'\')),'; },
-            'image-array-upload' => function ($varName) use ($func) { return '$this->zaaImageArrayUpload($this->'.$func.'(\''.$varName.'\')),'; },
-            'file-upload' => function ($varName) use ($func) { return '$this->zaaFileUpload($this->'.$func.'(\''.$varName.'\')),'; },
-            'file-array-upload' => function ($varName) use ($func) { return '$this->zaaFileArrayUpload($this->'.$func.'(\''.$varName.'\')),'; },
+            'image-upload' => function($varName) use ($func) { return '$this->zaaImageUpload($this->'.$func.'(\''.$varName.'\')),'; },
+            'image-array-upload' => function($varName) use ($func) { return '$this->zaaImageArrayUpload($this->'.$func.'(\''.$varName.'\')),'; },
+            'file-upload' => function($varName) use ($func) { return '$this->zaaFileUpload($this->'.$func.'(\''.$varName.'\')),'; },
+            'file-array-upload' => function($varName) use ($func) { return '$this->zaaFileArrayUpload($this->'.$func.'(\''.$varName.'\')),'; },
         ];
         
         if (array_key_exists($type, $info)) {
@@ -174,15 +174,15 @@ 
         $content .= '     * @var bool Choose whether block is a layout/container/segmnet/section block or not, Container elements will be optically displayed'.PHP_EOL;
         $content .= '     * in a different way for a better user experience. Container block will not display isDirty colorizing.'.PHP_EOL;
         $content .= '     */'.PHP_EOL;
-        $content .= '    public $isContainer = false;'.PHP_EOL . PHP_EOL;
+        $content .= '    public $isContainer = false;'.PHP_EOL.PHP_EOL;
         $content .= '    /**'.PHP_EOL;
         $content .= '     * @var bool Choose whether a block can be cached trough the caching component. Be carefull with caching container blocks.'.PHP_EOL;
         $content .= '     */'.PHP_EOL;
-        $content .= '    public $cacheEnabled = false;'.PHP_EOL . PHP_EOL;
+        $content .= '    public $cacheEnabled = false;'.PHP_EOL.PHP_EOL;
         $content .= '    /**'.PHP_EOL;
         $content .= '     * @var int The cache lifetime for this block in seconds (3600 = 1 hour), only affects when cacheEnabled is true'.PHP_EOL;
         $content .= '     */'.PHP_EOL;
-        $content .= '    public $cacheExpiration = 3600;'.PHP_EOL . PHP_EOL;
+        $content .= '    public $cacheExpiration = 3600;'.PHP_EOL.PHP_EOL;
         
         // method name
         $content .= '    public function name()'.PHP_EOL;

core/console/commands/HealthController.php

Doc Comments +1 added lines, -1 removed lines

@@ -79,7 +79,7 @@
     /**
      * Use --verbose=1 to enable smtp debug output
      * 
-     * @return bool|null
+     * @return integer|null
      * @throws Exception On smtp failure
      */
     public function actionMailer()

Spacing +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
         
         @chdir(Yii::getAlias('@app'));
 
-        $this->output('The directory the health commands is applying to: ' . Yii::getAlias('@app'));
+        $this->output('The directory the health commands is applying to: '.Yii::getAlias('@app'));
         
         foreach ($this->folders as $folder => $writable) {
             if (!file_exists($folder)) {

core/console/commands/MigrateController.php

Doc Comments +5 added lines

@@ -42,6 +42,11 @@
         }
     }
 
+    /**
+     * @param string|boolean $module
+     *
+     * @return string
+     */
     private function getModuleMigrationDirectorie($module)
     {
         if (!array_key_exists($module, $this->moduleMigrationDirectories)) {

Spacing +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
 
     protected function createMigration($class)
     {
-        $orig = $this->migrationPath . DIRECTORY_SEPARATOR . $class . '.php';
+        $orig = $this->migrationPath.DIRECTORY_SEPARATOR.$class.'.php';
         
         if (file_exists($orig)) {
             require_once $file;
@@ -71,7 +71,7 @@ 
         
         $module = $this->prompt("Could not find migration class. Please enter the module name who belongs to '$class.':");
         $dir = $this->getModuleMigrationDirectorie($module);
-        $file = $dir . DIRECTORY_SEPARATOR . $class . '.php';
+        $file = $dir.DIRECTORY_SEPARATOR.$class.'.php';
         if (file_exists($file)) {
             require_once $file;
             return new $class();

core/console/commands/SetupController.php

Doc Comments +3 added lines, -2 removed lines

@@ -9,6 +9,9 @@ 
 
 class SetupController extends \luya\console\Command
 {
+    /**
+     * @param string $table
+     */
     private function insert($table, $fields)
     {
         return Yii::$app->db->createCommand()->insert($table, $fields)->execute();
@@ -84,8 +87,6 @@ 
      * @todo use options instead, override options()
      * @todo see if admin is availoable
      *
-     * @param string $email
-     * @param string $password
      */
     public function actionIndex()
     {

core/helpers/Url.php

Doc Comments +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
      *
      * @param string $route
      * @param array  $params
-     * @param boolean $sheme Whether to return static url or not
+     * @param boolean $scheme Whether to return static url or not
      * @todo we have to remove this method as it provides no additinal functions to the yii\helpers\url to method
      */
     public static function toManager($route, array $params = [], $scheme = false)

core/web/Composition.php

Doc Comments +1 added lines, -1 removed lines

@@ -234,7 +234,7 @@
     /**
      * Return a path like string with all composition with trailing slash e.g. us/e.
      *
-     * @return void|string
+     * @return string
      */
     public function getFull()
     {

core/web/UrlManager.php

Spacing +3 added lines, -3 removed lines

@@ -48,7 +48,7 @@ 
         if ($route === $composition) {
             $parsedRequest[0] = false;
         // now see if the composition (+1 as we add add trailing slash at the end) matches the cutted route request part, if so its composition prefix, remove it.
-        } elseif (substr($route, 0, $length+1) == $composition.'/') {
+        } elseif (substr($route, 0, $length + 1) == $composition.'/') {
             $parsedRequest[0] = substr($parsedRequest[0], $length);
         }
         // fix broken request urls
@@ -211,10 +211,10 @@ 
         $params = (array) $params;
         $url = $this->internalCreateUrl($params);
         if (strpos($url, '://') === false) {
-            $url = $this->getHostInfo() . $url;
+            $url = $this->getHostInfo().$url;
         }
         if (is_string($scheme) && ($pos = strpos($url, '://')) !== false) {
-            $url = $scheme . substr($url, $pos);
+            $url = $scheme.substr($url, $pos);
         }
         return $url;
     }

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use Goutte\Client;
 use yii\base\InvalidConfigException;
 use yii\base\yii\base;
-use luya\helpers\Url;
 
 class CrawlPage extends \yii\base\Object
 {

Doc Comments +17 added lines

@@ -28,6 +28,9 @@ 
 
     private $_composition = null;
 
+    /**
+     * @param Request $request
+     */
     public function parseRequest($request)
     {
         // extra data from request to composition, which changes the pathInfo of the Request-Object.
@@ -91,6 +94,9 @@ 
         return $this->_menu;
     }
 
+    /**
+     * @return Composition
+     */
     public function getComposition()
     {
         if ($this->_composition === null) {
@@ -105,6 +111,9 @@ 
         return rtrim($this->baseUrl, '/').'/'.ltrim($route, '/');
     }
 
+    /**
+     * @return string
+     */
     public function removeBaseUrl($route)
     {
         return preg_replace('#'.preg_quote($this->baseUrl).'#', '', $route, 1);
@@ -133,6 +142,11 @@ 
         return $this->urlReplaceModule($url, $navItemId, $composition);
     }
 
+    /**
+     * @param string $route
+     *
+     * @return string
+     */
     private function findModuleInRoute($route)
     {
         $parts = array_values(array_filter(explode('/', $route)));
@@ -146,6 +160,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $url
+     */
     private function urlReplaceModule($url, $navItemId, \luya\web\Composition $composition)
     {
         $route = $this->removeBaseUrl($url);