Merge pull request phalcon-orphanage#964 from niden/master

3.1.1 API

en/api/Phalcon_Cli_Dispatcher.rst

@@ -259,10 +259,46 @@ Returns value returned by the latest dispatched action
 
 
 
-public  **setModelBinding** (*boolean* $value) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`
+public  **setModelBinding** (*mixed* $value, [*mixed* $cache]) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`
 
 Enable/Disable model binding during dispatch
 
+.. code-block:: php
+
+    <?php
+
+    $di->set('dispatcher', function() {
+        $dispatcher = new Dispatcher();
+
+        $dispatcher->setModelBinding(true, 'cache');
+        return $dispatcher;
+    });
+
+
+
+
+public  **setModelBinder** (:doc:`Phalcon\\Mvc\\Model\\BinderInterface <Phalcon_Mvc_Model_BinderInterface>` $modelBinder, [*mixed* $cache]) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`
+
+Enable model binding during dispatch
+
+.. code-block:: php
+
+    <?php
+
+    $di->set('dispatcher', function() {
+        $dispatcher = new Dispatcher();
+
+        $dispatcher->setModelBinder(new Binder(), 'cache');
+        return $dispatcher;
+    });
+
+
+
+
+public  **getModelBinder** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`
+
+Gets model binder
+
 
 
 public *object* **dispatch** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`
@@ -308,6 +344,25 @@ Possible class name that will be located to dispatch the request
 
 
 
+public  **getBoundModels** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`
+
+Returns bound models from binder instance
+
+.. code-block:: php
+
+    <?php
+
+    class UserController extends Controller
+    {
+        public function showAction(User $user)
+        {
+            $boundModels = $this->dispatcher->getBoundModels(); // return array with $user
+        }
+    }
+
+
+
+
 protected  **_resolveEmptyProperties** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`
 
 Set empty properties to their defaults (where defaults are available)

en/api/Phalcon_Db_Dialect_Mysql.rst

@@ -82,6 +82,12 @@ Generates SQL to create a table
 
 
 
+public  **truncateTable** (*mixed* $tableName, *mixed* $schemaName)
+
+Generates SQL to truncate a table
+
+
+
 public  **dropTable** (*mixed* $tableName, [*mixed* $schemaName], [*mixed* $ifExists])
 
 Generates SQL to drop a table

en/api/Phalcon_Db_Dialect_Postgresql.rst

@@ -82,6 +82,12 @@ Generates SQL to create a table
 
 
 
+public  **truncateTable** (*mixed* $tableName, *mixed* $schemaName)
+
+Generates SQL to truncate a table
+
+
+
 public  **dropTable** (*mixed* $tableName, [*mixed* $schemaName], [*mixed* $ifExists])
 
 Generates SQL to drop a table

en/api/Phalcon_Db_Dialect_Sqlite.rst

@@ -82,6 +82,12 @@ Generates SQL to create a table
 
 
 
+public  **truncateTable** (*mixed* $tableName, *mixed* $schemaName)
+
+Generates SQL to truncate a table
+
+
+
 public  **dropTable** (*mixed* $tableName, [*mixed* $schemaName], [*mixed* $ifExists])
 
 Generates SQL to drop a table

en/api/Phalcon_Db_Index.rst

@@ -12,6 +12,33 @@ Allows to define indexes to be used on tables. Indexes are a common way
 to enhance database performance. An index allows the database server to find
 and retrieve specific rows much faster than it could do without an index
 
+.. code-block:: php
+
+    <?php
+
+    // Define new unique index
+    $index_unique = new \Phalcon\Db\Index(
+        'column_UNIQUE',
+        [
+            'column',
+            'column'
+        ],
+        'UNIQUE'
+    );
+
+    // Define new primary index
+    $index_primary = new \Phalcon\Db\Index(
+        'PRIMARY',
+        [
+            'column'
+        ]
+    );
+
+    // Add index to existing table
+    $connection->addIndex("robots", null, $index_unique);
+    $connection->addIndex("robots", null, $index_primary);
+
+
 
 Methods
 -------

en/api/Phalcon_Dispatcher.rst

@@ -174,10 +174,46 @@ Returns value returned by the latest dispatched action
 
 
 
-public  **setModelBinding** (*boolean* $value)
+public  **setModelBinding** (*mixed* $value, [*mixed* $cache])
 
 Enable/Disable model binding during dispatch
 
+.. code-block:: php
+
+    <?php
+
+    $di->set('dispatcher', function() {
+        $dispatcher = new Dispatcher();
+
+        $dispatcher->setModelBinding(true, 'cache');
+        return $dispatcher;
+    });
+
+
+
+
+public  **setModelBinder** (:doc:`Phalcon\\Mvc\\Model\\BinderInterface <Phalcon_Mvc_Model_BinderInterface>` $modelBinder, [*mixed* $cache])
+
+Enable model binding during dispatch
+
+.. code-block:: php
+
+    <?php
+
+    $di->set('dispatcher', function() {
+        $dispatcher = new Dispatcher();
+
+        $dispatcher->setModelBinder(new Binder(), 'cache');
+        return $dispatcher;
+    });
+
+
+
+
+public  **getModelBinder** ()
+
+Gets model binder
+
 
 
 public *object* **dispatch** ()
@@ -228,6 +264,25 @@ public  **callActionMethod** (*mixed* $handler, *mixed* $actionMethod, [*array*
 ...
 
 
+public  **getBoundModels** ()
+
+Returns bound models from binder instance
+
+.. code-block:: php
+
+    <?php
+
+    class UserController extends Controller
+    {
+        public function showAction(User $user)
+        {
+            $boundModels = $this->dispatcher->getBoundModels(); // return array with $user
+        }
+    }
+
+
+
+
 protected  **_resolveEmptyProperties** ()
 
 Set empty properties to their defaults (where defaults are available)

en/api/Phalcon_Loader.rst

@@ -117,7 +117,7 @@ Returns the class-map currently registered in the autoloader
 
 
 
-public  **register** ()
+public  **register** ([*mixed* $prepend])
 
 Register the autoload method
 

en/api/Phalcon_Mvc_Collection.rst

@@ -23,6 +23,12 @@ Constants
 
 *integer* **OP_DELETE**
 
+*integer* **DIRTY_STATE_PERSISTENT**
+
+*integer* **DIRTY_STATE_TRANSIENT**
+
+*integer* **DIRTY_STATE_DETACHED**
+
 Methods
 -------
 
@@ -172,7 +178,7 @@ Executes internal events after save a document
 
 
 
-protected  **validate** (:doc:`Phalcon\\Mvc\\Model\\ValidatorInterface <Phalcon_Mvc_Model_ValidatorInterface>` $validator)
+protected  **validate** (*mixed* $validator)
 
 Executes validators on every validation call
 
@@ -186,6 +192,7 @@ Executes validators on every validation call
     {
         public function validation()
         {
+            // Old, deprecated syntax, use new one below
             $this->validate(
                 new ExclusionIn(
                     [
@@ -201,6 +208,30 @@ Executes validators on every validation call
         }
     }
 
+.. code-block:: php
+
+    <?php
+
+    use Phalcon\Validation\Validator\ExclusionIn as ExclusionIn;
+    use Phalcon\Validation;
+
+    class Subscriptors extends \Phalcon\Mvc\Collection
+    {
+        public function validation()
+        {
+            $validator = new Validation();
+            $validator->add("status",
+                new ExclusionIn(
+                    [
+                        "domain" => ["A", "I"]
+                    ]
+                )
+            );
+
+            return $this->validate($validator);
+        }
+    }
+
 
 
 
@@ -548,6 +579,18 @@ Deletes a model instance. Returning true on success or false otherwise.
 
 
 
+public  **setDirtyState** (*mixed* $dirtyState)
+
+Sets the dirty state of the object using one of the DIRTY_STATE_* constants
+
+
+
+public  **getDirtyState** ()
+
+Returns one of the DIRTY_STATE_* constants telling if the document exists in the collection or not
+
+
+
 protected  **addBehavior** (:doc:`Phalcon\\Mvc\\Collection\\BehaviorInterface <Phalcon_Mvc_Collection_BehaviorInterface>` $behavior)
 
 Sets up a behavior in a collection

en/api/Phalcon_Mvc_CollectionInterface.rst

@@ -39,6 +39,16 @@ abstract public  **getConnection** ()
 ...
 
 
+abstract public  **setDirtyState** (*mixed* $dirtyState)
+
+...
+
+
+abstract public  **getDirtyState** ()
+
+...
+
+
 abstract public static  **cloneResult** (:doc:`Phalcon\\Mvc\\CollectionInterface <Phalcon_Mvc_CollectionInterface>` $collection, *array* $document)
 
 ...