PHP Класс Acacha\Llum\Github\GithubAPI

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$api_url string Github API URL.
$authorizations_uri string Authorization URI in github API.
$client GuzzleHttp\Client Guzzle http client.
$filesystem Acacha\Llum\Filesystem\Filesystem Acacha Llum Filesystem.
$repos_uri string Authorization URI in github API.
$tokenName Token name;

Открытые методы

Метод Описание
__construct ( Filesystem $filesystem ) GithubAPI constructor.
createRepo ( $repo_name, $repo_description ) : mixed Create repo in github.
getPersonalToken ( $username, $password ) : mixed Obtain personal token.
setCredentials ( array $credentials ) Set github credentials.
tokenName ( ) : mixed

Защищенные методы

Метод Описание
authorization_url ( ) : string Authorization URL.
authorizationsRequestJson ( ) : array
compile ( $template, $data ) : mixed Compile the template using the given data.
compileStub ( $repo_name, $repo_description ) : mixed Compile stub.
create_repo_url ( ) : string Create repo URL.
credentials ( ) : mixed Get github credentials.
repo_json_stub ( ) : string Path to repo.json stub

Описание методов

__construct() публичный Метод

GithubAPI constructor.
public __construct ( Filesystem $filesystem )
$filesystem Acacha\Llum\Filesystem\Filesystem

authorization_url() защищенный Метод

Authorization URL.
protected authorization_url ( ) : string
Результат string

authorizationsRequestJson() защищенный Метод

protected authorizationsRequestJson ( ) : array
Результат array

compile() защищенный Метод

Compile the template using the given data.
protected compile ( $template, $data ) : mixed
$template
$data
Результат mixed

compileStub() защищенный Метод

Compile stub.
protected compileStub ( $repo_name, $repo_description ) : mixed
$repo_name
$repo_description
Результат mixed

createRepo() публичный Метод

Create repo in github.
public createRepo ( $repo_name, $repo_description ) : mixed
$repo_name
$repo_description
Результат mixed

create_repo_url() защищенный Метод

Create repo URL.
protected create_repo_url ( ) : string
Результат string

credentials() защищенный Метод

Get github credentials.
protected credentials ( ) : mixed
Результат mixed

getPersonalToken() публичный Метод

Obtain personal token.
public getPersonalToken ( $username, $password ) : mixed
$username
$password
Результат mixed

repo_json_stub() защищенный Метод

Path to repo.json stub
protected repo_json_stub ( ) : string
Результат string

setCredentials() публичный Метод

Set github credentials.
public setCredentials ( array $credentials )
$credentials array

tokenName() публичный Метод

public tokenName ( ) : mixed
Результат mixed

Описание свойств

$api_url защищенное свойство

Github API URL.
protected string $api_url
Результат string

$authorizations_uri защищенное свойство

Authorization URI in github API.
protected string $authorizations_uri
Результат string

$client защищенное свойство

Guzzle http client.
protected Client,GuzzleHttp $client
Результат GuzzleHttp\Client

$filesystem защищенное свойство

Acacha Llum Filesystem.
protected Filesystem,Acacha\Llum\Filesystem $filesystem
Результат Acacha\Llum\Filesystem\Filesystem

$repos_uri защищенное свойство

Authorization URI in github API.
protected string $repos_uri
Результат string

$tokenName защищенное свойство

Token name;
protected $tokenName