1. class
  2. ActiveRecord
  3. \
  4. AbstractRelationship

AbstractRelationship

class AbstractRelationship implements InterfaceRelationship (View source)

Abstract class that all relationships must extend from.

Properties

string $attribute_name Name to be used that will trigger call to the relationship.
string $class_name Class name of the associated model.
string $foreign_key Name of the foreign key.
protected array $options Options of the relationship.
protected boolean $poly_relationship Is the relationship single or multi.
static protected array $valid_association_options List of valid options for relationships.

Methods

__construct($options = array())

Constructs a relationship.

get_table()

No description

bool
is_poly()

What is this relationship's cardinality?

void
query_and_attach_related_models_eagerly(Table $table, $models, $attributes, $includes = array(), $query_keys = array(), $model_values_keys = array())

Eagerly loads relationships for $models.

build_association(Model $model, $attributes = array(), $guard_attributes = true)

Creates a new instance of specified {@link Model} with the attributes pre-loaded.

create_association(Model $model, $attributes = array(), $guard_attributes = true)

Creates a new instance of {@link Model} and invokes save.

append_record_to_associate(Model $associate, Model $record)

No description

merge_association_options($options)

No description

unset_non_finder_options($options)

No description

void
set_inferred_class_name()

Infers the $this->class_name based on $this->attribute_name.

set_class_name($class_name)

No description

create_conditions_from_keys(Model $model, $condition_keys = array(), $value_keys = array())

No description

string
construct_inner_join_sql(Table $from_table, bool $using_through = false, string $alias = null)

Creates INNER JOIN SQL for associations.

load(Model $model)

This will load the related model data.

Details

at line 75
__construct($options = array())

Constructs a relationship.

Parameters

$options

at line 99
protected get_table()

at line 109
bool is_poly()

What is this relationship's cardinality?

Return Value

bool

Eagerly loads relationships for $models.

This method takes an array of models, collects PK or FK (whichever is needed for relationship), then queries the related table by PK/FK and attaches the array of returned relationships to the appropriately named relationship on $models.

Parameters

Table $table
$models array of model objects
$attributes array of attributes from $models
$includes array of eager load directives
$query_keys -> key(s) to be queried for on included/related table
$model_values_keys -> key(s)/value(s) to be used in query from model which is including

Return Value

void

at line 222
build_association(Model $model, $attributes = array(), $guard_attributes = true)

Creates a new instance of specified {@link Model} with the attributes pre-loaded.

Parameters

Model $model
$attributes
$guard_attributes

at line 235
create_association(Model $model, $attributes = array(), $guard_attributes = true)

Creates a new instance of {@link Model} and invokes save.

Parameters

Model $model
$attributes
$guard_attributes

at line 242
protected append_record_to_associate(Model $associate, Model $record)

Parameters

Model $associate
Model $record

at line 254
protected merge_association_options($options)

Parameters

$options

at line 265
protected unset_non_finder_options($options)

Parameters

$options

at line 283
protected void set_inferred_class_name()

Infers the $this->class_name based on $this->attribute_name.

Will try to guess the appropriate class by singularizing and uppercasing $this->attribute_name.

Return Value

void

See also

attribute_name

at line 289
protected set_class_name($class_name)

Parameters

$class_name

at line 303
protected create_conditions_from_keys(Model $model, $condition_keys = array(), $value_keys = array())

Parameters

Model $model
$condition_keys
$value_keys

at line 331
string construct_inner_join_sql(Table $from_table, bool $using_through = false, string $alias = null)

Creates INNER JOIN SQL for associations.

Parameters

Table $from_table the table used for the FROM SQL statement
bool $using_through is this a THROUGH relationship?
string $alias a table alias for when a table is being joined twice

Return Value

string SQL INNER JOIN fragment

at line 384
abstract load(Model $model)

This will load the related model data.

Parameters

Model $model The model this relationship belongs to