API Documentation
\
duncan3dc
GitHub
Exceptions

\duncan3dc\GitHubDirectory

Summary

Methods
Properties
Constants
fromTreeItem()
getName()
getDirectories()
getDirectory()
hasDirectory()
getFiles()
getFile()
hasFile()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
__construct()
getTree()
$api
$data
$tree
N/A

Properties

$data

$data : \stdClass

Type

\stdClass — The directory's data.

Methods

fromTreeItem()

fromTreeItem(\stdClass  $item, \duncan3dc\GitHub\ApiInterface  $api) : \duncan3dc\GitHub\DirectoryInterface

Create a new instance.

Parameters

\stdClass $item

The tree item data from the GitHub Api
\duncan3dc\GitHub\ApiInterface $api

The Api instance to communicate with GitHub

Returns

\duncan3dc\GitHub\DirectoryInterface

getName()

getName() : string

Get the name of this directory.

Returns

string

getDirectories()

getDirectories()

getDirectory()

getDirectory(\duncan3dc\GitHub\string  $name)

Parameters

\duncan3dc\GitHub\string $name

hasDirectory()

hasDirectory(\duncan3dc\GitHub\string  $name)

Parameters

\duncan3dc\GitHub\string $name

getFiles()

getFiles()

getFile()

getFile(\duncan3dc\GitHub\string  $name)

Parameters

\duncan3dc\GitHub\string $name

hasFile()

hasFile(\duncan3dc\GitHub\string  $name)

Parameters

\duncan3dc\GitHub\string $name

__construct()

__construct(\stdClass  $data, \duncan3dc\GitHub\ApiInterface  $api)

Create a new instance.

Parameters

\stdClass $data

The directory's data from the GitHub Api
\duncan3dc\GitHub\ApiInterface $api

The Api instance to communicate with GitHub