Documentation

// Get a new instance
$user = Model_User::forge();

// A new instance with values
$user = Model_User::forge(array(
	'name' => 'John',
	'surname' => 'Doe',
	'email' => 'john@doe.org',
));

// Get a record where `id` = 2
$user = Model_User::find_by_pk(2);

if ($user === null)
{
	// not found
}
else
{
	// found
	echo $user->email;
}

// Get a record where `email` = "info@example.com"
$user = Model_User::find_one_by('email', 'info@example.com');

if ($user === null)
{
	// not found
}
else
{
	// found
	echo $user->email;
}

// SELECT * FROM `users` WHERE `email` LIKE "%@example.com" LIMIT 5 OFFSET 10
$users = Model_User::find_by('email', '%@example.com', 'like', 5, 10);

// Select * FROM `users` WHERE `name` = "John" AND `surname` LIKE "%Surname%" LIMIT 10
$users = \Model_User::find_by(array(
	'name' => 'John',
	array('surname', 'like', '%Surname%'),
), null, null, 10);

if ($users === null)
{
	// not found
}
else
{
	foreach($users as $user)
	{
		// Do something with $user
	}
}

// SELECT * FROM `users` LIMIT 10 OFFSET 20
$users = Model_User::find_all(10, 20);

$users = Model_User::find(array(
	'select' => array('id', 'name', 'email'),
	'where' => array(
		array('name', 'like', '%Name%'),
		'suspended' => 'no',
		array('id', 'in', array(1, 2, 3, 4)),
	),
	'order_by' => array(
		'name' => 'asc',
		'surname' => 'desc',
	),
	'limit' => 10,
	'offset' => 20,
));

$users = Model_User::find(array(
	'where' => array(
		'active' => 'yes',
		'banned' => 'no',
	),
	'order_by' => array('id' => 'desc'),
), 'id');

$users = Model_User::find(function ($query)
{
	return $query->join('roles')
	             ->on('roles.id', '=', 'users.role_id')
	             ->where('roles.name', 'admin');
});

// Inside your model
protected static function pre_find(&$query)
{
	// alter the query
	$query->where('active', 'yes');
}

// Inside your model
protected static function post_find($result)
{
	if ($result !== null)
	{
		// alter the result array
	}

	// return the result
	return $result;
}

$user = Model_User::forge()->set(array(
	'name' => 'My Name',
	'surname' => 'My Surname',
));

$user = Model_User::forge()->set(array(
	'name' => 'My Name',
	'surname' => 'My Surname',
));

// Insert a new user
$result = $user->save();

$user = Model_User::find_by_pk(2);

$user->name = 'New Name';

// Update a user
$user->save();

// Update without running validation
$user->save(false);

$user = Model_User::find_by_pk(2);
if ($user)
{
	// delete the user;
	$user->delete();
}

$user = Model_User::forge(array(
	'id' => 3,
	'name' => 'John',
	'surname' => 'Otherdoe',
));

$user->is_new(false);

// Update
$user->save();

// count all records in the table
$nbr_of_records = Model_User::count();

// filter the result count by only counting admin users
$nbr_of_records = Model_User::count('id', true, array('group', '=', 100));

$user = Model_User::find_by_pk(2);
$user->frozen(true);

// Pass the frozen object arround, no-one can change it...

$user->frozen(false);
// Now you can use it again.

$user = Model_User::find_by_pk(2);
$validation_object = $user->validation();

$model = new Model_User;
$model->set(array(
	'name' => 'John',
	'surname' => 'Doe',
));

if ($model->validates())
{
	// model is valid, skip validation.
	$model->save(false)
}
else
{
	// model is not valid
}

$user = Model_User::find_by_pk(2);
$user_array = $user->to_array();

// Inside your model
protected function pre_save(&$query)
{
	// conditionally add a where clause
	if ($something)
	{
		$query->where('field', '=', $something);
	}
}

// Inside your model
protected function post_save($result)
{
	// Do something with the result
	return $result;
}

// Inside your model
protected function pre_update(&$query)
{
	// Change the update query.
	$query->set(array('field' => 'value'));
}

// Inside your model
protected function post_update($result)
{
	// Do something with the result
	return $result;
}

// Inside your model
protected function pre_delete(&$query)
{
	// Do something with the delete query
}

// Inside your model
protected function post_delete($result)
{
	// Do something with the result
	return $result;
}

// Inside your model
protected function pre_validate($data)
{
	// Do something with the data
	return $data;
}

// Inside your model
protected function post_validate($data)
{
	// Do something with the data
	return $data;
}

// Inside your model
protected function prep_values($data)
{
	// Do something with the data
	return $data;
}