Merge pull request #86 from atk4/feature/rename-classes

Feature/rename classes etc.

CHANGELOG.md

@@ -1,3 +1,9 @@
+# upcomming
+
+* Change: classes Field_One, Field_Many and Field_SQL_One are renamed to Relation_One, Relation_Many and Relation_SQL_One respectively.
+
+
+
 # 1.0.1
 
 This is our first maintenance release that solves several important issues.

docs/quickstart.rst

@@ -484,20 +484,22 @@ user john::
 Implementation of Relations
 ---------------------------
 
-When relation is added using getOne or getMany, the new object is created and added
-into Model of class Field_Many or Field_One (or Field_SQL_One). The object itself
-is quite simple and you can fetch it form the model if you keep the return value
-of hasOne() / hasMany() or call getRef() with the same identifier later on.
-
-Calling ref() will proxy into the ref() method of relation object which will
-in turn figure out what to do. 
-
-Additionally you can call addField() on the reference model that will bring
-one or several fields from related model into your current model.
-
-Finally this reference object contains method getModel() which will produce
-a (possibly) fresh copy of related entity and will either adjust it's
-DataSet or set the active record.
+When relation is added using :php:meth:`Model::hasOne()` or :php:meth:`Model::hasMany()`,
+the new object is created and added into Model of class :php:class:`Relation_Many`
+or :php:class:`Relation_One` (or :php:class:`Relation_SQL_One` in case you use SQL
+database). The object itself is quite simple and you can fetch it form the model if
+you keep the return value of hasOne() / hasMany() or call :php:meth:`Model::getRef()`
+with the same identifier later on.
+
+Calling :php:meth:`Model::ref()` will proxy into the ref() method of relation
+object which will in turn figure out what to do. 
+
+Additionally you can call :php:meth:`Model::addField()` on the reference model
+that will bring one or several fields from related model into your current model.
+
+Finally this reference object contains method getModel() which will produce a
+(possibly) fresh copy of related entity and will either adjust it's DataSet or
+set the active record.
 
 Actions
 =======

src/Field.php

@@ -143,6 +143,10 @@ public function __debugInfo()
             $arr['join'] = $this->join;
         }
 
+        if ($this->editable) {
+            $arr['editable'] = $this->editable;
+        }
+
         return $arr;
     }
 

src/Model.php

@@ -31,14 +31,14 @@ class Model implements \ArrayAccess, \IteratorAggregate
      *
      * @var string
      */
-    public $_default_class_hasOne = 'atk4\data\Field_One';
+    public $_default_class_hasOne = 'atk4\data\Relation_One';
 
     /**
      * The class used by hasMany() method.
      *
      * @var string
      */
-    public $_default_class_hasMany = 'atk4\data\Field_Many';
+    public $_default_class_hasMany = 'atk4\data\Relation_Many';
 
     /**
      * The class used by addField() method.
@@ -259,7 +259,7 @@ public function init()
         $this->_init();
 
         if ($this->id_field) {
-            $this->addField($this->id_field, ['system' => true, 'type' => 'int']);
+            $this->addField($this->id_field, ['system' => true, 'type' => 'int', 'editable' => false]);
         }
     }
 
@@ -1234,18 +1234,14 @@ public function leftJoin($foreign_table, $defaults = [])
      *
      * @param string $c        Class name
      * @param string $link     Link
-     * @param array  $defaults Properties
+     * @param array  $defaults Properties which we will pass to Relation object constructor
      *
      * @return object
      */
     protected function _hasRelation($c, $link, $defaults = [])
     {
         if (!is_array($defaults)) {
-            if ($defaults) {
-                $defaults = ['model' => $defaults];
-            } else {
-                $defaults = ['model' => 'Model_'.$link];
-            }
+            $defaults = ['model' => $defaults ?: 'Model_'.$link];
         } elseif (isset($defaults[0])) {
             $defaults['model'] = $defaults[0];
             unset($defaults[0]);
@@ -1262,7 +1258,7 @@ protected function _hasRelation($c, $link, $defaults = [])
      * @param string $link
      * @param array  $defaults
      *
-     * @return Field_One
+     * @return Relation_One
      */
     public function hasOne($link, $defaults = [])
     {
@@ -1275,7 +1271,7 @@ public function hasOne($link, $defaults = [])
      * @param string $link
      * @param array  $defaults
      *
-     * @return Field_Many
+     * @return Relation_Many
      */
     public function hasMany($link, $defaults = [])
     {

src/Persistence_SQL.php

@@ -28,14 +28,14 @@ class Persistence_SQL extends Persistence
      *
      * @var string
      */
-    public $_default_class_hasOne = 'atk4\data\Field_SQL_One';
+    public $_default_class_hasOne = 'atk4\data\Relation_SQL_One';
 
     /**
      * Default class when adding hasMany field.
      *
      * @var string
      */
-    public $_default_class_hasMany = null; //'atk4\data\Field_Many';
+    public $_default_class_hasMany = null; //'atk4\data\Relation_Many';
 
     /**
      * Default class when adding Expression field.

src/Field_Many.php → src/Relation_Many.php

@@ -7,7 +7,7 @@
 /**
  * Class description?
  */
-class Field_Many
+class Relation_Many
 {
     use \atk4\core\TrackableTrait {
         init as _init;

src/Field_One.php → src/Relation_One.php

@@ -7,7 +7,7 @@
 /**
  * Class description?
  */
-class Field_One
+class Relation_One
 {
     use \atk4\core\InitializerTrait {
         init as _init;
@@ -58,7 +58,19 @@ class Field_One
      */
     protected $join = null;
 
-    protected $default = null;
+    /**
+     * Default value of field.
+     *
+     * @var mixed
+     */
+    public $default = null;
+
+    /**
+     * Is field editable? Normally you can edit fields.
+     *
+     * @var bool
+     */
+    public $editable = true;
 
     /**
      * Default constructor. Will copy argument into properties.
@@ -78,7 +90,7 @@ public function __construct($defaults = [])
     }
 
     /**
-     * Will use either foreign_alias or create #join_<table>.
+     * Will use #ref_<link>.
      *
      * @return string
      */
@@ -97,7 +109,16 @@ public function init()
             $this->our_field = $this->link;
         }
         if (!$this->owner->hasElement($this->our_field)) {
-            $this->owner->addField($this->our_field, ['system' => true, 'join' => $this->join, 'default' => $this->default]);
+            // Imants: proper way would be to get actual field type of id field of related model,
+            // but if we try to do so here, then we end up in infinite loop :(
+            //$m = $this->getModel();
+            $this->owner->addField($this->our_field, [
+                'type'     => 'int', //$m->getElement($m->id_field)->type,
+                'system'   => false,
+                'join'     => $this->join,
+                'default'  => $this->default,
+                'editable' => $this->editable,
+            ]);
         }
     }
 

src/Field_SQL_One.php → src/Relation_SQL_One.php

@@ -7,7 +7,7 @@
 /**
  * Class description?
  */
-class Field_SQL_One extends Field_One
+class Relation_SQL_One extends Relation_One
 {
     /**
      * Creates expression which sub-selects a field inside related model.