luyadev / luya

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/helpers/StringHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
      * @param string $search Search string to look for.
      * @param string $replace Replacement value for the first found occurrence.
      * @param string $subject The string you want to look up to replace the first element.
-     * @return mixed Replaced string
+     * @return string Replaced string
      * @since 1.0.0-rc1
      */
     public static function replaceFirst($search, $replace, $subject)

core/console/commands/CrudController.php

Doc Comments +1 added lines, -1 removed lines

@@ -45,7 +45,7 @@
     /**
      * Get the $moduleName without admin suffix (if any).
      *
-     * @return mixed Return the module name without admin suffix.
+     * @return string Return the module name without admin suffix.
      */
     public function getModuleNameWithoutAdminSuffix()
     {

Indentation +7 added lines, -7 removed lines

@@ -170,13 +170,13 @@ 
      */
     public function generateApiContent($fileNamespace, $className, $modelClass)
     {
-    	$alias = Inflector::humanize(Inflector::camel2words($className));
+        $alias = Inflector::humanize(Inflector::camel2words($className));
         return $this->view->render('@luya/console/commands/views/crud/create_api.php', [
             'namespace' => $fileNamespace,
             'className' => $className,
             'modelClass' =>  $modelClass,
             'luyaVersion' => $this->getGeneratorText('crud/create'),
-        	'alias' => $alias,
+            'alias' => $alias,
         ]);
     }
     
@@ -189,13 +189,13 @@ 
      */
     public function generateControllerContent($fileNamespace, $className, $modelClass)
     {
-    	$alias = Inflector::humanize(Inflector::camel2words($className));
+        $alias = Inflector::humanize(Inflector::camel2words($className));
         return $this->view->render('@luya/console/commands/views/crud/create_controller.php', [
             'namespace' => $fileNamespace,
             'className' => $className,
             'modelClass' =>  $modelClass,
             'luyaVersion' => $this->getGeneratorText('crud/create'),
-        	'alias' => $alias,
+            'alias' => $alias,
         ]);
     }
     
@@ -211,7 +211,7 @@ 
      */
     public function generateModelContent($fileNamepsace, $className, $apiEndpoint, TableSchema $schema, $i18nFields)
     {
-    	$alias = Inflector::humanize(Inflector::camel2words($className));
+        $alias = Inflector::humanize(Inflector::camel2words($className));
         $dbTableName = $schema->fullName;
         
         $fields = [];
@@ -259,7 +259,7 @@ 
             'properties' => $properties,
             'ngrestFieldConfig' => $ngrestFieldConfig,
             'i18nFields' => $i18nFields,
-        	'alias' => $alias,
+            'alias' => $alias,
         ]);
     }
 
@@ -366,7 +366,7 @@ 
                 $this->apiEndpoint,
                 $this->getDbTableShema(),
                 $this->enableI18n
-             ),
+                ),
         ];
         
         foreach ($files as $file) {

core/web/Composition.php

Doc Comments +1 added lines, -1 removed lines

@@ -397,7 +397,7 @@
      * 
      * @see ArrayAccess::offsetGet()
      * @param string $offset The key to get from the array.
-     * @return mixed The value for the offset key from the array.
+     * @return string|boolean The value for the offset key from the array.
      */
     public function offsetGet($offset)
     {

core/console/commands/BlockController.php

Doc Comments +14 added lines

@@ -146,6 +146,11 @@ 
         ];
     }
     
+    /**
+     * @param string $type
+     * @param string $varName
+     * @param string $func
+     */
     private function getExtraVarDef($type, $varName, $func)
     {
         $info = [
@@ -173,6 +178,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $type
+     */
     private function getVariableTypeOption($type)
     {
         $types = $this->getVariableTypesOptions();
@@ -180,11 +188,17 @@ 
         return $types[$type];
     }
 
+    /**
+     * @param string $type
+     */
     private function hasVariableTypeOption($type)
     {
         return array_key_exists($type, $this->getVariableTypesOptions());
     }
 
+    /**
+     * @param string $prefix
+     */
     private function placeholderCreator($prefix)
     {
         $this->output(PHP_EOL.'-> Create new '.$prefix, Console::FG_YELLOW);

Indentation +2 added lines, -2 removed lines

@@ -284,7 +284,7 @@ 
         return $this->view->render('@luya/console/commands/views/block/create_block_view.php', [
             'blockClassName' => $blockClassName,
             'phpdoc' => $this->viewFileDoc,
-        	'luyaText' => $this->getGeneratorText('block/create'),
+            'luyaText' => $this->getGeneratorText('block/create'),
         ]);
     }
     
@@ -380,7 +380,7 @@ 
             'config' => $this->config,
             'phpdoc' => $this->phpdoc,
             'extras' => $this->extras,
-        	'luyaText' => $this->getGeneratorText('block/create'),
+            'luyaText' => $this->getGeneratorText('block/create'),
         ]);
 
         if ($this->dryRun) {

core/web/UrlManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
      * @param string $from
      * @param string $to
      * @param string $subject
-     * @return mixed
+     * @return string
      * @since 1.0.0-rc1
      */
     public static function replaceFirst($from, $to, $subject)

core/console/commands/ModuleController.php

Doc Comments +1 added lines

@@ -17,6 +17,7 @@
 	/**
 	 * Humanize the class name
 	 * 
+	 * @param string $name
 	 * @return string The humanized name.
 	 */
 	public function humanizeName($name)

Indentation +61 added lines, -61 removed lines

@@ -14,70 +14,70 @@
  */
 class ModuleController extends \luya\console\Command
 {
-	/**
-	 * Humanize the class name
-	 * 
-	 * @return string The humanized name.
-	 */
-	public function humanizeName($name)
-	{
-		return $name = Inflector::humanize(Inflector::camel2words($name));
-	}
+    /**
+     * Humanize the class name
+     * 
+     * @return string The humanized name.
+     */
+    public function humanizeName($name)
+    {
+        return $name = Inflector::humanize(Inflector::camel2words($name));
+    }
 	
-	/**
-	 * Render the readme template.
-	 * 
-	 * @param string $folders
-	 * @param string $name
-	 * @param string $ns
-	 * @return string
-	 */
-	public function renderReadme($folders, $name, $ns)
-	{
-		return $this->view->render('@luya/console/commands/views/module/readme.php', [
-			'folders' => $folders,
-			'name' => $name,
-			'humanName' => $this->humanizeName($name),
-			'ns' => $ns,
-			'luyaText' => $this->getGeneratorText('module/create'),
-		]);
-	}
+    /**
+     * Render the readme template.
+     * 
+     * @param string $folders
+     * @param string $name
+     * @param string $ns
+     * @return string
+     */
+    public function renderReadme($folders, $name, $ns)
+    {
+        return $this->view->render('@luya/console/commands/views/module/readme.php', [
+            'folders' => $folders,
+            'name' => $name,
+            'humanName' => $this->humanizeName($name),
+            'ns' => $ns,
+            'luyaText' => $this->getGeneratorText('module/create'),
+        ]);
+    }
 	
-	/**
-	 * Render the admin template.
-	 * 
-	 * @param string $folders
-	 * @param string $name
-	 * @param string $ns
-	 * @return string
-	 */
-	public function renderAdmin($folders, $name, $ns)
-	{
-		return $this->view->render('@luya/console/commands/views/module/adminmodule.php', [
-			'folders' => $folders,
-			'name' => $this->humanizeName($name),
-			'ns' => $ns,
-			'luyaText' => $this->getGeneratorText('module/create'),
-		]);
-	}
+    /**
+     * Render the admin template.
+     * 
+     * @param string $folders
+     * @param string $name
+     * @param string $ns
+     * @return string
+     */
+    public function renderAdmin($folders, $name, $ns)
+    {
+        return $this->view->render('@luya/console/commands/views/module/adminmodule.php', [
+            'folders' => $folders,
+            'name' => $this->humanizeName($name),
+            'ns' => $ns,
+            'luyaText' => $this->getGeneratorText('module/create'),
+        ]);
+    }
 	
-	/**
-	 * Render the frontend template.
-	 * 
-	 * @param string $folders
-	 * @param string $name
-	 * @param string $ns
-	 * @return string
-	 */
-	public function renderFrontend($folders, $name, $ns)
-	{
-		return $this->view->render('@luya/console/commands/views/module/frontendmodule.php', [
-			'folders' => $folders,
-			'name' => $this->humanizeName($name),
-			'ns' => $ns,
-			'luyaText' => $this->getGeneratorText('module/create'),
-		]);
-	}
+    /**
+     * Render the frontend template.
+     * 
+     * @param string $folders
+     * @param string $name
+     * @param string $ns
+     * @return string
+     */
+    public function renderFrontend($folders, $name, $ns)
+    {
+        return $this->view->render('@luya/console/commands/views/module/frontendmodule.php', [
+            'folders' => $folders,
+            'name' => $this->humanizeName($name),
+            'ns' => $ns,
+            'luyaText' => $this->getGeneratorText('module/create'),
+        ]);
+    }
 	
     /**
      * Create a new frontend/admin module.

core/console/commands/ActiveWindowController.php

Indentation +2 added lines, -2 removed lines

@@ -30,8 +30,8 @@
      */
     public function renderWindowClassView($className, $namespace, $moduleId)
     {
-    	$alias = Inflector::humanize(Inflector::camel2words($className));
-    	return $this->view->render('@luya/console/commands/views/aw/create.php', [
+        $alias = Inflector::humanize(Inflector::camel2words($className));
+        return $this->view->render('@luya/console/commands/views/aw/create.php', [
             'className' => $className,
             'namespace' => $namespace,
             'luyaText' => $this->getGeneratorText('aw/create'),

Doc Comments +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
      * Render the view file with its parameters.
      *
      * @param string $className
-     * @param string $namepsace
+     * @param string $namespace
      * @param string $moduleId
      * @return string
      */

core/console/Command.php

Indentation +1 added lines, -1 removed lines

@@ -141,6 +141,6 @@
      */
     public function getGeneratorText($command)
     {
-    	return 'File has been created with `'.$command.'` command on LUYA version '.$this->getLuyaVersion().'.';	
+        return 'File has been created with `'.$command.'` command on LUYA version '.$this->getLuyaVersion().'.';	
     }
 }