Commit 324e1069 by Carsten Brandt

updated sphinx active record with changes from DB AR

parent 25fb11e9
...@@ -426,7 +426,7 @@ abstract class ActiveRecord extends Model ...@@ -426,7 +426,7 @@ abstract class ActiveRecord extends Model
* This method is overridden so that attributes and related objects can be accessed like properties. * This method is overridden so that attributes and related objects can be accessed like properties.
* @param string $name property name * @param string $name property name
* @return mixed property value * @return mixed property value
* @see getAttribute * @see getAttribute()
*/ */
public function __get($name) public function __get($name)
{ {
...@@ -498,7 +498,7 @@ abstract class ActiveRecord extends Model ...@@ -498,7 +498,7 @@ abstract class ActiveRecord extends Model
/** /**
* Declares a `has-one` relation. * Declares a `has-one` relation.
* The declaration is returned in terms of an [[ActiveRelationInterface]] instance * The declaration is returned in terms of an [[ActiveRelation]] instance
* through which the related record can be queried and retrieved back. * through which the related record can be queried and retrieved back.
* *
* A `has-one` relation means that there is at most one related record matching * A `has-one` relation means that there is at most one related record matching
...@@ -518,21 +518,18 @@ abstract class ActiveRecord extends Model ...@@ -518,21 +518,18 @@ abstract class ActiveRecord extends Model
* in the related class `ArticleContent`, while the 'id' value refers to an attribute name * in the related class `ArticleContent`, while the 'id' value refers to an attribute name
* in the current AR class. * in the current AR class.
* *
* @param string $type relation type or class name. * Call methods declared in [[ActiveRelation]] to further customize the relation.
* - if value contains backslash ("\"), it is treated as full active relation class name, *
* for example: "app\mydb\ActiveRelation"
* - if value does not contain backslash ("\"), the active relation class name will be composed
* by pattern: "yii\{type}\ActiveRelation", for example: type "db" refers "yii\db\ActiveRelation",
* type "sphinx" - "yii\sphinx\ActiveRelation"
* @param string $class the class name of the related record * @param string $class the class name of the related record
* @param array $link the primary-foreign key constraint. The keys of the array refer to * @param array $link the primary-foreign key constraint. The keys of the array refer to
* the attributes in the `$class` model, while the values of the array refer to the corresponding * the attributes in the `$class` model, while the values of the array refer to the corresponding
* attributes in the index associated with this AR class. * attributes in the index associated with this AR class.
* @return ActiveRelationInterface the relation object. * @return ActiveRelationInterface the relation object.
*/ */
public function hasOne($type, $class, $link) public function hasOne($class, $link)
{ {
return $this->createActiveRelation($type, [ /** @var ActiveRecord $class */
return $class::createActiveRelation([
'modelClass' => $class, 'modelClass' => $class,
'primaryModel' => $this, 'primaryModel' => $this,
'link' => $link, 'link' => $link,
...@@ -562,21 +559,16 @@ abstract class ActiveRecord extends Model ...@@ -562,21 +559,16 @@ abstract class ActiveRecord extends Model
* an attribute name in the related class `Tag`, while the 'tag_id' value refers to * an attribute name in the related class `Tag`, while the 'tag_id' value refers to
* a multi value attribute name in the current AR class. * a multi value attribute name in the current AR class.
* *
* @param string $type relation type or class name.
* - if value contains backslash ("\"), it is treated as full active relation class name,
* for example: "app\mydb\ActiveRelation"
* - if value does not contain backslash ("\"), the active relation class name will be composed
* by pattern: "yii\{type}\ActiveRelation", for example: type "db" refers "yii\db\ActiveRelation",
* type "sphinx" - "yii\sphinx\ActiveRelation"
* @param string $class the class name of the related record * @param string $class the class name of the related record
* @param array $link the primary-foreign key constraint. The keys of the array refer to * @param array $link the primary-foreign key constraint. The keys of the array refer to
* the columns in the table associated with the `$class` model, while the values of the * the columns in the table associated with the `$class` model, while the values of the
* array refer to the corresponding columns in the table associated with this AR class. * array refer to the corresponding columns in the table associated with this AR class.
* @return ActiveRelationInterface the relation object. * @return ActiveRelationInterface the relation object.
*/ */
public function hasMany($type, $class, $link) public function hasMany($class, $link)
{ {
return $this->createActiveRelation($type, [ /** @var ActiveRecord $class */
return $class::createActiveRelation([
'modelClass' => $class, 'modelClass' => $class,
'primaryModel' => $this, 'primaryModel' => $this,
'link' => $link, 'link' => $link,
...@@ -588,19 +580,12 @@ abstract class ActiveRecord extends Model ...@@ -588,19 +580,12 @@ abstract class ActiveRecord extends Model
* Creates an [[ActiveRelationInterface]] instance. * Creates an [[ActiveRelationInterface]] instance.
* This method is called by [[hasOne()]] and [[hasMany()]] to create a relation instance. * This method is called by [[hasOne()]] and [[hasMany()]] to create a relation instance.
* You may override this method to return a customized relation. * You may override this method to return a customized relation.
* @param string $type relation type or class name.
* @param array $config the configuration passed to the ActiveRelation class. * @param array $config the configuration passed to the ActiveRelation class.
* @return ActiveRelationInterface the newly created [[ActiveRelation]] instance. * @return ActiveRelationInterface the newly created [[ActiveRelation]] instance.
*/ */
protected function createActiveRelation($type, $config = []) public static function createActiveRelation($config = [])
{ {
if (strpos($type, '\\') === false) { return new ActiveRelation($config);
$class = "yii\\{$type}\\ActiveRelation";
} else {
$class = $type;
}
$config['class'] = $class;
return Yii::createObject($config);
} }
/** /**
...@@ -650,7 +635,7 @@ abstract class ActiveRecord extends Model ...@@ -650,7 +635,7 @@ abstract class ActiveRecord extends Model
*/ */
public function hasAttribute($name) public function hasAttribute($name)
{ {
return isset($this->_attributes[$name]) || isset($this->getIndexSchema()->columns[$name]); return isset($this->_attributes[$name]) || in_array($name, $this->attributes());
} }
/** /**
...@@ -659,7 +644,7 @@ abstract class ActiveRecord extends Model ...@@ -659,7 +644,7 @@ abstract class ActiveRecord extends Model
* null will be returned. * null will be returned.
* @param string $name the attribute name * @param string $name the attribute name
* @return mixed the attribute value. Null if the attribute is not set or does not exist. * @return mixed the attribute value. Null if the attribute is not set or does not exist.
* @see hasAttribute * @see hasAttribute()
*/ */
public function getAttribute($name) public function getAttribute($name)
{ {
...@@ -671,7 +656,7 @@ abstract class ActiveRecord extends Model ...@@ -671,7 +656,7 @@ abstract class ActiveRecord extends Model
* @param string $name the attribute name * @param string $name the attribute name
* @param mixed $value the attribute value. * @param mixed $value the attribute value.
* @throws InvalidParamException if the named attribute does not exist. * @throws InvalidParamException if the named attribute does not exist.
* @see hasAttribute * @see hasAttribute()
*/ */
public function setAttribute($name, $value) public function setAttribute($name, $value)
{ {
...@@ -708,7 +693,7 @@ abstract class ActiveRecord extends Model ...@@ -708,7 +693,7 @@ abstract class ActiveRecord extends Model
* @param string $name the attribute name * @param string $name the attribute name
* @return mixed the old attribute value. Null if the attribute is not loaded before * @return mixed the old attribute value. Null if the attribute is not loaded before
* or does not exist. * or does not exist.
* @see hasAttribute * @see hasAttribute()
*/ */
public function getOldAttribute($name) public function getOldAttribute($name)
{ {
...@@ -720,7 +705,7 @@ abstract class ActiveRecord extends Model ...@@ -720,7 +705,7 @@ abstract class ActiveRecord extends Model
* @param string $name the attribute name * @param string $name the attribute name
* @param mixed $value the old attribute value. * @param mixed $value the old attribute value.
* @throws InvalidParamException if the named attribute does not exist. * @throws InvalidParamException if the named attribute does not exist.
* @see hasAttribute * @see hasAttribute()
*/ */
public function setOldAttribute($name, $value) public function setOldAttribute($name, $value)
{ {
...@@ -1096,7 +1081,7 @@ abstract class ActiveRecord extends Model ...@@ -1096,7 +1081,7 @@ abstract class ActiveRecord extends Model
/** /**
* Sets the value indicating whether the record is new. * Sets the value indicating whether the record is new.
* @param boolean $value whether the record is new and should be inserted when calling [[save()]]. * @param boolean $value whether the record is new and should be inserted when calling [[save()]].
* @see getIsNewRecord * @see getIsNewRecord()
*/ */
public function setIsNewRecord($value) public function setIsNewRecord($value)
{ {
...@@ -1220,7 +1205,7 @@ abstract class ActiveRecord extends Model ...@@ -1220,7 +1205,7 @@ abstract class ActiveRecord extends Model
return false; return false;
} }
foreach ($this->attributes() as $name) { foreach ($this->attributes() as $name) {
$this->_attributes[$name] = $record->_attributes[$name]; $this->_attributes[$name] = isset($record->_attributes[$name]) ? $record->_attributes[$name] : null;
} }
$this->_oldAttributes = $this->_attributes; $this->_oldAttributes = $this->_attributes;
$this->_related = []; $this->_related = [];
...@@ -1230,23 +1215,28 @@ abstract class ActiveRecord extends Model ...@@ -1230,23 +1215,28 @@ abstract class ActiveRecord extends Model
/** /**
* Returns a value indicating whether the given active record is the same as the current one. * Returns a value indicating whether the given active record is the same as the current one.
* The comparison is made by comparing the index names and the primary key values of the two active records. * The comparison is made by comparing the index names and the primary key values of the two active records.
* If one of the records [[isNewRecord|is new]] they are also considered not equal.
* @param ActiveRecord $record record to compare to * @param ActiveRecord $record record to compare to
* @return boolean whether the two active records refer to the same row in the same index. * @return boolean whether the two active records refer to the same row in the same index.
*/ */
public function equals($record) public function equals($record)
{ {
if ($this->isNewRecord || $record->isNewRecord) {
return false;
}
return $this->indexName() === $record->indexName() && $this->getPrimaryKey() === $record->getPrimaryKey(); return $this->indexName() === $record->indexName() && $this->getPrimaryKey() === $record->getPrimaryKey();
} }
/** /**
* Returns the primary key value. * Returns the primary key value(s).
* @param boolean $asArray whether to return the primary key value as an array. If true, * @param boolean $asArray whether to return the primary key value as an array. If true,
* the return value will be an array with column names as keys and column values as values. * the return value will be an array with column names as keys and column values as values.
* Note that for composite primary keys, an array will always be returned regardless of this parameter value.
* @property mixed The primary key value. An array (column name => column value) is returned if * @property mixed The primary key value. An array (column name => column value) is returned if
* the primary key is composite. A string is returned otherwise (null will be returned if * the primary key is composite. A string is returned otherwise (null will be returned if
* the key value is null). * the key value is null).
* @return mixed the primary key value. An array (column name => column value) is returned * @return mixed the primary key value. An array (column name => column value) is returned if the primary key
* if `$asArray` is true. A string is returned otherwise (null will be returned if * is composite or `$asArray` is true. A string is returned otherwise (null will be returned if
* the key value is null). * the key value is null).
*/ */
public function getPrimaryKey($asArray = false) public function getPrimaryKey($asArray = false)
...@@ -1264,18 +1254,18 @@ abstract class ActiveRecord extends Model ...@@ -1264,18 +1254,18 @@ abstract class ActiveRecord extends Model
} }
/** /**
* Returns the old primary key value. * Returns the old primary key value(s).
* This refers to the primary key value that is populated into the record * This refers to the primary key value that is populated into the record
* after executing a find method (e.g. find(), findAll()). * after executing a find method (e.g. find(), findAll()).
* The value remains unchanged even if the primary key attribute is manually assigned with a different value. * The value remains unchanged even if the primary key attribute is manually assigned with a different value.
* @param boolean $asArray whether to return the primary key value as an array. If true, * @param boolean $asArray whether to return the primary key value as an array. If true,
* the return value will be an array with column name as key and column value as value. * the return value will be an array with column name as key and column value as value.
* If this is false (default), a scalar value will be returned. * If this is false (default), a scalar value will be returned for non-composite primary key.
* @property mixed The old primary key value. An array (column name => column value) is * @property mixed The old primary key value. An array (column name => column value) is
* returned if the primary key is composite. A string is returned otherwise (null will be * returned if the primary key is composite. A string is returned otherwise (null will be
* returned if the key value is null). * returned if the key value is null).
* @return mixed the old primary key value. An array (column name => column value) is returned if * @return mixed the old primary key value. An array (column name => column value) is returned if the primary key
* `$asArray` is true. A string is returned otherwise (null will be returned if * is composite or `$asArray` is true. A string is returned otherwise (null will be returned if
* the key value is null). * the key value is null).
*/ */
public function getOldPrimaryKey($asArray = false) public function getOldPrimaryKey($asArray = false)
...@@ -1302,7 +1292,7 @@ abstract class ActiveRecord extends Model ...@@ -1302,7 +1292,7 @@ abstract class ActiveRecord extends Model
public static function create($row) public static function create($row)
{ {
$record = static::instantiate($row); $record = static::instantiate($row);
$columns = static::getIndexSchema()->columns; $columns = array_flip(static::attributes());
foreach ($row as $name => $value) { foreach ($row as $name => $value) {
if (isset($columns[$name])) { if (isset($columns[$name])) {
$column = $columns[$name]; $column = $columns[$name];
...@@ -1359,7 +1349,7 @@ abstract class ActiveRecord extends Model ...@@ -1359,7 +1349,7 @@ abstract class ActiveRecord extends Model
if ($relation instanceof ActiveRelationInterface) { if ($relation instanceof ActiveRelationInterface) {
return $relation; return $relation;
} else { } else {
return null; throw new InvalidParamException(get_class($this) . ' has no relation named "' . $name . '".');
} }
} catch (UnknownMethodException $e) { } catch (UnknownMethodException $e) {
throw new InvalidParamException(get_class($this) . ' has no relation named "' . $name . '".', 0, $e); throw new InvalidParamException(get_class($this) . ' has no relation named "' . $name . '".', 0, $e);
......
...@@ -316,9 +316,9 @@ class ActiveRecord extends Model ...@@ -316,9 +316,9 @@ class ActiveRecord extends Model
* (because another user has modified the data), a [[StaleObjectException]] exception will be thrown, * (because another user has modified the data), a [[StaleObjectException]] exception will be thrown,
* and the update or deletion is skipped. * and the update or deletion is skipped.
* *
* Optimized locking is only supported by [[update()]] and [[delete()]]. * Optimistic locking is only supported by [[update()]] and [[delete()]].
* *
* To use optimized locking: * To use Optimistic locking:
* *
* 1. Create a column to store the version number of each row. The column type should be `BIGINT DEFAULT 0`. * 1. Create a column to store the version number of each row. The column type should be `BIGINT DEFAULT 0`.
* Override this method to return the name of this column. * Override this method to return the name of this column.
...@@ -469,9 +469,9 @@ class ActiveRecord extends Model ...@@ -469,9 +469,9 @@ class ActiveRecord extends Model
* *
* @param string $class the class name of the related record * @param string $class the class name of the related record
* @param array $link the primary-foreign key constraint. The keys of the array refer to * @param array $link the primary-foreign key constraint. The keys of the array refer to
* the columns in the table associated with the `$class` model, while the values of the * the attributes of the record associated with the `$class` model, while the values of the
* array refer to the corresponding columns in the table associated with this AR class. * array refer to the corresponding attributes in **this** AR class.
* @return ActiveRelation the relation object. * @return ActiveRelationInterface the relation object.
*/ */
public function hasOne($class, $link) public function hasOne($class, $link)
{ {
...@@ -508,9 +508,9 @@ class ActiveRecord extends Model ...@@ -508,9 +508,9 @@ class ActiveRecord extends Model
* *
* @param string $class the class name of the related record * @param string $class the class name of the related record
* @param array $link the primary-foreign key constraint. The keys of the array refer to * @param array $link the primary-foreign key constraint. The keys of the array refer to
* the columns in the table associated with the `$class` model, while the values of the * the attributes of the record associated with the `$class` model, while the values of the
* array refer to the corresponding columns in the table associated with this AR class. * array refer to the corresponding attributes in **this** AR class.
* @return ActiveRelation the relation object. * @return ActiveRelationInterface the relation object.
*/ */
public function hasMany($class, $link) public function hasMany($class, $link)
{ {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment