Skip to content

Commit

Permalink
Updating API and fixing typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Phalcon committed Nov 27, 2012
1 parent 108b5f3 commit 04acd27
Show file tree
Hide file tree
Showing 19 changed files with 108 additions and 33 deletions.
14 changes: 13 additions & 1 deletion en/api/Phalcon_Cache_Backend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This class implements common functionality for backend adapters. All the backend
Methods
---------

public **__construct** (:doc:`Phalcon\\Cache\\FrontendInterface <Phalcon_Cache_FrontendInterface>` $frontendObject, *array* $backendOptions)
public **__construct** (:doc:`Phalcon\\Cache\\FrontendInterface <Phalcon_Cache_FrontendInterface>` $frontend, *array* $options)

Phalcon\\Cache\\Backend constructor

Expand All @@ -31,6 +31,12 @@ Returns front-end instance adapter related to the back-end



public *array* **getOptions** ()

Returns the backend options



public *boolean* **isFresh** ()

Checks whether the last cache is fresh or cached
Expand All @@ -43,6 +49,12 @@ Checks whether the cache has starting buffering or not



public **setLastKey** (*string* $lastKey)

Sets the last key used in the cache



public *string* **getLastKey** ()

Gets the last key stored by the cache
Expand Down
14 changes: 13 additions & 1 deletion en/api/Phalcon_Cache_BackendInterface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Phalcon\\Cache\\BackendInterface initializer
Methods
---------

abstract public **__construct** (:doc:`Phalcon\\Cache\\FrontendInterface <Phalcon_Cache_FrontendInterface>` $frontendObject, *array* $backendOptions)
abstract public **__construct** (:doc:`Phalcon\\Cache\\FrontendInterface <Phalcon_Cache_FrontendInterface>` $frontend, *array* $options)

Phalcon\\Cache\\Backend constructor

Expand All @@ -31,6 +31,12 @@ Returns front-end instance adapter related to the back-end



abstract public *array* **getOptions** ()

Returns the backend options



abstract public *boolean* **isFresh** ()

Checks whether the last cache is fresh or cached
Expand All @@ -43,6 +49,12 @@ Checks whether the cache has starting buffering or not



abstract public **setLastKey** (*string* $lastKey)

Sets the last key used in the cache



abstract public *string* **getLastKey** ()

Gets the last key stored by the cache
Expand Down
14 changes: 13 additions & 1 deletion en/api/Phalcon_Cache_Backend_Apc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Checks if cache exists and it hasn't expired



public **__construct** (:doc:`Phalcon\\Cache\\FrontendInterface <Phalcon_Cache_FrontendInterface>` $frontendObject, *array* $backendOptions) inherited from Phalcon\\Cache\\Backend
public **__construct** (:doc:`Phalcon\\Cache\\FrontendInterface <Phalcon_Cache_FrontendInterface>` $frontend, *array* $options) inherited from Phalcon\\Cache\\Backend

Phalcon\\Cache\\Backend constructor

Expand All @@ -88,6 +88,12 @@ Returns front-end instance adapter related to the back-end



public *array* **getOptions** () inherited from Phalcon\\Cache\\Backend

Returns the backend options



public *boolean* **isFresh** () inherited from Phalcon\\Cache\\Backend

Checks whether the last cache is fresh or cached
Expand All @@ -100,6 +106,12 @@ Checks whether the cache has starting buffering or not



public **setLastKey** (*string* $lastKey) inherited from Phalcon\\Cache\\Backend

Sets the last key used in the cache



public *string* **getLastKey** () inherited from Phalcon\\Cache\\Backend

Gets the last key stored by the cache
Expand Down
16 changes: 14 additions & 2 deletions en/api/Phalcon_Cache_Backend_File.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ Allows to cache output fragments using a file backend
Methods
---------

public **__construct** (*mixed* $frontendObject, *array* $backendOptions)
public **__construct** (:doc:`Phalcon\\Cache\\FrontendInterface <Phalcon_Cache_FrontendInterface>` $frontend, *array* $options)

Phalcon\\Backend\\Adapter\\File constructor
Phalcon\\Cache\\Backend\\File constructor



Expand Down Expand Up @@ -90,6 +90,12 @@ Returns front-end instance adapter related to the back-end



public *array* **getOptions** () inherited from Phalcon\\Cache\\Backend

Returns the backend options



public *boolean* **isFresh** () inherited from Phalcon\\Cache\\Backend

Checks whether the last cache is fresh or cached
Expand All @@ -102,6 +108,12 @@ Checks whether the cache has starting buffering or not



public **setLastKey** (*string* $lastKey) inherited from Phalcon\\Cache\\Backend

Sets the last key used in the cache



public *string* **getLastKey** () inherited from Phalcon\\Cache\\Backend

Gets the last key stored by the cache
Expand Down
16 changes: 14 additions & 2 deletions en/api/Phalcon_Cache_Backend_Memcache.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ Allows to cache output fragments, PHP data or raw data to a memcache backend Th
Methods
---------

public **__construct** (*mixed* $frontendObject, *array* $backendOptions)
public **__construct** (:doc:`Phalcon\\Cache\\FrontendInterface <Phalcon_Cache_FrontendInterface>` $frontend, *array* $options)

Phalcon\\Backend\\Adapter\\Memcache constructor
Phalcon\\Cache\\Backend\\Memcache constructor



Expand Down Expand Up @@ -100,6 +100,12 @@ Returns front-end instance adapter related to the back-end



public *array* **getOptions** () inherited from Phalcon\\Cache\\Backend

Returns the backend options



public *boolean* **isFresh** () inherited from Phalcon\\Cache\\Backend

Checks whether the last cache is fresh or cached
Expand All @@ -112,6 +118,12 @@ Checks whether the cache has starting buffering or not



public **setLastKey** (*string* $lastKey) inherited from Phalcon\\Cache\\Backend

Sets the last key used in the cache



public *string* **getLastKey** () inherited from Phalcon\\Cache\\Backend

Gets the last key stored by the cache
Expand Down
16 changes: 14 additions & 2 deletions en/api/Phalcon_Cache_Backend_Mongo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ Allows to cache output fragments, PHP data or raw data to a MongoDb backend
Methods
---------

public **__construct** (*mixed* $frontendObject, *array* $backendOptions)
public **__construct** (:doc:`Phalcon\\Cache\\FrontendInterface <Phalcon_Cache_FrontendInterface>` $frontend, *array* $options)

Phalcon\\Backend\\Adapter\\Mongo constructor
Phalcon\\Cache\\Backend\\Mongo constructor



Expand Down Expand Up @@ -94,6 +94,12 @@ Returns front-end instance adapter related to the back-end



public *array* **getOptions** () inherited from Phalcon\\Cache\\Backend

Returns the backend options



public *boolean* **isFresh** () inherited from Phalcon\\Cache\\Backend

Checks whether the last cache is fresh or cached
Expand All @@ -106,6 +112,12 @@ Checks whether the cache has starting buffering or not



public **setLastKey** (*string* $lastKey) inherited from Phalcon\\Cache\\Backend

Sets the last key used in the cache



public *string* **getLastKey** () inherited from Phalcon\\Cache\\Backend

Gets the last key stored by the cache
Expand Down
6 changes: 3 additions & 3 deletions en/api/Phalcon_DI.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ Phalcon\\DI constructor



public :doc:`Phalcon\\DI <Phalcon_DI>` **set** (*string* $name, *mixed* $config, *boolean* $shared)
public :doc:`Phalcon\\Di\\ServiceInterface <Phalcon_Di_ServiceInterface>` **set** (*string* $name, *mixed* $config, *boolean* $shared)

Registers a service in the services container



public :doc:`Phalcon\\DI <Phalcon_DI>` **setShared** (*string* $name, *mixed* $config)
public :doc:`Phalcon\\Di\\ServiceInterface <Phalcon_Di_ServiceInterface>` **setShared** (*string* $name, *mixed* $config)

Registers an "always shared" service in the services container

Expand All @@ -33,7 +33,7 @@ Removes a service in the services container



public :doc:`Phalcon\\DI <Phalcon_DI>` **attempt** (*string* $name, *mixed* $config, *unknown* $shared)
public :doc:`Phalcon\\Di\\ServiceInterface <Phalcon_Di_ServiceInterface>` **attempt** (*string* $name, *mixed* $config, *unknown* $shared)

Attempts to register a service in the services container Only is successful if a service hasn't been registered previously with the same name

Expand Down
6 changes: 3 additions & 3 deletions en/api/Phalcon_DI_FactoryDefault.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ Phalcon\\DI\\FactoryDefault constructor



public :doc:`Phalcon\\DI <Phalcon_DI>` **set** (*string* $name, *mixed* $config, *boolean* $shared) inherited from Phalcon\\DI
public :doc:`Phalcon\\Di\\ServiceInterface <Phalcon_Di_ServiceInterface>` **set** (*string* $name, *mixed* $config, *boolean* $shared) inherited from Phalcon\\DI

Registers a service in the services container



public :doc:`Phalcon\\DI <Phalcon_DI>` **setShared** (*string* $name, *mixed* $config) inherited from Phalcon\\DI
public :doc:`Phalcon\\Di\\ServiceInterface <Phalcon_Di_ServiceInterface>` **setShared** (*string* $name, *mixed* $config) inherited from Phalcon\\DI

Registers an "always shared" service in the services container

Expand All @@ -35,7 +35,7 @@ Removes a service in the services container



public :doc:`Phalcon\\DI <Phalcon_DI>` **attempt** (*string* $name, *mixed* $config, *unknown* $shared) inherited from Phalcon\\DI
public :doc:`Phalcon\\Di\\ServiceInterface <Phalcon_Di_ServiceInterface>` **attempt** (*string* $name, *mixed* $config, *unknown* $shared) inherited from Phalcon\\DI

Attempts to register a service in the services container Only is successful if a service hasn't been registered previously with the same name

Expand Down
6 changes: 3 additions & 3 deletions en/api/Phalcon_DI_FactoryDefault_CLI.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ Phalcon\\DI\\FactoryDefault\\CLI constructor



public :doc:`Phalcon\\DI <Phalcon_DI>` **set** (*string* $name, *mixed* $config, *boolean* $shared) inherited from Phalcon\\DI
public :doc:`Phalcon\\Di\\ServiceInterface <Phalcon_Di_ServiceInterface>` **set** (*string* $name, *mixed* $config, *boolean* $shared) inherited from Phalcon\\DI

Registers a service in the services container



public :doc:`Phalcon\\DI <Phalcon_DI>` **setShared** (*string* $name, *mixed* $config) inherited from Phalcon\\DI
public :doc:`Phalcon\\Di\\ServiceInterface <Phalcon_Di_ServiceInterface>` **setShared** (*string* $name, *mixed* $config) inherited from Phalcon\\DI

Registers an "always shared" service in the services container

Expand All @@ -35,7 +35,7 @@ Removes a service in the services container



public :doc:`Phalcon\\DI <Phalcon_DI>` **attempt** (*string* $name, *mixed* $config, *unknown* $shared) inherited from Phalcon\\DI
public :doc:`Phalcon\\Di\\ServiceInterface <Phalcon_Di_ServiceInterface>` **attempt** (*string* $name, *mixed* $config, *unknown* $shared) inherited from Phalcon\\DI

Attempts to register a service in the services container Only is successful if a service hasn't been registered previously with the same name

Expand Down
2 changes: 1 addition & 1 deletion en/api/Phalcon_Db_Adapter_Pdo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This method is automatically called in Phalcon\\Db\\Adapter\\Pdo constructor. Ca



protected *\PDOStatement* **_executePrepared** ()
public *\PDOStatement* **executePrepared** (*\PDOStatement* $statement, *array* $placeholders, *array* $dataTypes)

Executes a prepared statement binding

Expand Down
2 changes: 1 addition & 1 deletion en/api/Phalcon_Db_Adapter_Pdo_Mysql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This method is automatically called in Phalcon\\Db\\Adapter\\Pdo constructor. Ca



protected *\PDOStatement* **_executePrepared** () inherited from Phalcon\\Db\\Adapter\\Pdo
public *\PDOStatement* **executePrepared** (*\PDOStatement* $statement, *array* $placeholders, *array* $dataTypes) inherited from Phalcon\\Db\\Adapter\\Pdo

Executes a prepared statement binding

Expand Down
2 changes: 1 addition & 1 deletion en/api/Phalcon_Db_Adapter_Pdo_Postgresql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Constructor for Phalcon\\Db\\Adapter\\Pdo



protected *\PDOStatement* **_executePrepared** () inherited from Phalcon\\Db\\Adapter\\Pdo
public *\PDOStatement* **executePrepared** (*\PDOStatement* $statement, *array* $placeholders, *array* $dataTypes) inherited from Phalcon\\Db\\Adapter\\Pdo

Executes a prepared statement binding

Expand Down
2 changes: 1 addition & 1 deletion en/api/Phalcon_Db_Adapter_Pdo_Sqlite.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Constructor for Phalcon\\Db\\Adapter\\Pdo



protected *\PDOStatement* **_executePrepared** () inherited from Phalcon\\Db\\Adapter\\Pdo
public *\PDOStatement* **executePrepared** (*\PDOStatement* $statement, *array* $placeholders, *array* $dataTypes) inherited from Phalcon\\Db\\Adapter\\Pdo

Executes a prepared statement binding

Expand Down
6 changes: 3 additions & 3 deletions en/api/Phalcon_DiInterface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Phalcon\\DiInterface initializer
Methods
---------

abstract public :doc:`Phalcon\\DI <Phalcon_DI>` **set** (*string* $alias, *mixed* $config, *boolean* $shared)
abstract public :doc:`Phalcon\\Di\\ServiceInterface <Phalcon_Di_ServiceInterface>` **set** (*string* $alias, *mixed* $config, *boolean* $shared)

Registers a service in the services container



abstract public :doc:`Phalcon\\DI <Phalcon_DI>` **setShared** (*string* $name, *mixed* $config)
abstract public :doc:`Phalcon\\Di\\ServiceInterface <Phalcon_Di_ServiceInterface>` **setShared** (*string* $name, *mixed* $config)

Registers an "always shared" service in the services container

Expand All @@ -25,7 +25,7 @@ Removes a service in the services container



abstract public :doc:`Phalcon\\DiInterface <Phalcon_DiInterface>` **attempt** (*string* $alias, *mixed* $config, *boolean* $shared)
abstract public :doc:`Phalcon\\Di\\ServiceInterface <Phalcon_Di_ServiceInterface>` **attempt** (*string* $alias, *mixed* $config, *boolean* $shared)

Attempts to register a service in the services container Only is successful if a service hasn't been registered previously with the same name

Expand Down
4 changes: 3 additions & 1 deletion en/reference/db.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,9 @@ The Phalcon\\Db::query() returns an instance of :doc:`Phalcon\\Db\\Result\\Pdo <
Binding Parameters
------------------
Bound parameters is also supported in :doc:`Phalcon\\Db <../api/Phalcon_Db>`. Although there is a minimal performance impact by using bound parameters, you are encouraged to use this methodology so as to eliminate the possibility of your code being subject to SQL injection attacks. Both string and integer placeholders are supported. Binding parameters can simply be achieved as follows:
Bound parameters is also supported in :doc:`Phalcon\\Db <../api/Phalcon_Db>`. Although there is a minimal performance impact by using
bound parameters, you are encouraged to use this methodology so as to eliminate the possibility of your code being subject to SQL
injection attacks. Both string and integer placeholders are supported. Binding parameters can simply be achieved as follows:

.. code-block:: php
Expand Down
2 changes: 1 addition & 1 deletion en/reference/events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ the same name. Now let's create a listener to this component:
}
A listener is simply a class that implements any of all the events triggered by the component. Now let's all working together:
A listener is simply a class that implements any of all the events triggered by the component. Now let's make everything work together:

.. code-block:: php
Expand Down
2 changes: 1 addition & 1 deletion en/reference/loader.rst
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ In the following example, the EventsManager is working with the class loader, al
));
//Listen all the loader events
$eventsManager->attach('loader', function() {
$eventsManager->attach('loader', function($event, $loader) {
if ($event->getType() == 'beforeCheckPath') {
echo $loader->getCheckedPath();
}
Expand Down
Loading

0 comments on commit 04acd27

Please sign in to comment.