orm changes

This commit is contained in:
Yuri Kuznetsov
2020-08-03 11:43:16 +03:00
parent c92a4bcf36
commit 659ae36ca6
6 changed files with 177 additions and 88 deletions
+34 -16
View File
@@ -94,10 +94,12 @@ class EntityManager
$this->entityFactory->setEntityManager($this);
$this->repositoryFactory = $repositoryFactory;
$this->queryExecutor = new RDBQueryExecutor($this);
}
/**
* Get Query.
* Get a Query.
*/
public function getQuery() : Query
{
@@ -128,7 +130,7 @@ class EntityManager
}
/**
* Get Mapper.
* Get a Mapper.
*/
public function getMapper(?string $name = null) : Mapper
{
@@ -171,15 +173,16 @@ class EntityManager
}
$this->pdo = new PDO(
$platform . ':host='.$params['host'].';'.$port.'dbname=' . $params['dbname'] . ';charset=' . $params['charset'],
$platform . ':host=' . $params['host'] . ';'. $port.'dbname=' . $params['dbname'] . ';charset=' . $params['charset'],
$params['user'], $params['password'], $options
);
$this->pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
}
/**
* Get entity. If $id is null, a new entity instance is created.
* If entity with a specified $id does not exist, then NULL is returned.
* Get an entity. If $id is null, a new entity instance is created.
* If an entity with a specified $id does not exist, then NULL is returned.
*/
public function getEntity(string $entityType, ?string $id = null) : ?Entity
{
@@ -191,42 +194,48 @@ class EntityManager
}
/**
* Store entity (in database).
* Store an entity (in database).
*/
public function saveEntity(Entity $entity, array $options = [])
{
$entityType = $entity->getEntityType();
$this->getRepository($entityType)->save($entity, $options);
}
/**
* Mark entity as deleted (in database).
* Mark an entity as deleted (in database).
*/
public function removeEntity(Entity $entity, array $options = [])
{
$entityType = $entity->getEntityType();
$this->getRepository($entityType)->remove($entity, $options);
}
/**
* Create entity (store it in database).
*
* @param \StdClass|array $data Entity attributes.
* @param StdClass|array $data Entity attributes.
*/
public function createEntity(string $entityType, $data, array $options = []) : Entity
{
$entity = $this->getEntity($entityType);
$entity->set($data);
$this->saveEntity($entity, $options);
return $entity;
}
/**
* Fetch entity (from database).
* Fetch an entity (from database).
*/
public function fetchEntity(string $entityType, string $id) : ?Entity
{
if (empty($id)) return null;
if (empty($id)) {
return null;
}
return $this->getEntity($entityType, $id);
}
@@ -244,12 +253,13 @@ class EntityManager
public function getRepository(string $entityType) : ?Repository
{
if (!$this->hasRepository($entityType)) {
// TODO Throw error
throw new Error("Repository '{$entityType}' does not exist.");
}
if (empty($this->repositoryHash[$entityType])) {
$this->repositoryHash[$entityType] = $this->repositoryFactory->create($entityType);
}
return $this->repositoryHash[$entityType] ?? null;
}
@@ -274,26 +284,26 @@ class EntityManager
/**
* Get an instance of PDO.
*/
public function getPDO() : \PDO
public function getPDO() : PDO
{
if (empty($this->pdo)) {
$this->initPDO();
}
return $this->pdo;
}
/**
* Create a Collection.
* Create a collection.
* Entity type can be omitted.
*/
public function createCollection(?string $entityType = null, array $data = [])
{
$collection = new EntityCollection($data, $entityType, $this->entityFactory);
return $collection;
return new EntityCollection($data, $entityType, $this->entityFactory);
}
/**
* Create an Sth Collection. Sth collection is preferable when a select query returns a large number of rows.
* Create an STH collection. An STH collection is preferable when a select query returns a large number of rows.
*/
public function createSthCollection(string $entityType, array $selectParams = [])
{
@@ -305,6 +315,14 @@ class EntityManager
return $this->entityFactory;
}
/**
* Get a Query Executor.
*/
public function getQueryExecutor() : RDBQueryExecutor
{
return $this->queryExecutor;
}
/**
* Run a query. Returns a result.
*
+59
View File
@@ -0,0 +1,59 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2020 Yuri Kuznetsov, Taras Machyshyn, Oleksiy Avramenko
* Website: https://www.espocrm.com
*
* EspoCRM is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* EspoCRM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with EspoCRM. If not, see http://www.gnu.org/licenses/.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
namespace Espo\ORM;
/**
* Executes queries by a given RDBSelect instances.
*
* @todo Add `select` method returning an array of StdClass objects.
*/
class RDBQueryExecutor
{
protected $entityManager;
public function __construct(EntityManager $entityManager)
{
$this->entityManager = $entityManager;
}
public function update(RDBSelect $select, array $values)
{
$sql = $this->entityManager->getQuery()->createUpdateQuery($select->getEntityType(), $select->getRawParams(), $values);
$this->entityManager->runQuery($sql, true);
}
public function delete(RDBSelect $select)
{
$sql = $this->entityManager->getQuery()->createDeleteQuery($select->getEntityType(), $select->getRawParams());
$this->entityManager->runQuery($sql, true);
}
}
@@ -32,7 +32,7 @@ namespace Espo\ORM;
/**
* Select parameters.
*/
class RDBSelectParams
class RDBSelect
{
protected $entityType;
@@ -55,7 +55,7 @@ class RDBSelectParams
/**
* Get parameters in RAW format.
*/
public function getRaw() : array
public function getRawParams() : array
{
return $this->params;
}
+2 -2
View File
@@ -321,11 +321,11 @@ class RDBSelectBuilder implements Findable
/**
* Builds result select parameters.
*/
public function build() : RDBSelectParams
public function build() : RDBSelect
{
$this->processExecutableCheck();
return new RDBSelectParams($this->entityType, $this->getMergedParams());
return new RDBSelect($this->entityType, $this->getMergedParams());
}
protected function getMergedParams(array $params = []) : array
+41 -35
View File
@@ -494,30 +494,31 @@ class EmailAddress extends \Espo\Core\Repositories\Database implements
if ($primary) {
$emailAddress = $this->getByAddress($primary);
if ($emailAddress) {
$query = "
UPDATE entity_email_address
SET `primary` = 0
WHERE
entity_id = ".$pdo->quote($entity->id)." AND
entity_type = ".$pdo->quote($entity->getEntityType())." AND
`primary` = 1 AND
deleted = 0
";
$sth = $pdo->prepare($query);
$sth->execute();
$query = "
UPDATE entity_email_address
SET `primary` = 1
WHERE
entity_id = ".$pdo->quote($entity->id)." AND
entity_type = ".$pdo->quote($entity->getEntityType())." AND
email_address_id = ".$pdo->quote($emailAddress->id)." AND
deleted = 0
";
$sth = $pdo->prepare($query);
$sth->execute();
if ($emailAddress) {
$updateSelect = $this->getEntityManager()->createSelectBuilder()
->from('EntityEmailAddress')
->where([
'entityId' => $entity->id,
'entityType' => $entity->getEntityType(),
'primary' => true,
'deleted' => false,
])
->build();
$this->getEntityManager()->getQueryExecutor()->update($updateSelect, ['primary' => false]);
$updateSelect = $this->getEntityManager()->createSelectBuilder()
->from('EntityEmailAddress')
->where([
'entityId' => $entity->id,
'entityType' => $entity->getEntityType(),
'emailAddressId' => $emailAddress->id,
'deleted' => false,
])
->build();
$this->getEntityManager()->getQueryExecutor()->update($updateSelect, ['primary' => true]);
}
}
@@ -544,6 +545,7 @@ class EmailAddress extends \Espo\Core\Repositories\Database implements
}
$entityRepository = $this->getEntityManager()->getRepository($entity->getEntityType());
if (!empty($emailAddressValue)) {
if ($emailAddressValue != $entity->getFetched('emailAddress')) {
@@ -572,16 +574,21 @@ class EmailAddress extends \Espo\Core\Repositories\Database implements
$this->markAddressOptedOut($emailAddressValue, !!$entity->get('emailAddressIsOptedOut'));
}
$query = "
UPDATE entity_email_address
SET `primary` = 1
WHERE
entity_id = ".$pdo->quote($entity->id)." AND
entity_type = ".$pdo->quote($entity->getEntityType())." AND
email_address_id = ".$pdo->quote($emailAddressNew->id)."
";
$sth = $pdo->prepare($query);
$sth->execute();
$updateSelect = $this->getEntityManager()->createSelectBuilder()
->from('EntityEmailAddress')
->where([
'entityId' => $entity->id,
'entityType' => $entity->getEntityType(),
'emailAddressId' => $emailAddressNew->id,
])
->build();
$sql = $this->getEntityManager()->getQuery()->createUpdateQuery('EntityEmailAddress', $updateSelect->getRawParams(), [
'primary' => true,
]);
$this->getEntityManager()->runQuery($sql, true);
} else {
if (
$entity->has('emailAddressIsOptedOut')
@@ -608,7 +615,6 @@ class EmailAddress extends \Espo\Core\Repositories\Database implements
}
}
}
}
public function storeEntityEmailAddress(Entity $entity)
@@ -625,7 +631,7 @@ class EmailAddress extends \Espo\Core\Repositories\Database implements
}
}
// TODO move it to another place
// @todo move it to another place
protected function checkChangeIsForbidden($entity, $excludeEntity)
{
return !$this->aclManager->getImplementation('EmailAddress')
+39 -33
View File
@@ -423,29 +423,30 @@ class PhoneNumber extends \Espo\Core\Repositories\Database implements
if ($primary) {
$phoneNumber = $this->getByNumber($primary);
if ($phoneNumber) {
$query = "
UPDATE entity_phone_number
SET `primary` = 0
WHERE
entity_id = ".$pdo->quote($entity->id)." AND
entity_type = ".$pdo->quote($entity->getEntityType())." AND
`primary` = 1 AND
deleted = 0
";
$sth = $pdo->prepare($query);
$sth->execute();
$query = "
UPDATE entity_phone_number
SET `primary` = 1
WHERE
entity_id = ".$pdo->quote($entity->id)." AND
entity_type = ".$pdo->quote($entity->getEntityType())." AND
phone_number_id = ".$pdo->quote($phoneNumber->id)." AND
deleted = 0
";
$sth = $pdo->prepare($query);
$sth->execute();
$updateSelect = $this->getEntityManager()->createSelectBuilder()
->from('EntityPhoneNumber')
->where([
'entityId' => $entity->id,
'entityType' => $entity->getEntityType(),
'primary' => true,
'deleted' => false,
])
->build();
$this->getEntityManager()->getQueryExecutor()->update($updateSelect, ['primary' => false]);
$updateSelect = $this->getEntityManager()->createSelectBuilder()
->from('EntityPhoneNumber')
->where([
'entityId' => $entity->id,
'entityType' => $entity->getEntityType(),
'phoneNumberId' => $phoneNumber->id,
'deleted' => false,
])
->build();
$this->getEntityManager()->getQueryExecutor()->update($updateSelect, ['primary' => true]);
}
}
@@ -501,16 +502,21 @@ class PhoneNumber extends \Espo\Core\Repositories\Database implements
$this->markNumberOptedOut($phoneNumberValue, !!$entity->get('phoneNumberIsOptedOut'));
}
$query = "
UPDATE entity_phone_number
SET `primary` = 1
WHERE
entity_id = ".$pdo->quote($entity->id)." AND
entity_type = ".$pdo->quote($entity->getEntityType())." AND
phone_number_id = ".$pdo->quote($phoneNumberNew->id)."
";
$sth = $pdo->prepare($query);
$sth->execute();
$updateSelect = $this->getEntityManager()->createSelectBuilder()
->from('EntityPhoneNumber')
->where([
'entityId' => $entity->id,
'entityType' => $entity->getEntityType(),
'phoneNumberId' => $phoneNumberNew->id,
])
->build();
$sql = $this->getEntityManager()->getQuery()->createUpdateQuery('EntityPhoneNumber', $updateSelect->getRawParams(), [
'primary' => true,
]);
$this->getEntityManager()->runQuery($sql, true);
} else {
if (
$entity->has('phoneNumberIsOptedOut')
@@ -553,7 +559,7 @@ class PhoneNumber extends \Espo\Core\Repositories\Database implements
}
}
// TODO move it to another place
// @todo move it to another place
protected function checkChangeIsForbidden($entity, $excludeEntity)
{
return !$this->aclManager->getImplementation('PhoneNumber')