mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
MINOR Documentation for DB::manipulate() (moved from http://doc.silverstripe.org/manipulation-arrays)
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/branches/2.4@104121 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
parent
3c7cd295a7
commit
d7134392d7
@ -2,6 +2,7 @@
|
||||
/**
|
||||
* Global database interface, complete with static methods.
|
||||
* Use this class for interacting with the database.
|
||||
*
|
||||
* @package sapphire
|
||||
* @subpackage model
|
||||
*/
|
||||
@ -132,6 +133,38 @@ class DB {
|
||||
* and the values are map containing 'command' and 'fields'. Command should be 'insert' or 'update',
|
||||
* and fields should be a map of field names to field values, including quotes. The field value can
|
||||
* also be a SQL function or similar.
|
||||
*
|
||||
* Example:
|
||||
* <code>
|
||||
* array(
|
||||
* // Command: insert
|
||||
* "table name" => array(
|
||||
* "command" => "insert",
|
||||
* "fields" => array(
|
||||
* "ClassName" => "'MyClass'", // if you're setting a literal, you need to escape and provide quotes
|
||||
* "Created" => "now()", // alternatively, you can call DB functions
|
||||
* "ID" => 234,
|
||||
* ),
|
||||
* "id" => 234 // an alternative to providing ID in the fields list
|
||||
* ),
|
||||
*
|
||||
* // Command: update
|
||||
* "other table" => array(
|
||||
* "command" => "update",
|
||||
* "fields" => array(
|
||||
* "ClassName" => "'MyClass'",
|
||||
* "LastEdited" => "now()",
|
||||
* ),
|
||||
* "where" => "ID = 234",
|
||||
* "id" => 234 // an alternative to providing a where clause
|
||||
* ),
|
||||
* )
|
||||
* </code>
|
||||
*
|
||||
* You'll note that only one command on a given table can be called.
|
||||
* That's a limitation of the system that's due to it being written for {@link DataObject::write()},
|
||||
* which needs to do a single write on a number of different tables.
|
||||
*
|
||||
* @param array $manipulation
|
||||
*/
|
||||
static function manipulate($manipulation) {
|
||||
|
Loading…
Reference in New Issue
Block a user