ViewTrait::endpoint() - Code Metrics - mpclarkson/freshdesk-php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

ViewTrait::endpoint()
last analyzed 2020-04-04 23:11 UTC

↳ Parent: ViewTrait

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	1
c	0
b	0
f	0
nc	1

<?php
/**
 * Created by PhpStorm.
 * User: Matthew
 * Date: 21/04/2016
 * Time: 9:10 AM
 */

namespace Freshdesk\Resources\Traits;

/**
 * View Trait
 *
 * @package Freshdesk\Resources\Traits
 *
 */
trait ViewTrait
{
    /**
     * @param integer $end string
     * @return string
     * @internal
     */
    abstract protected function endpoint($end = null);

    /**
     * @return \Freshdesk\Api
     * @internal
     */
    abstract protected function api();

    /**
     * View a resource
     *
     * Use 'include' to embed additional details in the response. Each include will consume an additional credit.
     * For example if you embed the requester and company information you will be charged a total of 3 API credits for the call.
     * See Freshdesk's documentation for details.
     *
     * @api
     * @param int $id The resource id
     * @param array|null $query
     * @return array|null
     * @throws \Freshdesk\Exceptions\AccessDeniedException
     * @throws \Freshdesk\Exceptions\ApiException
     * @throws \Freshdesk\Exceptions\AuthenticationException
     * @throws \Freshdesk\Exceptions\ConflictingStateException
     * @throws \Freshdesk\Exceptions\NotFoundException
     * @throws \Freshdesk\Exceptions\RateLimitExceededException
     * @throws \Freshdesk\Exceptions\UnsupportedContentTypeException
     * @throws \Freshdesk\Exceptions\MethodNotAllowedException
     * @throws \Freshdesk\Exceptions\UnsupportedAcceptHeaderException
     * @throws \Freshdesk\Exceptions\ValidationException
     */
    public function view($id, array $query = null)
    {
        return $this->api()->request('GET', $this->endpoint($id), null, $query);
    }
}


1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: Matthew
5			* Date: 21/04/2016
6			* Time: 9:10 AM
7			*/
8
9			namespace Freshdesk\Resources\Traits;
10
11			/**
12			* View Trait
13			*
14			* @package Freshdesk\Resources\Traits
15			*
16			*/
17			trait ViewTrait
18			{
19			/**
20			* @param integer $end string
21			* @return string
22			* @internal
23			*/
24			abstract protected function endpoint($end = null);
25
26			/**
27			* @return \Freshdesk\Api
28			* @internal
29			*/
30			abstract protected function api();
31
32			/**
33			* View a resource
34			*
35			* Use 'include' to embed additional details in the response. Each include will consume an additional credit.
36			* For example if you embed the requester and company information you will be charged a total of 3 API credits for the call.
37			* See Freshdesk's documentation for details.
38			*
39			* @api
40			* @param int $id The resource id
41			* @param array\|null $query
42			* @return array\|null
43			* @throws \Freshdesk\Exceptions\AccessDeniedException
44			* @throws \Freshdesk\Exceptions\ApiException
45			* @throws \Freshdesk\Exceptions\AuthenticationException
46			* @throws \Freshdesk\Exceptions\ConflictingStateException
47			* @throws \Freshdesk\Exceptions\NotFoundException
48			* @throws \Freshdesk\Exceptions\RateLimitExceededException
49			* @throws \Freshdesk\Exceptions\UnsupportedContentTypeException
50			* @throws \Freshdesk\Exceptions\MethodNotAllowedException
51			* @throws \Freshdesk\Exceptions\UnsupportedAcceptHeaderException
52			* @throws \Freshdesk\Exceptions\ValidationException
53			*/
54			public function view($id, array $query = null)
55			{
56			return $this->api()->request('GET', $this->endpoint($id), null, $query);
57			}
58			}
59

mpclarkson / freshdesk-php-sdk

ViewTrait::endpoint() last analyzed 2020-04-04 23:11 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ViewTrait::endpoint()
last analyzed 2020-04-04 23:11 UTC