Gogs PHP API Client

Table of content

Gogs
1. API
  1. Request
    1. Base Base class for request types.
    2. Collection Collection is a collection of data of one type.
    3. Exception
      1. InvalidMethodRequestException Thrown whenever a class that inherits the base-classis used wrong (e.g tries to create on a loaded object)
      2. NotImplementedException Thrown when the requested method for a class isn'timplemented.
      3. RequestErrorException Typically thrown when needed data to build the queryis missing.
      4. SearchParamException Thrown when needed parameters for a search is missing.
    4. Org Stores data and methods related to a single organization.
    5. Orgs Orgs is a collection of organizations.
    6. Repo Stores data and methods related to a single repository.
    7. Repos Repos is a collection of repos.
    8. RequestInterface Request interface, used by any kind of request object.
    9. User Stores user data and methods related to a single user.
    10. Users Returns one or more users in the Gogs installation,depending on the called method.
  2. Client Gogs API client.
2. Lib
  1. Curl
    1. Client A trait used for every class referencing the api-url and token.
    2. Exception
      1. HTTPUnexpectedResponse Defines an unexpected response.
      2. NotAuthorizedException When the request fails because of an unauthorized token,this is thrown instead.
  2. ArrayIterator Interface to store one or more elements in arrayproviding an iterator interface.
  3. Collection Base class for collections. Implements basicfunctions and typically used to return collectionswhich wont be a part of the "request package"

Documentation

Gogs

Gogs\API
Gogs\API\Request
Gogs\API\Request\Exception
Gogs\Lib
Gogs\Lib\Curl
Gogs\Lib\Curl\Exception

Gogs\API

Classes

Client `Gogs\API`

Class uses Gogs\Lib\Curl\Client

Gogs API client.

This class initially provide the programmer with a starting point (a kind of an "interface" to start from), to keep track of the context when going from a user, to a repo, organization etc.

Methods

Name	Return	Access	Description
__construct		public
users	Users	public	Returns a Request\Users to fetch users from theGogs installation.
user	User	public	Get a single user from Gogs.
repos	Repos	public	Returns an \Request\Repos to fetch repositorieson the Gogs installation.

Method details

__construct `Gogs\API\Client`

public function __construct(string $api_url, string $api_token);

Parameters

Type	Variable	Description
string	$api_url	The base URL for the Gogs API (e.g https://git.domain.tld/api/v1)
string	$api_token	The token for an authorized user to query Gogs API.

users `Gogs\API\Client`

public function users();

Returns a Request\Users to fetch users from the Gogs installation.

Returns: Users

user `Gogs\API\Client`

public function user(string $name = "me");

Get a single user from Gogs.

Returns either

the authorized user ($name = "" or "me")
the specified user ($name = anything else)

Parameters

Type	Variable	Description
string	$name	None

Returns: User

repos `Gogs\API\Client`

public function repos();

Returns an \Request\Repos to fetch repositories on the Gogs installation.

Returns: Repos

Gogs\API\Request

Classes

Base `Gogs\API\Request`

Class implementsGogs\API\Request\RequestInterface
Class uses Gogs\Lib\Curl\Client

Base class for request types.

Each request shall inherit this class to ensure it will have the correct methods required by interface, and get the cURL functionality.

Methods

Name	Return	Access	Description
__construct		public
load	object	final public	Load an object.
method_get	string	final protected	Perform a GET-request against the Gogs API.
method_post	string	final protected	Perform a POST-request against the Gogs API.
method_delete	string	final protected	Perform a DELETE-request against the Gogs API.
get	object	public	Get object references by identifier.
create	bool	public	Create object inherited by class.
patch	bool	public	Patch (update) object
delete	bool	public	Delete object.
json_decode	object	final protected	Decode JSON-string.
json_encode	string	final protected	Encode JSON-object/array.
json_error		final protected	Check for errors on encoding/decoding.
property_exists	string v false	final protected	Checks if the property (key) exists within selfor parent class.
__get	mixed v null	final public	Get property by name.
__set	mixed v null	final public	Set property by name.
__isset	bool	final public	Checks if property is set.
json_set_property	true v array	abstract protected	Set properties for the current object.
set_scope	bool	abstract protected	Set the scope for the request methods accepted by the child.

Method details

__construct `Gogs\API\Request\Base`

public function __construct(string $api_url, string $api_token);

Parameters

Type	Variable	Description
string	$api_url	The URL to the API.
string	$api_token	A token for an authorized user

load `Gogs\API\Request\Base`

final public function load(bool $force = false);

Load an object.

If $force = true the object will be fetched from the Gogs API again.

Parameters

Type	Variable	Description
bool	$force	Force update, default: true

Returns: object

method_get `Gogs\API\Request\Base`

final protected function method_get(array $params = array());

Perform a GET-request against the Gogs API.

Ensure the correct scope i set first, with

$this->set_scope("*valid scope*"); // e.g create

Parameters

Type	Variable	Description
array	$params	The parameters

Returns: string

method_post `Gogs\API\Request\Base`

final protected function method_post(array $params = array());

Perform a POST-request against the Gogs API.

Ensure the correct scope i set first, with

$this->set_scope("*valid scope*"); // e.g create

Parameters

Type	Variable	Description
array	$params	The parameters

Returns: string

method_delete `Gogs\API\Request\Base`

final protected function method_delete();

Perform a DELETE-request against the Gogs API.

Ensure the correct scope i set first, with

$this->set_scope("*valid scope*"); // e.g delete

Returns: string

get `Gogs\API\Request\Base`

public function get(string $s);

Get object references by identifier.

Parameters

Type	Variable	Description
string	$s	The idientifier to look up

Returns: object

create `Gogs\API\Request\Base`

public function create(... $args);

Create object inherited by class.

Child class must add a scope for 'create' and ensure child is not loaded, otherwise will create throw an exception.

Parameters

Type	Variable	Description
...	$args	Arguments required by create.

Returns: bool

Throws:

InvalidMethodRequestException
NotImplementedException

patch `Gogs\API\Request\Base`

public function patch();

Patch (update) object

Returns: bool

Throws:

InvalidMethodRequestException
NotImplementedException

delete `Gogs\API\Request\Base`

public function delete();

Delete object.

Returns: bool

Throws:

NotImplementedException

json_decode `Gogs\API\Request\Base`

final protected function json_decode(string $jenc);

Decode JSON-string.

Will ensure that there weren't any errors by calling $this->json_error.

Parameters

Type	Variable	Description
string	$jenc	Encoded JSON string

Returns: object

json_encode `Gogs\API\Request\Base`

final protected function json_encode(iterable $jdec);

Encode JSON-object/array.

Will ensure that there weren't any errors by calling $this->json_error.

Parameters

Type	Variable	Description
iterable	$jdec	JSON-data

Returns: string

json_error `Gogs\API\Request\Base`

final protected function json_error();

Check for errors on encoding/decoding.

Throws:

RequestErrorException

property_exists `Gogs\API\Request\Base`

final protected function property_exists(mixed $name);

Checks if the property (key) exists within self or parent class.

Returns the actual key if it does. A class key (aka property) start with the tag classname_ followed by property name, reflecting the JSON-object, and can be reached by

$class->parameter,
$class->classname_parameter or alternatively (for classes that inherits another class).
$class->parentclassname_parameter.

If a class override a parent class with the same parameter, the class's own parameter will be favoured.

As this is public properties this wont be an security issue;

Parameters

Type	Variable	Description
mixed	$name	Name of the key.

Returns: string v false

__get `Gogs\API\Request\Base`

final public function __get(string $name);

Get property by name.

Checks both self and parent for the property.

Returns the value if property exists, otherwise an E_USER_NOTICE is triggered.

Parameters

Type	Variable	Description
string	$name	None

Returns: mixed v null

__set `Gogs\API\Request\Base`

final public function __set(string $name, mixed $value);

Set property by name.

Checks both self and parent for the property.

Returns the value if property exists, otherwise an E_USER_NOTICE is triggered.

Parameters

Type	Variable	Description
string	$name	Property name
mixed	$value	Property value

Returns: mixed v null

__isset `Gogs\API\Request\Base`

final public function __isset(string $name);

Checks if property is set.

Checks both self and parent for property.

Triggers E_USER_NOTICE if property is unknown.

Parameters

Type	Variable	Description
string	$name	Property name

Returns: bool

json_set_property `Gogs\API\Request\Base`

abstract protected function json_set_property(mixed $obj);

Set properties for the current object.

Each child class must implement this to set its data. Will be called by methods such as load and from collection classes.

Will return true/false for singel objects but an array on collections. The array will contain the newly inserted elements. This to prevent additional iterations.

This method should also set loaded to true or false, depending on success or failure.

Parameters

Type	Variable	Description
mixed	$obj	None

Returns: true v array

set_scope `Gogs\API\Request\Base`

abstract protected function set_scope(string $method);

Set the scope for the request methods accepted by the child.

This can be

get,
search,
delete etc.

Must return true if scope exists of false otherwise. Methods the calls this will throw an exception if not true is returned.

Parameters

Type	Variable	Description
string	$method	Method type, e.g "get"

Returns: bool

Collection `Gogs\API\Request`

Class extends Gogs\API\Request\Base
Class implements
- Gogs\Lib\ArrayIterator
- Gogs\API\Request\RequestInterface

Collection is a collection of data of one type.

Methods

Name	Return	Access	Description
add	mixed v int	public	Add an object to the collection.
remove	bool	public	Remove an element in collection.
all	array	public
len	int	public
by_key	mixed	public
next	mixed	public
prev	mixed	public
current		public
reset	mixed	public
search	Collection	abstract public	Search for an object.

Method details

add `Gogs\API\Request\Collection`

public function add(mixed $obj, mixed $key = null);

Add an object to the collection.

When adding a key the object will be stored on the particual key, also overwriting existing data.

Parameters

Type	Variable	Description
mixed	$obj	Element to store
mixed	$key	Index key to store on

Returns: mixed v int

remove `Gogs\API\Request\Collection`

public function remove(mixed $any, bool $deep = true);

Remove an element in collection.

The function will first look for the element as a index key, but if its not found it will look for the element as a value.

Deep functions only when the value is given and not the key.

Parameters

Type	Variable	Description
mixed	$any	Index key or element value
bool	$deep	Delete every item and not just the first

Returns: bool

all `Gogs\API\Request\Collection`

public function all();

Returns: array

len `Gogs\API\Request\Collection`

public function len();

Returns: int

by_key `Gogs\API\Request\Collection`

public function by_key(mixed $idx);

Parameters

Type	Variable	Description
mixed	$idx	Index key.

Returns: mixed

next `Gogs\API\Request\Collection`

public function next();

Returns: mixed

prev `Gogs\API\Request\Collection`

public function prev();

Returns: mixed

current `Gogs\API\Request\Collection`

public function current();

reset `Gogs\API\Request\Collection`

public function reset();

Returns: mixed

search `Gogs\API\Request\Collection`

abstract public function search(array $params = array());

Search for an object.

Parameters

Type	Variable	Description
array	$params	Parameters

Returns: Collection

Org `Gogs\API\Request`

Class extends Gogs\API\Request\User
Class implementsGogs\API\Request\RequestInterface

Stores data and methods related to a single organization.

By now the following are supported:

GET /orgs/username
POST /admin/users/username/orgs (Requires admin rights. Curl will throw NotAuthorized exception if not).

Methods

Name	Return	Access	Description
__construct		public	Initialize an organization.
set_scope	bool	protected
search		public
create	bool	public	Create a new user

Method details

__construct `Gogs\API\Request\Org`

public function __construct(string $api_url, string $api_token, User $owner = null, string $oname = null);

Initialize an organization.

Parameters

Type	Variable	Description
string	$api_url	The URL to the API.
string	$api_token	A token for an authorized user
User	$owner	The owner of the organization
string	$oname	Organization name

set_scope `Gogs\API\Request\Org`

protected function set_scope(string $method);

Parameters

Type	Variable	Description
string	$method	Method type, e.g "get"

Returns: bool

Throws:

InvalidMethodRequestException
RequestErrorException

search `Gogs\API\Request\Org`

public function search(string $q);

Parameters

Type	Variable	Description
string	$q	None

create `Gogs\API\Request\Org`

public function create(... $args);

Create a new user

Valid parameters:

username
full_name
description
website
location

This reflects the API v1 doc, but is in an order where the required fields is first.

Parameters

Type	Variable	Description
...	$args	Arguments required by create.

Returns: bool

Orgs `Gogs\API\Request`

Class extends Gogs\API\Request\Collection
Class implements
- Gogs\Lib\ArrayIterator
- Gogs\API\Request\RequestInterface

Orgs is a collection of organizations.

Methods

Name	Return	Access	Description
__construct		public
set_scope	bool	protected	Set the scope for the request methods accepted by the child.
create	bool	public	Create object inherited by class.
get	object	public	Get an organization by indentifier.
search	Collection	public	Search for an organization.
json_set_property	true v array	protected

Method details

__construct `Gogs\API\Request\Orgs`

public function __construct(string $api_url, string $api_token, User $owner);

Parameters

Type	Variable	Description
string	$api_url	The URL to the API.
string	$api_token	A token for an authorized user
User	$owner	None

set_scope `Gogs\API\Request\Orgs`

protected function set_scope(string $method);

Set the scope for the request methods accepted by the child.

This can be

get,
search,
delete etc.

Must return true if scope exists of false otherwise. Methods the calls this will throw an exception if not true is returned.

Parameters

Type	Variable	Description
string	$method	Method type, e.g "get"

Returns: bool

create `Gogs\API\Request\Orgs`

public function create(... $args);

Create object inherited by class.

Child class must add a scope for 'create' and ensure child is not loaded, otherwise will create throw an exception.

Parameters

Type	Variable	Description
...	$args	Arguments required by create.

Returns: bool

Throws:

InvalidMethodRequestException
NotImplementedException

get `Gogs\API\Request\Orgs`

public function get(string $s);

Get an organization by indentifier.

Method will first look through organizations already loaded. If not found it will return a new object.

Method does not ensure the organization in loaded from Gogs so the user should call ->load() on returned element.

Parameters

Type	Variable	Description
string	$s	The idientifier to look up

Returns: object

search `Gogs\API\Request\Orgs`

public function search(array $params = array());

Search for an organization.

Params can be an array of

$orgs->search(array(
 "name"  => "name",      // alt. "q". required
 "limit" => 10,          // not required, default: 10
));

By now, this method can be intensive, as it will load every organization and then do a match on each entry.

Parameters

Type	Variable	Description
array	$params	Parameters

Returns: Collection

Throws:

SearchParamException

json_set_property `Gogs\API\Request\Orgs`

protected function json_set_property(mixed $obj);

Parameters

Type	Variable	Description
mixed	$obj	None

Returns: true v array

Repo `Gogs\API\Request`

Class extends Gogs\API\Request\Base
Class implementsGogs\API\Request\RequestInterface

Stores data and methods related to a single repository.

By now the following are supported:

GET /repos/username/reponame
POST /user/repos
POST /admin/user/username/repos
POST /org/orgname/repos
DELETE /repos/username/reponame

Methods

Name	Return	Access	Description
__construct		public	Initialize a repo object.
set_scope	bool	protected
json_set_property	true v array	protected
search		public
create	bool	public	Create a new repo

Method details

__construct `Gogs\API\Request\Repo`

public function __construct(string $api_url, string $api_token, User $owner = null, string $name = null);

Initialize a repo object.

Note that the owner can also be an Org (organization), or any other class that inherits a user.

Parameters

Type	Variable	Description
string	$api_url	The URL to the API.
string	$api_token	A token for an authorized user
User	$owner	The owner of the repo
string	$name	The repo name

set_scope `Gogs\API\Request\Repo`

protected function set_scope(string $method);

Parameters

Type	Variable	Description
string	$method	Method type, e.g "get"

Returns: bool

Throws:

RequestErrorException

json_set_property `Gogs\API\Request\Repo`

protected function json_set_property(mixed $obj);

Parameters

Type	Variable	Description
mixed	$obj	None

Returns: true v array

search `Gogs\API\Request\Repo`

public function search(string $q);

Parameters

Type	Variable	Description
string	$q	None

create `Gogs\API\Request\Repo`

public function create(... $args);

Create a new repo

Valid paramters:

name
description
private (default: false)
auto_init (default: false)
gitignore
license
readme (default: "Default")

This reflects the API v1 documentation, but is in an order where the required fields are first.

Parameters

Type	Variable	Description
...	$args	Arguments required by create.

Returns: bool

Repos `Gogs\API\Request`

Class extends Gogs\API\Request\Collection
Class implements
- Gogs\Lib\ArrayIterator
- Gogs\API\Request\RequestInterface

Repos is a collection of repos.

Methods

Name	Return	Access	Description
__construct		public	Initialize a repos collection
set_scope	bool	protected
create	bool	public
search	Collection	public	Searches for a repo.
json_set_property	true v array	protected

Method details

__construct `Gogs\API\Request\Repos`

public function __construct(string $api_url, string $api_token, User $owner = null);

Initialize a repos collection

If owner is not set it will query the whole repo archive on Gogs.

Parameters

Type	Variable	Description
string	$api_url	The URL to the API.
string	$api_token	A token for an authorized user
User	$owner	The owner of the collection

set_scope `Gogs\API\Request\Repos`

protected function set_scope(string $method);

Parameters

Type	Variable	Description
string	$method	Method type, e.g "get"

Returns: bool

create `Gogs\API\Request\Repos`

public function create(... $args);

Parameters

Type	Variable	Description
...	$args	Arguments required by create.

Returns: bool

search `Gogs\API\Request\Repos`

public function search(array $params = array());

Searches for a repo.

If the owner is specified the search will be limited to the actual user.

Parameters

Type	Variable	Description
array	$params	Parameters

Returns: Collection

json_set_property `Gogs\API\Request\Repos`

protected function json_set_property(mixed $obj);

Parameters

Type	Variable	Description
mixed	$obj	None

Returns: true v array

User `Gogs\API\Request`

Class extends Gogs\API\Request\Base
Class implementsGogs\API\Request\RequestInterface

Stores user data and methods related to a single user.

By now the following are supported:

GET /user
GET /users/username
POST /admin/users (Requires admin rights. Curl will throw NotAuthorized exception if not).
DELETE /admin/users (Requires admin rights. Curl will throw NotAuthorized exception if not).

A user can also list it's repos and organizations.

Methods

Name	Return	Access	Description
__construct		public	Initialize an user object.
set_scope	bool	protected
search		public
authenticated	bool	public	Returns if the user is the authenticated user.
repos	Repos	public	Returns every repo under user.
repo	Repo	public	Return a single repo.
organizations	Orgs	public	Return every organization under user.
organization	Org	public	Return a single organization.
create	bool	public	Create a new user.
json_set_property	true v array	protected

Method details

__construct `Gogs\API\Request\User`

public function __construct(string $api_url, string $api_token, string $user = "");

Initialize an user object.

Parameters

Type	Variable	Description
string	$api_url	The URL to the API.
string	$api_token	A token for an authorized user
string	$user	The username. "Empty" or "me" will return authenticated user

set_scope `Gogs\API\Request\User`

protected function set_scope(string $method);

Parameters

Type	Variable	Description
string	$method	Method type, e.g "get"

Returns: bool

Throws:

InvalidMethodRequest
RequestErrorException

search `Gogs\API\Request\User`

public function search(string $q);

Parameters

Type	Variable	Description
string	$q	None

authenticated `Gogs\API\Request\User`

public function authenticated();

Returns if the user is the authenticated user.

Returns: bool

repos `Gogs\API\Request\User`

public function repos();

Returns every repo under user.

Returns: Repos

repo `Gogs\API\Request\User`

public function repo(string $name);

Return a single repo.

Note: This will also load the repo.

Parameters

Type	Variable	Description
string	$name	Repo name

Returns: Repo

organizations `Gogs\API\Request\User`

public function organizations();

Return every organization under user.

Returns: Orgs

organization `Gogs\API\Request\User`

public function organization(string $name);

Return a single organization.

Note: This will also load the repo.

Parameters

Type	Variable	Description
string	$name	Organization name

Returns: Org

create `Gogs\API\Request\User`

public function create(... $args);

Create a new user.

Valid parameters

username
email
source_id
login_name
password
send_notify

This reflects the API v1 documentation, but is in an order where the required fields are first.

Parameters

Type	Variable	Description
...	$args	Arguments required by create.

Returns: bool

json_set_property `Gogs\API\Request\User`

protected function json_set_property(mixed $obj);

Parameters

Type	Variable	Description
mixed	$obj	None

Returns: true v array

Users `Gogs\API\Request`

Class extends Gogs\API\Request\Collection
Class implements
- Gogs\Lib\ArrayIterator
- Gogs\API\Request\RequestInterface

Returns one or more users in the Gogs installation, depending on the called method.

Methods

Name	Return	Access	Description
set_scope	bool	protected	Set the scope for the request methods accepted by the child.
create	bool	public	Returns a new user object. If argumentsis specified the user will be "created".
get	object	public	Get object references by identifier.
search	Collection	public	Search for an object.
json_set_property	true v array	protected	Set properties for the current object.

Method details

set_scope `Gogs\API\Request\Users`

protected function set_scope(string $method);

Set the scope for the request methods accepted by the child.

This can be

get,
search,
delete etc.

Must return true if scope exists of false otherwise. Methods the calls this will throw an exception if not true is returned.

Parameters

Type	Variable	Description
string	$method	Method type, e.g "get"

Returns: bool

create `Gogs\API\Request\Users`

public function create(... $args);

Returns a new user object. If arguments is specified the user will be "created".

The arguments can be left out to "create" the user through the user object iteself.

Parameters

Type	Variable	Description
...	$args	Arguments required by create.

Returns: bool

get `Gogs\API\Request\Users`

public function get(string $s = "");

Get object references by identifier.

Parameters

Type	Variable	Description
string	$s	The idientifier to look up

Returns: object

search `Gogs\API\Request\Users`

public function search(array $params = array());

Search for an object.

Parameters

Type	Variable	Description
array	$params	Parameters

Returns: Collection

json_set_property `Gogs\API\Request\Users`

protected function json_set_property(mixed $obj);

Set properties for the current object.

Each child class must implement this to set its data. Will be called by methods such as load and from collection classes.

Will return true/false for singel objects but an array on collections. The array will contain the newly inserted elements. This to prevent additional iterations.

This method should also set loaded to true or false, depending on success or failure.

Parameters

Type	Variable	Description
mixed	$obj	None

Returns: true v array

Interfaces

RequestInterface `Gogs\API\Request`

Request interface, used by any kind of request object.

Methods

Name	Return	Access	Description
load	object	public	Load object.
get	object	public	Get by identifier
create	bool	public	Create object
patch	bool	public	Patch (update) object
delete	bool	public	Delete object

Method details

load `Gogs\API\Request\RequestInterface`

public function load(bool $force = false);

Load object.

Parameters

Type	Variable	Description
bool	$force	Force update, default: true

Returns: object

get `Gogs\API\Request\RequestInterface`

public function get(string $s);

Get by identifier

Parameters

Type	Variable	Description
string	$s	The idientifier to look up

Returns: object

create `Gogs\API\Request\RequestInterface`

public function create(... $args);

Create object

Parameters

Type	Variable	Description
...	$args	Arguments required by create.

Returns: bool

patch `Gogs\API\Request\RequestInterface`

public function patch();

Patch (update) object

Returns: bool

delete `Gogs\API\Request\RequestInterface`

public function delete();

Delete object

Returns: bool

Gogs\API\Request\Exception

Exceptions

InvalidMethodRequestException `Gogs\API\Request\Exception`

Class extends Exception

Thrown whenever a class that inherits the base-class is used wrong (e.g tries to create on a loaded object)

NotImplementedException `Gogs\API\Request\Exception`

Class extends BadMethodCallException

Thrown when the requested method for a class isn't implemented.

RequestErrorException `Gogs\API\Request\Exception`

Class extends Exception

Typically thrown when needed data to build the query is missing.

SearchParamException `Gogs\API\Request\Exception`

Class extends Exception

Thrown when needed parameters for a search is missing.

Gogs\Lib

Classes

Collection `Gogs\Lib`

Class implementsGogs\Lib\ArrayIterator

Base class for collections. Implements basic functions and typically used to return collections which wont be a part of the "request package"

Methods

Name	Return	Access	Description
set		public	Set value(e) to the collection.
by_key	mixed	public
all	array	public
len	int	public
next	mixed	public
prev	mixed	public
current		public
reset	mixed	public

Method details

set `Gogs\Lib\Collection`

public function set(mixed $val, mixed $key = null);

Set value(e) to the collection.

If the value is an array it will overwrite the whole object-array, aka everything.

Parameters

Type	Variable	Description
mixed	$val	None
mixed	$key	None

by_key `Gogs\Lib\Collection`

public function by_key(mixed $idx);

Parameters

Type	Variable	Description
mixed	$idx	Index key.

Returns: mixed

all `Gogs\Lib\Collection`

public function all();

Returns: array

len `Gogs\Lib\Collection`

public function len();

Returns: int

next `Gogs\Lib\Collection`

public function next();

Returns: mixed

prev `Gogs\Lib\Collection`

public function prev();

Returns: mixed

current `Gogs\Lib\Collection`

public function current();

reset `Gogs\Lib\Collection`

public function reset();

Returns: mixed

Interfaces

ArrayIterator `Gogs\Lib`

Interface to store one or more elements in array providing an iterator interface.

Methods

Name	Return	Access	Description
current		public	Get current element in collection.
next	mixed	public	Get next element in collection.
prev	mixed	public	Return previous element in collection.
reset	mixed	public	Reset collection (set array to head).
len	int	public	Return collection size.
all	array	public	Return the whole colection.
by_key	mixed	public	Get element by index key.

Method details

current `Gogs\Lib\ArrayIterator`

public function current();

Get current element in collection.

next `Gogs\Lib\ArrayIterator`

public function next();

Get next element in collection.

Returns: mixed

prev `Gogs\Lib\ArrayIterator`

public function prev();

Return previous element in collection.

Returns: mixed

reset `Gogs\Lib\ArrayIterator`

public function reset();

Reset collection (set array to head).

Returns: mixed

len `Gogs\Lib\ArrayIterator`

public function len();

Return collection size.

Returns: int

all `Gogs\Lib\ArrayIterator`

public function all();

Return the whole colection.

Returns: array

by_key `Gogs\Lib\ArrayIterator`

public function by_key(mixed $idx);

Get element by index key.

Parameters

Type	Variable	Description
mixed	$idx	Index key.

Returns: mixed

Gogs\Lib\Curl

Traits

Client `Gogs\Lib\Curl`

A trait used for every class referencing the api-url and token.

Methods

Name	Return	Access	Description
method	int	protected	Initializes a curl request of different kinds, dependingon the specified method. This can be
authorized	bool	protected	Checks if the user is authorized for the scope. Shouldn'tbe used frequently. One test for one scope should be enough,but if you know for sure thats you're programming with theuse of an authorized user you should leave this and justhandle the NotAuthorizedExeption whenever thrown.

Method details

method `Gogs\Lib\Curl\Client`

protected function method(string $method, string $req, string $scope, array $params, bool $ret);

Initializes a curl request of different kinds, depending on the specified method. This can be

DELETE, PATCH, POST or GET. An unidentified value will become a GET-request.

Parameters

Type	Variable	Description
string	$method	either DELETE, PATCH, POST, GET
string	$req	&$req variable to store request body in
string	$scope	scope within the API (e.g /user/repos)
array	$params	parameters to pass
bool	$ret	return transfer

Returns: int

authorized `Gogs\Lib\Curl\Client`

protected function authorized(string $scope = "");

Checks if the user is authorized for the scope. Shouldn't be used frequently. One test for one scope should be enough, but if you know for sure thats you're programming with the use of an authorized user you should leave this and just handle the NotAuthorizedExeption whenever thrown.

Parameters

Type	Variable	Description
string	$scope	the scope, a relative uri.

Returns: bool

Throws:

Gogs\Lib\Curl\Exception

Exceptions

HTTPUnexpectedResponse `Gogs\Lib\Curl\Exception`

Class extends Exception

Defines an unexpected response.

Methods

Name	Return	Access	Description
__construct		public	Sets the exceptions.
__toString	string	public	Visual representation of the exception.
getResponse	string	public	Get the actual response from the body or the request.

Method details

__construct `Gogs\Lib\Curl\Exception\HTTPUnexpectedResponse`

public function __construct(string $message, int $code = -1, Exception $previous = null);

Sets the exceptions.

Parameters

Type	Variable	Description
string	$message	None
int	$code	None
Exception	$previous	None

__toString `Gogs\Lib\Curl\Exception\HTTPUnexpectedResponse`

public function __toString();

Visual representation of the exception.

Returns: string

getResponse `Gogs\Lib\Curl\Exception\HTTPUnexpectedResponse`

public function getResponse();

Get the actual response from the body or the request.

Returns: string

NotAuthorizedException `Gogs\Lib\Curl\Exception`

Class extends Gogs\Lib\Curl\Exception\HTTPUnexpectedResponse

When the request fails because of an unauthorized token, this is thrown instead.

Methods

Name	Return	Access	Description
__construct		public	Sets the exceptions.

Method details

__construct `Gogs\Lib\Curl\Exception\NotAuthorizedException`

public function __construct(string $message, int $code = 401, Exception $previous = null);

Sets the exceptions.

Parameters

Type	Variable	Description
string	$message	None
int	$code	None
Exception	$previous	None

Genetated using Sami and the Sami/Twig Markdown Extension

README.md 46 KB История Исходник

Gogs PHP API Client

Table of content

Documentation

Gogs

Gogs\API

Classes

Client Gogs\API

Methods

Method details

__construct Gogs\API\Client

users Gogs\API\Client

user Gogs\API\Client

repos Gogs\API\Client

Gogs\API\Request

Classes

Base Gogs\API\Request

Methods

Method details

__construct Gogs\API\Request\Base

load Gogs\API\Request\Base

method_get Gogs\API\Request\Base

method_post Gogs\API\Request\Base

method_delete Gogs\API\Request\Base

get Gogs\API\Request\Base

create Gogs\API\Request\Base

patch Gogs\API\Request\Base

delete Gogs\API\Request\Base

json_decode Gogs\API\Request\Base

json_encode Gogs\API\Request\Base

json_error Gogs\API\Request\Base

property_exists Gogs\API\Request\Base

__get Gogs\API\Request\Base

__set Gogs\API\Request\Base

__isset Gogs\API\Request\Base

json_set_property Gogs\API\Request\Base

set_scope Gogs\API\Request\Base

Collection Gogs\API\Request

Methods

Method details

add Gogs\API\Request\Collection

remove Gogs\API\Request\Collection

all Gogs\API\Request\Collection

len Gogs\API\Request\Collection

by_key Gogs\API\Request\Collection

next Gogs\API\Request\Collection

prev Gogs\API\Request\Collection

current Gogs\API\Request\Collection

reset Gogs\API\Request\Collection

search Gogs\API\Request\Collection

Org Gogs\API\Request

Methods

Method details

__construct Gogs\API\Request\Org

set_scope Gogs\API\Request\Org

search Gogs\API\Request\Org

create Gogs\API\Request\Org

Orgs Gogs\API\Request

Methods

Method details

__construct Gogs\API\Request\Orgs

set_scope Gogs\API\Request\Orgs

create Gogs\API\Request\Orgs

get Gogs\API\Request\Orgs

search Gogs\API\Request\Orgs

json_set_property Gogs\API\Request\Orgs

Repo Gogs\API\Request

Methods

Method details

__construct Gogs\API\Request\Repo

set_scope Gogs\API\Request\Repo

json_set_property Gogs\API\Request\Repo

search Gogs\API\Request\Repo

create Gogs\API\Request\Repo

Repos Gogs\API\Request

Methods

Method details

__construct Gogs\API\Request\Repos

set_scope Gogs\API\Request\Repos

create Gogs\API\Request\Repos

README.md 46 KB

История Исходник

Client `Gogs\API`

__construct `Gogs\API\Client`

users `Gogs\API\Client`

user `Gogs\API\Client`

repos `Gogs\API\Client`

Base `Gogs\API\Request`

__construct `Gogs\API\Request\Base`

load `Gogs\API\Request\Base`

method_get `Gogs\API\Request\Base`

method_post `Gogs\API\Request\Base`

method_delete `Gogs\API\Request\Base`

get `Gogs\API\Request\Base`

create `Gogs\API\Request\Base`

patch `Gogs\API\Request\Base`

delete `Gogs\API\Request\Base`

json_decode `Gogs\API\Request\Base`

json_encode `Gogs\API\Request\Base`

json_error `Gogs\API\Request\Base`

property_exists `Gogs\API\Request\Base`

__get `Gogs\API\Request\Base`

__set `Gogs\API\Request\Base`

__isset `Gogs\API\Request\Base`

json_set_property `Gogs\API\Request\Base`

set_scope `Gogs\API\Request\Base`

Collection `Gogs\API\Request`

add `Gogs\API\Request\Collection`

remove `Gogs\API\Request\Collection`

all `Gogs\API\Request\Collection`

len `Gogs\API\Request\Collection`

by_key `Gogs\API\Request\Collection`

next `Gogs\API\Request\Collection`

prev `Gogs\API\Request\Collection`

current `Gogs\API\Request\Collection`

reset `Gogs\API\Request\Collection`

search `Gogs\API\Request\Collection`

Org `Gogs\API\Request`

__construct `Gogs\API\Request\Org`

set_scope `Gogs\API\Request\Org`

search `Gogs\API\Request\Org`

create `Gogs\API\Request\Org`

Orgs `Gogs\API\Request`

__construct `Gogs\API\Request\Orgs`

set_scope `Gogs\API\Request\Orgs`

create `Gogs\API\Request\Orgs`

get `Gogs\API\Request\Orgs`

search `Gogs\API\Request\Orgs`

json_set_property `Gogs\API\Request\Orgs`

Repo `Gogs\API\Request`

__construct `Gogs\API\Request\Repo`

set_scope `Gogs\API\Request\Repo`

json_set_property `Gogs\API\Request\Repo`

search `Gogs\API\Request\Repo`

create `Gogs\API\Request\Repo`

Repos `Gogs\API\Request`

__construct `Gogs\API\Request\Repos`

set_scope `Gogs\API\Request\Repos`

create `Gogs\API\Request\Repos`

search `Gogs\API\Request\Repos`

json_set_property `Gogs\API\Request\Repos`

User `Gogs\API\Request`

__construct `Gogs\API\Request\User`

set_scope `Gogs\API\Request\User`

search `Gogs\API\Request\User`

authenticated `Gogs\API\Request\User`

repos `Gogs\API\Request\User`

repo `Gogs\API\Request\User`

organizations `Gogs\API\Request\User`

organization `Gogs\API\Request\User`

create `Gogs\API\Request\User`

json_set_property `Gogs\API\Request\User`

Users `Gogs\API\Request`

set_scope `Gogs\API\Request\Users`

create `Gogs\API\Request\Users`

get `Gogs\API\Request\Users`

search `Gogs\API\Request\Users`

json_set_property `Gogs\API\Request\Users`

RequestInterface `Gogs\API\Request`

load `Gogs\API\Request\RequestInterface`

get `Gogs\API\Request\RequestInterface`