aEntry

MMO\git\classes · 1 symbol · generated 5 Oct 2026

class

aEntry

Anything git status can report on: a file (File), a submodule (Module) or the repository itself (Repository).

abstract class MMO\git\classes\aEntry implements MMO\git\interfaces\iEntry

Namespace: MMO\git\classes
Implements: iEntry

An entry carries an absolute filename, a bitmask of [`iEntry`](https://mcp.mmoframework.fr/documentation/mmo.git/php/interfaces/iEntry.md#ientry) flags, and -- when git reported a rename or a copy -- the path it came from.

Index

	filename
	origin
	parent
	status
	STATUS_TEXT static
	addStatus($flags)
	clearStatus($flags)
	debugName()
	getFilename()
	getOrigin()
	getParent()
	getStatus()
	getStatusText($sep)
	relativeFilename()	The filename relative to the repository this entry belongs to.
	setOrigin($origin)
	setParent($parent)
	setStatus($flags, $origin)	Replace the status flags, and -- because git reports a rename's previous path alongside its status -- optionally the origin in the same call.
	StatusFlags($flags) static	Read the two-character `<XY>` field of a `git status --porcelain=2` entry.
	StatusModuleFlags($flags) static	Read the four-character `<sub>` field of a `git status --porcelain=2` entry (`N...` for a plain file, `S<c><m><u>` for a submodule).
	StatusText($status, $sep) static	Convert git status constants to text.
	__construct($filename, $status, $origin)

Properties5

filename

protected string $filename = ''

Type: string

origin

protected ?string $origin = null

Type: null | string

parent

protected ?MMO\git\helpers\Repository $parent = null

Type: null | Repository

status

protected int $status = 0

Type: int

STATUS_TEXT

static

static array $STATUS_TEXT = […20 items]

Type: array

Methods16

addStatus($flags)

aEntry.php:116

function addStatus(int $flags): static

$flags	int
returns	static

clearStatus($flags)

aEntry.php:121

function clearStatus(int $flags): static

$flags	int
returns	static

debugName()

aEntry.php:56

function debugName(): string

returns

string

getFilename()

aEntry.php:61

function getFilename(): string

returns

string

getOrigin()

aEntry.php:86

function getOrigin(): ?string

returns

null | string

getParent()

aEntry.php:77

function getParent(): ?MMO\git\helpers\Repository

returns

null | Repository

getStatus()

aEntry.php:95

function getStatus(): int

returns

int

getStatusText($sep)

aEntry.php:99

function getStatusText(?string $sep = ', '): array|string

$sep = ', '	null \| string
returns	array \| string

relativeFilename()

aEntry.php:70

The filename relative to the repository this entry belongs to. A standalone repository, having no parent, is its own root and answers with its absolute filename.

function relativeFilename(): string

returns

string

setOrigin($origin)

aEntry.php:90

function setOrigin(?string $origin): static

$origin	null \| string
returns	static

setParent($parent)

aEntry.php:81

function setParent(?MMO\git\helpers\Repository $parent): static

$parent	null \| Repository
returns	static

setStatus($flags, $origin)

aEntry.php:110

Replace the status flags, and -- because git reports a rename's previous path alongside its status -- optionally the origin in the same call.

function setStatus(int $flags, ?string $origin = null): static

$flags	int
$origin = null	null \| string	only replaces the current origin when not null
returns	static

StatusFlags($flags)

staticaEntry.php:147

Read the two-character <XY> field of a git status --porcelain=2 entry.

static function StatusFlags(string $flags): int

$flags	string
returns	int

StatusModuleFlags($flags)

staticaEntry.php:181

Read the four-character <sub> field of a git status --porcelain=2 entry (N... for a plain file, S<c><m><u> for a submodule).

static function StatusModuleFlags(string $flags): int

$flags	string
returns	int

StatusText($status, $sep)

staticaEntry.php:133

Convert git status constants to text.

static function StatusText(int $status, ?string $sep = ', '): array|string

$status	int	a binary combination of the `iEntry` constants
$sep = ', '	null \| string	if null, returns the list of texts, else implodes it with this separator
returns	array \| string

aEntry::StatusText(iEntry::WORKTREE_MODIFIED); // 'modified'

__construct($filename, $status, $origin)

aEntry.php:50

function __construct(string $filename, int $status = 0, ?string $origin = null)

$filename	string
$status = 0	int
$origin = null	null \| string

Inherited members (24)

	Constants	Declared by	Description
	`CAN_BE_ADDED`	iEntry
	`CAN_BE_COMMITED`	iEntry
	`COMMIT_CHANGED`	iEntry
	`ENTRY_STATUS`	iEntry
	`INDEX_ADDED`	iEntry
	`INDEX_COPIED`	iEntry
	`INDEX_DELETED`	iEntry
	`INDEX_IGNORED`	iEntry
	`INDEX_MODIFIED`	iEntry
	`INDEX_RENAMED`	iEntry
	`INDEX_UNMERGED`	iEntry
	`INDEX_UNTRACKED`	iEntry
	`MODULE_STATUS`	iEntry
	`TRACKED_CHANGES`	iEntry
	`UNKNOWN_ERROR`	iEntry
	`UNTRACKED_CHANGES`	iEntry
	`WORKTREE_ADDED`	iEntry
	`WORKTREE_COPIED`	iEntry
	`WORKTREE_DELETED`	iEntry
	`WORKTREE_IGNORED`	iEntry
	`WORKTREE_MODIFIED`	iEntry
	`WORKTREE_RENAMED`	iEntry
	`WORKTREE_UNMERGED`	iEntry
	`WORKTREE_UNTRACKED`	iEntry