PHP Класс PHPComposter\PHPComposter\BaseAction

This class should be extended by each new action.
С версии: 0.1.3
Автор: Alain Schlesser ([email protected])
Показать файл Открыть проект

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

Свойство Тип Описание
$hook string Hook that was triggered.
$root string Root folder of the package.

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

Метод Описание
__construct ( string $hook, string $root ) Instantiate a BaseAction object.
init ( ) Initialize the action.
shutdown ( ) Shut the action down.

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

Метод Описание
getAgainst ( ) : string Get the tree object to check against.
getStagedFiles ( $pattern ) : array Get the file sthat have been staged for the current commit.
recursiveGlob ( string $pattern, integer $flags ) : mixed Recursively iterate over folders and look for $pattern.

Приватные методы

Метод Описание
prependRoot ( string &$file, integer $index, string $root ) Prepend the repository root path

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

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

Instantiate a BaseAction object.
С версии: 0.1.3
public __construct ( string $hook, string $root )
$hook string The name of the hook that was triggered.
$root string Absolute path to the root folder of the package.

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

Get the tree object to check against.
protected getAgainst ( ) : string
Результат string HEAD or hash representing empty/initial commit state

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

Get the file sthat have been staged for the current commit.
С версии: 0.1.3
protected getStagedFiles ( $pattern ) : array
Результат array

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

Initialize the action.
С версии: 0.1.3
public init ( )

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

Recursively iterate over folders and look for $pattern.
С версии: 0.1.3
protected recursiveGlob ( string $pattern, integer $flags ) : mixed
$pattern string Pattern to look for.
$flags integer Optional. Flags to PHP glob() function. Defaults to 0.
Результат mixed

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

Shut the action down.
С версии: 0.1.3
public shutdown ( )

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

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

Hook that was triggered.
С версии: 0.1.3
protected string $hook
Результат string

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

Root folder of the package.
С версии: 0.1.3
protected string $root
Результат string