Spot ORM needs a new owner

Spot has a few issues and PRs piling up, and needs some love and attention.

I no longer write PHP full-time (these days I am slinging JavaScript on frontend, Node.js, and mobile apps), so I am not using Spot every day like I used to when I made it. This means that I am always a few steps removed from the pain points, and I don't want Spot the project to die due to my own lack of use.

So... who wants to assume ownership of Spot? I will transfer the repo, the packagist package, and the phpdatamapper.com website as well.

The only criteria are:

1. You are working in PHP with full time or near full time focus
2. You currently use Spot in a project (preferably your main one you work with daily)
3. You have contributed to Spot in some way (could just be reporting issues, fixing the docs, or facilitating discussion)

Hi,

First of all, thanks for this ORM. I needed something simple, non-intrusive, without annotations, and this delivers.

So this issue is fairly simple, in the documentation (http://phpdatamapper.com/docs/entities/), we can see the 'status' field is using "'default' => 0" in its definition. so one would assume it's building an Entity with such fields sets values according to this field if existing.

While this is the case when "'value' => 0" is set in the field definition, using 'default' doesn't seem to do much.

My understanding would be 'default' sets field value on insert if value is missing (i.e. NULL) and required, and 'value' sets it on entity build.

AFAIK, Entity::initFields() takes 'value' into account, and 'default' is used in Entity\Manager::fields() [206-207] to populate Entity\Manager::fieldDefaultValues, which is later used in Mapper::get() [518], but doesn't set any value on create.

So my question is fairly simple: is 'default' really relevant, since in almost any use case, 'value' does the trick? It seems there is, as of now, no point in using it. And if it's not, my guess is it shouldn't be referenced in the documentation.

When running toArray on an Entity, the eager loaded record(s) are never filled. With this update, if you have eager loaded a relationship using ->with, you will be able to run toArray from an entity and get the data from the relationship.

I took the advice and changed my belongsTo into a hasOne

inside my client-entity:

 public static function fields()
    {
        return [
            'id'                        => ['type' => 'integer', 'primary' => true, 'autoincrement' => true],
            ...some more fields...
            'country_id'                => ['type'  => 'integer'],
            'crmdepartment_id'          => ['type'  => 'integer'],
            'name'                      => ['type'  => 'string'],
            'user1_id'                  => ['type'  => 'integer'],
            'user2_id'                  => ['type'  => 'integer'],
            ...some more fields...
            ];
    }

And these are my relations:

    public static function relations(\Spot\MapperInterface $mapper, \Spot\EntityInterface $entity)
    {
        return [
            'country' => $mapper->hasOne($entity, 'Entities\Country', 'country_id'),
            'department' => $mapper->hasOne($entity, 'Entities\Department', 'crmdepartment_id'),
            'crmuser1' => $mapper->hasOne($entity, 'Entities\Crmuser', 'user1_id'),
            'crmuser2' => $mapper->hasOne($entity, 'Entities\Crmuser', 'user2_id'),
        ];
    }

Everything was a belongsTo and was working fine. Now I have the hasOne... and it is broken. I get and sql error and these are the 2 slq commands when I debug:

SELECT * FROM `client` `client` WHERE `client`.`crmdeletedby_id` = ? AND `client`.`crmdepartment_id` >= ? AND `client`.`clientstatus` = ? ORDER BY `client`.`name` ASC LIMIT 15 OFFSET 0 (Params: 0,0,100)
SELECT * FROM `crmdepartment` `crmdepartment` WHERE `crmdepartment`.`crmdepartment_id` IN (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?) (Params: 1,2,623,803,231,593,256,665,594,241,230,1153,1152,237,952)

What I see, is that with the 2nd query, it takes the wrong field, because it should be 'id' and not 'crmdepartment_id'.

Perhaps I still don't know the difference in belongsTo and hasOne, or I don't understand how it works.

Is there a way to map a column name to the object property name? I have an "employee_table" table with a PK of "employee_id" but want the proper in the Entity to just be "id", am I missing something or is that not available in Spot2?

Hey,

I've been tinkering with the ManyToMany relationship and stumbled upon a problem:

It seems that since I'm using an array, the validator doesn't work, i.e., no exception is thrown when inserting invalid values in the courses.

Now, I'm not sure I have the "glue" Entity properly implemented, or if this is the expected behavior, but I think it makes sense to have this check.

Trace:

$config = new Spot\Config();
$config->addConnection('mysql', [
    'driver'   => $settings['driver'],
    'host'     => $settings['host'],
    'dbname'   => $settings['database'],
    'user'     => $settings['username'],
    'password' => $settings['password'],
    'charset'  => $settings['charset']
    ]);
$database = new Spot\Locator($config);

$courseMapper = $database->mapper('Entities\Course');
$proposalMapper = $database->mapper('Entities\Proposal');

$course = $courseMapper->create([
    'name' => 'Something'
]); // I will assume this gets the id 1

$proposal = $proposalMapper->build([]);
$proposal->relation('courses', [2]); // Should throw validation exception or
$proposalMapper->save($proposal); // Should throw validation exception

Source (simplified):

Proposal Entity

<?php
namespace Entities;

use Spot\Entity;
use Spot\MapperInterface;
use Spot\EntityInterface;

class Proposal extends Entity
{
    protected static $table = 'proposals';

    public static function fields()
    {
        return [
            'id' => ['type' => 'integer', 'autoincrement' => true, 'primary' => true],
        ];
    }

    public static function relations(MapperInterface $mapper, EntityInterface $entity)
    {
        return [
            'courses' => $mapper->hasManyThrough(
                $entity,
                'Entities\Course',
                'Entities\ProposalCourse',
                'course_id',
                'proposal_id'
            )
        ];
    }
}

Course Entity

<?php
namespace Entities;

use Spot\Entity;

class Course extends Entity
{
    protected static $table = 'courses';

    public static function fields()
    {
        return [
            'id'       => ['type' => 'integer', 'autoincrement' => true, 'primary' => true],
            'name' => ['type' => 'text'],
        ];
    }
}

ProposalCourse Entity

<?php
namespace Entities;

use Spot\Entity;

class ProposalCourse extends Entity
{
    protected static $table = 'proposalscourses';

    public static function fields()
    {
        return [
            'id'                 => ['type' => 'integer', 'autoincrement' => true, 'primary' => true],
            'proposal_id' => ['type' => 'integer'],
            'course_id'    => ['type' => 'integer'],
        ];
    }
}

Edit: added replication code. Edit2: fix typo in course id number. Edit3: add missing 'course_id' to ProposalCourse and remove field 'courses' from Proposal. Create relation using the relation method.

Pull request to patch the addForeignKeys() function added in PR #136

Issue 1: The $relations variable is empty and the migration fails (@Schrank could reproduce the problem). Issue 2: If your foreign key is mapped to an aliased column then the migration fails.

Example Entity:

class Example extends \Spot\Entity
{
  protected static $table = 'example';
  public static function fields()
  {
    return [
      'id' => ['type' => 'integer', 'primary' => true, 'autoincrement' => true],
      'officeId' => ['type' => 'integer', 'required' => true, 'column' => 'office_id']
    ];
  }
  public static function relations(Mapper $mapper, Entity $entity)
  {
    return [
      'office' => $mapper->belongsTo($entity, 'Rendelo\Entity\Office', 'officeId')
    ];
  }
}

I am trying to select just some fields to reduce the data I have to put into my json result. I looked into building the query myself:

$sql = "SELECT client.field1, client.field2, client.field3 FROM client where city='Amsterdam';
$query = $this->query($sql);
$result = $query($sql)
    ->with(['department', 'country'])
    ->order(['name' => 'ASC']);

But this gives me an error: Call to undefined method Spot\Entity\Collection::with()

and I can't seem to find in the docs, or in the code, how this should be done.

I posted this by accident in the spot1 issues, but now in spot2. Vance already mentioned, that if I don't use the querybuilder, with doesn't work. So the final question would be: Can I get only fields instead of a asterix AND use the query builder?

In my workaround, I just remove all unnecessary data from the result, but that takes time, which seems like a waist to me.

This is a great container but allows just one argument per parameter, meaning this mysql or whatever should go inside the array and addConnection should accept just an array. Of course, for compatibility reasons this form should also be kept, but we should allow just one array as an argument.

$cfg->addConnection('mysql', [
    'dbname' => 'mydb',
    'user' => 'user',
    'password' => 'secret',
    'host' => 'localhost',
    'driver' => 'pdo_mysql',
]);

becomes like:

$cfg->addConnection([
    'name' => 'mysql',
    'dbname' => 'mydb',
    'user' => 'user',
    'password' => 'secret',
    'host' => 'localhost',
    'driver' => 'pdo_mysql',
]);

and the contract should be like:

/**
* $name string|array
*/
public function addConnection($name, $dsn = null, $default = false) {}

In the future releases it should probably loose the other parameters and keep just the array (debatable).

I have got problem with updating entity with multiple primary key column.

Table definition

public static function fields() {
        return [
            'storeNo' => ['type' => 'string','primary'=>true, 'required' => true],
            'weekday' => ['type' => 'integer','primary'=>true, 'required' => true],
            'open_hour' => ['type' => 'integer'],
            'close_hour' => ['type' => 'integer'],
        ];
    }

When i try to update an entity using mapper update method it update all rows in databases with the same weekdDay. Mapper create such SQL:UPDATEopening_hoursSETopen_hour= ?,close_hour= ? WHEREweekday= ?. A storeNo key is missing in where clause.

I know that, I can do update with raw sql, but i want to do this with orm funcionality :)

When I define a getter like this:

public function getSite()
{
    $site = $this->Site;

    if (!preg_match("~^https?://.+$~", $site)) {
        return "http://" . $site;
    } else {
        return $site;
    }
}

And I try to access the Site property like this:

$site = $object->Site;

I get an exception inside the getter saying the Site property is undefined, even though it worked fine the first time ($object->Site), thanks to the __get magic method. Why is that?

There is also, I think, a mistake in the __get magic method, as it sets $this->_inGetter[$field] = true while checking !in_array($this->_inGetter, $field). $field is put in the keys of the array, so it would not be found by the in_array function. I guess a !empty or array_key_exists would work.

After upgrade php version to 8.1 I am getting errors such as Return type of Spot\Query::count() should either be compatible with Countable::count(): int, or the #[\ReturnTypeWillChange] attribute should be used to temporarily suppress the notice

Hi! Please help me, how to search at the same time in some entities.

my tables:

items:

        'id' => ['type' => 'integer',  'autoincrement' => true, 'primary' => true, 'unsigned' => true, 'unique' => true, 'default' => null],   
        'status' => ['type' => 'integer', 'default' => 0],
        'avaible' => ['type' => 'integer', 'default' => 0],
        'created_by' => ['type' => 'integer', 'unsigned' => true, 'unique' => false, 'default' => null],
        'updated_by' => ['type' => 'integer', 'default' => null, 'unsigned' => true, 'unique' => false],
        'created_at' => ['type' => 'datetime', 'value' => new \DateTime()],
        'updated_at' => ['type' => 'datetime', 'value' => new \DateTime()],

relations:

        'price' => $mapper->hasOne($entity, ItemPrice::class, 'item')->order(['created_at' => 'DESC']),
        'image' => $mapper->hasOne($entity, Images::class, 'item'),
        'hu' => $mapper->hasOne($entity, ItemContent::class, 'item')->where(['lang' => 'hu']),
        'en' => $mapper->hasOne($entity, ItemContent::class, 'item')->where(['lang' => 'en']),
        'item_box' => $mapper->belongsTo($entity, ItemBox::class, 'box'),
        'categories' => $mapper->hasManyThrough($entity, Category::class, ItemCategory::class, 'category_id', 'item_id'),
        'created_user' => $mapper->belongsTo($entity, Admin::class, 'created_by'),
        'updated_user' => $mapper->belongsTo($entity, Admin::class, 'updated_by'),
        'search' => $mapper->hasOne($entity, ItemTitleSearch::class, 'item'),
        'getitem' => $mapper->hasOne($entity, ItemContent::class, 'item'),

item_contents:

        'id' => ['type' => 'integer', 'autoincrement' => true, 'primary' => true, 'unsigned' => true, 'unique' => true],
        'item' => ['type' => 'integer', 'default' => null, 'unsigned' => true, 'unique' => false],
        'lang' => ['type' => 'string', 'required' => true],
        'title' => ['type' => 'string', 'required' => true],
        'description' => ['type' => 'text', 'default' => '']

relations:

       'hu' => $mapper->belongsTo($entity, Items::class, 'item'),
       'en' => $mapper->belongsTo($entity, Items::class, 'item'),

item_categories:(manytomany), hasManyThrough

        'id' => ['type' => 'integer', 'autoincrement' => true, 'primary' => true, 'unsigned' => true, 'unique' => true, 'default' => null],
        'item_id' => ['type' => 'integer', 'default' => 0, 'unsigned' => true, 'unique' => false],
        'category_id' => ['type' => 'integer', 'default' => 0, 'unsigned' => true, 'unique' => false],

relations:

        'item' => $mapper->belongsTo($entity, Items::class, 'item_id'),
        'category' => $mapper->belongsTo($entity, Category::class, 'category_id'),

category:

        'category_id' => ['type' => 'integer', 'default' => 0,'primary' => true, 'unsigned' => true, 'unique' => true],
        'image' => ['type' => 'string'],
        'parent_id' => ['type' => 'integer', 'default' => 0, 'unsigned' => true, 'unique' => false],
        'status' => ['type' => 'integer', 'default' => 0],

relations:

        'hu' => $mapper->hasOne($entity, CategoryDescription::class, 'category_id')->where(['language_id' => 3]),
        'en' => $mapper->hasOne($entity, CategoryDescription::class, 'category_id')->where(['language_id' => 1]),
        'parentcategory' => $mapper->belongsTo($entity, Category::class, 'parent_id'),
        'items' => $mapper->hasManyThrough($entity, Items::class, ItemCategory::class, 'category_id', 'item_id')

ItemTitleSearch:

        'id' => array('type' => 'integer', 'serial' => true),
        'item' => array('type' => 'integer', 'primary' => true,'index' => true, 'required' => true),
        'title' => array('type' => 'text', 'required' => true, 'fulltext' => true),

relations:

        'getitem' => $mapper->hasOne($entity, Items::class, 'id'),

so, a make a search:

$searchText = 'stringintext';
$allItems = $this->entity->mapper(Items\ItemTitleSearch::class);
$allItems = $allItems->where(['title :like' => '%' . $allItems . '%'])

its working good!

But i want search in titles and categories, how can i do it? Thanks!

If one uses methods from the Query class that don't return the Query object through __call when dealing with a relation object, it becomes unusable.

This PR aims to fix that.

The test provided illustrate one of the cases in which this could happen (namely, ordering a hasMany relation before retrieving the first item).

This fixes a memory leak in the Entity class. In my case, this represented ~3kB per Entity (which has around 40 relations). I don't think tests are needed for this PR.

I have ProjectEntity with such relation in it 'users' => $mapper->hasManyThrough($entity, 'Api\V2\Entities\UserEntity', 'Api\V2\Entities\UserProjectEntity', 'user_id', 'project_id')->active()->order(['displayname' => 'ASC']) ->order() does not affect on the result, its sorted by id of UserProjectEntity (it has simple structure id - user_id -project_id)