413 lines
9.6 KiB
PHP
Executable File
413 lines
9.6 KiB
PHP
Executable File
<?php namespace Illuminate\Database\Eloquent\Relations;
|
|
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\Builder;
|
|
use Illuminate\Database\Query\Expression;
|
|
use Illuminate\Database\Eloquent\Collection;
|
|
|
|
abstract class HasOneOrMany extends Relation {
|
|
|
|
/**
|
|
* The foreign key of the parent model.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $foreignKey;
|
|
|
|
/**
|
|
* The local key of the parent model.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $localKey;
|
|
|
|
/**
|
|
* Create a new has one or many relationship instance.
|
|
*
|
|
* @param \Illuminate\Database\Eloquent\Builder $query
|
|
* @param \Illuminate\Database\Eloquent\Model $parent
|
|
* @param string $foreignKey
|
|
* @param string $localKey
|
|
* @return void
|
|
*/
|
|
public function __construct(Builder $query, Model $parent, $foreignKey, $localKey)
|
|
{
|
|
$this->localKey = $localKey;
|
|
$this->foreignKey = $foreignKey;
|
|
|
|
parent::__construct($query, $parent);
|
|
}
|
|
|
|
/**
|
|
* Set the base constraints on the relation query.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function addConstraints()
|
|
{
|
|
if (static::$constraints)
|
|
{
|
|
$this->query->where($this->foreignKey, '=', $this->getParentKey());
|
|
|
|
$this->query->whereNotNull($this->foreignKey);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add the constraints for a relationship count query.
|
|
*
|
|
* @param \Illuminate\Database\Eloquent\Builder $query
|
|
* @param \Illuminate\Database\Eloquent\Builder $parent
|
|
* @return \Illuminate\Database\Eloquent\Builder
|
|
*/
|
|
public function getRelationCountQuery(Builder $query, Builder $parent)
|
|
{
|
|
if ($parent->getQuery()->from == $query->getQuery()->from)
|
|
{
|
|
return $this->getRelationCountQueryForSelfRelation($query, $parent);
|
|
}
|
|
|
|
return parent::getRelationCountQuery($query, $parent);
|
|
}
|
|
|
|
/**
|
|
* Add the constraints for a relationship count query on the same table.
|
|
*
|
|
* @param \Illuminate\Database\Eloquent\Builder $query
|
|
* @param \Illuminate\Database\Eloquent\Builder $parent
|
|
* @return \Illuminate\Database\Eloquent\Builder
|
|
*/
|
|
public function getRelationCountQueryForSelfRelation(Builder $query, Builder $parent)
|
|
{
|
|
$query->select(new Expression('count(*)'));
|
|
|
|
$tablePrefix = $this->query->getQuery()->getConnection()->getTablePrefix();
|
|
|
|
$query->from($query->getModel()->getTable().' as '.$tablePrefix.$hash = $this->getRelationCountHash());
|
|
|
|
$key = $this->wrap($this->getQualifiedParentKeyName());
|
|
|
|
return $query->where($hash.'.'.$this->getPlainForeignKey(), '=', new Expression($key));
|
|
}
|
|
|
|
/**
|
|
* Get a relationship join table hash.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getRelationCountHash()
|
|
{
|
|
return 'self_'.md5(microtime(true));
|
|
}
|
|
|
|
/**
|
|
* Set the constraints for an eager load of the relation.
|
|
*
|
|
* @param array $models
|
|
* @return void
|
|
*/
|
|
public function addEagerConstraints(array $models)
|
|
{
|
|
$this->query->whereIn($this->foreignKey, $this->getKeys($models, $this->localKey));
|
|
}
|
|
|
|
/**
|
|
* Match the eagerly loaded results to their single parents.
|
|
*
|
|
* @param array $models
|
|
* @param \Illuminate\Database\Eloquent\Collection $results
|
|
* @param string $relation
|
|
* @return array
|
|
*/
|
|
public function matchOne(array $models, Collection $results, $relation)
|
|
{
|
|
return $this->matchOneOrMany($models, $results, $relation, 'one');
|
|
}
|
|
|
|
/**
|
|
* Match the eagerly loaded results to their many parents.
|
|
*
|
|
* @param array $models
|
|
* @param \Illuminate\Database\Eloquent\Collection $results
|
|
* @param string $relation
|
|
* @return array
|
|
*/
|
|
public function matchMany(array $models, Collection $results, $relation)
|
|
{
|
|
return $this->matchOneOrMany($models, $results, $relation, 'many');
|
|
}
|
|
|
|
/**
|
|
* Match the eagerly loaded results to their many parents.
|
|
*
|
|
* @param array $models
|
|
* @param \Illuminate\Database\Eloquent\Collection $results
|
|
* @param string $relation
|
|
* @param string $type
|
|
* @return array
|
|
*/
|
|
protected function matchOneOrMany(array $models, Collection $results, $relation, $type)
|
|
{
|
|
$dictionary = $this->buildDictionary($results);
|
|
|
|
// Once we have the dictionary we can simply spin through the parent models to
|
|
// link them up with their children using the keyed dictionary to make the
|
|
// matching very convenient and easy work. Then we'll just return them.
|
|
foreach ($models as $model)
|
|
{
|
|
$key = $model->getAttribute($this->localKey);
|
|
|
|
if (isset($dictionary[$key]))
|
|
{
|
|
$value = $this->getRelationValue($dictionary, $key, $type);
|
|
|
|
$model->setRelation($relation, $value);
|
|
}
|
|
}
|
|
|
|
return $models;
|
|
}
|
|
|
|
/**
|
|
* Get the value of a relationship by one or many type.
|
|
*
|
|
* @param array $dictionary
|
|
* @param string $key
|
|
* @param string $type
|
|
* @return mixed
|
|
*/
|
|
protected function getRelationValue(array $dictionary, $key, $type)
|
|
{
|
|
$value = $dictionary[$key];
|
|
|
|
return $type == 'one' ? reset($value) : $this->related->newCollection($value);
|
|
}
|
|
|
|
/**
|
|
* Build model dictionary keyed by the relation's foreign key.
|
|
*
|
|
* @param \Illuminate\Database\Eloquent\Collection $results
|
|
* @return array
|
|
*/
|
|
protected function buildDictionary(Collection $results)
|
|
{
|
|
$dictionary = array();
|
|
|
|
$foreign = $this->getPlainForeignKey();
|
|
|
|
// First we will create a dictionary of models keyed by the foreign key of the
|
|
// relationship as this will allow us to quickly access all of the related
|
|
// models without having to do nested looping which will be quite slow.
|
|
foreach ($results as $result)
|
|
{
|
|
$dictionary[$result->{$foreign}][] = $result;
|
|
}
|
|
|
|
return $dictionary;
|
|
}
|
|
|
|
/**
|
|
* Attach a model instance to the parent model.
|
|
*
|
|
* @param \Illuminate\Database\Eloquent\Model $model
|
|
* @return \Illuminate\Database\Eloquent\Model
|
|
*/
|
|
public function save(Model $model)
|
|
{
|
|
$model->setAttribute($this->getPlainForeignKey(), $this->getParentKey());
|
|
|
|
return $model->save() ? $model : false;
|
|
}
|
|
|
|
/**
|
|
* Attach an array of models to the parent instance.
|
|
*
|
|
* @param array $models
|
|
* @return array
|
|
*/
|
|
public function saveMany(array $models)
|
|
{
|
|
array_walk($models, array($this, 'save'));
|
|
|
|
return $models;
|
|
}
|
|
|
|
/**
|
|
* Find a model by its primary key or return new instance of the related model.
|
|
*
|
|
* @param mixed $id
|
|
* @param array $columns
|
|
* @return \Illuminate\Support\Collection|\Illuminate\Database\Eloquent\Model
|
|
*/
|
|
public function findOrNew($id, $columns = ['*'])
|
|
{
|
|
if (is_null($instance = $this->find($id, $columns)))
|
|
{
|
|
$instance = $this->related->newInstance();
|
|
|
|
$instance->setAttribute($this->getPlainForeignKey(), $this->getParentKey());
|
|
}
|
|
|
|
return $instance;
|
|
}
|
|
|
|
/**
|
|
* Get the first related model record matching the attributes or instantiate it.
|
|
*
|
|
* @param array $attributes
|
|
* @return \Illuminate\Database\Eloquent\Model
|
|
*/
|
|
public function firstOrNew(array $attributes)
|
|
{
|
|
if (is_null($instance = $this->where($attributes)->first()))
|
|
{
|
|
$instance = $this->related->newInstance($attributes);
|
|
|
|
$instance->setAttribute($this->getPlainForeignKey(), $this->getParentKey());
|
|
}
|
|
|
|
return $instance;
|
|
}
|
|
|
|
/**
|
|
* Get the first related record matching the attributes or create it.
|
|
*
|
|
* @param array $attributes
|
|
* @return \Illuminate\Database\Eloquent\Model
|
|
*/
|
|
public function firstOrCreate(array $attributes)
|
|
{
|
|
if (is_null($instance = $this->where($attributes)->first()))
|
|
{
|
|
$instance = $this->create($attributes);
|
|
}
|
|
|
|
return $instance;
|
|
}
|
|
|
|
/**
|
|
* Create or update a related record matching the attributes, and fill it with values.
|
|
*
|
|
* @param array $attributes
|
|
* @param array $values
|
|
* @return \Illuminate\Database\Eloquent\Model
|
|
*/
|
|
public function updateOrCreate(array $attributes, array $values = [])
|
|
{
|
|
$instance = $this->firstOrNew($attributes);
|
|
|
|
$instance->fill($values);
|
|
|
|
$instance->save();
|
|
|
|
return $instance;
|
|
}
|
|
|
|
/**
|
|
* Create a new instance of the related model.
|
|
*
|
|
* @param array $attributes
|
|
* @return \Illuminate\Database\Eloquent\Model
|
|
*/
|
|
public function create(array $attributes)
|
|
{
|
|
// Here we will set the raw attributes to avoid hitting the "fill" method so
|
|
// that we do not have to worry about a mass accessor rules blocking sets
|
|
// on the models. Otherwise, some of these attributes will not get set.
|
|
$instance = $this->related->newInstance($attributes);
|
|
|
|
$instance->setAttribute($this->getPlainForeignKey(), $this->getParentKey());
|
|
|
|
$instance->save();
|
|
|
|
return $instance;
|
|
}
|
|
|
|
/**
|
|
* Create an array of new instances of the related model.
|
|
*
|
|
* @param array $records
|
|
* @return array
|
|
*/
|
|
public function createMany(array $records)
|
|
{
|
|
$instances = array();
|
|
|
|
foreach ($records as $record)
|
|
{
|
|
$instances[] = $this->create($record);
|
|
}
|
|
|
|
return $instances;
|
|
}
|
|
|
|
/**
|
|
* Perform an update on all the related models.
|
|
*
|
|
* @param array $attributes
|
|
* @return int
|
|
*/
|
|
public function update(array $attributes)
|
|
{
|
|
if ($this->related->usesTimestamps())
|
|
{
|
|
$attributes[$this->relatedUpdatedAt()] = $this->related->freshTimestampString();
|
|
}
|
|
|
|
return $this->query->update($attributes);
|
|
}
|
|
|
|
/**
|
|
* Get the key for comparing against the parent key in "has" query.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getHasCompareKey()
|
|
{
|
|
return $this->getForeignKey();
|
|
}
|
|
|
|
/**
|
|
* Get the foreign key for the relationship.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getForeignKey()
|
|
{
|
|
return $this->foreignKey;
|
|
}
|
|
|
|
/**
|
|
* Get the plain foreign key.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getPlainForeignKey()
|
|
{
|
|
$segments = explode('.', $this->getForeignKey());
|
|
|
|
return $segments[count($segments) - 1];
|
|
}
|
|
|
|
/**
|
|
* Get the key value of the parent's local key.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function getParentKey()
|
|
{
|
|
return $this->parent->getAttribute($this->localKey);
|
|
}
|
|
|
|
/**
|
|
* Get the fully qualified parent key name.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getQualifiedParentKeyName()
|
|
{
|
|
return $this->parent->getTable().'.'.$this->localKey;
|
|
}
|
|
|
|
}
|