espocrm-extensions/espocrm-base
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:espocrm/espocrm

Browse Source
This commit is contained in:
Yuri Kuznetsov
2022-05-23 17:30:01 +03:00
parent 02ebef1db8 79bc345307
commit 99cd5ddf3c
16 changed files with 1415 additions and 189 deletions
Download Patch File Download Diff File Expand all files Collapse all files
application/Espo/Core/ApplicationRunners/Command.php
+6 -2
View File
@@ -42,7 +42,7 @@ class Command implements Runner
use Cli;
use SetupSystemUser;
private $commandManager;
private ConsoleCommandManager $commandManager;
public function __construct(ConsoleCommandManager $commandManager)
{
@@ -52,10 +52,14 @@ class Command implements Runner
public function run(): void
{
try {
$this->commandManager->run($_SERVER['argv']);
$exitStatus = $this->commandManager->run($_SERVER['argv']);
}
catch (Exception $e) {
echo "Error: " . $e->getMessage() . "\n";
exit(1);
}
exit($exitStatus);
}
}
application/Espo/Core/Console/CommandManager.php
+6 -2
View File
@@ -57,8 +57,10 @@ class CommandManager
/**
* @param array<int,string> $argv
*
* @return int<0, 255> Exit-status.
*/
public function run(array $argv): void
public function run(array $argv): int
{
$command = $this->getCommandNameFromArgv($argv);
$params = $this->createParamsFromArgv($argv);
@@ -89,10 +91,12 @@ class CommandManager
$commandObj->run($params->getOptions(), $params->getFlagList(), $params->getArgumentList());
return;
return 0;
}
$commandObj->run($params, $io);
return $io->getExitStatus();
}
/**
application/Espo/Core/Console/Commands/EntityUtil.php
+157
View File
@@ -0,0 +1,157 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii 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\Core\Console\Commands;
use Espo\Core\Console\Command;
use Espo\Core\Console\Command\Params;
use Espo\Core\Console\IO;
use Espo\Tools\EntityManager\Rename\Renamer;
use Espo\Tools\EntityManager\Rename\FailReason as RenameFailReason;
class EntityUtil implements Command
{
private Renamer $renamer;
public function __construct(Renamer $renamer)
{
$this->renamer = $renamer;
}
public function run(Params $params, IO $io): void
{
$subCommand = $params->getArgument(0);
if (!$subCommand) {
$io->writeLine("No sub-command specified.");
return;
}
if ($subCommand === 'rename') {
$this->runRename($params, $io);
return;
}
}
private function runRename(Params $params, IO $io): void
{
$entityType = $params->getOption('entityType');
$newName = $params->getOption('newName');
if (!$entityType) {
$io->writeLine("No --entity-type option specified.");
}
if (!$newName) {
$io->writeLine("No --new-name option specified.");
}
if (!$entityType || !$newName) {
return;
}
$result = $this->renamer->process($entityType, $newName, $io);
$io->writeLine("");
if (!$result->isFail()) {
$io->writeLine("Finished.");
return;
}
$io->setExitStatus(1);
$io->write("Failed. ");
$failReason = $result->getFailReason();
if ($failReason === RenameFailReason::NAME_BAD) {
$io->writeLine("Name is bad.");
return;
}
if ($failReason === RenameFailReason::NAME_NOT_ALLOWED) {
$io->writeLine("Name is not allowed.");
return;
}
if ($failReason === RenameFailReason::NAME_TOO_LONG) {
$io->writeLine("Name is too long.");
return;
}
if ($failReason === RenameFailReason::NAME_TOO_SHORT) {
$io->writeLine("Name is too short.");
return;
}
if ($failReason === RenameFailReason::NAME_USED) {
$io->writeLine("Name is already used.");
return;
}
if ($failReason === RenameFailReason::DOES_NOT_EXIST) {
$io->writeLine("Entity type `{$entityType}` does not exist.");
return;
}
if ($failReason === RenameFailReason::NOT_CUSTOM) {
$io->writeLine("Entity type `{$entityType}` is not custom, hence can't be renamed.");
return;
}
if ($failReason === RenameFailReason::ENV_NOT_SUPPORTED) {
$io->writeLine("Environment is not supported.");
return;
}
if ($failReason === RenameFailReason::TABLE_EXISTS) {
$io->writeLine("Table already exists.");
return;
}
if ($failReason === RenameFailReason::ERROR) {
$io->writeLine("Error occurred.");
return;
}
}
}
application/Espo/Core/Console/Commands/Extension.php
+10 -1
View File
@@ -70,6 +70,7 @@ class Extension implements Command
if (!$name && !$id) {
$io->writeLine("Can't uninstall. Specify --name=\"Extension Name\".");
$io->setExitStatus(1);
return;
}
@@ -112,6 +113,7 @@ class Extension implements Command
if (!$this->fileManager->isFile($file)) {
$io->writeLine("File does not exist.");
$io->setExitStatus(1);
return;
}
@@ -125,6 +127,7 @@ class Extension implements Command
}
catch (Throwable $e) {
$io->writeLine($e->getMessage());
$io->setExitStatus(1);
return;
}
@@ -136,6 +139,7 @@ class Extension implements Command
if (!$name) {
$io->writeLine("Can't install. Bad manifest.json file.");
$io->setExitStatus(1);
return;
}
@@ -148,6 +152,7 @@ class Extension implements Command
catch (Throwable $e) {
$io->writeLine("");
$io->writeLine($e->getMessage());
$io->setExitStatus(1);
return;
}
@@ -173,6 +178,7 @@ class Extension implements Command
if (!$record) {
$io->writeLine("Extension with ID '{$id}' is not installed.");
$io->setExitStatus(1);
return;
}
@@ -182,6 +188,7 @@ class Extension implements Command
else {
if (!$name) {
$io->writeLine("Can't uninstall. No --name or --id specified.");
$io->setExitStatus(1);
return;
}
@@ -196,6 +203,7 @@ class Extension implements Command
if (!$record) {
$io->writeLine("Extension '{$name}' is not installed.");
$io->setExitStatus(1);
return;
}
@@ -213,6 +221,7 @@ class Extension implements Command
catch (Throwable $e) {
$io->writeLine("");
$io->writeLine($e->getMessage());
$io->setExitStatus(1);
return;
}
@@ -221,11 +230,11 @@ class Extension implements Command
if ($toKeep) {
$io->writeLine("Extension '{$name}' is uninstalled.");
$io->setExitStatus(1);
return;
}
try {
$manager->delete(['id' => $id]);
}
application/Espo/Core/Console/Commands/RunJob.php
+1
View File
@@ -110,6 +110,7 @@ class RunJob implements Command
}
$io->writeLine($message);
$io->setExitStatus(1);
return;
}
application/Espo/Core/Console/Commands/SetPassword.php
+6 -6
View File
@@ -55,6 +55,7 @@ class SetPassword implements Command
if (!$userName) {
$io->writeLine("User name must be specified.");
$io->setExitStatus(1);
return;
}
@@ -67,6 +68,7 @@ class SetPassword implements Command
if (!$user) {
$io->writeLine("User '{$userName}' not found.");
$io->setExitStatus(1);
return;
}
@@ -74,9 +76,8 @@ class SetPassword implements Command
if (!in_array($user->get('type'), ['admin', 'super-admin', 'portal', 'regular'])) {
$userType = $user->get('type');
$io->writeLine(
"Can't set password for a user of the type '{$userType}'."
);
$io->writeLine("Can't set password for a user of the type '{$userType}'.");
$io->setExitStatus(1);
return;
}
@@ -87,13 +88,12 @@ class SetPassword implements Command
if (!$password) {
$io->writeLine("Password can not be empty.");
$io->setExitStatus(1);
return;
}
$hash = $this->passwordHash;
$user->set('password', $hash->hash($password));
$user->set('password', $this->passwordHash->hash($password));
$em->saveEntity($user);
application/Espo/Core/Console/IO.php
+28
View File
@@ -39,6 +39,11 @@ use const PHP_EOL;
*/
class IO
{
/**
* @var int<0, 255>
*/
private int $exitStatus = 0;
/**
* Write a string to output.
*/
@@ -78,4 +83,27 @@ class IO
return $string;
}
/**
* Set exit-status.
*
* @param int<0, 255> $exitStatus
* - `0` - success;
* - `1` - error;
* - `127` - command not found;
*/
public function setExitStatus(int $exitStatus): void
{
$this->exitStatus = $exitStatus;
}
/**
* Get exit-status.
*
* @return int<0, 255>
*/
public function getExitStatus(): int
{
return $this->exitStatus;
}
}
application/Espo/ORM/QueryComposer/BaseQueryComposer.php
+5 -8
View File
@@ -2373,7 +2373,11 @@ abstract class BaseQueryComposer implements QueryComposer
$string[0] = strtolower($string[0]);
/** @var string */
$dbString = preg_replace_callback('/([A-Z])/', [$this, 'toDbMatchConversion'], $string);
$dbString = preg_replace_callback(
'/([A-Z])/',
fn($matches) => '_' . strtolower($matches[1]),
$string
);
$this->attributeDbMapCache[$string] = $dbString;
}
@@ -2381,13 +2385,6 @@ abstract class BaseQueryComposer implements QueryComposer
return $this->attributeDbMapCache[$string];
}
/**
* @param array<string> $matches
*/
protected function toDbMatchConversion(array $matches): string
{
return '_' . strtolower($matches[1]);
}
protected function getAlias(Entity $entity, string $relationName): ?string
{
application/Espo/Tools/EntityManager/EntityManager.php
+22 -170
View File
@@ -48,8 +48,6 @@ use Espo\Core\{
Utils\Language,
Utils\Config,
Utils\Config\ConfigWriter,
ORM\EntityManager as OrmEntityManager,
ServiceFactory,
DataManager,
InjectableFactory,
};
@@ -73,63 +71,13 @@ class EntityManager
private $configWriter;
private $entityManager;
private $serviceFactory;
private $injectableFactory;
private $dataManager;
private LinkHookProcessor $linkHookProcessor;
private const MAX_ENTITY_NAME = 100;
private const MAX_LINK_NAME = 100;
/**
* @var string[]
*/
private $reservedWordList = [
'__halt_compiler', 'abstract', 'and', 'array', 'as', 'break', 'callable',
'case', 'catch', 'class', 'clone', 'const', 'continue', 'declare', 'default',
'die', 'do', 'echo', 'else', 'elseif', 'empty', 'enddeclare', 'endfor', 'endforeach',
'endif', 'endswitch', 'endwhile', 'eval', 'exit', 'extends', 'final', 'for', 'foreach',
'function', 'global', 'goto', 'if', 'implements', 'include', 'include_once', 'instanceof',
'insteadof', 'interface', 'isset', 'list', 'namespace', 'new', 'or', 'print', 'private',
'protected', 'public', 'require', 'require_once', 'return', 'static', 'switch', 'throw',
'trait', 'try', 'unset', 'use', 'var', 'while', 'xor', 'common', 'fn', 'parent',
];
/**
* @var string[]
*/
private $linkForbiddenNameList = [
'posts',
'stream',
'subscription',
'followers',
'action',
'null',
'false',
'true',
];
/**
* @var string[]
*/
private $forbiddenEntityTypeNameList = [
'Common',
'PortalUser',
'ApiUser',
'Timeline',
'About',
'Admin',
'Null',
'False',
'True',
'Base',
];
private NameUtil $nameUtil;
public function __construct(
Metadata $metadata,
@@ -138,11 +86,10 @@ class EntityManager
FileManager $fileManager,
Config $config,
ConfigWriter $configWriter,
OrmEntityManager $entityManager,
ServiceFactory $serviceFactory,
DataManager $dataManager,
InjectableFactory $injectableFactory,
LinkHookProcessor $linkHookProcessor
LinkHookProcessor $linkHookProcessor,
NameUtil $nameUtil
) {
$this->metadata = $metadata;
$this->language = $language;
@@ -150,74 +97,10 @@ class EntityManager
$this->fileManager = $fileManager;
$this->config = $config;
$this->configWriter = $configWriter;
$this->entityManager = $entityManager;
$this->serviceFactory = $serviceFactory;
$this->dataManager = $dataManager;
$this->injectableFactory = $injectableFactory;
$this->linkHookProcessor = $linkHookProcessor;
}
protected function checkControllerExists(string $name): bool
{
$controllerClassName = 'Espo\\Custom\\Controllers\\' . Util::normilizeClassName($name);
if (class_exists($controllerClassName)) {
return true;
}
else {
foreach ($this->metadata->getModuleList() as $moduleName) {
$controllerClassName =
'Espo\\Modules\\' . $moduleName . '\\Controllers\\' . Util::normilizeClassName($name);
if (class_exists($controllerClassName)) {
return true;
}
}
$controllerClassName = 'Espo\\Controllers\\' . Util::normilizeClassName($name);
if (class_exists($controllerClassName)) {
return true;
}
}
return false;
}
protected function checkRelationshipExists(string $name): bool
{
$name = ucfirst($name);
/** @var string[] */
$scopeList = array_keys($this->metadata->get(['scopes'], []));
foreach ($scopeList as $entityType) {
$relationsDefs = $this->entityManager
->getMetadata()
->get($entityType, 'relations');
if (empty($relationsDefs)) {
continue;
}
foreach ($relationsDefs as $link => $item) {
if (empty($item['type'])) {
continue;
}
if (empty($item['relationName'])) {
continue;
}
if ($item['type'] === 'manyMany') {
if (ucfirst($item['relationName']) === $name) {
return true;
}
}
}
}
return false;
$this->nameUtil = $nameUtil;
}
/**
@@ -236,14 +119,6 @@ class EntityManager
throw new BadRequest();
}
if (strlen($name) > self::MAX_ENTITY_NAME) {
throw new Error("Entity name should not be longer than " . self::MAX_ENTITY_NAME . ".");
}
if (is_numeric($name[0])) {
throw new Error('Bad entity name.');
}
if (!in_array($type, $this->metadata->get(['app', 'entityTemplateList'], []))) {
throw new Error('Type \''.$type.'\' does not exist.');
}
@@ -254,48 +129,25 @@ class EntityManager
throw new Error('Type \''.$type.'\' is not creatable.');
}
if ($this->metadata->get('scopes.' . $name)) {
throw new Conflict('Entity \''.$name.'\' already exists.');
if ($this->nameUtil->nameIsBad($name)) {
throw new Error("Entity name should contain only letters and numbers, " .
"start with an upper case letter.");
}
if ($this->metadata->get(['entityDefs.', $name])) {
throw new Conflict('Entity \''.$name.'\' already exists.');
if ($this->nameUtil->nameIsTooShort($name)) {
throw new Error("Entity name should not shorter than " . NameUtil::MIN_ENTITY_NAME_LENGTH . ".");
}
if ($this->metadata->get(['clientDefs.', $name])) {
throw new Conflict('Entity \''.$name.'\' already exists.');
if ($this->nameUtil->nameIsTooLong($name)) {
throw new Error("Entity name should not be longer than " . NameUtil::MAX_ENTITY_NAME_LENGTH . ".");
}
if ($this->checkControllerExists($name)) {
throw new Conflict('Entity name \''.$name.'\' is not allowed. Controller already exists.');
if ($this->nameUtil->nameIsUsed($name)) {
throw new Conflict("Name '{$name}' is already used.");
}
$serviceFactory = $this->serviceFactory;
if ($serviceFactory->checkExists($name)) {
throw new Conflict('Entity name \''.$name.'\' is not allowed.');
}
if (in_array($name, $this->forbiddenEntityTypeNameList)) {
throw new Conflict('Entity name \''.$name.'\' is not allowed.');
}
if (in_array(strtolower($name), $this->reservedWordList)) {
throw new Conflict('Entity name \''.$name.'\' is not allowed.');
}
if ($this->checkRelationshipExists($name)) {
throw new Conflict('Relationship with the same name \''.$name.'\' exists.');
}
if (preg_match('/[^a-zA-Z\d]/', $name)) {
throw new Error("Entity name should contain only letters and numbers.");
}
$firstLatter = $name[0];
if (preg_match('/[^A-Z]/', $firstLatter)) {
throw new Error("Entity name should start with an upper case letter.");
if ($this->nameUtil->nameIsNotAllowed($name)) {
throw new Conflict("Entity name '{$name}' is not allowed.");
}
$normalizedName = Util::normilizeClassName($name);
@@ -918,9 +770,9 @@ class EntityManager
lcfirst($entity) . $entityForeign;
if (
strlen($relationName) > self::MAX_LINK_NAME
strlen($relationName) > NameUtil::MAX_LINK_NAME_LENGTH
) {
throw new Error("Relation name should not be longer than " . self::MAX_LINK_NAME . ".");
throw new Error("Relation name should not be longer than " . NameUtil::MAX_LINK_NAME_LENGTH . ".");
}
if (preg_match('/[^a-z]/', $relationName[0])) {
@@ -931,7 +783,7 @@ class EntityManager
throw new Conflict("Entity with the same name '{$relationName}' exists.");
}
if ($this->checkRelationshipExists($relationName)) {
if ($this->nameUtil->relationshipExists($relationName)) {
throw new Conflict("Relationship with the same name '{$relationName}' exists.");
}
}
@@ -945,8 +797,8 @@ class EntityManager
->setName($relationName)
->build();
if (strlen($link) > self::MAX_LINK_NAME || strlen($linkForeign) > self::MAX_LINK_NAME) {
throw new Error("Link name should not be longer than " . self::MAX_LINK_NAME . ".");
if (strlen($link) > NameUtil::MAX_LINK_NAME_LENGTH || strlen($linkForeign) > NameUtil::MAX_LINK_NAME_LENGTH) {
throw new Error("Link name should not be longer than " . NameUtil::MAX_LINK_NAME_LENGTH . ".");
}
if (is_numeric($link[0]) || is_numeric($linkForeign[0])) {
@@ -961,11 +813,11 @@ class EntityManager
throw new Error("Link name should start with a lower case letter.");
}
if (in_array($link, $this->linkForbiddenNameList)) {
if (in_array($link, NameUtil::LINK_FORBIDDEN_NAME_LIST)) {
throw new Conflict("Link name '{$link}' is not allowed.");
}
if (in_array($linkForeign, $this->linkForbiddenNameList)) {
if (in_array($linkForeign, NameUtil::LINK_FORBIDDEN_NAME_LIST)) {
throw new Conflict("Link name '{$linkForeign}' is not allowed.");
}
application/Espo/Tools/EntityManager/NameUtil.php
+233
View File
@@ -0,0 +1,233 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii 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\Tools\EntityManager;
use Espo\Core\Utils\Metadata;
use Espo\Core\Utils\Util;
use Espo\Core\ServiceFactory;
use Espo\ORM\EntityManager;
use Espo\ORM\Entity;
class NameUtil
{
public const MAX_ENTITY_NAME_LENGTH = 100;
public const MIN_ENTITY_NAME_LENGTH = 3;
public const MAX_LINK_NAME_LENGTH = 100;
/**
* @var string[]
*/
public const RESERVED_WORLD_LIST = [
'__halt_compiler', 'abstract', 'and', 'array', 'as', 'break', 'callable',
'case', 'catch', 'class', 'clone', 'const', 'continue', 'declare', 'default',
'die', 'do', 'echo', 'else', 'elseif', 'empty', 'enddeclare', 'endfor', 'endforeach',
'endif', 'endswitch', 'endwhile', 'eval', 'exit', 'extends', 'final', 'for', 'foreach',
'function', 'global', 'goto', 'if', 'implements', 'include', 'include_once', 'instanceof',
'insteadof', 'interface', 'isset', 'list', 'namespace', 'new', 'or', 'print', 'private',
'protected', 'public', 'require', 'require_once', 'return', 'static', 'switch', 'throw',
'trait', 'try', 'unset', 'use', 'var', 'while', 'xor', 'common', 'fn', 'parent',
];
/**
* @var string[]
*/
public const LINK_FORBIDDEN_NAME_LIST = [
'posts',
'stream',
'subscription',
'followers',
'action',
'null',
'false',
'true',
];
/**
* @var string[]
*/
public const ENTITY_TYPE_FORBIDDEN_NAME_LIST = [
'Common',
'PortalUser',
'ApiUser',
'Timeline',
'About',
'Admin',
'Null',
'False',
'True',
'Base',
];
private Metadata $metadata;
private ServiceFactory $serviceFactory;
private EntityManager $entityManager;
public function __construct(Metadata $metadata, ServiceFactory $serviceFactory, EntityManager $entityManager)
{
$this->metadata = $metadata;
$this->serviceFactory = $serviceFactory;
$this->entityManager = $entityManager;
}
public function nameIsBad(string $name): bool
{
if (!$name) {
return true;
}
if (preg_match('/[^a-zA-Z\d]/', $name)) {
return true;
}
if (preg_match('/[^A-Z]/', $name[0])) {
return true;
}
return false;
}
public function nameIsTooShort(string $name): bool
{
return strlen($name) < NameUtil::MIN_ENTITY_NAME_LENGTH;
}
public function nameIsTooLong(string $name): bool
{
return strlen($name) > NameUtil::MAX_ENTITY_NAME_LENGTH;
}
public function nameIsNotAllowed(string $name): bool
{
if (in_array($name, self::ENTITY_TYPE_FORBIDDEN_NAME_LIST)) {
return true;
}
if (in_array(strtolower($name), NameUtil::RESERVED_WORLD_LIST)) {
return true;
}
if ($name !== Util::normilizeScopeName($name)) {
return true;
}
return false;
}
public function nameIsUsed(string $name): bool
{
if ($this->metadata->get(['scopes', $name])) {
return true;
}
if ($this->metadata->get(['entityDefs', $name])) {
return true;
}
if ($this->metadata->get(['clientDefs', $name])) {
return true;
}
if ($this->relationshipExists($name)) {
return true;
}
if ($this->controllerExists($name)) {
return true;
}
if ($this->serviceFactory->checkExists($name)) {
return true;
}
return false;
}
private function controllerExists(string $name): bool
{
$controllerClassName = 'Espo\\Custom\\Controllers\\' . Util::normilizeClassName($name);
if (class_exists($controllerClassName)) {
return true;
}
foreach ($this->metadata->getModuleList() as $moduleName) {
$controllerClassName =
'Espo\\Modules\\' . $moduleName . '\\Controllers\\' . Util::normilizeClassName($name);
if (class_exists($controllerClassName)) {
return true;
}
}
$controllerClassName = 'Espo\\Controllers\\' . Util::normilizeClassName($name);
if (class_exists($controllerClassName)) {
return true;
}
return false;
}
public function relationshipExists(string $name): bool
{
/** @var string[] */
$scopeList = array_keys($this->metadata->get(['scopes'], []));
foreach ($scopeList as $entityType) {
$relationsDefs = $this->entityManager
->getMetadata()
->get($entityType, 'relations');
if (empty($relationsDefs)) {
continue;
}
foreach ($relationsDefs as $item) {
if (empty($item['type']) || empty($item['relationName'])) {
continue;
}
if (
$item['type'] === Entity::MANY_MANY &&
ucfirst($item['relationName']) === ucfirst($name)
) {
return true;
}
}
}
return false;
}
}
application/Espo/Tools/EntityManager/Rename/ClassType.php
+43
View File
@@ -0,0 +1,43 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii 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\Tools\EntityManager\Rename;
class ClassType
{
public const ENTITY = 'Entities';
public const CONTROLLER = 'Controllers';
public const REPOSITORY = 'Repositories';
public const SELECT_MANAGER = 'SelectManagers';
public const SERVICE = 'Services';
}
application/Espo/Tools/EntityManager/Rename/FailReason.php
+53
View File
@@ -0,0 +1,53 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii 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\Tools\EntityManager\Rename;
class FailReason
{
public const ENV_NOT_SUPPORTED = 'envNotSupported';
public const TABLE_EXISTS = 'tableExists';
public const DOES_NOT_EXIST = 'doesNotExist';
public const NOT_CUSTOM = 'notCustom';
public const NAME_USED = 'nameUsed';
public const NAME_NOT_ALLOWED = 'nameIsNotAllosed';
public const NAME_BAD = 'nameBad';
public const NAME_TOO_LONG = 'nameTooLong';
public const NAME_TOO_SHORT = 'nameTooShort';
public const ERROR = 'error';
}
application/Espo/Tools/EntityManager/Rename/MetadataType.php
+53
View File
@@ -0,0 +1,53 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii 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\Tools\EntityManager\Rename;
class MetadataType
{
public const ENTITY_DEFS = 'entityDefs';
public const SCOPES = 'scopes';
public const ACL_DEFS = 'aclDefs';
public const ENTITY_ACL = 'entityAcl';
public const CLIENT_DEFS = 'clientDefs';
public const SELECT_DEFS = 'selectDefs';
public const RECORD_DEFS = 'recordDefs';
public const NOTIFICATION_DEFS = 'notificationDefs';
public const PDF_DEFS = 'pdfDefs';
public const FORMULA = 'formula';
}
application/Espo/Tools/EntityManager/Rename/Renamer.php
+675
View File
@@ -0,0 +1,675 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii 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\Tools\EntityManager\Rename;
use Espo\Core\Console\IO;
use Espo\Core\Utils\Metadata;
use Espo\Core\Utils\File\Manager as FileManager;
use Espo\Core\Utils\Util;
use Espo\Core\DataManager;
use Espo\Core\Utils\Config;
use Espo\Core\Utils\Config\ConfigWriter;
use Espo\Core\Utils\Language;
use Espo\Core\Utils\Log;
use Espo\ORM\EntityManager;
use Espo\Tools\EntityManager\NameUtil;
use RuntimeException;
use Throwable;
class Renamer
{
/**
* @var array<int,ClassType::*>
*/
private $classTypeList = [
ClassType::ENTITY,
ClassType::CONTROLLER,
ClassType::REPOSITORY,
ClassType::SELECT_MANAGER,
ClassType::SERVICE,
];
/**
* @var array<int,MetadataType::*>
*/
private $metadataTypeList = [
MetadataType::ACL_DEFS,
MetadataType::CLIENT_DEFS,
MetadataType::ENTITY_DEFS,
MetadataType::ENTITY_ACL,
MetadataType::FORMULA,
MetadataType::NOTIFICATION_DEFS,
MetadataType::PDF_DEFS,
MetadataType::RECORD_DEFS,
MetadataType::SCOPES,
MetadataType::SELECT_DEFS,
];
private NameUtil $nameUtil;
private Metadata $metadata;
private FileManager $fileManager;
private EntityManager $entityManager;
private DataManager $dataManager;
private Config $config;
private ConfigWriter $configWriter;
private Language $language;
private Log $log;
public function __construct(
NameUtil $nameUtil,
Metadata $metadata,
FileManager $fileManager,
EntityManager $entityManager,
DataManager $dataManager,
Config $config,
ConfigWriter $configWriter,
Language $language,
Log $log
) {
$this->nameUtil = $nameUtil;
$this->metadata = $metadata;
$this->fileManager = $fileManager;
$this->entityManager = $entityManager;
$this->dataManager = $dataManager;
$this->config = $config;
$this->configWriter = $configWriter;
$this->language = $language;
$this->log = $log;
}
public function process(string $entityType, string $newName, IO $io): Result
{
$failResult = $this->validate($entityType, $newName);
if ($failResult) {
return $failResult;
}
$io->writeLine(' DB table...');
$this->renameDbTable($entityType, $newName);
$io->writeLine(' DB many-to-many tables...');
$this->renameDbManyToMany($entityType, $newName);
$io->writeLine(' metadata relationships...');
$this->renameInRelationships($entityType, $newName);
$io->writeLine(' metadata fields...');
$this->renameInFields($entityType, $newName);
$io->writeLine(' php classes...');
foreach ($this->classTypeList as $classType) {
$this->renameClass($classType, $entityType, $newName);
}
$io->writeLine(' metadata files...');
foreach ($this->metadataTypeList as $metadataType) {
$this->renameMetadata($metadataType, $entityType, $newName);
}
$io->writeLine(' layouts...');
$this->renameLayouts($entityType, $newName);
$io->writeLine(' values in DB...');
$this->changeValuesInDb($entityType, $newName);
$io->writeLine(' language...');
$this->renameLanguage($entityType, $newName);
$io->writeLine(' config parameters...');
$this->renameInConfig($entityType, $newName);
$io->writeLine(' rebuild...');
$this->dataManager->rebuild();
return Result::createSuccess();
}
private function validate(string $entityType, string $newName): ?Result
{
if (!$this->metadata->get(['scopes', $entityType, 'entity'])) {
return Result::createFail(FailReason::DOES_NOT_EXIST);
}
if (!$this->metadata->get(['scopes', $entityType, 'isCustom'])) {
return Result::createFail(FailReason::NOT_CUSTOM);
}
if ($this->nameUtil->nameIsBad($newName)) {
return Result::createFail(FailReason::NAME_BAD);
}
/** @var non-empty-string $newName */
if ($this->nameUtil->nameIsTooLong($newName)) {
return Result::createFail(FailReason::NAME_TOO_LONG);
}
if ($this->nameUtil->nameIsTooShort($newName)) {
return Result::createFail(FailReason::NAME_TOO_SHORT);
}
if ($this->nameUtil->nameIsNotAllowed($newName)) {
return Result::createFail(FailReason::NAME_NOT_ALLOWED);
}
if ($this->nameUtil->nameIsUsed($newName)) {
return Result::createFail(FailReason::NAME_USED);
}
if (!$this->fileManager->isFile($this->getClassFilePath(ClassType::ENTITY, $entityType))) {
return Result::createFail(FailReason::NOT_CUSTOM);
}
if (!$this->fileManager->isFile($this->getClassFilePath(ClassType::CONTROLLER, $entityType))) {
return Result::createFail(FailReason::NOT_CUSTOM);
}
if (!$this->fileManager->isFile($this->getMetadataFilePath(MetadataType::ENTITY_DEFS, $entityType))) {
return Result::createFail(FailReason::NOT_CUSTOM);
}
if (!$this->fileManager->isFile($this->getMetadataFilePath(MetadataType::SCOPES, $entityType))) {
return Result::createFail(FailReason::NOT_CUSTOM);
}
if ($this->tableExists($newName)) {
return Result::createFail(FailReason::TABLE_EXISTS);
}
return null;
}
private function renameDbManyToMany(string $entityType, string $newName): void
{
$relationList = $this->entityManager
->getDefs()
->getEntity($entityType)
->getRelationList();
foreach ($relationList as $relation) {
if (!$relation->isManyToMany()) {
continue;
}
if (lcfirst($relation->getRelationshipName()) === 'entityTeam') {
continue;
}
$this->renameDbRelationshipTableColumn(
$relation->getRelationshipName(),
$entityType . 'Id',
$newName . 'Id'
);
}
}
/**
* @param ClassType::* $classType
*/
private function renameClass(string $classType, string $name, string $newName): void
{
$path = $this->getClassFilePath($classType, $name);
$newPath = $this->getClassFilePath($classType, $newName);
if (!$this->fileManager->isFile($path)) {
return;
}
$contents = $this->fileManager->getContents($path);
$replaceFrom = [
"class {$name}",
"'{$name}'",
];
$replaceTo = [
"class {$newName}",
"'{$newName}'",
];
$newContents = str_replace($replaceFrom, $replaceTo, $contents);
$this->fileManager->putContents($newPath, $newContents);
$this->fileManager->removeFile($path);
}
/**
* @param MetadataType::* $metadataType
*/
private function renameMetadata(string $metadataType, string $name, string $newName): void
{
$path = $this->getMetadataFilePath($metadataType, $name);
$newPath = $this->getMetadataFilePath($metadataType, $newName);
if (!$this->fileManager->isFile($path)) {
return;
}
$contents = $this->fileManager->getContents($path);
$replaceFrom = [];
$replaceTo = [];
$newContents = str_replace($replaceFrom, $replaceTo, $contents);
$this->fileManager->putContents($newPath, $newContents);
$this->fileManager->removeFile($path);
}
/**
* @param ClassType::* $classType
*/
private function getClassFilePath(string $classType, string $name): string
{
return "custom/Espo/Custom/{$classType}/{$name}.php";
}
/**
* @param MetadataType::* $metadataType
*/
private function getMetadataFilePath(string $metadataType, string $name): string
{
return "custom/Espo/Custom/Resources/metadata/{$metadataType}/{$name}.json";
}
private function renameLayouts(string $name, string $newName): void
{
$fromPath = "custom/Espo/Custom/Resources/layouts/{$name}";
$toPath = "custom/Espo/Custom/Resources/layouts/{$newName}";
rename($fromPath, $toPath);
}
private function tableExists(string $newName): bool
{
$table = Util::camelCaseToUnderscore($newName);
if (self::dbNameSanitize($table) !== $table) {
throw new RuntimeException();
}
$sql = "SHOW TABLES LIKE '{$table}'";
$sth = $this->entityManager->getSqlExecutor()->execute($sql);
if ($sth->fetch()) {
return true;
}
return false;
}
private function renameDbTable(string $name, string $newName): void
{
$table = Util::camelCaseToUnderscore($name);
$newTable = Util::camelCaseToUnderscore($newName);
if (self::dbNameSanitize($table) !== $table) {
throw new RuntimeException();
}
if (self::dbNameSanitize($newTable) !== $newTable) {
throw new RuntimeException();
}
$sql = "RENAME TABLE `{$table}` TO `{$newTable}`";
$this->entityManager->getSqlExecutor()->execute($sql);
}
private function renameDbRelationshipTableColumn(string $entityType, string $name, string $newName): void
{
$table = Util::camelCaseToUnderscore($entityType);
$column = Util::camelCaseToUnderscore($name);
$newColumn = Util::camelCaseToUnderscore($newName);
if (self::dbNameSanitize($table) !== $table) {
throw new RuntimeException();
}
if (self::dbNameSanitize($column) !== $column) {
throw new RuntimeException();
}
if (self::dbNameSanitize($newColumn) !== $newColumn) {
throw new RuntimeException();
}
$sql = "ALTER TABLE `{$table}` CHANGE `{$column}` `{$newColumn}` VARCHAR(24)";
try {
$this->entityManager->getSqlExecutor()->execute($sql);
}
catch (Throwable $e) {
$msg = $e->getMessage();
$this->log->error("Entity-rename: Rename relationship column failed: {$msg}.");
}
}
private static function dbNameSanitize(string $name): string
{
return preg_replace('/[^A-Za-z0-9_]+/', '', $name) ?? '';
}
private function renameLanguage(string $entityType, string $newName): void
{
$label = $this->language->translateLabel($entityType, 'scopeNames');
$labelPlural = $this->language->translateLabel($entityType, 'scopeNamesPlural');
$this->language->delete('Global', 'scopeNames', $entityType);
$this->language->delete('Global', 'scopeNamesPlural', $entityType);
$this->language->set('Global', 'scopeNames', $newName, $label);
$this->language->set('Global', 'scopeNamesPlural', $newName, $labelPlural);
$this->language->save();
$langList = $this->fileManager->getDirList('custom/Espo/Custom/Resources/i18n');
foreach ($langList as $lang) {
$fromPath = "custom/Espo/Custom/Resources/i18n/{$lang}/{$entityType}.json";
$toPath = "custom/Espo/Custom/Resources/i18n/{$lang}/{$newName}.json";
if (!$this->fileManager->isFile($fromPath)) {
continue;
}
$contents = $this->fileManager->getContents($fromPath);
$this->fileManager->putContents($toPath, $contents);
$this->fileManager->removeFile($fromPath);
}
}
private function renameInConfig(string $entityType, string $newName): void
{
/** @var string[] */
$entityTypeListParamList = $this->metadata->get(['app', 'config', 'entityTypeListParamList']) ?? [];
foreach ($entityTypeListParamList as $param) {
/** @var ?string[] */
$list = $this->config->get($param);
if ($list === null) {
continue;
}
$index = array_search($entityType, $list, true);
if ($index === false) {
continue;
}
$list[$index] = $newName;
$this->configWriter->set($param, $list);
}
$this->configWriter->save();
}
private function renameInRelationships(string $entityType, string $newName): void
{
/** @var string[] */
$entityTypeList = array_keys($this->metadata->get(['entityDefs']) ?? []);
foreach ($entityTypeList as $itemEntityType) {
$this->renameInRelationshipsEntity($itemEntityType, $entityType, $newName);
}
$this->metadata->save();
}
private function renameInRelationshipsEntity(string $entityType, string $fromEntityType, string $toEntityType): void
{
/** @var array<string,array<string,mixed>> */
$linkDefs = $this->metadata->get(['entityDefs', $entityType, 'links']) ?? [];
foreach ($linkDefs as $link => $defs) {
$itemEntityType = $defs['entity'] ?? null;
if ($itemEntityType !== $fromEntityType) {
continue;
}
$this->metadata->set('entityDefs', $entityType, [
'links' => [
$link => [
'entity' => $toEntityType,
]
]
]);
}
}
private function renameInFields(string $entityType, string $newName): void
{
$entityList = $this->entityManager
->getDefs()
->getEntityList();
foreach ($entityList as $entityDefs) {
foreach ($entityDefs->getFieldNameList() as $field) {
$this->renameInFieldsField($entityDefs->getName(), $field, $entityType, $newName);
}
}
$this->metadata->save();
}
private function renameInFieldsField(string $entityType, string $field, string $from, string $to): void
{
$defs = $this->entityManager
->getDefs()
->getEntity($entityType)
->getField($field);
if ($defs->getType() === 'linkParent') {
$this->renameInLinkParentField($entityType, $defs->getName(), $from, $to);
return;
}
}
private function renameInLinkParentField(string $entityType, string $field, string $from, string $to): void
{
/** @var string[] */
$list = $this->metadata->get(['entityDefs', $entityType, 'fields', $field, 'entityList']) ?? [];
$index = array_search($from, $list, true);
if ($index === false) {
return;
}
$list[$index] = $to;
$this->metadata->set('entityDefs', $entityType, [
'fields' => [
$field => ['entityList' => $list]
]
]);
}
private function changeValuesInDb(string $from, string $to): void
{
$this->changeValuesInDbFields($from, $to);
$this->changeValuesInDbRoles($from, $to);
$query1 = $this->entityManager
->getQueryBuilder()
->update()
->in('EntityTeam')
->set(['entityType' => $to])
->where(['entityType' => $from])
->build();
$this->entityManager->getQueryExecutor()->execute($query1);
$query2 = $this->entityManager
->getQueryBuilder()
->update()
->in('EntityEmailAddress')
->set(['entityType' => $to])
->where(['entityType' => $from])
->build();
$this->entityManager->getQueryExecutor()->execute($query2);
$query3 = $this->entityManager
->getQueryBuilder()
->update()
->in('EntityPhoneNumber')
->set(['entityType' => $to])
->where(['entityType' => $from])
->build();
$this->entityManager->getQueryExecutor()->execute($query3);
}
private function changeValuesInDbFields(string $from, string $to): void
{
$entityList = $this->entityManager
->getDefs()
->getEntityList();
foreach ($entityList as $entityDefs) {
foreach ($entityDefs->getFieldNameList() as $field) {
$this->changeValuesInDbFieldsField($entityDefs->getName(), $field, $from, $to);
}
}
}
private function changeValuesInDbFieldsField(string $entityType, string $field, string $from, string $to): void
{
$defs = $this->entityManager
->getDefs()
->getEntity($entityType)
->getField($field);
if ($defs->getType() === 'linkParent') {
$this->changeValuesInDbFieldsFieldLinkParent($entityType, $defs->getName(), $from, $to);
return;
}
}
private function changeValuesInDbFieldsFieldLinkParent(
string $entityType,
string $field,
string $from,
string $to
): void {
$typeAttribute = $field . 'Type';
$query = $this->entityManager
->getQueryBuilder()
->update()
->in($entityType)
->set([$typeAttribute => $to])
->where([$typeAttribute => $from])
->build();
try {
$this->entityManager->getQueryExecutor()->execute($query);
}
catch (Throwable $e) {
$msg = $e->getMessage();
$this->log->error("Entity-rename: Update values in link-parent field {$entityType}.{$field}: {$msg}.");
}
}
private function changeValuesInDbRoles(string $from, string $to): void
{
$roleList = $this->entityManager
->getRDBRepository(\Espo\Entities\Role::ENTITY_TYPE)
->find();
foreach ($roleList as $role) {
/** @var \stdClass */
$data = $role->get('data');
/** @var \stdClass */
$fieldData = $role->get('fieldData');
if (isset($data->$from)) {
$data->$to = $data->$from;
unset($data->$from);
$role->set('data', $data);
}
if (isset($fieldData->$from)) {
$fieldData->$to = $fieldData->$from;
unset($fieldData->$from);
$role->set('fieldData', $fieldData);
}
$this->entityManager->saveEntity($role);
}
$portalRoleList = $this->entityManager
->getRDBRepository(\Espo\Entities\PortalRole::ENTITY_TYPE)
->find();
foreach ($portalRoleList as $role) {
/** @var \stdClass */
$data = $role->get('data');
/** @var \stdClass */
$fieldData = $role->get('fieldData');
if (isset($data->$from)) {
$data->$to = $data->$from;
unset($data->$from);
$role->set('data', $data);
}
if (isset($fieldData->$from)) {
$fieldData->$to = $fieldData->$from;
unset($fieldData->$from);
$role->set('fieldData', $fieldData);
}
$this->entityManager->saveEntity($role);
}
}
}
application/Espo/Tools/EntityManager/Rename/Result.php
+71
View File
@@ -0,0 +1,71 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii 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\Tools\EntityManager\Rename;
class Result
{
private bool $isFail = false;
/**
* @var FailReason::*|null
*/
private ?string $failReason = null;
public static function createSuccess(): self
{
return new self();
}
/**
* @param FailReason::* $reason
*/
public static function createFail(string $reason): self
{
$obj = new self();
$obj->isFail = true;
$obj->failReason = $reason;
return $obj;
}
public function isFail(): bool
{
return $this->isFail;
}
/**
* @return FailReason::*|null
*/
public function getFailReason(): ?string
{
return $this->failReason;
}
}
tests/unit/Espo/Core/Console/IOTest.php
+46
View File
@@ -0,0 +1,46 @@
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii 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 tests\unit\Espo\Core\Console;
use Espo\Core\Console\IO;
class IOTest extends \PHPUnit\Framework\TestCase
{
public function testExitStatus(): void
{
$io = new IO();
$this->assertEquals(0, $io->getExitStatus());
$io->setExitStatus(1);
$this->assertEquals(1, $io->getExitStatus());
}
}