zendesk/zendesk_api_client_php

View on GitHub
src/Zendesk/API/Resources/Core/Requests.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

namespace Zendesk\API\Resources\Core;

use Zendesk\API\Resources\ResourceAbstract;
use Zendesk\API\Traits\Resource\Defaults;
use Zendesk\API\Traits\Utility\InstantiatorTrait;

/**
 * The Requests class exposes request management methods
 *
 * @method RequestComments comments()
 */
class Requests extends ResourceAbstract
{
    use InstantiatorTrait;

    use Defaults;

    /**
     * {@inheritdoc}
     */
    protected function setUpRoutes()
    {
        $this->setRoutes([
            'findAllOpen'   => "{$this->resourceName}/open.json",
            'findAllSolved' => "{$this->resourceName}/solved.json",
            'findAllCCd'    => "{$this->resourceName}/ccd.json",
            'search'        => "{$this->resourceName}/search.json",
        ]);
    }

    /**
     * {@inheritdoc}
     */
    public static function getValidSubResources()
    {
        return [
            'comments' => RequestComments::class,
        ];
    }

    /**
     * {$@inheritdoc}
     */
    public function getRoute($name, array $params = [])
    {
        $lastChained = $this->getLatestChainedParameter([self::class]);

        if ((empty($lastChained)) || ! (in_array($name, ['findAll']))) {
            return parent::getRoute($name, $params);
        }

        $chainedResourceId    = reset($lastChained);
        $chainedResourceNames = array_keys($lastChained);
        $chainedResourceName  = (new $chainedResourceNames[0]($this->client))->resourceName;

        if ($name === 'findAll') {
            if (in_array($chainedResourceName, ['users', 'organizations'])) {
                return "{$chainedResourceName}/{$chainedResourceId}/{$this->resourceName}.json";
            }

            return "{$this->resourceName}.json";
        }
    }

    /**
     * Find all open requests
     *
     * @param array $params
     *
     * @return \stdClass | null
     */
    public function findAllOpen(array $params = [])
    {
        return $this->findAll($params, __FUNCTION__);
    }

    /**
     * Find all open requests
     *
     * @param array $params
     *
     * @return \stdClass | null
     */
    public function findAllSolved(array $params = [])
    {
        return $this->findAll($params, __FUNCTION__);
    }

    /**
     * Find all open requests
     *
     * @param array $params
     *
     * @return \stdClass | null
     */
    public function findAllCCd(array $params = [])
    {
        return $this->findAll($params, __FUNCTION__);
    }

    /**
     * Searching requests
     *
     * @param array $queryParams
     *
     * @return \stdClass | null
     */
    public function search(array $queryParams)
    {
        return $this->client->get($this->getRoute(__FUNCTION__), $queryParams);
    }
}