Files
espocrm/application/Espo/ORM/Query/Delete.php
Yuri Kuznetsov 331fb69364 phpdoc
2022-10-16 17:53:31 +03:00

82 lines
2.2 KiB
PHP

<?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\ORM\Query;
use RuntimeException;
/**
* Delete parameters.
*
* @immutable
*/
class Delete implements Query
{
use SelectingTrait;
use BaseTrait;
/**
* Get an entity type.
*/
public function getFrom(): string
{
return $this->params['from'];
}
/**
* Get a from-alias
*/
public function getFromAlias(): ?string
{
return $this->params['fromAlias'] ?? null;
}
/**
* Get a LIMIT.
*/
public function getLimit(): ?int
{
return $this->params['limit'] ?? null;
}
/**
* @param array<string,mixed> $params
*/
private function validateRawParams(array $params): void
{
$this->validateRawParamsSelecting($params);
$from = $params['from'] ?? null;
if (!$from || !is_string($from)) {
throw new RuntimeException("Select params: Missing 'from'.");
}
}
}