GitModuleSource

class GitModuleSource extends AbstractObject implements IdAble

Module source originating from a git repo.

Properties

| | $lastQuery | | from AbstractObject |

Methods

__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

from AbstractObject

null|array|string|int|float|bool

queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

from AbstractObject

string

cloneRef()

The ref to clone the root of the git repo from

string

commit()

The resolved commit of the git repo this source points to.

Directory

contextDirectory()

The directory containing everything needed to load load and use the module.

string

htmlRepoURL()

The URL to access the web view of the repository (e.g., GitHub, GitLab, Bitbucket)

string

htmlURL()

The URL to the source's git repo in a web browser

AbstractId

id()

A unique identifier for this GitModuleSource.

string

root()

The clean module name of the root of the module

string

rootSubpath()

The path to the root of the module source under the context directory. This directory contains its configuration file. It also contains its source code (possibly as a subdirectory).

string

version()

The specified version of the git repo this source points to.

Details

in AbstractObject at line 13 __construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

Parameters

| AbstractClient | $client | | | QueryBuilderChain | $queryBuilderChain | |

in AbstractObject at line 19 protected null|array|string|int|float|bool queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

Parameters

| QueryBuilder | $leafQueryBuilder | | | string | $leafKey | |

Return Value

| null|array|string|int|float|bool | |

at line 19 string cloneRef()

The ref to clone the root of the git repo from

Return Value

| string | |

at line 28 string commit()

The resolved commit of the git repo this source points to.

Return Value

| string | |

at line 37 Directory contextDirectory()

The directory containing everything needed to load load and use the module.

Return Value

| Directory | |

at line 46 string htmlRepoURL()

The URL to access the web view of the repository (e.g., GitHub, GitLab, Bitbucket)

Return Value

| string | |

at line 55 string htmlURL()

The URL to the source's git repo in a web browser

Return Value

| string | |

at line 64 AbstractId id()

A unique identifier for this GitModuleSource.

Return Value

| AbstractId | |

at line 73 string root()

The clean module name of the root of the module

Return Value

| string | |

at line 82 string rootSubpath()

The path to the root of the module source under the context directory. This directory contains its configuration file. It also contains its source code (possibly as a subdirectory).

Return Value

| string | |

at line 91 string version()

The specified version of the git repo this source points to.

Return Value

| string | |

Generated by Doctum, a API Documentation generator and fork of Sami.