class finder

This commit is contained in:
Yuri Kuznetsov
2020-06-17 16:22:06 +03:00
parent c0b68e7da5
commit af7a73ec42
4 changed files with 175 additions and 38 deletions

View File

@@ -0,0 +1,40 @@
<?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\Core\Loaders;
class ClassFinder extends Base
{
public function load()
{
return new \Espo\Core\Utils\ClassFinder(
$this->getContainer()->get('classParser')
);
}
}

View File

@@ -28,72 +28,40 @@
************************************************************************/
namespace Espo\Core;
use \Espo\Core\Exceptions\Error;
use \Espo\Core\Utils\Util;
use Espo\Core\Exceptions\Error;
class ServiceFactory
{
private $container;
protected $cacheFile = 'data/cache/application/services.php';
/**
* @var array - path to Service files
*/
protected $paths = [
'corePath' => 'application/Espo/Services',
'modulePath' => 'application/Espo/Modules/{*}/Services',
'customPath' => 'custom/Espo/Custom/Services',
];
protected $data;
public function __construct(Container $container)
{
$this->container = $container;
}
protected function getFileManager()
{
return $this->container->get('fileManager');
}
protected function getContainer()
{
return $this->container;
}
protected function init()
{
$classParser = $this->getContainer()->get('classParser');
$this->data = $classParser->getData($this->paths, $this->cacheFile);
}
protected function getClassName($name)
{
if (!isset($this->data)) {
$this->init();
}
if (isset($this->data[$name])) {
return $this->data[$name];
}
return false;
return $this->getContainer()->get('classFinder')->find('Services', $name);
}
public function checkExists($name) {
$className = $this->getClassName($name);
if (!empty($className)) {
return true;
if (!$className) {
return false;
}
return true;
}
public function create($name)
{
$className = $this->getClassName($name);
if (empty($className)) {
if (!$className) {
throw new Error("Service '{$name}' was not found.");
}
return $this->createByClassName($className);

View File

@@ -0,0 +1,79 @@
<?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\Core\Utils;
class ClassFinder
{
protected $classParser;
protected $pathsTemplate = [
'corePath' => 'application/Espo/{category}',
'modulePath' => 'application/Espo/Modules/{*}/{category}',
'customPath' => 'custom/Espo/Custom/{category}',
];
protected $dataHash = [];
public function __construct(File\ClassParser $classParser)
{
$this->classParser = $classParser;
}
/**
* Find class name by category (e.g. Controllers, Services) and name.
*/
public function find(string $category, string $name) : ?string
{
if (!array_key_exists($category, $this->dataHash)) {
$path = $this->buildPaths($category);
$cacheFile = $this->buildCacheFilePath($category);
$this->dataHash[$category] = $this->classParser->getData($path, $cacheFile);
}
$className = $this->dataHash[$category][$name] ?? null;
return $className;
}
protected function buildPaths(string $category) : array
{
$paths = [];
foreach ($this->pathsTemplate as $key => $value) {
$path[$key] = str_replace('{category}', $category, $value);
}
return $path;
}
protected function buildCacheFilePath(string $category) : string
{
$path = 'data/cache/application/' . str_replace('/', '_', strtolower($category)) . '.php';
return $path;
}
}

View File

@@ -0,0 +1,50 @@
<?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 tests\integration\Espo\Core\Utils;
class ClassFinder extends \tests\integration\Core\BaseTestCase
{
public function testFind1()
{
$classFinder = $this->getContainer()->get('classFinder');
$this->assertEquals(
'\\Espo\\Modules\\Crm\\Services\\Account',
$classFinder->find('Services', 'Account')
);
$this->assertEquals(
'\\Espo\\Services\\Record',
$classFinder->find('Services', 'Record')
);
$this->assertTrue(file_exists('data/cache/application/services.php'));
}
}