Element index for package Source
Package indexes
[ a ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ l ]
[ m ]
[ n ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ x ]
[ _ ]
Letter '_'
- __construct
- in file updated.php, method arbitSourceUpdatedStruct::__construct()
Construct signal struct from its major data fields.
- __construct
- in file initialized.php, method arbitSourceInitializedStruct::__construct()
Construct signal struct from its major data fields.
- __construct
- in file exceptions.php, method arbitModuleSourceRessourceNotAvailableException::__construct()
Create exception from signal struct name
- __construct
- in file exceptions.php, method arbitModuleSourceRepositoryNotInitializedException::__construct()
Create exception from signal struct name
- __construct
- in file annotate.php, method arbitSourceAnnotateStruct::__construct()
Construct signal struct from its major data fields.
- __construct
- in file vcs.php, method arbitModuleSourceVcsModel::__construct()
Construct vcs wrapper model
Initialises the repository, if not done before.
- __construct
- in file initialized.php, method arbitSourceInitializedViewStruct::__construct()
Create view struct from signal struct
- __construct
- in file updated.php, method arbitSourceUpdatedViewStruct::__construct()
Create view struct from signal struct
- __construct
- in file history.php, method arbitSourceHistoryModel::__construct()
Construct project view model from common values
- __construct
- in file file.php, method arbitSourceFileViewModel::__construct()
Construct project view model from common values
- __construct
- in file diff.php, method arbitSourceDiffViewModel::__construct()
Construct project view model from common values
- __construct
- in file directory.php, method arbitSourceDirectoryViewModel::__construct()
Construct project view model from common values
- __construct
- in file annotations.php, method arbitSourceAnnotationsViewModel::__construct()
Construct project view model from common values
Letter 'a'
- $actions
- in file cli_tool.php, variable arbitModuleSourceAdminCliTool::$actions
Available actions.
- annotateSource
- in file controller.php, method arbitModuleSourceController::annotateSource()
Handle source annotation signals
- annotations
- in file controller.php, method arbitModuleSourceController::annotations()
Annotation action
- arbitHasModuleCommand
- in file has_module.php, class arbitHasModuleCommand
Arbit has module command
- arbitModuleSourceAdminCliTool
- in file cli_tool.php, class arbitModuleSourceAdminCliTool
CLI tool class, which handles various adimistrative tasks.
- arbitModuleSourceCleanMetadataCacheCommand
- in file clean_metadata_cache.php, class arbitModuleSourceCleanMetadataCacheCommand
Arbit source module prime cache command
- arbitModuleSourceController
- in file controller.php, class arbitModuleSourceController
Base source controller.
- arbitModuleSourceDefintion
- in file definition.php, class arbitModuleSourceDefintion
Arbit Source module definition
- arbitModuleSourceException
- in file exceptions.php, class arbitModuleSourceException
Basic arbit notification module exception
- arbitModuleSourcePrimeCacheCommand
- in file prime_cache.php, class arbitModuleSourcePrimeCacheCommand
Arbit source module prime cache command
- arbitModuleSourceRepositoryNotInitializedException
- in file exceptions.php, class arbitModuleSourceRepositoryNotInitializedException
Exception throw, when a repository has not been initialized yet.
- arbitModuleSourceRessourceNotAvailableException
- in file exceptions.php, class arbitModuleSourceRessourceNotAvailableException
Exception throw, when a resource could not be located in a repository.
- arbitModuleSourceUpdateCommand
- in file update.php, class arbitModuleSourceUpdateCommand
Arbit source module update command
- arbitScheduledTaskCommand
- in file command.php, class arbitScheduledTaskCommand
Arbit abstract base command
- arbitSourceAnnotateStruct
- in file annotate.php, class arbitSourceAnnotateStruct
Source module annotate signal struct
- arbitSourceInitializedStruct
- in file initialized.php, class arbitSourceInitializedStruct
Source module initialized signal struct
- arbitSourceUpdatedStruct
- in file updated.php, class arbitSourceUpdatedStruct
Source module updated signal struct
- annotate.php
- procedural page annotate.php
- arbitCouchDbSourceAnnotationFacade
- in file annotations.php, class arbitCouchDbSourceAnnotationFacade
Annotattion facade implementing all methods to access annotations of the source backend.
- arbitSourceAnnotationFacade
- in file annotations.php, class arbitSourceAnnotationFacade
Annotattion facade implementing all methods to access annotations of the source backend.
- attachFile
- in file annotations.php, method arbitSourceAnnotationFacade::attachFile()
Attach file to annotation
Attach a file to the annotation specified by its ID. given as a third parameter and should also be stored.
- attachFile
- in file annotations.php, method arbitCouchDbSourceAnnotationFacade::attachFile()
Attach file to annotation
Attach a file to the annotation specified by its ID. given as a third parameter and should also be stored.
- annotations.php
- procedural page annotations.php
- annotations.php
- procedural page annotations.php
- arbitSourceBackendIniModuleConfiguration
- in file module.php, class arbitSourceBackendIniModuleConfiguration
arbit project configuration
- arbitModuleModelSourceAnnotation
- in file annotation.php, class arbitModuleModelSourceAnnotation
Project model
- arbitModuleSourceVcsModel
- in file vcs.php, class arbitModuleSourceVcsModel
Project model
- attachFile
- in file annotation.php, method arbitModuleModelSourceAnnotation::attachFile()
Attach file to annotation
- annotation.php
- procedural page annotation.php
- arbitModuleSourceTextHandler
- in file text.php, class arbitModuleSourceTextHandler
Text view handler generating Text from the provided view model.
- arbitModuleSourceXHtmlHandler
- in file xhtml.php, class arbitModuleSourceXHtmlHandler
XHtml view handler generating XHtml from the provided view model.
- arbitSourceAnnotationsViewModel
- in file annotations.php, class arbitSourceAnnotationsViewModel
Base model struct for the source diffs
- arbitSourceCheckoutViewModel
- in file checkout.php, class arbitSourceCheckoutViewModel
Base model struct for the Source overview
- arbitSourceDiffViewModel
- in file diff.php, class arbitSourceDiffViewModel
Base model struct for the source diffs
- arbitSourceDirectoryViewModel
- in file directory.php, class arbitSourceDirectoryViewModel
Base model struct for the Source overview
- arbitSourceFileViewModel
- in file file.php, class arbitSourceFileViewModel
Base model struct for the Source overview
- arbitSourceHistoryModel
- in file history.php, class arbitSourceHistoryModel
Base model struct for the Source overview
- arbitSourceInitializedViewStruct
- in file initialized.php, class arbitSourceInitializedViewStruct
View model fur source initialized struct
- arbitSourceUpdatedViewStruct
- in file updated.php, class arbitSourceUpdatedViewStruct
View model fur source updated struct
- arbitSourceViewModel
- in file source.php, class arbitSourceViewModel
Base model struct for the Source overview
- annotations.php
- procedural page annotations.php
Letter 'c'
- $caches
- in file definition.php, variable arbitModuleSourceDefintion::$caches
Array with caches registered on initialization
Each cache must have a unique name, normally prefixed with the module identifier. time to live for the cache.
- $commands
- in file definition.php, variable arbitModuleSourceDefintion::$commands
List of command definitions of the module
Array containing command names and their assiciated classes in the module definition.
- $couchDbDocuments
- in file definition.php, variable arbitModuleSourceDefintion::$couchDbDocuments
CouchDB documents to be registered at the document manager.
- $couchDbViews
- in file definition.php, variable arbitModuleSourceDefintion::$couchDbViews
CouchDB documents to be registered at the document manager.
- checkout
- in file controller.php, method arbitModuleSourceController::checkout()
Checkout action
Display the requested path in the repository.
- command.php
- procedural page command.php
- createController
- in file cli_tool.php, method arbitModuleSourceAdminCliTool::createController()
Get controller
- cli_tool.php
- procedural page cli_tool.php
- clean_metadata_cache.php
- procedural page clean_metadata_cache.php
- controller.php
- procedural page controller.php
- createAnnotation
- in file annotations.php, method arbitSourceAnnotationFacade::createAnnotation()
Create a new annotation
Create a new annotation with the given ID. if there already is a annotation with the given ID.
- createAnnotation
- in file annotations.php, method arbitCouchDbSourceAnnotationFacade::createAnnotation()
Create a new annotation
Create a new annotation with the given ID. if there already is a annotation with the given ID.
- $checkout
- in file vcs.php, variable arbitModuleSourceVcsModel::$checkout
VCS wrapper Checkount instance
- $configuration
- in file vcs.php, variable arbitModuleSourceVcsModel::$configuration
Repository configuration
- checkout
- in file vcs.php, method arbitModuleSourceVcsModel::checkout()
Initialize repository
Repository initialization may take too long, this should be done using the respective cronjob.
- create
- in file annotation.php, method arbitModuleModelSourceAnnotation::create()
Method called to create a new instance in the backend.
- configureTemplate
- in file xhtml.php, method arbitModuleSourceXHtmlHandler::configureTemplate()
Configure tempalte library
- checkout.php
- procedural page checkout.php
Letter 'd'
- $description
- in file cli_tool.php, variable arbitModuleSourceAdminCliTool::$description
Short description of the purpose of the current CLI tool
- diff
- in file controller.php, method arbitModuleSourceController::diff()
Diff action
Display the diff for the given path between the given version numbers.
- definition.php
- procedural page definition.php
- $defaultValues
- in file module.php, variable arbitSourceBackendIniModuleConfiguration::$defaultValues
Array with default values for all required configuration directives. array has the following structure:
- $defaultFetchMethod
- in file annotation.php, variable arbitModuleModelSourceAnnotation::$defaultFetchMethod
Method from the model class implementation used to fetch the requested data value for the constructed model. the data is actually requested from the model.
- deleteAll
- in file annotation.php, method arbitModuleModelSourceAnnotation::deleteAll()
Method called to create a new instance in the backend.
- diff
- in file vcs.php, method arbitModuleSourceVcsModel::diff()
Diff two versions of a given resource
- diff.php
- procedural page diff.php
- directory.php
- procedural page directory.php
Letter 'e'
- emit
- in file controller.php, method arbitModuleSourceController::emit()
Emit signal action
Emits a source updated signal, jsut to trigger other modules.
- exceptions.php
- procedural page exceptions.php
Letter 'f'
- $facades
- in file definition.php, variable arbitModuleSourceDefintion::$facades
Array with facades registered on initialization
Array with facedes for all known database backends linked with their respective implementation.
- file.php
- procedural page file.php
Letter 'g'
- getMenu
- in file controller.php, method arbitModuleSourceController::getMenu()
Return the menu for the source controller
- getRequest
- in file command.php, method arbitScheduledTaskCommand::getRequest()
Get current request
Get the current request, optionally for the specified module.
- getAnnotationData
- in file annotations.php, method arbitSourceAnnotationFacade::getAnnotationData()
Get annotation data
- getAnnotationData
- in file annotations.php, method arbitCouchDbSourceAnnotationFacade::getAnnotationData()
Get annotation data
- getAnnotations
- in file annotations.php, method arbitSourceAnnotationFacade::getAnnotations()
Get annotations for file
Return an array with all annotations for the given file.
- getAnnotations
- in file annotations.php, method arbitCouchDbSourceAnnotationFacade::getAnnotations()
Get annotations for file
Return an array with all annotations for the given file.
- getAnnotationsWithMessage
- in file annotations.php, method arbitCouchDbSourceAnnotationFacade::getAnnotationsWithMessage()
Get all annotations with messages
Get annotation list from backend, which do have a message assigned. each annotation the file name it is associated with and the ID is given.
- getAnnotationsWithMessage
- in file annotations.php, method arbitSourceAnnotationFacade::getAnnotationsWithMessage()
Get all annotations with messages
Get annotation list from backend, which do have a message assigned.
- getFileContents
- in file annotations.php, method arbitSourceAnnotationFacade::getFileContents()
Get file contents
Return the contents of the file specified by its storage file name.
- getFileContents
- in file annotations.php, method arbitCouchDbSourceAnnotationFacade::getFileContents()
Get file contents
Return the contents of the file specified by its storage file name.
- getAnnotationData
- in file annotation.php, method arbitModuleModelSourceAnnotation::getAnnotationData()
Fetch the basic project data
- getAnnotationsForFile
- in file annotation.php, method arbitModuleModelSourceAnnotation::getAnnotationsForFile()
Get annotation list for file
Get annotation list from backend for the given file.
- getAnnotationsWithMessage
- in file annotation.php, method arbitModuleModelSourceAnnotation::getAnnotationsWithMessage()
Get all annotations with messages
Get annotation list from backend, which do have a message assigned.
- getAttachment
- in file annotation.php, method arbitModuleModelSourceAnnotation::getAttachment()
Get attachment contents
Return the contents of the attachment specified by its storage file name.
- getResource
- in file vcs.php, method arbitModuleSourceVcsModel::getResource()
Get resource from checkout by path
- getViewModel
- in file vcs.php, method arbitModuleSourceVcsModel::getViewModel()
Return view model for given path
Return a view model for the given path. the repository an exception will be thrown.
- getExtendedInformation
- in file source.php, method arbitSourceViewModel::getExtendedInformation()
Get optional extended information
Set properties with optional extended information available in the version control system.
Letter 'h'
- has_module.php
- procedural page has_module.php
- history
- in file controller.php, method arbitModuleSourceController::history()
View action
Display the requested path in the repository.
- history.php
- procedural page history.php
Letter 'i'
- index
- in file controller.php, method arbitModuleSourceController::index()
Index action
The index action just dispatches to the default view of the source module - the custom source configuration.
- initialized.php
- procedural page initialized.php
- initialized.php
- procedural page initialized.php
Letter 'l'
- $location
- in file vcs.php, variable arbitModuleSourceVcsModel::$location
Location of the checkout in the filesystem.
Letter 'm'
- module.php
- procedural page module.php
- $moduleTemplates
- in file xhtml.php, variable arbitModuleSourceXHtmlHandler::$moduleTemplates
Method template association for default calls.
- $moduleTemplates
- in file text.php, variable arbitModuleSourceTextHandler::$moduleTemplates
Method template association for default calls.
Letter 'n'
- $name
- in file cli_tool.php, variable arbitModuleSourceAdminCliTool::$name
Name of CLI tool
Letter 'p'
- $properties
- in file updated.php, variable arbitSourceUpdatedStruct::$properties
Array containing the structs properties.
- $properties
- in file initialized.php, variable arbitSourceInitializedStruct::$properties
Array containing the structs properties.
- $properties
- in file definition.php, variable arbitModuleSourceDefintion::$properties
Array containing the module structures properties.
- $properties
- in file annotate.php, variable arbitSourceAnnotateStruct::$properties
Array containing the structs properties.
- prime_cache.php
- procedural page prime_cache.php
- primeCaches
- in file controller.php, method arbitModuleSourceController::primeCaches()
Prime cache action
Prime all caches file and metadata caches from the VCS backend for faster future access.
- $properties
- in file annotation.php, variable arbitModuleModelSourceAnnotation::$properties
Array containing the projects properties
- $properties
- in file initialized.php, variable arbitSourceInitializedViewStruct::$properties
Array containing the actual view data.
- $properties
- in file updated.php, variable arbitSourceUpdatedViewStruct::$properties
Array containing the actual view data.
- $properties
- in file history.php, variable arbitSourceHistoryModel::$properties
Array containing the actual view data.
- $properties
- in file file.php, variable arbitSourceFileViewModel::$properties
Array containing the actual view data.
- $properties
- in file diff.php, variable arbitSourceDiffViewModel::$properties
Array containing the actual view data.
- $properties
- in file directory.php, variable arbitSourceDirectoryViewModel::$properties
Array containing the actual view data.
- $properties
- in file annotations.php, variable arbitSourceAnnotationsViewModel::$properties
Array containing the actual view data.
Letter 'r'
- registerOptions
- in file cli_tool.php, method arbitModuleSourceAdminCliTool::registerOptions()
Register options
Register a set of options, which are special for this CLI tool. left empty, if no additional options are required.
- reportDashboardData
- in file controller.php, method arbitModuleSourceController::reportDashboardData()
Report data to the dashboard
- revision
- in file controller.php, method arbitModuleSourceController::revision()
Show revision
- run
- in file update.php, method arbitModuleSourceUpdateCommand::run()
Run command
Execute the actual bits.
- run
- in file prime_cache.php, method arbitModuleSourcePrimeCacheCommand::run()
Run command
Execute the actual bits.
- run
- in file has_module.php, method arbitHasModuleCommand::run()
Run command
Execute the actual bits.
- run
- in file clean_metadata_cache.php, method arbitModuleSourceCleanMetadataCacheCommand::run()
Run command
Execute the actual bits.
- removeAllAnnotations
- in file annotations.php, method arbitSourceAnnotationFacade::removeAllAnnotations()
Remove all annotations
Remove all annotations from the source backend.
- removeAllAnnotations
- in file annotations.php, method arbitCouchDbSourceAnnotationFacade::removeAllAnnotations()
Remove all annotations
Remove all annotations from the source backend.
- recursivelyPrimeCaches
- in file vcs.php, method arbitModuleSourceVcsModel::recursivelyPrimeCaches()
Recursively prime caches for checkout
Optionally a depth may be specified up to which the caches are primed.
Letter 's'
- $shortcuts
- in file module.php, variable arbitSourceBackendIniModuleConfiguration::$shortcuts
Shortcuts for configuration value access.
- storeChanges
- in file annotation.php, method arbitModuleModelSourceAnnotation::storeChanges()
Method called to store changes to the model.
- source.php
- procedural page source.php
Letter 't'
- toBytes
- in file vcs.php, method arbitModuleSourceVcsModel::toBytes()
Convert size value to bytes
- text.php
- procedural page text.php
Letter 'u'
- update.php
- procedural page update.php
- updated.php
- procedural page updated.php
- update
- in file controller.php, method arbitModuleSourceController::update()
Update action
Display the requested path in the repository.
- updateAnnotationData
- in file annotations.php, method arbitSourceAnnotationFacade::updateAnnotationData()
Update stored information for the given annotation
The array with the information to update may any number of the common keys, and only the given keys will be updated in the storage backend.
- updateAnnotationData
- in file annotations.php, method arbitCouchDbSourceAnnotationFacade::updateAnnotationData()
Update stored information for the given annotation
The array with the information to update may any number of the common keys, and only the given keys will be updated in the storage backend.
- update
- in file vcs.php, method arbitModuleSourceVcsModel::update()
Update repository
Repository updates may take too long, this should be done using the respective cronjob.
- updated.php
- procedural page updated.php
Letter 'v'
- $viewModels
- in file definition.php, variable arbitModuleSourceDefintion::$viewModels
List of view models used by the module
List of used view handlers associated with a list of view models used by the module, each associated with a callback to the concrete handler implementation to visit the view model.
- view
- in file controller.php, method arbitModuleSourceController::view()
View action
Display the requested path in the repository.
- vcs.php
- procedural page vcs.php
- versionDiff
- in file vcs.php, method arbitModuleSourceVcsModel::versionDiff()
Return diff for the given revision
Retunrs the diff for the given path for the given revision. will return an array with the prior version, the current version and the actual diff.
Letter 'x'
- xhtml.php
- procedural page xhtml.php
|