GitRepo Class Reference

Public Member Functions
	__construct ($workTree)
	addRemote ($alias, $url)
	removeRemote ($alias)
	fetch ($remoteAlias)
	getBranches ($source='--all')
	compareChanges ($remoteAlias, $remoteBranch, $changesType=self::CHANGE_TYPE_ALL)
	getChangedContentFiles ()

Data Fields
const	CHANGE_TYPE_ADDED = 1
const	CHANGE_TYPE_MODIFIED = 2
const	CHANGE_TYPE_ALL = 3

Protected Member Functions
	filterChangedFiles (array $changes, $remoteAlias, $remoteBranch, $changesType=self::CHANGE_TYPE_ALL)

Detailed Description

Definition at line 198 of file get_github_changes.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$workTree

)

Parameters

string

$workTree

absolute path to git project

Definition at line 232 of file get_github_changes.php.

    {
        if (empty($workTree) || !is_dir($workTree)) {
            throw new UnexpectedValueException('Working tree should be a valid path to directory');
        }

Member Function Documentation

addRemote()

addRemote	(		$alias,
			$url
	)

Adds remote

Parameters

string	$alias
string	$url

Definition at line 246 of file get_github_changes.php.

    {
        if (isset($this->remoteList[$alias])) {
            return;
        }
        $this->remoteList[$alias] = $url;

compareChanges()

compareChanges	(		$remoteAlias,
			$remoteBranch,
			$changesType = self::CHANGE_TYPE_ALL
	)

Returns files changes between branch and HEAD

Parameters

string	$remoteAlias
string	$remoteBranch
int	$changesType

Returns

array

Definition at line 304 of file get_github_changes.php.

    {
        if (!isset($this->remoteList[$remoteAlias])) {
            throw new LogicException('Alias "' . $remoteAlias . '" is not defined');
        }

        $result = $this->call(sprintf('log %s/%s..HEAD  --name-status --oneline', $remoteAlias, $remoteBranch));

        return is_array($result)
            ? $this->filterChangedFiles(
                $result,
                $remoteAlias,
                $remoteBranch,
                $changesType
            )

fetch()

fetch

(

$remoteAlias

)

Fetches remote

Parameters

string

$remoteAlias

Definition at line 274 of file get_github_changes.php.

    {
        if (!isset($this->remoteList[$remoteAlias])) {
            throw new LogicException('Alias "' . $remoteAlias . '" is not defined');
        }

filterChangedFiles()

filterChangedFiles ( array  $changes,   $remoteAlias,   $remoteBranch,   $changesType = self::CHANGE_TYPE_ALL  )

protected

Makes a diff of file for specified remote/branch and filters only those have real changes

Parameters

array	$changes
string	$remoteAlias
string	$remoteBranch
int	$changesType

Returns

array

Definition at line 331 of file get_github_changes.php.

      {
        $countScannedFiles = 0;
        $changedFilesMasks = $this->buildChangedFilesMask($changesType);
        $filteredChanges = [];
        foreach ($changes as $fileName) {
            $countScannedFiles++;
            if (($countScannedFiles % 5000) == 0) {
                echo $countScannedFiles . " files scanned so far\n";
            }

            $changeTypeMask = $this->detectChangeTypeMask($fileName, $changedFilesMasks);
            if (null === $changeTypeMask) {
                continue;
            }

            $fileName = trim(substr($fileName, strlen($changeTypeMask)));
            if (in_array($fileName, $filteredChanges)) {
                continue;
            }

            $fileChanges = $this->getFileChangeDetails($fileName, $remoteAlias, $remoteBranch);
            if (empty($fileChanges)) {
                continue;
            }

            if (!(isset($this->changedContentFiles[$fileName]))) {
                $this->setChangedContentFile($fileChanges, $fileName);
            }
            $filteredChanges[] = $fileName;
        }
        echo $countScannedFiles . " files scanned\n";

getBranches()

getBranches

(

$source = '--all'

)

Returns branches

Parameters

string

$source

Returns

array|mixed

Definition at line 289 of file get_github_changes.php.

    {
        $result = $this->call(sprintf('branch ' . $source));

getChangedContentFiles()

getChangedContentFiles

(

)

Get changed content files collection.

Returns

array

Definition at line 462 of file get_github_changes.php.

    {

removeRemote()

removeRemote

(

$alias

)

Remove remote

Parameters

string

$alias

Definition at line 261 of file get_github_changes.php.

    {
        if (isset($this->remoteList[$alias])) {
            $this->call(sprintf('remote rm %s', $alias));
            unset($this->remoteList[$alias]);

Field Documentation

CHANGE_TYPE_ADDED

const CHANGE_TYPE_ADDED = 1

Definition at line 201 of file get_github_changes.php.

CHANGE_TYPE_ALL

const CHANGE_TYPE_ALL = 3

Definition at line 203 of file get_github_changes.php.

CHANGE_TYPE_MODIFIED

const CHANGE_TYPE_MODIFIED = 2

Definition at line 202 of file get_github_changes.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/dev/tests/static/get_github_changes.php