luyadev / luya

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)

core/web/Composition.php

Doc Comments +1 added lines, -1 removed lines

@@ -398,7 +398,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/web/UrlManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -187,7 +187,7 @@
      * Remove the base url from a route
      *
      * @param string $route The route where the baseUrl should be removed from.
-     * @return mixed
+     * @return string
      */
     public function removeBaseUrl($route)
     {

core/helpers/StringHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -105,7 +105,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
      */
     public static function replaceFirst($search, $replace, $subject)
     {

core/console/commands/HealthController.php

Doc Comments +2 added lines, -2 removed lines

@@ -37,7 +37,7 @@ 
     /**
      * Create all required directories an check whether they are writeable or not.
      *
-     * @return string The action output.
+     * @return integer The action output.
      */
     public function actionIndex()
     {
@@ -97,7 +97,7 @@ 
     /**
      * Test Mail-Component (Use --verbose=1 to enable smtp debug output)
      *
-     * @return boolean Whether successfull or not.
+     * @return integer|null Whether successfull or not.
      * @throws Exception On smtp failure
      */
     public function actionMailer()

core/web/jsonld/EventInterface.php

Doc Comments +2 added lines

@@ -193,6 +193,7 @@ 
 
     /**
      * @param int $maximumAttendeeCapacity
+     * @return void
      */
     public function setMaximumAttendeeCapacity($maximumAttendeeCapacity);
 
@@ -302,6 +303,7 @@ 
 
     /**
      * @param Event $subEvent
+     * @return void
      */
     public function setSubEvent($subEvent);
 

core/traits/CacheableTrait.php

Indentation +27 added lines, -27 removed lines

@@ -80,33 +80,33 @@
     }
     
     /**
-    * Method combines both [[setHasCache()]] and [[getHasCache()]] methods to retrieve value identified by a $key,
-    * or to store the result of $closure execution if there is no cache available for the $key.
-    *
-    * Usage example:
-    *
-    * ```php
-    * use CacheableTrait;
-    *
-    * public function getTopProducts($count = 10)
-    * {
-    *     return $this->getOrSetHasCache(['top-n-products', 'n' => $count], function ($cache) use ($count) {
-    *         return Products::find()->mostPopular()->limit(10)->all();
-    *     }, 1000);
-    * }
-    * ```
-    *
-    * @param mixed $key a key identifying the value to be cached. This can be a simple string or
-    * a complex data structure consisting of factors representing the key.
-    * @param \Closure $closure the closure that will be used to generate a value to be cached.
-    * In case $closure returns `false`, the value will not be cached.
-    * @param int $duration default duration in seconds before the cache will expire. If not set,
-    * [[defaultDuration]] value will be used. 0 means never expire.
-    * @param Dependency $dependency dependency of the cached item. If the dependency changes,
-    * the corresponding value in the cache will be invalidated when it is fetched via [[get()]].
-    * This parameter is ignored if [[serializer]] is `false`.
-    * @return mixed result of $closure execution
-    */
+     * Method combines both [[setHasCache()]] and [[getHasCache()]] methods to retrieve value identified by a $key,
+     * or to store the result of $closure execution if there is no cache available for the $key.
+     *
+     * Usage example:
+     *
+     * ```php
+     * use CacheableTrait;
+     *
+     * public function getTopProducts($count = 10)
+     * {
+     *     return $this->getOrSetHasCache(['top-n-products', 'n' => $count], function ($cache) use ($count) {
+     *         return Products::find()->mostPopular()->limit(10)->all();
+     *     }, 1000);
+     * }
+     * ```
+     *
+     * @param mixed $key a key identifying the value to be cached. This can be a simple string or
+     * a complex data structure consisting of factors representing the key.
+     * @param \Closure $closure the closure that will be used to generate a value to be cached.
+     * In case $closure returns `false`, the value will not be cached.
+     * @param int $duration default duration in seconds before the cache will expire. If not set,
+     * [[defaultDuration]] value will be used. 0 means never expire.
+     * @param Dependency $dependency dependency of the cached item. If the dependency changes,
+     * the corresponding value in the cache will be invalidated when it is fetched via [[get()]].
+     * This parameter is ignored if [[serializer]] is `false`.
+     * @return mixed result of $closure execution
+     */
     public function getOrSetHasCache($key, \Closure $closure, $duration = null, $dependency = null)
     {
         if (($value = $this->getHasCache($key)) !== false) {

dev/BaseDevCommand.php

Doc Comments +2 added lines, -2 removed lines

@@ -25,7 +25,7 @@ 
     /**
      * Display config data and location.
      *
-     * @return boolean|void
+     * @return integer|null
      */
     public function actionConfigInfo()
     {
@@ -75,7 +75,7 @@ 
      * Save a value in the config for a given key.
      *
      * @param string $key
-     * @param mixed $value
+     * @param string $value
      * @return mixed
      */
     protected function saveConfig($key, $value)

dev/RepoController.php

Doc Comments +7 added lines

@@ -192,6 +192,10 @@ 
         return $this->_gitWrapper;
     }
     
+    /**
+     * @param boolean $isFork
+     * @param boolean $exists
+     */
     private function summaryItem($repo, $isFork, $exists)
     {
         return [$repo, $exists, $isFork];
@@ -202,6 +206,9 @@ 
         return 'repos' . DIRECTORY_SEPARATOR . $repo;
     }
     
+    /**
+     * @param string|boolean $username
+     */
     private function forkExists($username, $repo)
     {
         return (new Curl())->get('https://api.github.com/repos/'.$username.'/'.$repo)->isSuccess();

Indentation +5 added lines, -5 removed lines

@@ -166,17 +166,17 @@
      */
     public function actionClone($vendor = null, $repo = null)
     {
-    	// if `vendor/repo` notation is provided
-    	if ($vendor !== null && strpos($vendor, '/')) {
-    		list($vendor, $repo) = explode("/", $vendor);	
-    	}
+        // if `vendor/repo` notation is provided
+        if ($vendor !== null && strpos($vendor, '/')) {
+            list($vendor, $repo) = explode("/", $vendor);	
+        }
     	
         if (empty($vendor)) {
             $vendor = $this->prompt("Enter the username/vendor for this repo (e.g. luyadev)");
         }
         
         if (empty($repo)) {
-        	$repo = $this->prompt("Enter the name of the repo you like to clone (e.g. luya-module-news)");
+            $repo = $this->prompt("Enter the name of the repo you like to clone (e.g. luya-module-news)");
         }
         
         return $this->cloneRepo($repo, $this->getCloneUrlBasedOnType($repo, $vendor), $this->getFilesystemRepoPath($repo), $vendor);