Merge pull request #930 from sergeyklay/3.0.x

Update stubs

Author: sergeyklay

ide/stubs/Phalcon/Acl.php

@@ -1,35 +1,47 @@
 <?php
 
 namespace Phalcon;
+
 /**
  * Phalcon\Acl
+ *
  * This component allows to manage ACL lists. An access control list (ACL) is a list
  * of permissions attached to an object. An ACL specifies which users or system processes
  * are granted access to objects, as well as what operations are allowed on given objects.
+ *
  * <code>
  * use Phalcon\Acl;
  * use Phalcon\Acl\Role;
  * use Phalcon\Acl\Resource;
  * use Phalcon\Acl\Adapter\Memory;
+ *
  * $acl = new Memory();
+ *
  * // Default action is deny access
  * $acl->setDefaultAction(Acl::DENY);
+ *
  * // Create some roles
  * $roleAdmins = new Role("Administrators", "Super-User role");
  * $roleGuests = new Role("Guests");
+ *
  * // Add "Guests" role to acl
  * $acl->addRole($roleGuests);
+ *
  * // Add "Designers" role to acl
  * $acl->addRole("Designers");
+ *
  * // Define the "Customers" resource
  * $customersResource = new Resource("Customers", "Customers management");
+ *
  * // Add "customers" resource with a couple of operations
  * $acl->addResource($customersResource, "search");
  * $acl->addResource($customersResource, ["create", "update"]);
+ *
  * // Set access level for roles into resources
  * $acl->allow("Guests", "Customers", "search");
  * $acl->allow("Guests", "Customers", "create");
  * $acl->deny("Guests", "Customers", "update");
+ *
  * // Check whether role has access to the operations
  * $acl->isAllowed("Guests", "Customers", "edit"); // Returns 0
  * $acl->isAllowed("Guests", "Customers", "search"); // Returns 1

ide/stubs/Phalcon/Application.php

@@ -1,8 +1,10 @@
 <?php
 
 namespace Phalcon;
+
 /**
  * Phalcon\Application
+ *
  * Base class for Phalcon\Cli\Console and Phalcon\Mvc\Application.
  */
 abstract class Application extends \Phalcon\Di\Injectable implements \Phalcon\Events\EventsAwareInterface
@@ -48,18 +50,19 @@ public function getEventsManager() {}
 
     /**
      * Register an array of modules present in the application
+     *
      * <code>
      * $this->registerModules(
-     * [
-     * "frontend" => [
-     * "className" => "Multiple\\Frontend\\Module",
-     * "path"      => "../apps/frontend/Module.php",
-     * ],
-     * "backend" => [
-     * "className" => "Multiple\\Backend\\Module",
-     * "path"      => "../apps/backend/Module.php",
-     * ],
-     * ]
+     *     [
+     *         "frontend" => [
+     *             "className" => "Multiple\\Frontend\\Module",
+     *             "path"      => "../apps/frontend/Module.php",
+     *         ],
+     *         "backend" => [
+     *             "className" => "Multiple\\Backend\\Module",
+     *             "path"      => "../apps/backend/Module.php",
+     *         ],
+     *     ]
      * );
      * </code>
      *

ide/stubs/Phalcon/Config.php

@@ -1,27 +1,30 @@
 <?php
 
 namespace Phalcon;
+
 /**
  * Phalcon\Config
+ *
  * Phalcon\Config is designed to simplify the access to, and the use of, configuration data within applications.
  * It provides a nested object property based user interface for accessing this configuration data within
  * application code.
+ *
  * <code>
  * $config = new \Phalcon\Config(
- * [
- * "database" => [
- * "adapter"  => "Mysql",
- * "host"     => "localhost",
- * "username" => "scott",
- * "password" => "cheetah",
- * "dbname"   => "test_db",
- * ],
- * "phalcon" => [
- * "controllersDir" => "../app/controllers/",
- * "modelsDir"      => "../app/models/",
- * "viewsDir"       => "../app/views/",
- * ],
- * ]
+ *     [
+ *         "database" => [
+ *             "adapter"  => "Mysql",
+ *             "host"     => "localhost",
+ *             "username" => "scott",
+ *             "password" => "cheetah",
+ *             "dbname"   => "test_db",
+ *         ],
+ *         "phalcon" => [
+ *             "controllersDir" => "../app/controllers/",
+ *             "modelsDir"      => "../app/models/",
+ *             "viewsDir"       => "../app/views/",
+ *         ],
+ *     ]
  * );
  * </code>
  */
@@ -37,9 +40,10 @@ public function __construct(array $arrayConfig = null) {}
 
     /**
      * Allows to check whether an attribute is defined using the array-syntax
+     *
      * <code>
      * var_dump(
-     * isset($config["database"])
+     *     isset($config["database"])
      * );
      * </code>
      *
@@ -51,6 +55,7 @@ public function offsetExists($index) {}
     /**
      * Gets an attribute from the configuration, if the attribute isn't defined returns null
      * If the value is exactly null or is not defined the default value will be used instead
+     *
      * <code>
      * echo $config->get("controllersDir", "../app/controllers/");
      * </code>
@@ -63,9 +68,10 @@ public function get($index, $defaultValue = null) {}
 
     /**
      * Gets an attribute using the array-syntax
+     *
      * <code>
      * print_r(
-     * $config["database"]
+     *     $config["database"]
      * );
      * </code>
      *
@@ -76,9 +82,10 @@ public function offsetGet($index) {}
 
     /**
      * Sets an attribute using the array-syntax
+     *
      * <code>
      * $config["database"] = [
-     * "type" => "Sqlite",
+     *     "type" => "Sqlite",
      * ];
      * </code>
      *
@@ -89,6 +96,7 @@ public function offsetSet($index, $value) {}
 
     /**
      * Unsets an attribute using the array-syntax
+     *
      * <code>
      * unset($config["database"]);
      * </code>
@@ -99,14 +107,16 @@ public function offsetUnset($index) {}
 
     /**
      * Merges a configuration into the current one
+     *
      * <code>
      * $appConfig = new \Phalcon\Config(
-     * [
-     * "database" => [
-     * "host" => "localhost",
-     * ],
-     * ]
+     *     [
+     *         "database" => [
+     *             "host" => "localhost",
+     *         ],
+     *     ]
      * );
+     *
      * $globalConfig->merge($appConfig);
      * </code>
      *
@@ -117,9 +127,10 @@ public function merge(Config $config) {}
 
     /**
      * Converts recursively the object to an array
+     *
      * <code>
      * print_r(
-     * $config->toArray()
+     *     $config->toArray()
      * );
      * </code>
      *
@@ -129,10 +140,13 @@ public function toArray() {}
 
     /**
      * Returns the count of properties set in the config
+     *
      * <code>
      * print count($config);
      * </code>
+     *
      * or
+     *
      * <code>
      * print $config->count();
      * </code>
@@ -152,8 +166,11 @@ public static function __set_state(array $data) {}
     /**
      * Helper method for merge configs (forwarding nested config instance)
      *
+     *
+     * @param Config instance = null
+     *
      * @param Config $config
-     * @param Config $instance = null
+     * @param mixed $instance
      * @return Config
      */
     protected final function _merge(Config $config, $instance = null) {}

ide/stubs/Phalcon/Crypt.php

@@ -1,14 +1,20 @@
 <?php
 
 namespace Phalcon;
+
 /**
  * Phalcon\Crypt
+ *
  * Provides encryption facilities to phalcon applications
+ *
  * <code>
  * $crypt = new \Phalcon\Crypt();
+ *
  * $key  = "le password";
  * $text = "This is a secret text";
+ *
  * $encrypted = $crypt->encrypt($text, $key);
+ *
  * echo $crypt->decrypt($encrypted, $key);
  * </code>
  */
@@ -86,6 +92,7 @@ public function getKey() {}
     /**
      * Pads texts before encryption
      *
+     *
      * @see http://www.di-mgt.com.au/cryptopad.html
      * @param string $text
      * @param string $mode
@@ -98,6 +105,7 @@ protected function _cryptPadText($text, $mode, $blockSize, $paddingType) {}
      * Removes padding @a padding_type from @a text
      * If the function detects that the text was not padded, it will return it unmodified
      *
+     *
      * @param string $text Message to be unpadded
      * @param string $mode Encryption mode; unpadding is applied only in CBC or ECB mode
      * @param int $blockSize Cipher block size
@@ -107,6 +115,7 @@ protected function _cryptUnpadText($text, $mode, $blockSize, $paddingType) {}
 
     /**
      * Encrypts a text
+     *
      * <code>
      * $encrypted = $crypt->encrypt("Ultra-secret text", "encrypt password");
      * </code>
@@ -119,6 +128,7 @@ public function encrypt($text, $key = null) {}
 
     /**
      * Decrypts an encrypted text
+     *
      * <code>
      * echo $crypt->decrypt($encrypted, "decrypt password");
      * </code>

ide/stubs/Phalcon/CryptInterface.php

@@ -1,8 +1,10 @@
 <?php
 
 namespace Phalcon;
+
 /**
  * Phalcon\CryptInterface
+ *
  * Interface for Phalcon\Crypt
  */
 interface CryptInterface

ide/stubs/Phalcon/Db.php

@@ -1,37 +1,46 @@
 <?php
 
 namespace Phalcon;
+
 /**
  * Phalcon\Db
+ *
  * Phalcon\Db and its related classes provide a simple SQL database interface for Phalcon Framework.
  * The Phalcon\Db is the basic class you use to connect your PHP application to an RDBMS.
  * There is a different adapter class for each brand of RDBMS.
+ *
  * This component is intended to lower level database operations. If you want to interact with databases using
  * higher level of abstraction use Phalcon\Mvc\Model.
+ *
  * Phalcon\Db is an abstract class. You only can use it with a database adapter like Phalcon\Db\Adapter\Pdo
+ *
  * <code>
  * use Phalcon\Db;
  * use Phalcon\Db\Exception;
  * use Phalcon\Db\Adapter\Pdo\Mysql as MysqlConnection;
+ *
  * try {
- * $connection = new MysqlConnection(
- * [
- * "host"     => "192.168.0.11",
- * "username" => "sigma",
- * "password" => "secret",
- * "dbname"   => "blog",
- * "port"     => "3306",
- * ]
- * );
- * $result = $connection->query(
- * "SELECTFROM robots LIMIT 5"
- * );
- * $result->setFetchMode(Db::FETCH_NUM);
- * while ($robot = $result->fetch()) {
- * print_r($robot);
- * }
+ *     $connection = new MysqlConnection(
+ *         [
+ *             "host"     => "192.168.0.11",
+ *             "username" => "sigma",
+ *             "password" => "secret",
+ *             "dbname"   => "blog",
+ *             "port"     => "3306",
+ *         ]
+ *     );
+ *
+ *     $result = $connection->query(
+ *         "SELECT FROM robots LIMIT 5"
+ *     );
+ *
+ *     $result->setFetchMode(Db::FETCH_NUM);
+ *
+ *     while ($robot = $result->fetch()) {
+ *         print_r($robot);
+ *     }
  * } catch (Exception $e) {
- * echo $e->getMessage(), PHP_EOL;
+ *     echo $e->getMessage(), PHP_EOL;
  * }
  * </code>
  */

ide/stubs/Phalcon/Debug.php

@@ -1,8 +1,10 @@
 <?php
 
 namespace Phalcon;
+
 /**
  * Phalcon\Debug
+ *
  * Provides debug capabilities to Phalcon applications
  */
 class Debug