FlexyProject\GitHub\Receiver\Miscellaneous\Licenses

Complexity

Total Complexity

2

Size/Duplication

Total Lines	30
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	listAllLicenses()	0	4	1
A	getIndividualLicense()	0	6	1

<?php
namespace FlexyProject\GitHub\Receiver\Miscellaneous;

/**
 * The Licenses API class returns information about open source licenses or under what license, if any a given project
 * is distributed.
 *
 * @link    https://developer.github.com/v3/licenses/
 * @package FlexyProject\GitHub\Receiver\Miscellaneous
 */
class Licenses extends AbstractMiscellaneous
{

    /**
     * List all licenses
     *
     * @link https://developer.github.com/v3/licenses/#list-all-licenses
     * @return array
     */
    public function listAllLicenses(): array
    {
        return $this->getApi()->setAccept('application/vnd.github.drax-preview+json')->request('/licenses');
    }

    /**
     * Get an individual license
     *
     * @link https://developer.github.com/v3/licenses/#get-an-individual-license
     *
     * @param string $license
     *
     * @return array
     */
    public function getIndividualLicense(string $license): array
    {
        return $this->getApi()->setAccept('application/vnd.github.drax-preview+json')->request($this->getApi()
                                                                                                    ->sprintf('/licenses/:license',
                                                                                                        $license));
    }
}