Annotatable
extends Extension
in package
Class Annotatable
Annotate extension for the provided DataObjects for autocompletion purposes. Start annotation, if skipannotation is not set and the annotator is enabled.
Table of Contents
Properties
- $annotated_extensions : array<string|int, mixed>
- Keep track ot the annotation actions for extensions An Extension can belong to many DataObjects.
- $owner : DevBuildController|Annotatable
- $annotator : DataObjectAnnotator
- $permissionChecker : AnnotatePermissionChecker
Methods
- afterCallActionHandler() : mixed
- Annotated Controllers and Extensions
- annotateModules() : bool
- Conditionally annotate this project's modules if enabled and not skipped
- displayMessage() : mixed
- getAnnotator() : DataObjectAnnotator
- getPermissionChecker() : AnnotatePermissionChecker
- setUp() : mixed
- Annotatable setup.
Properties
$annotated_extensions
Keep track ot the annotation actions for extensions An Extension can belong to many DataObjects.
public
static array<string|int, mixed>
$annotated_extensions
= []
This prevents that an Extension is ran twice on dev/build
$owner
public
DevBuildController|Annotatable
$owner
$annotator
protected
DataObjectAnnotator
$annotator
$permissionChecker
protected
AnnotatePermissionChecker
$permissionChecker
Methods
afterCallActionHandler()
Annotated Controllers and Extensions
public
afterCallActionHandler() : mixed
Tags
annotateModules()
Conditionally annotate this project's modules if enabled and not skipped
public
annotateModules() : bool
Tags
Return values
bool —Return true if annotation was successful
displayMessage()
public
displayMessage(string $message[, bool $heading = false ][, bool $end = false ]) : mixed
Parameters
- $message : string
- $heading : bool = false
- $end : bool = false
getAnnotator()
public
getAnnotator() : DataObjectAnnotator
Return values
DataObjectAnnotatorgetPermissionChecker()
public
getPermissionChecker() : AnnotatePermissionChecker
Return values
AnnotatePermissionCheckersetUp()
Annotatable setup.
public
setUp() : mixed
This is theoretically a constructor, but to save memory we're using setup called from afterCallActionHandler