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)

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()

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)) {

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

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);