Merge pull request #81 from niden/master

v5.1.0

src/Acl/Adapter/AdapterInterface.php

@@ -40,7 +40,7 @@ public function addRole($role, $accessInherits = null): bool;
      * Adds a component to the ACL list
      *
      * Access names can be a particular action, by example
-     * search, update, delete, etc or a list of them
+     * search, update, delete, etc. or a list of them
      *
      * @param mixed $componentValue
      * @param mixed $accessList
@@ -80,7 +80,7 @@ public function allow(string $roleName, string $componentName, $access, $func =
     public function deny(string $roleName, string $componentName, $access, $func = null): void;
 
     /**
-     * Removes an access from a component
+     * Removes access from a component
      *
      * @param string $componentName
      * @param mixed $accessList

src/Acl/Adapter/Memory.php

@@ -99,7 +99,7 @@ class Memory extends \Phalcon\Acl\Adapter\AbstractAdapter
     protected $accessList;
 
     /**
-     * Returns latest function used to acquire access
+     * Returns the latest function used to acquire access
      *
      * @var mixed
      */
@@ -113,7 +113,7 @@ class Memory extends \Phalcon\Acl\Adapter\AbstractAdapter
     protected $activeFunctionCustomArgumentsCount = 0;
 
     /**
-     * Returns latest key used to acquire access
+     * Returns the latest key used to acquire access
      *
      * @var string|null
      */
@@ -141,7 +141,7 @@ class Memory extends \Phalcon\Acl\Adapter\AbstractAdapter
     protected $func;
 
     /**
-     * Default action for no arguments is allow
+     * Default action for no arguments is `allow`
      *
      * @var mixed
      */
@@ -172,11 +172,11 @@ public function __construct()
      * Adds a component to the ACL list
      *
      * Access names can be a particular action, by example
-     * search, update, delete, etc or a list of them
+     * search, update, delete, etc. or a list of them
      *
      * Example:
      * ```php
-     * // Add a component to the the list allowing access to an action
+     * // Add a component to the list allowing access to an action
      * $acl->addComponent(
      *     new Phalcon\Acl\Component("customers"),
      *     "search"
@@ -312,7 +312,7 @@ public function deny(string $roleName, string $componentName, $access, $func = n
     }
 
     /**
-     * Removes an access from a component
+     * Removes access from a component
      *
      * @param string $componentName
      * @param mixed $accessList
@@ -323,7 +323,7 @@ public function dropComponentAccess(string $componentName, $accessList): void
     }
 
     /**
-     * Returns latest function used to acquire access
+     * Returns the latest function used to acquire access
      *
      * @return mixed
      */
@@ -341,7 +341,7 @@ public function getActiveFunctionCustomArgumentsCount(): int
     }
 
     /**
-     * Returns latest key used to acquire access
+     * Returns the latest key used to acquire access
      *
      * @return string|null
      */

src/Assets/Asset.php

@@ -15,18 +15,6 @@
  * ```php
  * $asset = new \Phalcon\Assets\Asset("js", "js/jquery.js");
  * ```
- *
- * @property array       $attributes
- * @property bool        $isAutoVersion
- * @property bool        $filter
- * @property bool        $isLocal
- * @property string      $path
- * @property string      $sourcePath
- * @property string      $targetPath
- * @property string      $targetUri
- * @property string      $type
- * @property string|null $version
- *
  */
 class Asset implements \Phalcon\Assets\AssetInterface
 {

src/Assets/Collection.php

@@ -15,20 +15,6 @@
 
 /**
  * Collection of asset objects
- *
- * @property array  $assets
- * @property array  $attributes
- * @property bool   $autoVersion
- * @property array  $codes
- * @property array  $filters
- * @property bool   $join
- * @property bool   $isLocal
- * @property string $prefix
- * @property string $sourcePath
- * @property bool   $targetIsLocal
- * @property string $targetPath
- * @property string $targetUri
- * @property string $version
  */
 class Collection implements \Countable, \IteratorAggregate
 {

src/Assets/Filters/Cssmin.php

@@ -19,7 +19,9 @@ class Cssmin implements \Phalcon\Assets\FilterInterface
 {
     /**
      * Filters the content using CSSMIN
-     * NOTE: This functionality is not currently available
+     *
+     * > NOTE: This functionality is not currently available
+     * {: .alert .alert-info }
      *
      * @param string $content
      * @return string

src/Assets/Filters/Jsmin.php

@@ -20,7 +20,9 @@ class Jsmin implements \Phalcon\Assets\FilterInterface
 {
     /**
      * Filters the content using JSMIN
-     * NOTE: This functionality is not currently available
+     *
+     * > NOTE: This functionality is not currently available
+     * {: .alert .alert-info }
      *
      * @param string $content
      * @return string

src/Assets/Manager.php

@@ -21,11 +21,6 @@
 
 /**
  * Manages collections of CSS/JavaScript assets
- *
- * @property array      $collections
- * @property bool       $implicitOutput
- * @property array      $options
- * @property TagFactory $tagFactory
  */
 class Manager extends AbstractInjectionAware
 {

src/Autoload/Loader.php

@@ -15,18 +15,6 @@
  * The Phalcon Autoloader provides an easy way to automatically load classes
  * (namespaced or not) as well as files. It also features extension loading,
  * allowing the user to autoload files with different extensions than .php.
- *
- * @property string|null          $checkedPath
- * @property array                $classes
- * @property array                $debug
- * @property array                $directories
- * @property array                $extensions
- * @property string|callable|null $fileCheckingCallback
- * @property array                $files
- * @property string|null          $foundPath
- * @property bool                 $isDebug
- * @property bool                 $isRegistered
- * @property array                $namespaces
  */
 class Loader extends AbstractEventsAware
 {

src/Cache/AbstractCache.php

@@ -16,9 +16,6 @@
 
 /**
  * This component offers caching capabilities for your application.
- * Phalcon\Cache implements PSR-16.
- *
- * @property AdapterInterface $adapter
  */
 abstract class AbstractCache implements \Phalcon\Cache\CacheInterface
 {

src/Cache/AdapterFactory.php

@@ -16,8 +16,6 @@
 
 /**
  * Factory to create Cache adapters
- *
- * @property SerializerFactory $serializerFactory
  */
 class AdapterFactory extends AbstractFactory
 {

src/Cache/Cache.php

@@ -15,9 +15,6 @@
 
 /**
  * This component offers caching capabilities for your application.
- * Phalcon\Cache implements PSR-16.
- *
- * @property AdapterInterface $adapter
  */
 class Cache extends \Phalcon\Cache\AbstractCache
 {

src/Cache/CacheFactory.php

@@ -17,8 +17,6 @@
 
 /**
  * Creates a new Cache class
- *
- * @property AdapterFactory $adapterFactory;
  */
 class CacheFactory extends AbstractConfigFactory
 {

src/Cli/Router.php

@@ -38,14 +38,14 @@
 class Router extends AbstractInjectionAware
 {
     /**
-     * @var string|null
+     * @var string
      */
-    protected $action = null;
+    protected $action = '';
 
     /**
-     * @var string|null
+     * @var string
      */
-    protected $defaultAction = null;
+    protected $defaultAction = '';
 
     /**
      * @var string
@@ -58,20 +58,19 @@ class Router extends AbstractInjectionAware
     protected $defaultParams = [];
 
     /**
-     * @var string|null
+     * @var string
      */
-    protected $defaultTask = null;
+    protected $defaultTask = '';
 
     /**
      * @var RouteInterface|null
      */
     protected $matchedRoute = null;
 
     /**
-     * @var array|null
-     * TODO: make always array
+     * @var array
      */
-    protected $matches = null;
+    protected $matches = [];
 
     /**
      * @var string
@@ -89,9 +88,9 @@ class Router extends AbstractInjectionAware
     protected $routes = [];
 
     /**
-     * @var string|null
+     * @var string
      */
-    protected $task = null;
+    protected $task = '';
 
     /**
      * @var bool
@@ -161,12 +160,22 @@ public function getModuleName(): string
     /**
      * Returns processed extra params
      *
+     * @todo deprecate this in future versions
      * @return array
      */
     public function getParams(): array
     {
     }
 
+    /**
+     * Returns processed extra params
+     *
+     * @return array
+     */
+    public function getParameters(): array
+    {
+    }
+
     /**
      * Returns a route object by its id
      *

src/Cli/Router/Route.php

@@ -22,9 +22,9 @@ class Route implements \Phalcon\Cli\Router\RouteInterface
     protected $beforeMatch = null;
 
     /**
-     * @var string|null
+     * @var string
      */
-    protected $compiledPattern = null;
+    protected $compiledPattern = '';
 
     /**
      * @var array
@@ -42,19 +42,19 @@ class Route implements \Phalcon\Cli\Router\RouteInterface
     protected static $delimiterPath = self::DEFAULT_DELIMITER;
 
     /**
-     * @var string|null
+     * @var string
      */
-    protected $description = null;
+    protected $description = '';
 
     /**
      * @var string
      */
-    protected $id;
+    protected $routeId;
 
     /**
-     * @var string|null
+     * @var string
      */
-    protected $name = null;
+    protected $name = '';
 
     /**
      * @var array
@@ -64,10 +64,10 @@ class Route implements \Phalcon\Cli\Router\RouteInterface
     /**
      * @var string
      */
-    protected $pattern;
+    protected $pattern = '';
 
     /**
-     * @var int|string
+     * @var int
      */
     protected static $uniqueId = 0;
 

src/Cli/RouterInterface.php

@@ -56,10 +56,18 @@ public function getModuleName(): string;
     /**
      * Returns processed extra params
      *
+     * @todo deprecate this in the future
      * @return array
      */
     public function getParams(): array;
 
+    /**
+     * Returns processed extra params
+     *
+     * @return array
+     */
+    public function getParameters(): array;
+
     /**
      * Returns a route object by its id
      *

src/Config/Config.php

@@ -35,8 +35,6 @@
  *     ]
  * );
  * ```
- *
- * @property string $pathDelimiter
  */
 class Config extends Collection implements \Phalcon\Config\ConfigInterface
 {

src/DataMapper/Pdo/Connection.php

@@ -17,10 +17,6 @@
 /**
  * Provides array quoting, profiling, a new `perform()` method, new `fetch()`
  * methods
- *
- * @property array             $arguments
- * @property PDO               $pdo
- * @property ProfilerInterface $profiler
  */
 class Connection extends AbstractConnection
 {

src/DataMapper/Pdo/Connection/AbstractConnection.php

@@ -16,9 +16,6 @@
 /**
  * Provides array quoting, profiling, a new `perform()` method, new `fetch()`
  * methods
- *
- * @property PDO               $pdo
- * @property ProfilerInterface $profiler
  */
 abstract class AbstractConnection implements \Phalcon\DataMapper\Pdo\Connection\ConnectionInterface
 {