You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
167 lines
4.2 KiB
167 lines
4.2 KiB
<?php
|
|
/**
|
|
* Fuel
|
|
*
|
|
* Fuel is a fast, lightweight, community driven PHP5 framework.
|
|
*
|
|
* @package Fuel
|
|
* @version 1.8
|
|
* @author Fuel Development Team
|
|
* @license MIT License
|
|
* @copyright 2010 - 2016 Fuel Development Team
|
|
* @link http://fuelphp.com
|
|
*/
|
|
|
|
namespace Orm;
|
|
|
|
abstract class Relation
|
|
{
|
|
/**
|
|
* @var string name of the relationship in the model_from
|
|
*/
|
|
protected $name;
|
|
|
|
/**
|
|
* @var Model classname of the parent model
|
|
*/
|
|
protected $model_from;
|
|
|
|
/**
|
|
* @var string classname of the related model
|
|
*/
|
|
protected $model_to;
|
|
|
|
/**
|
|
* @var string primary key of parent model
|
|
*/
|
|
protected $key_from = array('id');
|
|
|
|
/**
|
|
* @var string foreign key in related model
|
|
*/
|
|
protected $key_to = array();
|
|
|
|
/**
|
|
* @var array where & order_by conditions for loading this relation
|
|
*/
|
|
protected $conditions = array();
|
|
|
|
/**
|
|
* @var bool whether it's a single object or multiple
|
|
*/
|
|
protected $singular = false;
|
|
|
|
/**
|
|
* @var bool whether saving this one's model_from should cascade to save model_to
|
|
*/
|
|
protected $cascade_save = true;
|
|
|
|
/**
|
|
* @var bool whether deleting this one's model_from should cascade to delete model_to
|
|
*/
|
|
protected $cascade_delete = false;
|
|
|
|
/**
|
|
* Configures the relationship
|
|
*
|
|
* @param string $from the model that initiates the relationship
|
|
* @param string $name name of the relationship
|
|
* @param array $config config values like model_to classname, key_from & key_to
|
|
*/
|
|
abstract public function __construct($from, $name, array $config);
|
|
|
|
/**
|
|
* Should get the objects related to the given object by this relation
|
|
*
|
|
* @param Model
|
|
* @return object|array
|
|
*/
|
|
abstract public function get(Model $from);
|
|
|
|
/**
|
|
* Should get the properties as associative array with alias => property, the table alias is
|
|
* given to be included with the property
|
|
*
|
|
* @param string
|
|
* @return array
|
|
*/
|
|
public function select($table)
|
|
{
|
|
$props = call_user_func(array($this->model_to, 'properties'));
|
|
$i = 0;
|
|
$properties = array();
|
|
foreach ($props as $pk => $pv)
|
|
{
|
|
$properties[] = array($table.'.'.$pk, $table.'_c'.$i);
|
|
$i++;
|
|
}
|
|
|
|
return $properties;
|
|
}
|
|
|
|
/**
|
|
* Returns tables to join and fields to select with optional additional settings like order/where
|
|
*
|
|
* @param $alias_from
|
|
* @param $rel_name
|
|
* @param $alias_to
|
|
*
|
|
* @return array
|
|
*/
|
|
abstract public function join($alias_from, $rel_name, $alias_to);
|
|
|
|
/**
|
|
* Saves the current relationships and may cascade saving to model_to instances
|
|
*
|
|
* @param Model $model_from
|
|
* @param Model $model_to
|
|
* @param $original_model_id
|
|
* @param $parent_saved
|
|
* @param bool|null $cascade
|
|
* @internal param \Orm\instance $Model of model_from
|
|
* @internal param array|\Orm\Model $single or multiple model instances to save
|
|
* @internal param \Orm\whether $bool the model_from has been saved already
|
|
* @internal param bool|null $either uses default setting (null) or forces when true or prevents when false
|
|
*
|
|
* @return
|
|
*/
|
|
abstract public function save($model_from, $model_to, $original_model_id, $parent_saved, $cascade);
|
|
|
|
/**
|
|
* Takes the current relations and attempts to delete them when cascading is allowed or forced
|
|
*
|
|
* @param Model $model_from instance of model_from
|
|
* @param array|Model $model_to single or multiple model instances to delete
|
|
* @param bool $parent_deleted whether the model_from has been saved already
|
|
* @param null|bool $cascade either uses default setting (null) or forces when true or prevents when false
|
|
*/
|
|
abstract public function delete($model_from, $model_to, $parent_deleted, $cascade);
|
|
|
|
/**
|
|
* Allow outside access to protected properties
|
|
*
|
|
* @param $property
|
|
* @throws \FuelException Invalid relation property
|
|
* @return
|
|
*/
|
|
public function __get($property)
|
|
{
|
|
if (strncmp($property, '_', 1) == 0 or ! property_exists($this, $property))
|
|
{
|
|
throw new \FuelException('Invalid relation property: '.$property);
|
|
}
|
|
|
|
return $this->{$property};
|
|
}
|
|
|
|
/**
|
|
* Returns true if this relation is a singular relation. Eg, has_one not has_many
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_singular()
|
|
{
|
|
return $this->singular;
|
|
}
|
|
}
|