API Documentation
\

\

Interfaces

AccountInterface
DisputeStateInterface
LifespanInterface

Classes

AccountCommonMethods This abstract class defines the functions which are identical in all account types, be they Organisation or Individual and be they Agent or Mediator, Law Firm or Mediation Centre.
AccountDetails
AccountMock
Agent This abstract class defines the functions which are identical in all account types, be they Organisation or Individual and be they Agent or Mediator, Law Firm or Mediation Centre.
Database
DBDispute
DBL This is the Database Layer class - it acts as middleware between the application and the database, and is mainly used for defining methods that create new rows in the database.
DBMediation
Dispute
DisputeAssignedToLawFirmB
DisputeClosed
DisputeController
DisputeCreated
DisputeDefaults
DisputeOpened
DisputeStateCalculator
Evidence
EvidenceController
Individual This abstract class defines the functions which are identical in all account types, be they Organisation or Individual and be they Agent or Mediator, Law Firm or Mediation Centre.
InMediation
InRoundTableMediation
LawFirm This abstract class defines the functions which are identical in all account types, be they Organisation or Individual and be they Agent or Mediator, Law Firm or Mediation Centre.
Lifespan
LifespanController
LifespanFactory
LifespanMock
LifespanNegotiated
MediationCentre This abstract class defines the functions which are identical in all account types, be they Organisation or Individual and be they Agent or Mediator, Law Firm or Mediation Centre.
MediationController
MediationState
Mediator This abstract class defines the functions which are identical in all account types, be they Organisation or Individual and be they Agent or Mediator, Law Firm or Mediation Centre.
Message
MessageController
Messages
Module
ModuleController
Notification
Organisation This abstract class defines the functions which are identical in all account types, be they Organisation or Individual and be they Agent or Mediator, Law Firm or Mediation Centre.
ProfileController
RegisterController
Session
SessionController
SummaryController
Utils

Functions

declare_module()

declare_module(Array  $config, \Function  $moduleDefinitionFunction)

Defines the module in the system.

Decorator pattern. Syntactic sugar instead of calling ModuleController static function directly. Improves decoupling.

Parameters

Array $config
\Function $moduleDefinitionFunction

errorPage()

errorPage(  $errorMessage)

Parameters

$errorMessage

mustBeLoggedIn()

mustBeLoggedIn()

mustBeLoggedInAsAn()

mustBeLoggedInAsAn(  $accountType)

Parameters

$accountType

noSystemMessages()

noSystemMessages()

notificationsList()

notificationsList(  $f3)

Parameters

$f3

on()

on(String  $event, String  $action, String|Int  $priority = 'medium')

Subscribes an anonymous function (defined within a module) to a given event.

Decorator pattern. Syntactic sugar instead of calling ModuleController static function directly. Improves decoupling.

Parameters

String $event
String $action
String|Int $priority

prettyTime()

prettyTime(  $unixTimestamp)

Parameters

$unixTimestamp

require_all()

require_all(String  $dir)

Requires all of the files in a given directory, pulling in interfaces before classes to remove dependency issues.

Parameters

String $dir

Directory to include

secondsToTime()

secondsToTime(integer  $seconds) : String

If we do time() minus a UNIX timestamp on file, we can work out the number of seconds the thing is in the past or in the future. This function converts those seconds into a human-readable time.

Based on http://stackoverflow.com/a/19680778

Parameters

integer $seconds

Number of seconds calculated.

Returns

String —

Formatted time.

setDisputeFromParams()

setDisputeFromParams(  $f3,   $params)

Parameters

$f3
$params