studio-backend-bundle/src/Element/Service/ElementDeleteServiceInterface.php at b6ac4ee37acf03fda1045ad49eb21c7dec5be471 · pimcore/studio-backend-bundle · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<?php
declare(strict_types=1);

/**
 * This source file is available under the terms of the
 * Pimcore Open Core License (POCL)
 * Full copyright and license information is available in
 * LICENSE.md which is distributed with this source code.
 *
 *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
 *  @license    Pimcore Open Core License (POCL)
 */

namespace Pimcore\Bundle\StudioBackendBundle\Element\Service;

use Pimcore\Bundle\StudioBackendBundle\Element\Schema\DeleteInfo;
use Pimcore\Bundle\StudioBackendBundle\Exception\Api\ElementDeletionFailedException;
use Pimcore\Bundle\StudioBackendBundle\Exception\Api\EnvironmentException;
use Pimcore\Bundle\StudioBackendBundle\Exception\Api\ForbiddenException;
use Pimcore\Bundle\StudioBackendBundle\Exception\Api\InvalidElementTypeException;
use Pimcore\Bundle\StudioBackendBundle\Exception\Api\NotFoundException;
use Pimcore\Bundle\StudioBackendBundle\MappedParameter\ElementParameters;
use Pimcore\Bundle\StudioBackendBundle\MappedParameter\IdsParameter;
use Pimcore\Model\Element\ElementInterface;
use Pimcore\Model\UserInterface;

interface ElementDeleteServiceInterface
{
    /**
     * @throws ElementDeletionFailedException
     * @throws EnvironmentException
     * @throws ForbiddenException
     * @throws InvalidElementTypeException
     * @throws NotFoundException
     */
    public function deleteElements(
        ElementParameters $elementParameters,
        UserInterface $user
    ): ?int;

    /**
     * @throws ForbiddenException|InvalidElementTypeException|NotFoundException
     */
    public function batchDeleteElements(IdsParameter $elementIds, string $elementType, UserInterface $user): ?int;

    /**
     * @throws ElementDeletionFailedException|EnvironmentException|ForbiddenException|InvalidElementTypeException
     */
    public function processBatchDelete(ElementInterface $parentElement, UserInterface $user, string $elementType): void;

    /**
     * @throws ElementDeletionFailedException|EnvironmentException|ForbiddenException|InvalidElementTypeException
     */
    public function deleteParentElement(
        ElementInterface $element,
        UserInterface $user
    ): void;

    /**
     * @throws ElementDeletionFailedException|EnvironmentException|ForbiddenException
     */
    public function deleteElement(
        ElementInterface $element,
        UserInterface $user,
        bool $skipChildrenCheck = false
    ): void;

    public function addElementToRecycleBin(
        ElementInterface $element,
        UserInterface $user
    ): void;

    /**
     * @throws InvalidElementTypeException
     */
    public function getElementDeleteInfo(
        ElementInterface $element,
        UserInterface $user
    ): DeleteInfo;
}