79 lines
1.7 KiB
Markdown
79 lines
1.7 KiB
Markdown
|
# Basic Usage
|
||
|
|
|
||
|
|
## Load a new model instance
|
||
|
|
|
||
|
|
To create a new `Model_User` instance you can do two things:
|
||
|
|
|
||
|
|
$user = ORM::factory('user');
|
||
|
|
// or
|
||
|
|
$user = new Model_User();
|
||
|
|
|
||
|
|
## Inserting
|
||
|
|
|
||
|
|
To insert a new record into the database, create a new instance of the model:
|
||
|
|
|
||
|
|
$user = ORM::factory('user');
|
||
|
|
|
||
|
|
Then, assign values for each of the properties;
|
||
|
|
|
||
|
|
$user->first_name = 'Trent';
|
||
|
|
$user->last_name = 'Reznor';
|
||
|
|
$user->city = 'Mercer';
|
||
|
|
$user->state = 'PA';
|
||
|
|
|
||
|
|
Insert the new record into the database by running [ORM::save]:
|
||
|
|
|
||
|
|
$user->save();
|
||
|
|
|
||
|
|
[ORM::save] checks to see if a value is set for the primary key (`id` by default). If the primary key is set, then ORM will execute an `UPDATE` otherwise it will execute an `INSERT`.
|
||
|
|
|
||
|
|
|
||
|
|
## Finding a object
|
||
|
|
|
||
|
|
To find an object you can call the [ORM::find] function or pass the id into the ORM constructor:
|
||
|
|
|
||
|
|
//find user with ID 20
|
||
|
|
$user = ORM::factory('user');
|
||
|
|
$user->find(20);
|
||
|
|
// or
|
||
|
|
$user = ORM::factory('user', 20);
|
||
|
|
|
||
|
|
## Check that ORM loaded a record
|
||
|
|
|
||
|
|
Use the [ORM::loaded] function to check that ORM successfully loaded a record.
|
||
|
|
|
||
|
|
if ($user->loaded())
|
||
|
|
{
|
||
|
|
//load was successful
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
//error
|
||
|
|
}
|
||
|
|
|
||
|
|
## Updating and Saving
|
||
|
|
|
||
|
|
Once an ORM model has been loaded, you can modify a model's properties like this:
|
||
|
|
|
||
|
|
$user->first_name = "Trent";
|
||
|
|
$user->last_name = "Reznor";
|
||
|
|
|
||
|
|
And if you want to save the changes you just made back to the database, just run a `save()` call like this:
|
||
|
|
|
||
|
|
$user->save();
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Deleting
|
||
|
|
|
||
|
|
|
||
|
|
To delete an object, you can call the [ORM::delete] function on a loaded ORM model, or pass an id to the delete function of a unloaded model.
|
||
|
|
|
||
|
|
$user = ORM::factory('user')->find(20);
|
||
|
|
$user->delete();
|
||
|
|
|
||
|
|
or
|
||
|
|
|
||
|
|
ORM::factory('user')->delete(20);
|
||
|
|
|