zendesk/zendesk_api_client_php

View on GitHub
src/Zendesk/API/Traits/Resource/DeleteMany.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

namespace Zendesk\API\Traits\Resource;

use Zendesk\API\Exceptions\RouteException;
use Zendesk\API\Http;

/**
 * Allows resources to call a bulk delete endpoint.
 *
 */
trait DeleteMany
{
    /**
     * Show multiple resources
     *
     * @param array  $ids Array of IDs to delete
     * @param string $key Could be `id` or `external_id`
     *
     * @return \stdClass | null
     *
     */
    public function deleteMany(array $ids = [], $key = 'ids')
    {
        try {
            $route = $this->getRoute(__FUNCTION__);
        } catch (RouteException $e) {
            if (! isset($this->resourceName)) {
                $this->resourceName = $this->getResourceNameFromClass();
            }

            $route = $this->resourceName . '/destroy_many.json';
            $this->setRoute('', $route);
        }

        $response = Http::send(
            $this->client,
            $route,
            [
                'method'      => 'DELETE',
                'queryParams' => [$key => implode(',', $ids)]
            ]
        );

        $this->client->setSideload(null);

        return $response;
    }
}