EspoCRM – Open Source CRM Application
PHP calendarcontactscrmcrm-platformcrm-systemcustomer-portalcustomer-supportcustomizabledocumentsemail-marketingkanbanleadsopen-sourcephpplatformsales-automationsingle-page-applicationsupport
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 EspoCRM, Inc.
* Website: https://www.espocrm.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://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 Affero General Public License version 3.
*
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
namespace Espo\Core\Upgrades\Actions\Extension;
use Espo\Core\Exceptions\Error;
use Espo\Entities\Extension;
use Throwable;
class Uninstall extends \Espo\Core\Upgrades\Actions\Base\Uninstall
{
protected ?Extension $extensionEntity = null;
/**
* Get entity of this extension.
*
* @return Extension
* @throws Error
*/
protected function getExtensionEntity()
{
if (!isset($this->extensionEntity)) {
$processId = $this->getProcessId();
$this->extensionEntity = $this->getEntityManager()->getEntityById(Extension::ENTITY_TYPE, $processId);
if (!$this->extensionEntity) {
throw new Error('Extension entity not found.');
}
}
return $this->extensionEntity;
}
/**
* @throws Error
*/
protected function afterRunAction(): void
{
/** Set extension entity, isInstalled = false */
$extensionEntity = $this->getExtensionEntity();
$extensionEntity->set('isInstalled', false);
try {
$this->getEntityManager()->saveEntity($extensionEntity);
} catch (Throwable $e) {
$this->getLog()->error(
'Error saving Extension entity. The error occurred by existing Hook, more details: ' .
$e->getMessage() .' at '. $e->getFile() . ':' . $e->getLine()
);
$this->throwErrorAndRemovePackage('Error saving Extension entity. Check logs for details.', false);
}
}
/**
* @return string[]
* @throws Error
*/
protected function getRestoreFileList(): array
{
if (!isset($this->data['restoreFileList'])) {
$extensionEntity = $this->getExtensionEntity();
$this->data['restoreFileList'] = $extensionEntity->get('fileList');
}
return $this->data['restoreFileList'] ?? [];
}
}