public __get( string $field ) (defined in Model_Auth_User)

Parameters

• string $field required - $column Column name

Return Values

• mixed

public function __get($field)
{
	if( $field === 'name' OR $field === 'mail' )
	{
		return HTML::chars( parent::__get($field) );
	}

	// Return the best version of the user's name. Either their specified
	// nick name, or fall back to the user name.
	if( $field === 'nick' )
	{
		$nick = parent::__get('nick');
		return empty($nick) ? HTML::chars( $this->name ) : HTML::chars($nick);
	}

	if( $field === 'rawurl' )
		return Route::get('user')->uri( array( 'id' => $this->id ) );

		// Model specefic links; view, edit, delete url's.
			if( $field === 'url' )
		return ($path = Path::load($this->rawurl) ) ? $path['alias'] : $this->rawurl;

			if( $field === 'edit_url' )
		return Route::get('user')->uri( array( 'id' => $this->id, 'action' => 'edit' ) );

			if( $field === 'delete_url' )
		return Route::get('user')->uri( array( 'id' => $this->id, 'action' => 'delete' ) );

	return parent::__get($field);
}

public change_pass( ) (defined in Model_Auth_User)

public function change_pass($values, $expected = NULL )
{
	// Validation for passwords
	$extra_validation = Model_User::get_password_validation($values)
				->rule('old_pass', 'not_empty')
				->rule('pass_confirm', 'not_empty')
				->rule('pass', 'not_empty')
				->rule('old_pass', array(Auth::instance(), 'check_password') );

	return $this->values($values, $expected)->save($extra_validation);
}

public complete_login( ) (defined in Model_Auth_User)

Return Values

• void

public function complete_login()
{
	if ($this->_loaded)
	{
		// Update the number of logins
		$this->logins = new Database_Expression('logins + 1');

		// Set the last login date
		$this->login = time();

		//if the pass is md5.. convert to new hash system
		if( strlen($this->pass) == 32 AND isset($this->password) AND strlen($this->password) > 3 )
		{
			$this->pass = $this->password;
		}

		// Save the user
		$this->update();
	}
}

public confirm_reset_password_form( array & $data ) (defined in Model_Auth_User)

Parameters

• byref array $data required - Values to check

Return Values

• boolean

public function confirm_reset_password_form(array & $data)
{
	$data = Validation::factory($data)
			->label('pass', __('Password') )
			->rule('pass', 'not_empty' )
			->rule('pass', 'min_length', array(':value', 4) )
			->rule('pass_confirm', 'matches', array(':validation', ':field', 'pass'));

	if ( ! $data->check())
		return FALSE;

	// Store the new password
	$this->pass = $data['pass'];
	$this->save();

	Kohana::$log->add(LOG::INFO, 'User %name used one-time login link.', array('%name' => $this->name) );

	// It could be that the user resets his password before he confirmed his sign-up,
	// or a the reset password form could be used in case the original sign-up confirmation mail got lost.
	// Since the user could only come to this point if he supplied a valid email address,
	// we confirm his account right here.
	if ( ! $this->has('roles', 3))
	{
		// Give the user the "user" role
		$this->add('roles', 3);
	}

	return TRUE;
}

public confirm_reset_password_link( integer $id , string $token , integer $time ) (defined in Model_Auth_User)

Parameters

• integer $id required - User id
• string $token required - Confirmation token
• integer $time required - Timestamp

Return Values

• boolean

public function confirm_reset_password_link($id, $token, $time)
{
	// Don't even bother, save us the user lookup query
	if (empty($id) OR empty($token) OR empty($time))
		return FALSE;

	// Confirmation link expired
	if ($time + Kohana::$config->load('site.reset_password_expiration') < time())
		return FALSE;

	//clear any loaded object in memory
	$this->clear();

	// Load user by id and status is active
	$this->where('id', '=', $id)->where('status', '=', 1)->find();

	// Invalid user id
	if ( ! $this->loaded() )
		return FALSE;

	// Used onetime login link
	if ( $time < $this->login ) return FALSE;

	// Invalid confirmation token
	if ($token !== Auth::instance()->hash($this->mail.'+'.$this->pass.'+'.$time.'+'.(int)$this->login))
		return FALSE;

	return TRUE;
}

public confirm_signup( integer $id , string $token ) (defined in Model_Auth_User)

Parameters

• integer $id required - User id
• string $token required - Confirmation token

Return Values

• boolean

public function confirm_signup($id, $token)
{
	// Don't even bother, save us the user lookup query
	if (empty($id) OR empty($token))
		return FALSE;

	// Load user by id and status is active
	$this->where('id', '=', $id)->where('status', '=', 1)->find();

	// Invalid user id or account blocked
	if ( ! $this->loaded() )
		return FALSE;

	// Invalid confirmation token
	if ($token !== Auth::instance()->hash($this->mail.'+'.$this->pass.'+'.(int)$this->login))
		return FALSE;

	//send welcome mail
	$this->welcome_mail();

	// User is already confirmed.
	// We're not showing an error message.
	if ($this->has('roles', ORM::factory('role', array('name' => 'user'))))
		return TRUE;

	// Give the user the "user" role
	$this->add('roles', ORM::factory('role', array('name' => 'user')));

	return TRUE;
}

public create( ) (defined in Model_Auth_User)

Tags

• Throws - Kohana_Exception

public function create(Validation $validation = NULL)
{
	if ($this->_loaded)
	{
		throw new Kohana_Exception('Cannot create :model model because it is already loaded.', array(':model' => $this->_object_name));
	}

	$this->init = $this->mail;
	$this->status = (int) 1;

	return parent::create($validation);
}

public email_available( Validation $validation , string $field ) (defined in Model_Auth_User)

Parameters

• Validation $validation required - Validation object
• string $field required - Field name

Return Values

• void

public function email_available(Validation $validation, $field)
{
	if ($this->unique_key_exists($validation[$field], 'mail'))
	{
		$validation->error($field, 'email_available', array($validation[$field]));
	}
}

public email_not_available( object $validation , string $field ) (defined in Model_Auth_User)

Parameters

• object $validation required - Validate
• string $field required - Field name

Return Values

• void

public function email_not_available(Validation $validation, $field)
{
	if ( ! $this->unique_key_exists($validation[$field], 'mail'))
	{
		$validation->error($field, 'email_not_available', array($validation[$field]));
	}
}

public filters( ) (defined in Model_Auth_User)

Return Values

• array - Filters

public function filters()
{
	return array(
		'pass' => array(
			array(array(Auth::instance(), 'hash'))
		),
		'picture' => array(
			array(array($this, 'upload_photo'))
		)
	);
}

public find_all( ) (defined in Model_Auth_User)

Tags

• See - Gleez_ORM_Core::find_all

public function find_all($id = NULL)
{
	$this->where($this->_object_name.'.id', '!=', 1);

	return parent::find_all($id);
}

public find_sso_user( string $provider_field , array $data ) (defined in Model_Auth_User)

Parameters

• string $provider_field required - $provider_field
• array $data required - $data

Return Values

• ORM

public function find_sso_user($provider_field, $data)
{
	return $this->where($provider_field, '=', $data['id'])
		->or_where('mail', '=', $data['mail'])
		->find();
}

public static get_password_validation( array $values ) (defined in Model_Auth_User)

Parameters

• array $values required - $values

Return Values

• Validation

public static function get_password_validation($values)
{
	return Validation::factory($values)
		->rule('pass', 'min_length', array(':value', 4))
		->rule('pass_confirm', 'matches', array(':validation', ':field', 'pass'));
}

public labels( ) (defined in Model_Auth_User)

Return Values

• array - Labels

public function labels()
{
	return array(
		'name'         => __('Username'),
		'mail'         => __('Email'),
		'pass'         => __('Password'),
		'nick'         => __('Display Name'),
		'old_pass'     => __('Old Password'),
		'gender'       => __('Gender'),
		'dob'          => __('Birthday'),
	);
}

public login( array $array [, string $redirect = bool FALSE ] ) (defined in Model_Auth_User)

Parameters

• array $array required - Values to check
• string $redirect = bool FALSE - URI or URL to redirect to

Return Values

• boolean

public function login(array $array, $redirect = FALSE)
{
	$labels = $this->labels();
	$rules  = $this->rules();

	$array = Validation::factory($array);

	//important to check isset to avoid unecessary routing
			if( isset( $array['name'] ) )
	{
		$login_name = $this->unique_key($array['name']);

		//be sure remove the name/email_available rule during login
		if( isset($rules[$login_name][4]))
			unset($rules[$login_name][4]);

		$array->rules('name', $rules[$login_name]);
		$array->label('name', $labels[$login_name]);

		$array->label('password', $labels['pass']);
		$array->rules('password', $rules['pass']);
			}

	// Get the remember login option
	$remember = isset($array['remember']);
			Module::event('user_login_validate', $array);

	if ($array->check())
	{
		// Attempt to load the user
		$this->where($login_name, '=', $array['name'])->find();

		if ($this->loaded() AND $this->status != 1)
		{
			$array->error('name', 'blocked');
			Module::event('user_blocked', $array);

			Kohana::$log->add( Log::ERROR, 'User: :name account blocked.', array(':name' => $array['name']) );
			throw new Validation_Exception($array, 'Account Blocked');
		}
		elseif ($this->loaded() AND Auth::instance()->login($this, $array['password'], $remember))
		{
			// Redirect after a successful login
			if (is_string($redirect))
				Request::initial()->redirect($redirect);

			return $this;
		}
		else
		{
			$array->error('name', 'invalid');
			Module::event('user_auth_failed', $array);

			Kohana::$log->add( Log::ERROR, 'User: :name failed login.', array(':name' => $array['name']) );
			throw new Validation_Exception($array, 'Validation has failed for login');
		}
	}
	else
			{
		Kohana::$log->add( Log::ERROR, 'User Login error');
					throw new Validation_Exception($array, 'Validation has failed for login');
			}

	return FALSE;
}

public reset_password( array & $data ) (defined in Model_Auth_User)

Parameters

• byref array $data required - Values to check

Return Values

• boolean

public function reset_password(array & $data)
{
	$labels = $this->labels();
	$rules  = $this->rules();

	$data = Validation::factory($data)
			->rule('mail', 'not_empty')
			->rule('mail', 'min_length', array(':value', 4) )
			->rule('mail', 'max_length', array(':value', 254) )
			->rule('mail', 'email' )
			->rule('mail', array($this, 'email_not_available'), array(':validation', ':field') );

	if ( ! $data->check())
		return FALSE;

	// Load user data
	$this->where('mail', '=', $data['mail'])->find();

	// Invalid user
	if ( ! $this->_loaded ) return FALSE;

	// Create e-mail body with reset password link
	//Token consists of email and the last_login field.
	//So as soon as the user logs in again, the reset link expires automatically
	$time = time();
	$token = Auth::instance()->hash($this->mail.'+'.$this->pass.'+'.$time.'+'.(int)$this->login);

	$body = View::factory('email/confirm_reset_password', $this->as_array())
		->set('time', $time)
		->set('url', URL::site(
			Route::get('user/reset')->uri(array('action' => 'confirm_password',
								'id' => $this->id,
								'token' => $token,
								'time'  => $time
								)),
			TRUE // Add protocol to URL
		));

	// Create an email message
	$email = Email::factory()
			->subject(__('Gleez - Reset password for :name', array(':name' => $this->nick)) )
			->to( $this->mail, $this->nick )
			->message($body);

	// Send the message
	$email->send();

	return TRUE;
}

public roles( ) (defined in Model_Auth_User)

public function roles()
{
	return $this->roles->find_all();
}

public rules( ) (defined in Model_Auth_User)

Return Values

• array - Rules

public function rules()
{
	$config = Kohana::$config->load('auth.name');
	return array(
		'name' => array(
			array('not_empty'),
			array('min_length', array(':value', max((int)$config['length_min'], 4)) ),
			array('max_length', array(':value', min((int)$config['length_max'], 32)) ),
			array('regex', array(':value', '/^[' . $config['chars'] . ']+$/ui') ),
			array(array($this, 'unique'), array('name', ':value')),
		),
		'pass' => array(
			array('not_empty'),
			array('min_length', array(':value', 4)),
		),
		'mail' => array(
			array('not_empty'),
			array('min_length', array(':value', 4)),
			array('max_length', array(':value', 254)),
			array('email'),
			array(array($this, 'unique'), array('mail', ':value')),
		),
	);
}

public signup( array $data ) (defined in Model_Auth_User)

Parameters

• array $data required - Values to check

Return Values

• boolean

public function signup(array $data)
{
	// Add user
	$this->values($data)->save();

	// Give user the "login" role
	if ( ! $this->has('roles', 2))
	{
		// Give the user the "user" role
		$this->add('roles', 2);
	}

	//Create e-mail body with reset password link
	//Token consists of email and the last_login field.
	//So as soon as the user logs in again, the reset link expires automatically
	$token = Auth::instance()->hash($this->mail.'+'.$this->pass.'+'.(int)$this->login);

	$body = View::factory('email/confirm_signup', $this->as_array())
		->set('url', URL::site(
			Route::get('user')->uri(array('action' => 'confirm',
								'id' => $this->id,
								'token' => $token,
								)),
			TRUE // Add protocol to URL
		));

	// Create an email message
	$email = Email::factory()
			->subject( __('Gleez - Validate account details for :name', array(':name' => $this->nick)) )
			->to($this->mail, $this->nick)
			->message($body);

	// Send the message
	$email->send();

	return TRUE;
}

public sso_signup( array $data , array $provider ) (defined in Model_Auth_User)

Parameters

• array $data required - $data
• array $provider required - $provider

Return Values

• ORM

public function sso_signup(array $data, array $provider)
{
	if ( ! $this->_loaded)
	{
		// Add user
		$this->name = $provider['provider'].'_'.$data['id'];
		$this->pass = $data['id']; //set id as pass( we can't save without password)
		$this->nick = $data['nick'];
		$this->url  = $data['link'];
		$this->status  = (int) 1;

		// Set email if it's available via OAuth provider
		if ( isset($data['email']) )
		{
			$this->mail = $data['email'];
		}

		// Set gender if it's available via OAuth provider
		if( isset($data['gender']) )
		{
			$this->gender = ($data['gender'] === 'male') ? 1 : 2;
		}

		// Save user
		$this->save();

		//give "login" role as it is verified
		$this->add('roles', 2);

		$identity = ORM::factory('identity');
		$identity->user_id = $this->id;
		$identity->values($provider);
		$identity->save();

		//send welcome mail
		$this->welcome_mail();
	}
	elseif ( $this->_loaded )
	{
		// If user is found, but provider id is missing add it to details.
		// We can do this merge, because this means user is found by email address,
		// that is already confirmed by this OAuth provider, so it's considered trusted.
		$identity = ORM::factory('identity');
		$identity->user_id = $this->id;
		$identity->values($provider);
		$identity->save();

		// Set email if it's available via OAuth provider and save
		if (isset($data['email']))
		{
			$this->status  = (int) 1;
			//$this->mail = $data['email'];
			$this->save();
		}
	}

	if ( ! $this->has('roles', 3))
	{
		// Give the user the "user" role
		$this->add('roles', 3);
	}

	// Return user
	return $this;
}

public unique_key( string $value ) (defined in Model_Auth_User)

Parameters

• string $value required - Unique value

Return Values

• string - Field name

public function unique_key($value)
{
	return Valid::email($value) ? 'mail' : 'name';
}

public unique_key_exists( mixed $value [, string $field = NULL ] ) (defined in Model_Auth_User)

Parameters

• mixed $value required - The value to test
• string $field = NULL - Field name

Return Values

• boolean

public function unique_key_exists($value, $field = NULL)
{
	if ($field === NULL)
	{
		// Automatically determine field by looking at the value
		$field = $this->unique_key($value);
	}

	return (bool) DB::select(array('COUNT("*")', 'total_count'))
		->from($this->_table_name)
		->where($field, '=', $value)
		->where($this->_primary_key, '!=', $this->pk())
		->execute($this->_db)
		->get('total_count');
}

public upload_photo( string $file ) (defined in Model_Auth_User)

Parameters

• string $file required - Uploaded file

Tags

• Uses - System::mkdir Making dir for uploading photo

Return Values

• NULL|string - File path

public function upload_photo($file)
{
	// Uploads directory and url for profile pictures
	$profile_path = APPPATH . self::DEFAULT_PATH;

	if( ! is_dir($profile_path))
	{
		if( ! System::mkdir($profile_path))
		{
			Message::error(__('Failed to create directory %dir for uploading prfile image. Check the permissions the web server to create this directory.',
				array('%dir' => Text::plain($profile_path))
			));

			Kohana::$log->add(Log::ERROR, 'Failed to create directory %dir for uploading profile image.',
				array('%dir' => Text::plain($profile_path))
			);
		}
	}

	// check if there is an uploaded file
	if (Upload::valid($file))
	{
		$filename = uniqid().preg_replace('/\s+/u', '-', $file['name']);
		$path = Upload::save($file, $filename, $profile_path);

		if ($path)
		{
			return self::DEFAULT_PATH.DIRECTORY_SEPARATOR.$filename;
		}
	}

	return NULL;
}

public username_available( Validation $validation , string $field ) (defined in Model_Auth_User)

Parameters

• Validation $validation required - Validation object
• string $field required - Field name

Return Values

• void

public function username_available(Validation $validation, $field)
{
	if ($this->unique_key_exists($validation[$field], 'name'))
	{
		$validation->error($field, 'username_available', array($validation[$field]));
	}
}

public welcome_mail( ) (defined in Model_Auth_User)

Return Values

• boolean

public function welcome_mail()
{
	if ($this->_loaded)
	{
		$body = View::factory('email/welcome_signup', $this->as_array())
				->set('url', URL::site('', TRUE ));

		// Create an email message
		$email = Email::factory()
			->subject( __('Gleez - Account details for :name (approved)', array(':name' => $this->nick)) )
			->to($this->mail, $this->nick)
			->message($body);

		// Send the message
		$email->send();
	}

	return TRUE;
}

public __construct( [ mixed $id = NULL ] ) (defined in Gleez_ORM_Core)

Parameters

• mixed $id = NULL - Parameter for find or object to load

Return Values

• void

public function __construct($id = NULL)
{
	$this->_initialize();

	if ($id !== NULL)
	{
		if (is_array($id))
		{
			foreach ($id as $column => $value)
			{
				// Passing an array of column => values
				$this->where($column, '=', $value);
			}

			$this->find();
		}
		else
		{
			// Passing the primary key
			$this->where($this->_object_name.'.'.$this->_primary_key, '=', $id)->find();
		}
	}
	elseif ( ! empty($this->_cast_data))
	{
		// Load preloaded data from a database call cast
		$this->_load_values($this->_cast_data);

		$this->_cast_data = array();
	}
}

public __isset( string $column ) (defined in Gleez_ORM_Core)

Parameters

• string $column required - Column name

Return Values

• boolean

public function __isset($column)
{
	return (isset($this->_object[$column]) OR
		isset($this->_related[$column]) OR
		isset($this->_has_one[$column]) OR
		isset($this->_belongs_to[$column]) OR
		isset($this->_has_many[$column]));
}

public __set( string $column , mixed $value ) (defined in Gleez_ORM_Core)

Parameters

• string $column required - Column name
• mixed $value required - Column value

Return Values

• void

public function __set($column, $value)
{
	if ( ! isset($this->_object_name))
	{
		// Object not yet constructed, so we're loading data from a database call cast
		$this->_cast_data[$column] = $value;
	}
	else
	{
		// Set the model's column to given value
		$this->set($column, $value);
	}
}

public __toString( ) (defined in Gleez_ORM_Core)

Return Values

• string

public function __toString()
{
	return (string) $this->pk();
}

public __unset( string $column ) (defined in Gleez_ORM_Core)

Parameters

• string $column required - Column name

Return Values

• void

public function __unset($column)
{
	unset($this->_object[$column], $this->_changed[$column], $this->_related[$column]);
}

public add( string $alias , mixed $far_keys [, array $data = NULL ] ) (defined in Gleez_ORM_Core)

// Add the login role using a model instance
$model->add('roles', ORM::factory('role', array('name' => 'login')));
// Add the login role if you know the roles.id is 5
$model->add('roles', 5);
// Add multiple roles (for example, from checkboxes on a form)
$model->add('roles', array(1, 2, 3, 4));

Parameters

• string $alias required - Alias of the has_many "through" relationship
• mixed $far_keys required - Related model, primary key, or an array of primary keys
• array $data = NULL - Additional data to store in "through"/pivot table

Return Values

• ORM

public function add($alias, $far_keys, $data = NULL)
{
	$far_keys = ($far_keys instanceof ORM) ? $far_keys->pk() : $far_keys;

	$columns = array($this->_has_many[$alias]['foreign_key'], $this->_has_many[$alias]['far_key']);
	$foreign_key = $this->pk();

	if ($data !== NULL)
	{
		// Additional data stored in pivot table
		$columns = array_merge($columns, array_keys($data));
	}

	$query = DB::insert($this->_has_many[$alias]['through'], $columns);

	foreach ( (array) $far_keys as $key)
	{
		$values = array($foreign_key, $key);
		if ($data !== NULL)
		{
			// Additional data stored in pivot table
			$values  = array_merge($values, array_values($data));
		}
		
		$query->values($values);
	}

	$query->execute($this->_db);

	return $this;
}

public and_having( mixed $column , string $op [, mixed $value = NULL ] ) (defined in Gleez_ORM_Core)

Parameters

• mixed $column required - Column name or array($column, $alias) or object
• string $op required - Logic operator
• mixed $value = NULL - Column value

Return Values

• $this

public function and_having($column, $op, $value = NULL)
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'and_having',
		'args' => array($column, $op, $value),
	);

	return $this;
}

public and_having_close( ) (defined in Gleez_ORM_Core)

Return Values

• $this

public function and_having_close()
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'and_having_close',
		'args' => array(),
	);

	return $this;
}

public and_having_open( ) (defined in Gleez_ORM_Core)

Return Values

• $this

public function and_having_open()
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'and_having_open',
		'args' => array(),
	);

	return $this;
}

public and_where( mixed $column , string $op , mixed $value ) (defined in Gleez_ORM_Core)

Parameters

• mixed $column required - Column name or array($column, $alias) or object
• string $op required - Logic operator
• mixed $value required - Column value

Return Values

• $this

public function and_where($column, $op, $value)
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'and_where',
		'args' => array($column, $op, $value),
	);

	return $this;
}

public and_where_close( ) (defined in Gleez_ORM_Core)

Return Values

• $this

public function and_where_close()
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'and_where_close',
		'args' => array(),
	);

	return $this;
}

public and_where_open( ) (defined in Gleez_ORM_Core)

Return Values

• $this

public function and_where_open()
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'and_where_open',
		'args' => array(),
	);

	return $this;
}

public as_array( ) (defined in Gleez_ORM_Core)

Return Values

• array

public function as_array()
{
	$object = array();
	$extra = array('url', 'edit_url', 'delete_url');

	foreach ($this->_object as $column => $value)
	{
		// Call __get for any user processing
		$object[$column] = $this->__get($column);
	}

	foreach ($this->_related as $column => $model)
	{
		// Include any related objects that are already loaded
		$object[$column] = $model->as_array();
	}

	foreach ($extra as $column)
	{
		try
		{
			// Call __get for any user processing
			$object[$column] = $this->__get($column);
		}catch(Exception $e){}
	}

	return $object;
}

public belongs_to( ) (defined in Gleez_ORM_Core)

public function belongs_to()
{
	return $this->_belongs_to;
}

public cached( [ integer $lifetime = NULL ] ) (defined in Gleez_ORM_Core)

Parameters

• integer $lifetime = NULL - Number of seconds to cache

Tags

• Uses - Kohana::$cache_life

Return Values

• $this

public function cached($lifetime = NULL)
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'cached',
		'args' => array($lifetime),
	);

	return $this;
}

public changed( [ string $field = NULL ] ) (defined in Gleez_ORM_Core)

Parameters

• string $field = NULL - Field to check for changes

Return Values

• bool - Whether or not the field has changed

public function changed($field = NULL)
{
	return ($field === NULL)
		? $this->_changed
		: Arr::get($this->_changed, $field);
}

public check( [ Validation $extra_validation = NULL ] ) (defined in Gleez_ORM_Core)

Parameters

• Validation $extra_validation = NULL - Validation object

Return Values

• ORM

public function check(Validation $extra_validation = NULL)
{
	// Determine if any external validation failed
	$extra_errors = ($extra_validation AND ! $extra_validation->check());

	// Always build a new validation object
	$this->_validation();

               // add custom rules to $this->_validation();
	Module::event($this->_object_name .'_validation', $this->_validation, $extra_errors);
       
	$array = $this->_validation;

	if (($this->_valid = $array->check()) === FALSE OR $extra_errors)
	{
		$exception = new ORM_Validation_Exception($this->errors_filename(), $array);

		if ($extra_errors)
		{
			// Merge any possible errors from the external object
			$exception->add_object('_external', $extra_validation);
		}
		$this->_validation = NULL; //Fixed memory leak @http://dev.kohanaframework.org/issues/4286
		throw $exception;
	}

	$this->_validation = NULL; //Fixed memory leak @http://dev.kohanaframework.org/issues/4286
	return $this;
}

public clear( ) (defined in Gleez_ORM_Core)

Tags

• Chainable -

Return Values

• ORM

public function clear()
{
	// Create an array with all the columns set to NULL
	$values = array_combine(array_keys($this->_table_columns), array_fill(0, count($this->_table_columns), NULL));

	// Replace the object and reset the object status
	$this->_object = $this->_changed = $this->_related = $this->_original_values = array();

	// Replace the current object with an empty one
	$this->_load_values($values);

	// Reset primary key
	$this->_primary_key_value = NULL;

	$this->reset();

	return $this;
}

public count_all( ) (defined in Gleez_ORM_Core)

Return Values

• integer

public function count_all()
{
	$selects = array();

	foreach ($this->_db_pending as $key => $method)
	{
		if ($method['name'] == 'select')
		{
			// Ignore any selected columns for now
			$selects[] = $method;
			unset($this->_db_pending[$key]);
		}
		elseif ($method['name'] == 'order_by')
		{
			// Also, ignore order clause
			$order_by[$key] = $method; // Fix of the fix here!
			unset($this->_db_pending[$key]);
		}
	}

	if ( ! empty($this->_load_with))
	{
		foreach ($this->_load_with as $alias)
		{
			// Bind relationship
			$this->with($alias);
		}
	}

	$this->_build(Database::SELECT);

	$records = $this->_db_builder->from(array($this->_table_name, $this->_object_name))
		->select(array('COUNT("*")', 'records_found'))
		->execute($this->_db)
		->get('records_found');

	// Add back in selected columns
	//$this->_db_pending += $selects;
	$this->_db_pending = array_merge($this->_db_pending, $selects);

	if( isset($order_by) )
	{
		// Add back in order_by clause
		//$this->_db_pending += $order_by;
		$this->_db_pending = array_merge($this->_db_pending, $order_by);
	}

	$this->reset();

	// Return the total number of records in a table
	return $records;
}

public created_column( ) (defined in Gleez_ORM_Core)

public function created_column()
{
	return $this->_created_column;
}

public dataTables( ) (defined in Gleez_ORM_Core)

Return Values

• object - DataTables

public function dataTables(array $columns = NULL)
{
	if ( ! empty($columns) )
	{
		$this->_datatables = DataTables::factory($this)->columns($columns)->execute();
	}
	
	return $this->_datatables;
}

public delete( ) (defined in Gleez_ORM_Core)

Tags

• Chainable -

Return Values

• ORM

public function delete()
{
	if ( ! $this->_loaded)
		throw new Kohana_Exception('Cannot delete :model model because it is not loaded.', array(':model' => $this->_object_name));

	// Use primary key value
	$id = $this->pk();

	$this->before_delete($id);
               Module::event($this->_object_name .'_predelete', $this);

	// Delete the object
	DB::delete($this->_table_name)
		->where($this->_primary_key, '=', $id)
		->execute($this->_db);

	$this->after_delete($id);
               Module::event($this->_object_name .'_delete', $this);
       
	return $this->clear();
}

public delete_all( ) (defined in Gleez_ORM_Core)

Tags

• Chainable -

Return Values

• ORM

public function delete_all()
{
	if ( $this->_loaded)
		throw new Kohana_Exception('Cannot delete all :model model because it is loaded.', array(':model' => $this->_object_name));
       
               Module::event($this->_object_name .'_pre_delete_all', $this);
       
	$this->_build(ORM::DELETE);
	$this->_db_builder->execute($this->_db);

               Module::event($this->_object_name .'_delete_all', $this);
       
	return $this->clear();
}

public distinct( boolean $value ) (defined in Gleez_ORM_Core)

Parameters

• boolean $value required - Enable or disable distinct columns

Return Values

• $this

public function distinct($value)
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'distinct',
		'args' => array($value),
	);

	return $this;
}

public errors_filename( ) (defined in Gleez_ORM_Core)

public function errors_filename()
{
	return $this->_errors_filename;
}

public static factory( string $model [, mixed $id = NULL ] ) (defined in Gleez_ORM_Core)

Parameters

• string $model required - Model name
• mixed $id = NULL - Parameter for find()

Tags

• Chainable -

Return Values

• ORM

public static function factory($model, $id = NULL)
{
	// Set class name
	$model = 'Model_'.ucfirst($model);

	return new $model($id);
}

public find( ) (defined in Gleez_ORM_Core)

Tags

• Chainable -

Return Values

• ORM

public function find()
{
	if ($this->_loaded)
		throw new Kohana_Exception('Method find() cannot be called on loaded objects');

	if ( ! empty($this->_load_with))
	{
		foreach ($this->_load_with as $alias)
		{
			// Bind auto relationships
			$this->with($alias);
		}
	}

	$this->_build(Database::SELECT);

	return $this->_load_result(FALSE);
}

public find_or_create( array $values ) (defined in Gleez_ORM_Core)

Parameters

• array $values required - $values

Tags

• Throws - ORM_Validation_Exception If the object was not found and could not be created due to validation errors

Return Values

• $this

public function find_or_create($values)
{
	// Unload any previously loaded objects
	$this->clear();

	// Attempt to find the object
	foreach ($values as $key => $value)
	{
	    $this->where($key, '=', $value);
	}
	
	$found = $this->find()->loaded();
	
	if ($found)
	{
	    return $this;
	}
	else
	{
	    $this->values($values);
	    $s = $this->save();
	    return $s;
	}
}

public from( mixed $tables ) (defined in Gleez_ORM_Core)

Parameters

• mixed $tables required - Table name or array($table, $alias) or object

Return Values

• $this

public function from($tables)
{
	$tables = func_get_args();

	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'from',
		'args' => $tables,
	);

	return $this;
}

public group_by( mixed $columns ) (defined in Gleez_ORM_Core)

Parameters

• mixed $columns required - Column name or array($column, $alias) or object

Return Values

• $this

public function group_by($columns)
{
	$columns = func_get_args();

	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'group_by',
		'args' => $columns,
	);

	return $this;
}

public has( string $alias [, mixed $far_keys = NULL ] ) (defined in Gleez_ORM_Core)

// Check if $model has the login role
$model->has('roles', ORM::factory('role', array('name' => 'login')));
// Check for the login role if you know the roles.id is 5
$model->has('roles', 5);
// Check for all of the following roles
$model->has('roles', array(1, 2, 3, 4));
// Check if $model has any roles
$model->has('roles')

Parameters

• string $alias required - Alias of the has_many "through" relationship
• mixed $far_keys = NULL - Related model, primary key, or an array of primary keys

Return Values

• Database_Result

public function has($alias, $far_keys = NULL)
{
	if ($far_keys === NULL)
	{
		return (bool) DB::select(array('COUNT("*")', 'records_found'))
			->from($this->_has_many[$alias]['through'])
			->where($this->_has_many[$alias]['foreign_key'], '=', $this->pk())
			->execute($this->_db)->get('records_found');
	}

	$far_keys = ($far_keys instanceof ORM) ? $far_keys->pk() : $far_keys;

	// We need an array to simplify the logic
	$far_keys = (array) $far_keys;

	// Nothing to check if the model isn't loaded or we don't have any far_keys
	if ( ! $far_keys OR ! $this->_loaded)
		return FALSE;

	$count = (int) DB::select(array('COUNT("*")', 'records_found'))
		->from($this->_has_many[$alias]['through'])
		->where($this->_has_many[$alias]['foreign_key'], '=', $this->pk())
		->where($this->_has_many[$alias]['far_key'], 'IN', $far_keys)
		->execute($this->_db)->get('records_found');

	// Rows found need to match the rows searched
	return $count === count($far_keys);
}

public has_many( ) (defined in Gleez_ORM_Core)

public function has_many()
{
	return $this->_has_many;
}

public has_many_keys( ) (defined in Gleez_ORM_Core)

public function has_many_keys()
{
	return $this->_has_many_keys;
}

public has_one( ) (defined in Gleez_ORM_Core)

public function has_one()
{
	return $this->_has_one;
}

public having( mixed $column , string $op [, mixed $value = NULL ] ) (defined in Gleez_ORM_Core)

Parameters

• mixed $column required - Column name or array($column, $alias) or object
• string $op required - Logic operator
• mixed $value = NULL - Column value

Return Values

• $this

public function having($column, $op, $value = NULL)
{
	return $this->and_having($column, $op, $value);
}

public having_close( ) (defined in Gleez_ORM_Core)

Return Values

• $this

public function having_close()
{
	return $this->and_having_close();
}

public having_open( ) (defined in Gleez_ORM_Core)

Return Values

• $this

public function having_open()
{
	return $this->and_having_open();
}

public join( mixed $table [, string $type = NULL ] ) (defined in Gleez_ORM_Core)

Parameters

• mixed $table required - Column name or array($column, $alias) or object
• string $type = NULL - Join type (LEFT, RIGHT, INNER, etc)

Return Values

• $this

public function join($table, $type = NULL)
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'join',
		'args' => array($table, $type),
	);

	return $this;
}

public last_query( ) (defined in Gleez_ORM_Core)

Return Values

• string

public function last_query()
{
	return $this->_db->last_query;
}

public limit( integer $number ) (defined in Gleez_ORM_Core)

Parameters

• integer $number required - Maximum results to return

Return Values

• $this

public function limit($number)
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'limit',
		'args' => array($number),
	);

	return $this;
}

public list_columns( ) (defined in Gleez_ORM_Core)

Return Values

• array

public function list_columns()
{
	// Proxy to database
	return $this->_db->list_columns($this->_table_name);
}

public load_with( ) (defined in Gleez_ORM_Core)

public function load_with()
{
	return $this->_load_with;
}

public loaded( ) (defined in Gleez_ORM_Core)

public function loaded()
{
	return $this->_loaded;
}

public my_on( mixed $c1 , string $op , mixed $c2 ) (defined in Gleez_ORM_Core)

Parameters

• mixed $c1 required - Column name or array($column, $alias) or object
• string $op required - Logic operator
• mixed $c2 required - Column name or array($column, $alias) or object

Return Values

• $this

public function my_on($c1, $op, $c2)
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'join_and',
		'args' => array($c1, $op, $c2),
	);

	return $this;
}

public object( ) (defined in Gleez_ORM_Core)

public function object()
{
	return $this->_object;
}

public object_name( ) (defined in Gleez_ORM_Core)

public function object_name()
{
	return $this->_object_name;
}

public object_plural( ) (defined in Gleez_ORM_Core)

public function object_plural()
{
	return $this->_object_plural;
}

public offset( integer $number ) (defined in Gleez_ORM_Core)

Parameters

• integer $number required - Starting result number

Return Values

• $this

public function offset($number)
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'offset',
		'args' => array($number),
	);

	return $this;
}

public on( mixed $c1 , string $op , mixed $c2 ) (defined in Gleez_ORM_Core)

Parameters

• mixed $c1 required - Column name or array($column, $alias) or object
• string $op required - Logic operator
• mixed $c2 required - Column name or array($column, $alias) or object

Return Values

• $this

public function on($c1, $op, $c2)
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'on',
		'args' => array($c1, $op, $c2),
	);

	return $this;
}

public or_having( mixed $column , string $op [, mixed $value = NULL ] ) (defined in Gleez_ORM_Core)

Parameters

• mixed $column required - Column name or array($column, $alias) or object
• string $op required - Logic operator
• mixed $value = NULL - Column value

Return Values

• $this

public function or_having($column, $op, $value = NULL)
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'or_having',
		'args' => array($column, $op, $value),
	);

	return $this;
}

public or_having_close( ) (defined in Gleez_ORM_Core)

Return Values

• $this

public function or_having_close()
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'or_having_close',
		'args' => array(),
	);

	return $this;
}

public or_having_open( ) (defined in Gleez_ORM_Core)

Return Values

• $this

public function or_having_open()
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'or_having_open',
		'args' => array(),
	);

	return $this;
}

public or_where( mixed $column , string $op , mixed $value ) (defined in Gleez_ORM_Core)

Parameters

• mixed $column required - Column name or array($column, $alias) or object
• string $op required - Logic operator
• mixed $value required - Column value

Return Values

• $this

public function or_where($column, $op, $value)
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'or_where',
		'args' => array($column, $op, $value),
	);

	return $this;
}

public or_where_close( ) (defined in Gleez_ORM_Core)

Return Values

• $this

public function or_where_close()
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'or_where_close',
		'args' => array(),
	);

	return $this;
}

public or_where_open( ) (defined in Gleez_ORM_Core)

Return Values

• $this

public function or_where_open()
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'or_where_open',
		'args' => array(),
	);

	return $this;
}

public order_by( mixed $column [, string $direction = NULL ] ) (defined in Gleez_ORM_Core)

Parameters

• mixed $column required - Column name or array($column, $alias) or object
• string $direction = NULL - Direction of sorting

Return Values

• $this

public function order_by($column, $direction = NULL)
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'order_by',
		'args' => array($column, $direction),
	);

	return $this;
}

public original_values( ) (defined in Gleez_ORM_Core)

public function original_values()
{
	return $this->_original_values;
}

public param( string $param , mixed $value ) (defined in Gleez_ORM_Core)

Parameters

• string $param required - Parameter key to replace
• mixed $value required - Value to use

Return Values

• $this

public function param($param, $value)
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'param',
		'args' => array($param, $value),
	);

	return $this;
}

public pk( ) (defined in Gleez_ORM_Core)

Return Values

• mixed - Primary key

public function pk()
{
	return $this->_primary_key_value;
}

public primary_key( ) (defined in Gleez_ORM_Core)

public function primary_key()
{
	return $this->_primary_key;
}

public reload( ) (defined in Gleez_ORM_Core)

Tags

• Chainable -

Return Values

• ORM

public function reload()
{
	$primary_key = $this->pk();

	// Replace the object and reset the object status
	$this->_object = $this->_changed = $this->_related = $this->_original_values = array();

	// Only reload the object if we have one to reload
	if ($this->_loaded)
		return $this->clear()
			->where($this->_object_name.'.'.$this->_primary_key, '=', $primary_key)
			->find();
	else
		return $this->clear();
}

public reload_columns( [ boolean $force = bool FALSE ] ) (defined in Gleez_ORM_Core)

Parameters

• boolean $force = bool FALSE - Force reloading

Tags

• Chainable -

Return Values

• ORM

public function reload_columns($force = FALSE)
{
	if ($force === TRUE OR empty($this->_table_columns))
	{
		if (isset(ORM::$_column_cache[$this->_object_name]))
		{
			// Use cached column information
			$this->_table_columns = ORM::$_column_cache[$this->_object_name];
		}
		else
		{
			// Grab column information from database
			$this->_table_columns = $this->list_columns(TRUE);

			// Load column cache
			ORM::$_column_cache[$this->_object_name] = $this->_table_columns;
		}
	}

	return $this;
}

public remove( string $alias [, mixed $far_keys = NULL ] ) (defined in Gleez_ORM_Core)

// Remove a role using a model instance
$model->remove('roles', ORM::factory('role', array('name' => 'login')));
// Remove the role knowing the primary key
$model->remove('roles', 5);
// Remove multiple roles (for example, from checkboxes on a form)
$model->remove('roles', array(1, 2, 3, 4));
// Remove all related roles
$model->remove('roles');

Parameters

• string $alias required - Alias of the has_many "through" relationship
• mixed $far_keys = NULL - Related model, primary key, or an array of primary keys

Return Values

• ORM

public function remove($alias, $far_keys = NULL)
{
	$far_keys = ($far_keys instanceof ORM) ? $far_keys->pk() : $far_keys;

	$query = DB::delete($this->_has_many[$alias]['through'])
		->where($this->_has_many[$alias]['foreign_key'], '=', $this->pk());

	if ($far_keys !== NULL)
	{
		// Remove all the relationships in the array
		$query->where($this->_has_many[$alias]['far_key'], 'IN', (array) $far_keys);
	}

	$query->execute($this->_db);

	return $this;
}

public reset( [ bool $next = bool TRUE ] ) (defined in Gleez_ORM_Core)

Parameters

• bool $next = bool TRUE - Pass FALSE to avoid resetting on the next call

Return Values

• ORM

public function reset($next = TRUE)
{
	if ($next AND $this->_db_reset)
	{
		$this->_db_pending   = array();
		$this->_db_applied   = array();
		$this->_db_builder   = NULL;
		$this->_with_applied = array();
	}

	// Reset on the next call?
	$this->_db_reset = $next;

	return $this;
}

public save( [ Validation $validation = NULL ] ) (defined in Gleez_ORM_Core)

Parameters

• Validation $validation = NULL - Validation object

Tags

• Chainable -

Return Values

• ORM

public function save(Validation $validation = NULL)
{
	return $this->loaded() ? $this->update($validation) : $this->create($validation);
}

public saved( ) (defined in Gleez_ORM_Core)

public function saved()
{
	return $this->_saved;
}

public select( [ mixed $columns = NULL ] ) (defined in Gleez_ORM_Core)

Parameters

• mixed $columns = NULL - Column name or array($column, $alias) or object

Return Values

• $this

public function select($columns = NULL)
{
	$columns = func_get_args();

	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'select',
		'args' => $columns,
	);

	return $this;
}

public serialize( ) (defined in Gleez_ORM_Core)

Return Values

• array

public function serialize()
{
	// Store only information about the object
	foreach (array('_primary_key_value', '_object', '_changed', '_loaded', '_saved', '_sorting', '_original_values', '_ignored_columns') as $var)
	{
		$data[$var] = $this->{$var};
	}

	return serialize($data);
}

public set( string $column , mixed $value ) (defined in Gleez_ORM_Core)

Parameters

• string $column required - Column name
• mixed $value required - Column value

Return Values

• void

public function set($column, $value)
{
               if ( ! isset($this->_object_name))
               {
                       // Object not yet constructed, so we're loading data from a database call cast
                       $this->_cast_data[$column] = $value;
                       
                       return $this;
               }
       
	if (in_array($column, $this->_serialize_columns))
	{
		$value = $this->_serialize_value($value);
	}

	if (array_key_exists($column, $this->_ignored_columns))
	{
		// No processing for ignored columns, just store it
		$this->_object[$column] = $value;
	}
	elseif (array_key_exists($column, $this->_object))
	{
		// Filter the data
		$value = $this->run_filter($column, $value);

		// See if the data really changed
		if ($value !== $this->_object[$column])
		{
			$this->_object[$column] = $value;

			// Data has changed
			$this->_changed[$column] = $column;

			// Object is no longer saved or valid
			$this->_saved = $this->_valid = FALSE;
		}
	}
	elseif (isset($this->_belongs_to[$column]))
	{
		// Update related object itself
		$this->_related[$column] = $value;

		// Update the foreign key of this model
		$this->_object[$this->_belongs_to[$column]['foreign_key']] = $value->pk();

		$this->_changed[$column] = $this->_belongs_to[$column]['foreign_key'];
	}
	else
	{
		throw new Kohana_Exception('The :property: property does not exist in the :class: class',
			array(':property:' => $column, ':class:' => get_class($this)));
	}

	return $this;
}

public table_columns( ) (defined in Gleez_ORM_Core)

public function table_columns()
{
	return $this->_table_columns;
}

public table_name( ) (defined in Gleez_ORM_Core)

public function table_name()
{
	return $this->_table_name;
}

public unique( string $field , mixed $value ) (defined in Gleez_ORM_Core)

Parameters

• string $field required - The field to check for uniqueness
• mixed $value required - The value to check for uniqueness

Return Values

• bool - Whteher the value is unique

public function unique($field, $value)
{
	$model = ORM::factory($this->object_name())
		->where($field, '=', $value)
		->find();

	if ($this->loaded())
	{
		return ( ! ($model->loaded() AND $model->pk() != $this->pk()));
	}

	return ( ! $model->loaded());
}

public unserialize( string $data ) (defined in Gleez_ORM_Core)

Parameters

• string $data required - String for unserialization

Return Values

• void

public function unserialize($data)
{
	// Initialize model
	$this->_initialize();

	foreach (unserialize($data) as $name => $var)
	{
		$this->{$name} = $var;
	}

	if ($this->_reload_on_wakeup === TRUE)
	{
		// Reload the object
		$this->reload();
	}
}

public update( [ Validation $validation = NULL ] ) (defined in Gleez_ORM_Core)

Parameters

• Validation $validation = NULL - Validation object

Tags

• Chainable -

Return Values

• ORM

public function update(Validation $validation = NULL)
{
	if ( ! $this->_loaded)
		throw new Kohana_Exception('Cannot update :model model because it is not loaded.', array(':model' => $this->_object_name));

	Module::event($this->_object_name .'_prevalid', $this, $validation);

	// Run validation if the model isn't valid or we have additional validation rules.
	if ( ! $this->_valid OR $validation)
	{
		$this->check($validation);
	}

	if (empty($this->_changed))
	{
		return $this;
	}

	$this->before_save();
               Module::event($this->_object_name .'_presave', $this, $validation);

	$data = array();
	foreach ($this->_changed as $column)
	{
		// Compile changed data
		$data[$column] = $this->_object[$column];
	}

	if (is_array($this->_updated_column))
	{
		// Fill the updated column
		$column = $this->_updated_column['column'];
		$format = $this->_updated_column['format'];

		$data[$column] = $this->_object[$column] = ($format === TRUE) ? time() : date($format);
	}

	// Use primary key value
	$id = $this->pk();

	// Update a single record
	DB::update($this->_table_name)
		->set($data)
		->where($this->_primary_key, '=', $id)
		->execute($this->_db);

	if (isset($data[$this->_primary_key]))
	{
		// Primary key was changed, reflect it
		$this->_primary_key_value = $data[$this->_primary_key];
	}

	// Object has been saved
	$this->_saved  = $this->_updated = TRUE;

	// All changes have been saved
	$this->_changed = array();
	$this->_original_values = $this->_object;

	$this->after_save();
               Module::event($this->_object_name .'_save', $this);

	return $this;
}

public updated( ) (defined in Gleez_ORM_Core)

public function updated()
{
	return $this->_updated;
}

public updated_column( ) (defined in Gleez_ORM_Core)

public function updated_column()
{
	return $this->_updated_column;
}

public using( string $columns ) (defined in Gleez_ORM_Core)

Parameters

• string $columns required - Column name

Return Values

• $this

public function using($columns)
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'using',
		'args' => array($columns),
	);

	return $this;
}

public validation( ) (defined in Gleez_ORM_Core)

public function validation()
{
	if ( ! isset($this->_validation))
	{
		// Initialize the validation object
		$this->_validation();
	}

	return $this->_validation;
}

public values( array $values [, array $expected = NULL ] ) (defined in Gleez_ORM_Core)

Parameters

• array $values required - Array of column => val
• array $expected = NULL - Array of keys to take from $values

Return Values

• ORM

public function values(array $values, array $expected = NULL)
{
	// Default to expecting everything except the primary key
	if ($expected === NULL)
	{
		$expected = array_keys($this->_table_columns);

		// Don't set the primary key by default
		unset($values[$this->_primary_key]);
	}
       
               if ( ! empty($this->_ignored_columns) )
	{
		// merge the columns needed to process
		$expected = array_merge($expected, array_keys($this->_ignored_columns) );
	}
       
	foreach ($expected as $key => $column)
	{
		if (is_string($key))
		{
			// isset() fails when the value is NULL (we want it to pass)
			if ( ! array_key_exists($key, $values))
				continue;

			// Try to set values to a related model
			$this->{$key}->values($values[$key], $column);
		}
		else
		{
			// isset() fails when the value is NULL (we want it to pass)
			if ( ! array_key_exists($column, $values))
				continue;

			// Update the column, respects __set()
			$this->$column = $values[$column];
		}
	}

	return $this;
}

public where( mixed $column , string $op , mixed $value ) (defined in Gleez_ORM_Core)

Parameters

• mixed $column required - Column name or array($column, $alias) or object
• string $op required - Logic operator
• mixed $value required - Column value

Return Values

• $this

public function where($column, $op, $value)
{
	// Add pending database call which is executed after query type is determined
	$this->_db_pending[] = array(
		'name' => 'where',
		'args' => array($column, $op, $value),
	);

	return $this;
}

public where_close( ) (defined in Gleez_ORM_Core)

Return Values

• $this

public function where_close()
{
	return $this->and_where_close();
}

public where_open( ) (defined in Gleez_ORM_Core)

Return Values

• $this

public function where_open()
{
	return $this->and_where_open();
}

public with( string $target_path ) (defined in Gleez_ORM_Core)

Parameters

• string $target_path required - Target model to bind to

Return Values

• void

public function with($target_path)
{
	if (isset($this->_with_applied[$target_path]))
	{
		// Don't join anything already joined
		return $this;
	}

	// Split object parts
	$aliases = explode(':', $target_path);
	$target = $this;
	foreach ($aliases as $alias)
	{
		// Go down the line of objects to find the given target
		$parent = $target;
		$target = $parent->_related($alias);

		if ( ! $target)
		{
			// Can't find related object
			return $this;
		}
	}

	// Target alias is at the end
	$target_alias = $alias;

	// Pop-off top alias to get the parent path (user:photo:tag becomes user:photo - the parent table prefix)
	array_pop($aliases);
	$parent_path = implode(':', $aliases);

	if (empty($parent_path))
	{
		// Use this table name itself for the parent path
		$parent_path = $this->_object_name;
	}
	else
	{
		if ( ! isset($this->_with_applied[$parent_path]))
		{
			// If the parent path hasn't been joined yet, do it first (otherwise LEFT JOINs fail)
			$this->with($parent_path);
		}
	}

	// Add to with_applied to prevent duplicate joins
	$this->_with_applied[$target_path] = TRUE;

	// Use the keys of the empty object to determine the columns
	foreach (array_keys($target->_object) as $column)
	{
		$name = $target_path.'.'.$column;
		$alias = $target_path.':'.$column;

		// Add the prefix so that load_result can determine the relationship
		$this->select(array($name, $alias));
	}

	if (isset($parent->_belongs_to[$target_alias]))
	{
		// Parent belongs_to target, use target's primary key and parent's foreign key
		$join_col1 = $target_path.'.'.$target->_primary_key;
		$join_col2 = $parent_path.'.'.$parent->_belongs_to[$target_alias]['foreign_key'];
	}
	else
	{
		// Parent has_one target, use parent's primary key as target's foreign key
		$join_col1 = $parent_path.'.'.$parent->_primary_key;
		$join_col2 = $target_path.'.'.$parent->_has_one[$target_alias]['foreign_key'];
	}

	// Join the related object into the result
	$this->join(array($target->_table_name, $target_path), 'LEFT')->on($join_col1, '=', $join_col2);

	return $this;
}

protected _build( integer $type ) (defined in Gleez_ORM_Core)

Parameters

• integer $type required - Type of Database query

Return Values

• ORM

protected function _build($type)
{
	// Construct new builder object based on query type
	switch ($type)
	{
		case Database::SELECT:
			$this->_db_builder = DB::select();
		break;
		case Database::UPDATE:
			$this->_db_builder = DB::update(array($this->_table_name, $this->_object_name));
		break;
		case Database::DELETE:
			$this->_db_builder = DB::delete(array($this->_table_name, $this->_object_name));
		break;
		case ORM::DELETE:
			$this->_db_builder = DB::delete($this->_table_name);
	}

	// Process pending database method calls
	foreach ($this->_db_pending as $method)
	{
		$name = $method['name'];
		$args = $method['args'];

		$this->_db_applied[$name] = $name;

		call_user_func_array(array($this->_db_builder, $name), $args);
	}

	return $this;
}

protected _build_select( ) (defined in Gleez_ORM_Core)

Return Values

• array - Columns to select

protected function _build_select()
{
        $columns = array();
        
        foreach ($this->_table_columns as $column => $_)
        {
        $columns[] = array($this->_object_name.'.'.$column, $column);
        }
        
        return $columns;
}

protected _initialize( ) (defined in Gleez_ORM_Core)

Return Values

• void

protected function _initialize()
{
	// Set the object name and plural name
	$this->_object_name = strtolower(substr(get_class($this), 6));

	// Check if this model has already been initialized
	if ( ! $init = Arr::get(ORM::$_init_cache, $this->_object_name, FALSE))
	{
		$init = array(
			'_belongs_to'     => array(),
			'_has_one'        => array(),
			'_has_many'   	  => array(),
			'_has_many_keys'  => array(),
		);

		// Set the object plural name if none predefined
		if ( ! isset($this->_object_plural))
		{
			$init['_object_plural'] = Inflector::plural($this->_object_name);
		}

		if ( ! $this->_errors_filename)
		{
			$init['_errors_filename'] = $this->_object_name;
		}

		if ( ! is_object($this->_db))
		{
			// Get database instance
			$init['_db'] = Database::instance($this->_db_group);
		}

		if (empty($this->_table_name))
		{
			// Table name is the same as the object name
			$init['_table_name'] = $this->_object_name;

			if ($this->_table_names_plural === TRUE)
			{
				// Make the table name plural
				$init['_table_name'] = Arr::get($init, '_object_plural', $this->_object_plural);
			}
		}

		if ( ! empty($this->_ignored_columns))
		{
			// Optimize for performance
			$init['_ignored_columns']= array_combine($this->_ignored_columns, $this->_ignored_columns);
		}

		$defaults = array();

		foreach ($this->_belongs_to as $alias => $details)
		{
			$defaults['model'] = $alias;
			$defaults['foreign_key'] = $alias.$this->_foreign_key_suffix;

			$init['_belongs_to'][$alias] = array_merge($defaults, $details);
		}

		foreach ($this->_has_one as $alias => $details)
		{
			$defaults['model'] = $alias;
			$defaults['foreign_key'] = $this->_object_name.$this->_foreign_key_suffix;

			$init['_has_one'][$alias] = array_merge($defaults, $details);
		}

		foreach ($this->_has_many as $alias => $details)
		{
			$defaults['model'] = Inflector::singular($alias);
			$defaults['foreign_key'] = $this->_object_name.$this->_foreign_key_suffix;
			$defaults['through'] = NULL;
			$defaults['far_key'] = Inflector::singular($alias).$this->_foreign_key_suffix;
		
			$init['_has_many'][$alias] = array_merge($defaults, $details);
		}

		foreach ($this->_has_many_keys as $alias => $details)
		{
			$defaults['model'] = Inflector::singular($alias);
			$defaults['foreign_key'] = array($this->_object_name.$this->_foreign_key_suffix);
			$defaults['far_key'] = array(Inflector::singular($alias).$this->_foreign_key_suffix);
		
			$init['_has_many_keys'][$alias] = array_merge($defaults, $details);
		}
		
		ORM::$_init_cache[$this->_object_name] = $init;
	}

	// Assign initialized properties to the current object
	foreach ($init as $property => $value)
	{
		$this->{$property} = $value;
	}

	// Load column information
	$this->reload_columns();

	// Clear initial model state
	$this->clear();
}

protected _load_result( [ bool $multiple = bool FALSE ] ) (defined in Gleez_ORM_Core)

Parameters

• bool $multiple = bool FALSE - Return an iterator or load a single row

Tags

• Chainable -

Return Values

• ORM|Database_Result

protected function _load_result($multiple = FALSE)
{
	$this->_db_builder->from(array($this->_table_name, $this->_object_name));

	if ($multiple === FALSE)
	{
		// Only fetch 1 record
		$this->_db_builder->limit(1);
	}

	// Select all columns by default
	$this->_db_builder->select($this->_object_name.'.*');

	if ( ! isset($this->_db_applied['order_by']) AND ! empty($this->_sorting))
	{
		foreach ($this->_sorting as $column => $direction)
		{
			if (strpos($column, '.') === FALSE)
			{
				// Sorting column for use in JOINs
				$column = $this->_object_name.'.'.$column;
			}

			$this->_db_builder->order_by($column, $direction);
		}
	}

	if ($multiple === TRUE)
	{
		// Return database iterator casting to this object type
		$result = $this->_db_builder->as_object(get_class($this))->execute($this->_db);

		$this->reset();

		return $result;
	}
	else
	{
		// Load the result as an associative array
		$result = $this->_db_builder->as_assoc()->execute($this->_db);

		$this->reset();

		if ($result->count() === 1)
		{
			// Load object values
			$this->_load_values($result->current());
		}
		else
		{
			// Clear the object, nothing was found
			$this->clear();
		}

		return $this;
	}
}

protected _load_values( array $values ) (defined in Gleez_ORM_Core)

Parameters

• array $values required - Values to load

Tags

• Chainable -

Return Values

• ORM

protected function _load_values(array $values)
{
	if (array_key_exists($this->_primary_key, $values))
	{
		if ($values[$this->_primary_key] !== NULL)
		{
			// Flag as loaded and valid
			$this->_loaded = $this->_valid = TRUE;

			// Store primary key
			$this->_primary_key_value = $values[$this->_primary_key];
		}
		else
		{
			// Not loaded or valid
			$this->_loaded = $this->_valid = FALSE;
		}
	}

	// Related objects
	$related = array();

	foreach ($values as $column => $value)
	{
		if (strpos($column, ':') === FALSE)
		{
			// Load the value to this model
			$this->_object[$column] = $value;
		}
		else
		{
			// Column belongs to a related model
			list ($prefix, $column) = explode(':', $column, 2);

			$related[$prefix][$column] = $value;
		}
	}

	if ( ! empty($related))
	{
		foreach ($related as $object => $values)
		{
			// Load the related objects with the values in the result
			$this->_related($object)->_load_values($values);
		}
	}

	if ($this->_loaded)
	{
		// Store the object in its original state
		$this->_original_values = $this->_object;
	}

	return $this;
}

protected _related( string $alias ) (defined in Gleez_ORM_Core)

Parameters

• string $alias required - Alias name

Return Values

• ORM

protected function _related($alias)
{
	if (isset($this->_related[$alias]))
	{
		return $this->_related[$alias];
	}
	elseif (isset($this->_has_one[$alias]))
	{
		return $this->_related[$alias] = ORM::factory($this->_has_one[$alias]['model']);
	}
	elseif (isset($this->_belongs_to[$alias]))
	{
		return $this->_related[$alias] = ORM::factory($this->_belongs_to[$alias]['model']);
	}
	else
	{
		return FALSE;
	}
}

protected _serialize_value( ) (defined in Gleez_ORM_Core)

protected function _serialize_value($value)
{
	return json_encode($value);
}

protected _unserialize_value( ) (defined in Gleez_ORM_Core)

protected function _unserialize_value($value)
{
	return json_decode($value);
}

protected _validation( ) (defined in Gleez_ORM_Core)

Return Values

• void

protected function _validation()
{
	// Build the validation object with its rules
	$this->_validation = Validation::factory($this->_object)
		->bind(':model', $this)
		->bind(':original_values', $this->_original_values)
		->bind(':changed', $this->_changed);

	foreach ($this->rules() as $field => $rules)
	{
		$this->_validation->rules($field, $rules);
	}

	// Use column names by default for labels
	$columns = array_keys($this->_table_columns);

	// Merge user-defined labels
	$labels = array_merge(array_combine($columns, $columns), $this->labels());

	foreach ($labels as $field => $label)
	{
		$this->_validation->label($field, $label);
	}
}

protected after_delete( ) (defined in Gleez_ORM_Core)

protected function after_delete($id){}

protected after_load( ) (defined in Gleez_ORM_Core)

protected function after_load(){}

protected after_save( ) (defined in Gleez_ORM_Core)

protected function after_save(){}

protected before_delete( ) (defined in Gleez_ORM_Core)

protected function before_delete($id){}

protected before_load( ) (defined in Gleez_ORM_Core)

protected function before_load(){}

protected before_save( ) (defined in Gleez_ORM_Core)

protected function before_save(){}

protected run_filter( string $field , string $value ) (defined in Gleez_ORM_Core)

Parameters

• string $field required - The column name
• string $value required - The value to filter

Return Values

• string

protected function run_filter($field, $value)
{
	$filters = $this->filters();

	// Get the filters for this column
	$wildcards = empty($filters[TRUE]) ? array() : $filters[TRUE];

	// Merge in the wildcards
	$filters = empty($filters[$field]) ? $wildcards : array_merge($wildcards, $filters[$field]);

	// Bind the field name and model so they can be used in the filter method
	$_bound = array
	(
		':field' => $field,
		':model' => $this,
	);

	foreach ($filters as $array)
	{
		// Value needs to be bound inside the loop so we are always using the
		// version that was modified by the filters that already ran
		$_bound[':value'] = $value;

		// Filters are defined as array($filter, $params)
		$filter = $array[0];
		$params = Arr::get($array, 1, array(':value'));

		foreach ($params as $key => $param)
		{
			if (is_string($param) AND array_key_exists($param, $_bound))
			{
				// Replace with bound value
				$params[$key] = $_bound[$param];
			}
		}

		if (is_array($filter) OR ! is_string($filter))
		{
			// This is either a callback as an array or a lambda
			$value = call_user_func_array($filter, $params);
		}
		elseif (strpos($filter, '::') === FALSE)
		{
			// Use a function call
			$function = new ReflectionFunction($filter);

			// Call $function($this[$field], $param, ...) with Reflection
			$value = $function->invokeArgs($params);
		}
		else
		{
			// Split the class and method of the rule
			list($class, $method) = explode('::', $filter, 2);

			// Use a static method call
			$method = new ReflectionMethod($class, $method);

			// Call $Class::$method($this[$field], $param, ...) with Reflection
			$value = $method->invokeArgs(NULL, $params);
		}
	}

	return $value;
}