PHP Interface TQ\Vcs\StreamWrapper\PathInformationInterface

Datei anzeigen Open project: teqneers/php-stream-wrapper-for-git Interface Usage Examples

Public Methods

Method Description
getArgument ( string $argument ) : string | null Returns the given argument from the argument collection
getArguments ( ) : array Returns the additional arguments given
getFullPath ( ) : string Returns the absolute path to the resource
getLocalPath ( ) : string Returns the relative path to the resource based on the repository path
getRef ( ) : string Returns the version ref
getRepository ( ) : TQ\Vcs\Repository\RepositoryInterface Returns the repository instance
getRepositoryPath ( ) : string Returns the absolute repository path
getUrl ( ) : string Returns the URL
hasArgument ( string $argument ) : boolean Checks if the given argument exists

Method Details

getArgument() public method

Returns the given argument from the argument collection
public getArgument ( string $argument ) : string | null
$argument string The argument name
return string | null The argument value or NULL if the argument does not exist

getArguments() public method

Returns the additional arguments given
public getArguments ( ) : array
return array

getFullPath() public method

Returns the absolute path to the resource
public getFullPath ( ) : string
return string

getLocalPath() public method

Returns the relative path to the resource based on the repository path
public getLocalPath ( ) : string
return string

getRef() public method

Returns the version ref
public getRef ( ) : string
return string

getRepository() public method

Returns the repository instance
public getRepository ( ) : TQ\Vcs\Repository\RepositoryInterface
return TQ\Vcs\Repository\RepositoryInterface

getRepositoryPath() public method

Returns the absolute repository path
public getRepositoryPath ( ) : string
return string

getUrl() public method

Returns the URL
public getUrl ( ) : string
return string

hasArgument() public method

Checks if the given argument exists
public hasArgument ( string $argument ) : boolean
$argument string The argument name
return boolean