File

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

class

One file inside a Repository, as git status reported it.

class MMO\git\helpers\File extends MMO\git\classes\aEntry

	addToCommit($option)	Stage the file. @return string
	getRepository()
	mtime($options)
	remove($option)	Unstage and delete the file.
	show($revision)
	__construct($repo, $filename, $status, $origin)

Stage the file. @return string

function addToCommit(string $option = ''): string

$option = ''	string
returns	string

function getRepository(): MMO\git\helpers\Repository

returns

the repository the file belongs to.

function mtime(string $options = ''): ?int

$options = ''	string
returns	null \| int	the timestamp of the last commit that touched the file.

Unstage and delete the file. @return string

function remove(string $option = ''): string

$option = ''	string
returns	string

function show(string $revision = 'HEAD'): string

$revision = 'HEAD'	string
returns	string	the file's content at $revision.

function __construct( MMO\git\helpers\Repository $repo, string $filename, int $status = 0, ?string $origin = null )

$repo	Repository	the repository the file belongs to
$filename	string	the absolute filename
$status = 0	int	the status, as a combination of the `iEntry` flags
$origin = null	null \| string	the previous path, when git reported a rename or a copy

Inherited members (44)

Methods	Declared by	Description
`addStatus($flags)`	aEntry
`clearStatus($flags)`	aEntry
`debugName()`	aEntry
`getFilename()`	aEntry
`getOrigin()`	aEntry
`getParent()`	aEntry
`getStatus()`	aEntry
`getStatusText($sep)`	aEntry
`relativeFilename()`	aEntry	The filename relative to the repository this entry belongs to.
`setOrigin($origin)`	aEntry
`setParent($parent)`	aEntry
`setStatus($flags, $origin)`	aEntry	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)`	aEntry	Read the two-character `<XY>` field of a `git status --porcelain=2` entry.
`StatusModuleFlags($flags)`	aEntry	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)`	aEntry	Convert git status constants to text.