MMOframework
Pourquoi l'IA Playground Bibliothèques Documentation Rechercher Agence
FR EN
Index

DiffController

MMO\git\controllers · 1 symbole · générée le 27 Oct 2026

class

DiffController

DiffController.php:32

The diffs and the history of git repositories, as JSON: what <mmo-diff> shows.

class MMO\git\controllers\DiffController extends MMO\core\classes\aDataController
Espace de noms
MMO\git\controllers
Étend
aDataController
- `GET git.json`: the repositories it shows. - `GET git/{repository}/log.json?range=v3.0.1..develop`: the commits of a range. - `GET git/{repository}/diff.json?from=v3.0.1&to=develop` (or `?commit=b93d05f`): the commits and the changed files, without their lines. No `to`: against the working tree. - `GET git/{repository}/diff/file.json?from=&to=&path=` (`old=` the old path of a renamed file): one file's hunks, both its full texts (to colour the code and unfold what the hunks leave out), and, over several commits, the commit of each changed line ([`Repository::attribute`](https://mmoframework.fr/fr/documentation/mmo.git/php/helpers/Repository.md#repository-attribute)). Only the repositories of [`$sources`](https://mmoframework.fr/fr/documentation/mmo.git/php/controllers/DiffController.md#diffcontroller-sources) are shown, by name: a request never names a folder. > WARNING: it checks no one's rights, and it hands out source code. Put it behind a login, or keep it on localhost.
//configuration \MMO\git\controllers\DiffController::class => ['sources' => ['mmo.git' => '{root}/libs/git']], //then curl 'http://localhost/MMO/master/libs/git/git/mmo.git/diff.json?commit=HEAD'

Index

maxCommits
maxText
sources
commits($repo, $diff)
diff($repo, $route, $paths)The diff a request asks for: of commit, or from from to to (the working tree when there is no to).
fail($route, $status, $error)
git($route, $read)Run what reads git, and answer git's refusal (an unknown revision, a range that does not resolve) as a 422.
paths($route)
repository($name, $route)
routeDiff($route)
routeFile($route)
routeLog($route)
routeRepositories($route)

Propriétés3

maxCommits

int $maxCommits = 500
Type
int

maxText

int $maxText = 1048576
Type
int

sources

array $sources = []
Type
array

Méthodes10

commits($repo, $diff)

DiffController.php:167
protected function commits(MMO\git\helpers\Repository $repo, MMO\git\helpers\Diff $diff): array
$repoRepository
$diffDiff
retournearraythe commits from $diff's old revision to its new one, the newest first; none against the working tree

diff($repo, $route, $paths)

DiffController.php:153

The diff a request asks for: of commit, or from from to to (the working tree when there is no to).

protected function diff( MMO\git\helpers\Repository $repo, MMO\core\server\Route $route, array $paths ): MMO\git\helpers\Diff|array
$repoRepository
$routeRoute
$pathsarray
retourneDiff | arraystring} the diff, or the error to answer when the request names no revision

git($route, $read)

DiffController.php:185

Run what reads git, and answer git's refusal (an unknown revision, a range that does not resolve) as a 422.

protected function git(MMO\core\server\Route $route, callable $read): array
$routeRoute
$readcallable
retournearraystring}

paths($route)

DiffController.php:173
protected function paths(MMO\core\server\Route $route): array
$routeRoute
retournearraythe request's path: one path, or a list of them (path[]=)

repository($name, $route)

DiffController.php:139
protected function repository(string $name, MMO\core\server\Route $route): MMO\git\helpers\Repository
$namestring
$routeRoute
retourneRepositorythe repository of $sources named $name
lèvewhen there is none, or its folder is not a git repository

routeDiff($route)

DiffController.php:76
#[MMO\core\attributes\APIRoute('GET|git/{repository}/diff.json', 'The changed files of a commit or between two revisions, without their lines', mediaTypes: ['json'])] function routeDiff(MMO\core\server\Route $route): array
$routeRoutecommit, or from and to (none: the working tree); path, context, whitespace=ignore
retournearraymixed> {from, to, commits, additions, deletions, files} (each file as DiffFile serializes, without its hunks), or {error}

routeFile($route)

DiffController.php:97
#[MMO\core\attributes\APIRoute('GET|git/{repository}/diff/file.json', 'One changed file: its lines, both its texts and who changed each line', mediaTypes: ['json'])] function routeFile(MMO\core\server\Route $route): array
$routeRouteas routeDiff, with path (the file, as it is now) and old (its old path, when renamed)
retournearraymixed> {from, to, file, old, new, truncated}: the file with its hunks, both its texts (null when it does not exist on that side, is binary, or is longer than $maxText: then truncated), or {error}

routeLog($route)

DiffController.php:61
#[MMO\core\attributes\APIRoute('GET|git/{repository}/log.json', 'The commits of a range, the newest first', mediaTypes: ['json'])] function routeLog(MMO\core\server\Route $route): array
$routeRouterange (default HEAD), path (only the commits touching it), max
retournearraymixed> {commits}, or {error} when git refuses the range

routeRepositories($route)

DiffController.php:47
#[MMO\core\attributes\APIRoute('GET|git.json', 'The git repositories whose history can be read', mediaTypes: ['json'])] function routeRepositories(MMO\core\server\Route $route): array
$routeRoute
retournearraylist<array{name: string, branch: string}>}
Membres hérités (62)
ConstantesDéclaré parDescription
ALERTiLogLevelAlert: Action must be taken immediately.
ALLiLogLevelMask for all
ALL_PLUSiLogLeveldebug everything
BACKTRACEiLogLevel
COLORSaDataControllerNamed color palettes for chart/report endpoints, e.g.
CRITICALiLogLevelCritical: Critical conditions.
DEBUGiLogLevelDebug: Detailed debug information.
DEEPiLogLeveldebug everything with arguments
EMERGENCYiLogLevelEmergency: System is unusable.
ERRORiLogLevelError: Runtime errors that do not require immediate action but should typically be logged and monitored.
ERROR_PLUSiLogLevelMask for all error
FATALiLogLevelMask for all fatal error
INFOiLogLevelInfo: Interesting events.
INFO_PLUSiLogLevelMask for all errors/warning/notices/info
MEMORYiLogLevelinclude backtrace object
NOTICEiLogLevelNotice: Normal but significant events.
NOTICE_PLUSiLogLevelMask for all errors/warning/notices/info
TRACEiLogLevelinclude backtrace as origins
WARNINGiLogLevelWarning: Exceptional occurrences that are not errors.
WARNING_PLUSiLogLevelMask for all errors and warnings
PropriétésDéclaré parDescription
repositoriesaDataController
verbosityaModule
MéthodesDéclaré parDescription
alert($message, $context)aModuleAction must be taken immediately.
backtraces($message, $context)aModuleForce-log a message at INFO level together with a full stack trace/memory snapshot (iLogLevel::BACKTRACE), bypassing the verbosity mask entirely (any non-zero verbosity is enough to trigger it).
Configure($config)aModuleMerge $config into this module's configuration in the shared Configuration.
critical($message, $context)aModuleCritical conditions. No-op if CRITICAL is currently filtered out by the verbosity mask.
debug($message, $context)aModuleDetailed debug information.
debugName()aModuleHuman-readable identifier used as the default {origin} in this instance's log messages.
DefaultConfig()aModuleThe config a module starts from before anything loaded via Configuration is merged in.
emergency($message, $context)aModuleSystem is unusable. No-op if EMERGENCY is currently filtered out by the verbosity mask.
error($message, $context)aModuleRuntime errors that do not require immediate action but should typically be logged and monitored.
ExtractRoutes($config)aControllerExtract all the APIRoute from this class, regardless of the fact they are registered in the application
getMainRepository()aDataController
getRepositories()aDataController
getRepository($repo)aDataController
getVerbosity()aModule
HasRoutes()aControllerTells if any APIRoute are registered in the application
info($message, $context)aModuleInteresting events. No-op if INFO is currently filtered out by the verbosity mask.
Instantiate($config)aModule(Re)create the shared instance immediately, configured with $config merged into the class's existing config.
IsShared()aModule
Link($method, $data)aControllerBuild a Link (URL + label/icon/description/title, taken from the route's APIRoute metadata) for a registered route.
log($level, $message, $context)aModuleLogs with an arbitrary level.
notice($message, $context)aModuleNormal but significant events.
offsetExists($key)aModule\ArrayAccess::offsetExists -- tells whether $key is a declared property at all, regardless of whether it is currently readable/writable through array access.
offsetGet($key)aModule\ArrayAccess::offsetGet -- reads a property directly, unless it has a #[Serialize(serialize: 'methodName')] attribute, in which case that zero-argument method is called instead (e.g.
offsetSet($key, $value)aModule\ArrayAccess::offsetSet -- sets a property directly, unless it has a #[Serialize(unserialize: 'methodName')] attribute, in which case that method is called with $value instead (e.g.
offsetUnset($key)aModule\ArrayAccess::offsetUnset -- equivalent to $module[$key] = null.
onRoute($route)aDataControllerSame as aController::onRoute, plus forcing the response to JSON (Response::Json) for every route this controller claims.
Route($method)aControllerGet a registered APIRoute WARNING: if this class was not registered in the application, it will return null.
Routes()aControllerGet a list of registered APIRoutes (from this class) in the application WARNING: if this class was not registered in the application, it will return an empty array.
serialize($path, $serializer)aModule\MMO\core\interfaces\iSerializable::serialize -- exports every property (via
setRepositories($repositories)aDataControllerRegister the repositories this controller can query, keyed by name (e.g.
setVerbosity($verb)aModuleSet the current verbosity mask, replacing whatever it was before.
Shared()aModuleGet the shared instance, creating (and configuring) it on first call.
testVerbosity($level)aModuleTest whether a given level (or set of levels) is currently enabled by this instance's verbosity mask.
traitUnshare($serialize)aModuleRemove the shared instance, so the next Shared() call creates a fresh one.
unserialize($data, $path, $instances)aModule\MMO\core\interfaces\iSerializable::unserialize -- merges $data onto DefaultConfig, runs it through the (possibly overridden) constructor, then applies each resulting value to its property (via
Unshare($serialize)aModuleLike tSingleton::Unshare, but also disconnects this module's instance from every event it was listening to (via Event::DisconnectListeners) before dropping it.
Url($method, $data)aControllerBuild the URL for a registered route, filling in any {placeholder} from $data.
warning($message, $context)aModuleExceptional occurrences that are not errors.
__construct($config)aModuleprotected constructor, so it is not possible to do new Module(...) called by the serialization process just before being injected with data.
__wakeup()aControllerCalled automatically right after the controller's shared instance is built (aModule::unserialize): registers onRoute as a Route listener with a low priority (-10), so it…