STOP_MESSAGE
-STOP_MESSAGE-
Error severity: message only, continue processing
- -diff --git a/.hgignore b/.hgignore index 29a79b09..f1a7c8b0 100644 --- a/.hgignore +++ b/.hgignore @@ -1,4 +1,5 @@ syntax: regexp +^doc/* ^logs/* ^media/* ^tmp/* diff --git a/doc/classes/PHPMailer.html b/doc/classes/PHPMailer.html deleted file mode 100644 index b5d80bfc..00000000 --- a/doc/classes/PHPMailer.html +++ /dev/null @@ -1,7052 +0,0 @@ - - -
- - -PHPMailer - PHP email creation and transport class.
- - - -- type - | -
- string - |
-
---|
$Body :-
An HTML or plain text message body.
-If HTML then call isHTML(true).
- -- type - | -
- string - |
-
---|
$AltBody :-
The plain-text message body.
-This body can be read by mail clients that do not have HTML email -capability such as mutt & Eudora. -Clients that can read HTML will view the normal Body.
- -- type - | -
- string - |
-
---|
$Ical :-
An iCal message part body.
-Only supported in simple alt or alt_inline message types -To generate iCal events, use the bundled extras/EasyPeasyICS.php class or iCalcreator
- -- type - | -
- string - |
-
---|
$WordWrap :-
Word-wrap the message body to this number of chars.
- - -- type - | -
- int - |
-
---|
$Mailer :-
Which method to use to send mail.
-Options: "mail", "sendmail", or "smtp".
- -- type - | -
- string - |
-
---|
- type - | -
- string - |
-
---|
$UseSendmailOptions :-
Whether mail() uses a fully sendmail-compatible MTA.
-One which supports sendmail's "-oi -f" options.
- -- type - | -
- bool - |
-
---|
$PluginDir :-
Path to PHPMailer plugins.
-Useful if the SMTP class is not in the PHP include path.
- -- type - | -
- string - |
-
---|
$ConfirmReadingTo :-
The email address that a reading confirmation should be sent to.
- - -- type - | -
- string - |
-
---|
$Hostname :-
The hostname to use in Message-Id and Received headers -and as default HELO string.
-If empty, the value returned -by SERVER_NAME is used or 'localhost.localdomain'.
- -- type - | -
- string - |
-
---|
$MessageID :-
An ID to be used in the Message-Id header.
-If empty, a unique id will be generated.
- -- type - | -
- string - |
-
---|
$MessageDate :-
The message Date to be used in the Date header.
-If empty, the current date will be added.
- -- type - | -
- string - |
-
---|
$Host :-
SMTP hosts.
-Either a single hostname or multiple semicolon-delimited hostnames. -You can also specify a different port -for each host by using this format: [hostname:port] -(e.g. "smtp1.example.com:25;smtp2.example.com"). -Hosts will be tried in order.
- -- type - | -
- string - |
-
---|
- type - | -
- int - |
-
---|---|
- Todo - | -
- Why is this needed when the SMTP class takes care of it? - |
-
- type - | -
- string - |
-
---|
$SMTPSecure :-
The secure connection prefix.
-Options: "", "ssl" or "tls"
- -- type - | -
- string - |
-
---|
$SMTPAuth :-
Whether to use SMTP authentication.
-Uses the Username and Password properties.
- -- type - | -
- bool - |
-
---|
- type - | -
- string - |
-
---|
- type - | -
- string - |
-
---|
$AuthType :-
SMTP auth type.
-Options are LOGIN (default), PLAIN, NTLM, CRAM-MD5
- -- type - | -
- string - |
-
---|
- type - | -
- string - |
-
---|
- type - | -
- string - |
-
---|
- type - | -
- int - |
-
---|
$SMTPDebug :-
SMTP class debug output mode.
-Options: -0: no output -1: commands -2: data and commands -3: as 2 plus connection status -4: low level data output
- -- type - | -
- int - |
-
---|
$Debugoutput :-
How to handle debug output.
-Options:
-'echo': Output plain-text as-is, appropriate for CLI
-'html': Output escaped, line breaks converted to
, appropriate for browser output
-'error_log': Output to error log as configured in php.ini
- type - | -
- string - |
-
---|
$SMTPKeepAlive :-
Whether to keep SMTP connection open after each message.
-If this is set to true then to close the connection -requires an explicit call to smtpClose().
- -- type - | -
- bool - |
-
---|
$SingleTo :-
Whether to split multiple to addresses into multiple messages -or send them all in one message.
- - -- type - | -
- bool - |
-
---|
$SingleToArray :-
Storage for addresses when SingleTo is enabled.
- - -- type - | -
- array - |
-
---|---|
- todo - | -
- This should really not be public - |
-
$do_verp :-
Whether to generate VERP addresses on send.
-Only applicable when sending via SMTP.
- -- type - | -
- bool - |
-
---|
$AllowEmpty :-
Whether to allow sending messages with an empty body.
- - -- type - | -
- bool - |
-
---|
- note - | -
- The default remains "\n". We force CRLF where we know -it must be used via self::CRLF. - |
-
---|---|
- type - | -
- string - |
-
- type - | -
- string - |
-
---|
$DKIM_identity :-
DKIM Identity.
-Usually the email address used as the source of the email
- -- type - | -
- string - |
-
---|
$DKIM_passphrase :-
DKIM passphrase.
-Used if your key is encrypted.
- -- type - | -
- string - |
-
---|
- example - | -- - | -
---|---|
- type - | -
- string - |
-
- type - | -
- string - |
-
---|
$action_function :-
Callback Action function name.
-The function that handles the result of the send email action. -It is called out by send() for each email sent.
-Value can be any php callable: http://www.php.net/is_callable
-Parameters: -bool $result result of the send action -string $to email address of the recipient -string $cc cc email addresses -string $bcc bcc email addresses -string $subject the subject -string $body the email body -string $from email address of sender
- -- type - | -
- string - |
-
---|
$XMailer :-
What to use in the X-Mailer header.
-Options: null for default, whitespace for none, or a string to use
- -- type - | -
- string - |
-
---|
- type - | -
- string - |
-
---|
- type - | -
- string - |
-
---|
$mailHeader :-
Extra headers that createHeader() doesn't fold in.
- - -- type - | -
- string - |
-
---|
- type - | -
- SMTP - |
-
---|
- type - | -
- array - |
-
---|
- type - | -
- array - |
-
---|
- type - | -
- array - |
-
---|
- type - | -
- array - |
-
---|
$all_recipients :-
An array of all kinds of addresses.
-Includes all of $to, $cc, $bcc, $replyto
- -- type - | -
- array - |
-
---|
- type - | -
- array - |
-
---|
- type - | -
- array - |
-
---|
$lastMessageID :-
The most recent Message-ID (including angular brackets).
- - -- type - | -
- string - |
-
---|
- type - | -
- string - |
-
---|
- type - | -
- array - |
-
---|
- type - | -
- array - |
-
---|
- type - | -
- integer - |
-
---|
- type - | -
- string - |
-
---|
- type - | -
- string - |
-
---|
$sign_key_pass :-
The S/MIME password for the key.
-Used only if the key is encrypted.
- -- type - | -
- string - |
-
---|
- type - | -
- bool - |
-
---|
__construct(boolean $exceptions = false)
- Constructor
- - -boolean | -$exceptions | -Should we throw external exceptions? |
-
None found |
None found |
isHTML(boolean $ishtml = true) : void
- Sets message type to HTML or plain.
- - -boolean | -$ishtml | -True for HTML mode. |
-
None found |
None found |
None found |
None found |
None found |
addAddress(string $address, string $name = '') : boolean-
Add a "To" address.
- - -string | -$address | -- |
string | -$name | -- |
true on success, false if address already used
- -None found |
addCC(string $address, string $name = '') : boolean-
Add a "CC" address.
- - -string | -$address | -- |
string | -$name | -- |
true on success, false if address already used
- -- note - | -
- : This function works with the SMTP mailer on win32, not with the "mail" mailer. - |
-
---|
addBCC(string $address, string $name = '') : boolean-
Add a "BCC" address.
- - -string | -$address | -- |
string | -$name | -- |
true on success, false if address already used
- -- note - | -
- : This function works with the SMTP mailer on win32, not with the "mail" mailer. - |
-
---|
addReplyTo(string $address, string $name = '') : boolean-
Add a "Reply-to" address.
- - -string | -$address | -- |
string | -$name | -- |
None found |
setFrom(string $address, string $name = '', boolean $auto = true) : boolean-
Set the From and FromName properties.
- - -string | -$address | -- |
string | -$name | -- |
boolean | -$auto | -Whether to also set the Sender address, defaults to true |
-
None found |
getLastMessageID() : string-
Return the Message-ID header of the last email.
-Technically this is the value from the last time the headers were created, -but it's also the message ID of the last sent message except in -pathological cases.
- - - -None found |
validateAddress(string $address, string $patternselect = 'auto') : boolean-
Check that a string looks like an email address.
- - -string | -$address | -The email address to check |
-
string | -$patternselect | -A selector for the validation pattern to use : -
|
-
- static - | -- - | -
---|
send() : boolean-
Create a message and send it.
-Uses the sending method specified by $Mailer.
- - -false on error - See the ErrorInfo property for details of the error.
- -None found |
preSend() : boolean-
Prepare a message for sending.
- - - -None found |
postSend() : boolean-
Actually send a message.
-Send the email via the selected mechanism
- - -None found |
getSMTPInstance() : \SMTP-
Get an instance to use for SMTP operations.
-Override this function to load your own SMTP implementation
- - - -None found |
smtpConnect(array $options = array()) : boolean
- Initiate a connection to an SMTP server.
-Returns false if the operation failed.
- -array | -$options | -An array of options compatible with stream_context_create() |
-
None found |
smtpClose() : void-
Close the active SMTP session if one exists.
- - - - - -None found |
setLanguage(string $langcode = 'en', string $lang_path = '') : boolean-
Set the language for error messages.
-Returns false if it cannot load the language file. -The default language is English.
- -string | -$langcode | -ISO 639-1 2-character language code (e.g. French is "fr") |
-
string | -$lang_path | -Path to the language file directory, with trailing separator (slash) |
-
None found |
getTranslations() : array-
Get the array of strings for the current language.
- - - - -None found |
addrAppend(string $type, array $addr) : string-
Create recipient headers.
- - -string | -$type | -- |
array | -$addr | -An array of recipient, -where each recipient is a 2-element indexed array with element 0 containing an address -and element 1 containing a name, like: -array(array('joe@example.com', 'Joe User'), array('zoe@example.com', 'Zoe User')) |
-
None found |
addrFormat(array $addr) : string
- Format an address for use in a message header.
- - -array | -$addr | -A 2-element indexed array, element 0 containing an address, element 1 containing a name -like array('joe@example.com', 'Joe User') |
-
None found |
wrapText(string $message, integer $length, boolean $qp_mode = false) : string-
Word-wrap message.
-For use with mailers that do not automatically perform wrapping -and for quoted-printable encoded messages. -Original written by philippe.
- -string | -$message | -The message to wrap |
-
integer | -$length | -The line length to wrap to |
-
boolean | -$qp_mode | -Whether to run in Quoted-Printable mode |
-
None found |
utf8CharBoundary(string $encodedText, integer $maxLength) : integer-
Find the last character boundary prior to $maxLength in a utf-8 -quoted (printable) encoded string.
-Original written by Colin Brown.
- -string | -$encodedText | -utf-8 QP text |
-
integer | -$maxLength | -find last character boundary prior to this length |
-
None found |
None found |
createHeader() : string-
Assemble message headers.
- - - - -The assembled headers
- -None found |
getMailMIME() : string-
Get the message MIME type headers.
- - - - -None found |
getSentMIMEMessage() : string-
Returns the whole MIME message.
-Includes complete headers and body. -Only valid post preSend().
- - - -None found |
createBody() : string-
Assemble the message body.
-Returns an empty string on failure.
- - -The assembled message body
- -None found |
headerLine(string $name, string $value) : string-
Format a header line.
- - -string | -$name | -- |
string | -$value | -- |
None found |
textLine(string $value) : string
- Return a formatted mail line.
- - -string | -$value | -- |
None found |
addAttachment(string $path, string $name = '', string $encoding = 'base64', string $type = '', string $disposition = 'attachment') : boolean-
Add an attachment from a path on the filesystem.
-Returns false if the file could not be found or read.
- -string | -$path | -Path to the attachment. |
-
string | -$name | -Overrides the attachment name. |
-
string | -$encoding | -File encoding (see $Encoding). |
-
string | -$type | -File extension (MIME) type. |
-
string | -$disposition | -Disposition to use |
-
None found |
getAttachments() : array-
Return the array of attachments.
- - - - -None found |
encodeString(string $str, string $encoding = 'base64') : string-
Encode a string in requested format.
-Returns an empty string on failure.
- -string | -$str | -The text to encode |
-
string | -$encoding | -The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable' |
-
None found |
encodeHeader(string $str, string $position = 'text') : string-
Encode a header string optimally.
-Picks shortest of Q, B, quoted-printable or none.
- -string | -$str | -- |
string | -$position | -- |
None found |
hasMultiBytes(string $str) : boolean
- Check if a string contains multi-byte characters.
- - -string | -$str | -multi-byte text to wrap encode |
-
None found |
has8bitChars(string $text) : boolean
- Does a string contain any 8-bit chars (in any charset)?
- - -string | -$text | -- |
None found |
base64EncodeWrapMB(string $str, string $linebreak = null) : string-
Encode and wrap long multibyte strings for mail headers -without breaking lines within a character.
-Adapted from a function by paravoid
- -string | -$str | -multi-byte text to wrap encode |
-
string | -$linebreak | -string to use as linefeed/end-of-line |
-
None found |
encodeQP(string $string, integer $line_max = 76) : string-
Encode a string in quoted-printable format.
-According to RFC2045 section 6.7.
- -string | -$string | -The text to encode |
-
integer | -$line_max | -Number of chars allowed on a line before wrapping |
-
None found |
encodeQPphp(string $string, integer $line_max = 76, boolean $space_conv = false) : string-
Backward compatibility wrapper for an old QP encoding function that was removed.
- - -string | -$string | -- |
integer | -$line_max | -- |
boolean | -$space_conv | -- |
None found |
encodeQ(string $str, string $position = 'text') : string-
Encode a string using Q encoding.
- - -string | -$str | -the text to encode |
-
string | -$position | -Where the text is going to be used, see the RFC for what that means |
-
None found |
addStringAttachment(string $string, string $filename, string $encoding = 'base64', string $type = '', string $disposition = 'attachment') : void-
Add a string or binary attachment (non-filesystem).
-This method can be used to attach ascii or binary data, -such as a BLOB record from a database.
- -string | -$string | -String attachment data. |
-
string | -$filename | -Name of the attachment. |
-
string | -$encoding | -File encoding (see $Encoding). |
-
string | -$type | -File extension (MIME) type. |
-
string | -$disposition | -Disposition to use |
-
None found |
addEmbeddedImage(string $path, string $cid, string $name = '', string $encoding = 'base64', string $type = '', string $disposition = 'inline') : boolean-
Add an embedded (inline) attachment from a file.
-This can include images, sounds, and just about any other document type. -These differ from 'regular' attachmants in that they are intended to be -displayed inline with the message, not just attached for download. -This is used in HTML messages that embed the images -the HTML refers to using the $cid value.
- -string | -$path | -Path to the attachment. |
-
string | -$cid | -Content ID of the attachment; Use this to reference -the content when using an embedded image in HTML. |
-
string | -$name | -Overrides the attachment name. |
-
string | -$encoding | -File encoding (see $Encoding). |
-
string | -$type | -File MIME type. |
-
string | -$disposition | -Disposition to use |
-
True on successfully adding an attachment
- -None found |
addStringEmbeddedImage(string $string, string $cid, string $name = '', string $encoding = 'base64', string $type = '', string $disposition = 'inline') : boolean-
Add an embedded stringified attachment.
-This can include images, sounds, and just about any other document type. -Be sure to set the $type to an image type for images: -JPEG images use 'image/jpeg', GIF uses 'image/gif', PNG uses 'image/png'.
- -string | -$string | -The attachment binary data. |
-
string | -$cid | -Content ID of the attachment; Use this to reference -the content when using an embedded image in HTML. |
-
string | -$name | -- |
string | -$encoding | -File encoding (see $Encoding). |
-
string | -$type | -MIME type. |
-
string | -$disposition | -Disposition to use |
-
True on successfully adding an attachment
- -None found |
inlineImageExists() : boolean-
Check if an inline attachment is present.
- - - - -None found |
attachmentExists() : boolean-
Check if an attachment (non-inline) is present.
- - - - -None found |
alternativeExists() : boolean-
Check if this message has an alternative body set.
- - - - -None found |
None found |
None found |
None found |
None found |
clearAllRecipients() : void-
Clear all recipient types.
- - - - - -None found |
clearAttachments() : void-
Clear all filesystem, string, and binary attachments.
- - - - - -None found |
clearCustomHeaders() : void-
Clear all custom headers.
- - - - - -None found |
rfcDate() : string-
Return an RFC 822 formatted date.
- - - - -- static - | -- - | -
---|
isError() : boolean-
Check if an error occurred.
- - - - -True if an error did occur.
- -None found |
fixEOL(string $str) : string
- Ensure consistent line endings in a string.
-Changes every end of line from CRLF, CR or LF to $this->LE.
- -string | -$str | -String to fixEOL |
-
None found |
addCustomHeader(string $name, string $value = null) : void-
Add a custom header.
-$name value can be overloaded to contain -both header name and value (name:value)
- -string | -$name | -Custom header name |
-
string | -$value | -Header value |
-
None found |
msgHTML(string $message, string $basedir = '', boolean $advanced = false) : string-
Create a message from an HTML string.
-Automatically makes modifications for inline images and backgrounds -and creates a plain-text version by converting the HTML. -Overwrites any existing values in $this->Body and $this->AltBody
- -string | -$message | -HTML message string |
-
string | -$basedir | -baseline directory for path |
-
boolean | -$advanced | -Whether to use the advanced HTML to text converter |
-
$message
- -None found |
html2text(string $html, boolean $advanced = false) : string-
Convert an HTML string into plain text.
- - -string | -$html | -The HTML text to convert |
-
boolean | -$advanced | -Should this use the more complex html2text converter or just a simple one? |
-
None found |
_mime_types(string $ext = '') : string
- Get the MIME type for a file extension.
- - -string | -$ext | -File extension |
-
MIME type of file.
- -- static - | -- - | -
---|
filenameToType(string $filename) : string
- Map a file name to a MIME type.
-Defaults to 'application/octet-stream', i.e.. arbitrary binary data.
- -string | -$filename | -A file name or full path, does not need to exist as a file |
-
- static - | -- - | -
---|
mb_pathinfo(string $path, integer|string $options = null) : string|array-
Multi-byte-safe pathinfo replacement.
-Drop-in replacement for pathinfo(), but multibyte-safe, cross-platform-safe, old-version-safe. -Works similarly to the one in PHP >= 5.2.0
- -string | -$path | -A filename or path, does not need to exist as a file |
-
integer|string | -$options | -Either a PATHINFO_* constant, -or a string name to return only the specified piece, allows 'filename' to work on PHP < 5.2 |
-
- static - | -- - | -
---|
set(string $name, mixed $value = '') : boolean-
Set or reset instance properties.
-Usage Example: -$page->set('X-Priority', '3');
- -string | -$name | -- |
mixed | -$value | -NOTE: will not work with arrays, there are no arrays to set/reset |
-
- todo - | -
- Should this not be using __set() magic function? - |
-
---|
secureHeader(string $str) : string
- Strip newlines to prevent header injection.
- - -string | -$str | -- |
None found |
normalizeBreaks(string $text, string $breaktype = "\r\n") : string-
Normalize line breaks in a string.
-Converts UNIX LF, Mac CR and Windows CRLF line breaks into a single line break format. -Defaults to CRLF (for message bodies) and preserves consecutive breaks.
- -string | -$text | -- |
string | -$breaktype | -What kind of line break to use, defaults to CRLF |
-
- static - | -- - | -
---|
sign(string $cert_filename, string $key_filename, string $key_pass)-
Set the public and private key files and password for S/MIME signing.
- - -string | -$cert_filename | -- |
string | -$key_filename | -- |
string | -$key_pass | -Password for private key |
-
None found |
DKIM_QP(string $txt) : string
- Quoted-Printable-encode a DKIM header.
- - -string | -$txt | -- |
None found |
DKIM_Sign(string $signheader) : string
- Generate a DKIM signature.
- - -string | -$signheader | -Header |
-
None found |
DKIM_HeaderC(string $signheader) : string
- Generate a DKIM canonicalization header.
- - -string | -$signheader | -Header |
-
None found |
DKIM_BodyC(string $body) : string
- Generate a DKIM canonicalization body.
- - -string | -$body | -Message Body |
-
None found |
DKIM_Add(string $headers_line, string $subject, string $body) : string-
Create the DKIM header and body in a new message header.
- - -string | -$headers_line | -Header lines |
-
string | -$subject | -Subject |
-
string | -$body | -Body |
-
None found |
getToAddresses() : array-
Allows for public read access to 'to' property.
- - - - -None found |
getCcAddresses() : array-
Allows for public read access to 'cc' property.
- - - - -None found |
getBccAddresses() : array-
Allows for public read access to 'bcc' property.
- - - - -None found |
getReplyToAddresses() : array-
Allows for public read access to 'ReplyTo' property.
- - - - -None found |
getAllRecipientAddresses() : array-
Allows for public read access to 'all_recipients' property.
- - - - -None found |
edebug(string $str)
- Output debugging info via user-defined method.
-Only if debug output is enabled.
- -string | -$str | -- |
None found |
addAnAddress(string $kind, string $address, string $name = '') : boolean-
Add an address to one of the recipient arrays.
-Addresses that have been added already return false, but do not throw exceptions
- -string | -$kind | -One of 'to', 'cc', 'bcc', 'ReplyTo' |
-
string | -$address | -The email address to send to |
-
string | -$name | -- |
true on success, false if address already used or invalid in some way
- -None found |
sendmailSend(string $header, string $body) : boolean-
Send mail using the $Sendmail program.
- - -string | -$header | -The message headers |
-
string | -$body | -The message body |
-
None found |
mailSend(string $header, string $body) : boolean-
Send mail using the PHP mail() function.
- - -string | -$header | -The message headers |
-
string | -$body | -The message body |
-
None found |
smtpSend(string $header, string $body) : boolean-
Send mail via SMTP.
-Returns false if there is a bad MAIL FROM, RCPT, or DATA input. -Uses the PHPMailerSMTP class by default.
- -string | -$header | -The message headers |
-
string | -$body | -The message body |
-
None found |
getBoundary(string $boundary, string $charSet, string $contentType, string $encoding) : string-
Return the start of a message boundary.
- - -string | -$boundary | -- |
string | -$charSet | -- |
string | -$contentType | -- |
string | -$encoding | -- |
None found |
endBoundary(string $boundary) : string
- Return the end of a message boundary.
- - -string | -$boundary | -- |
None found |
setMessageType() : void-
Set the message type.
-PHPMailer only supports some preset message types, -not arbitrary MIME structures.
- - - - -None found |
attachAll(string $disposition_type, string $boundary) : string-
Attach all file, string, and binary attachments to the message.
-Returns an empty string on failure.
- -string | -$disposition_type | -- |
string | -$boundary | -- |
None found |
encodeFile(string $path, string $encoding = 'base64') : string-
Encode a file attachment in requested format.
-Returns an empty string on failure.
- -string | -$path | -The full path to the file |
-
string | -$encoding | -The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable' |
-
None found |
setError(string $msg) : void
- Add an error message to the error container.
- - -string | -$msg | -- |
None found |
serverHostname() : string-
Get the server hostname.
-Returns 'localhost.localdomain' if unknown.
- - - -None found |
lang(string $key) : string
- Get an error message in the current language.
- - -string | -$key | -- |
None found |
doCallback(boolean $isSent, string $to, string $cc, string $bcc, string $subject, string $body, string $from = null)-
Perform a callback.
- - -boolean | -$isSent | -- |
string | -$to | -- |
string | -$cc | -- |
string | -$bcc | -- |
string | -$subject | -- |
string | -$body | -- |
string | -$from | -- |
None found |
mailPassthru(string $to, string $subject, string $body, string $header, string $params) : boolean-
Call mail() in a safe_mode-aware fashion.
-Also, unless sendmail_path points to sendmail (or something that -claims to be sendmail), don't pass params (not a perfect fix, -but it will do)
- -string | -$to | -To |
-
string | -$subject | -Subject |
-
string | -$body | -Message Body |
-
string | -$header | -Additional Header(s) |
-
string | -$params | -Params |
-
None found |
PHPMailer RFC821 SMTP email transport class.
-Implements RFC 821 SMTP commands and provides some utility methods for sending mail to an SMTP server.
- - -- author - | -
- Chris Ryan unknown@example.com -Marcus Bointon phpmailer@synchromedia.co.uk - |
-
---|
- type - | -
- string - |
-
---|
- type - | -
- string - |
-
---|
- type - | -
- int - |
-
---|
MAX_LINE_LENGTH-
The maximum line length allowed by RFC 2822 section 2.1.1
- -- type - | -
- int - |
-
---|
- type - | -
- string - |
-
---|
- type - | -
- int - |
-
---|
- type - | -
- string - |
-
---|
$do_debug :-
Debug output level.
-Options:
-0
No output1
Commands2
Data and commands3
As 2 plus connection status4
Low-level data output- type - | -
- int - |
-
---|
$Debugoutput :-
How to handle debug output.
-Options:
-echo
Output plain-text as-is, appropriate for CLIhtml
Output escaped, line breaks converted to error_log
Output to error log as configured in php.ini- type - | -
- string - |
-
---|
- type - | -
- bool - |
-
---|
$Timeout :-
The timeout value for connection, in seconds.
-Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2 -This needs to be quite high to function correctly with hosts using greetdelay as an anti-spam measure.
- -- type - | -
- int - |
-
---|
- type - | -
- int - |
-
---|
- type - | -
- resource - |
-
---|
- type - | -
- string - |
-
---|
- type - | -
- string - |
-
---|
$last_reply :-
The most recent reply received from the server.
- - -- type - | -
- string - |
-
---|
None found |
connect(string $host, integer $port = null, integer $timeout = 30, array $options = array()) : boolean-
Connect to an SMTP server.
- - -string | -$host | -SMTP server IP or host name |
-
integer | -$port | -The port number to connect to |
-
integer | -$timeout | -How long to wait for the connection to open |
-
array | -$options | -An array of options for stream_context_create() |
-
None found |
startTLS() : boolean-
Initiate a TLS (encrypted) session.
- - - - -None found |
authenticate(string $username, string $password, string $authtype = 'LOGIN', string $realm = '', string $workstation = '') : boolean-
Perform SMTP authentication.
-Must be run after hello().
- -string | -$username | -The user name |
-
string | -$password | -The password |
-
string | -$authtype | -The auth type (PLAIN, LOGIN, NTLM, CRAM-MD5) |
-
string | -$realm | -The auth realm for NTLM |
-
string | -$workstation | -The auth workstation for NTLM |
-
True if successfully authenticated.
- -None found |
connected() : boolean-
Check connection state.
- - - - -True if connected.
- -None found |
close() : void-
Close the socket and clean up the state of the class.
-Don't use this function without first trying to use QUIT.
- - - - -None found |
data(string $msg_data) : boolean
- Send an SMTP DATA command.
-Issues a data command and sends the msg_data to the server,
-finializing the mail transaction. $msg_data is the message
-that is to be send with the headers. Each header needs to be
-on a single line followed by a
string | -$msg_data | -Message data to send |
-
None found |
hello(string $host = '') : boolean
- Send an SMTP HELO or EHLO command.
-Used to identify the sending server to the receiving server.
-This makes sure that client and server are in a known state.
-Implements RFC 821: HELO
string | -$host | -The host name or IP to connect to |
-
None found |
mail(string $from) : boolean
- Send an SMTP MAIL command.
-Starts a mail transaction from the email address specified in
-$from. Returns true if successful or false otherwise. If True
-the mail transaction is started and then one or more recipient
-commands may be called followed by a data command.
-Implements rfc 821: MAIL
string | -$from | -Source address of this message |
-
None found |
quit(boolean $close_on_error = true) : boolean
- Send an SMTP QUIT command.
-Closes the socket if there is no error or the $close_on_error argument is true.
-Implements from rfc 821: QUIT
boolean | -$close_on_error | -Should the connection close if an error occurs? |
-
None found |
recipient(string $toaddr) : boolean
- Send an SMTP RCPT command.
-Sets the TO argument to $toaddr.
-Returns true if the recipient was accepted false if it was rejected.
-Implements from rfc 821: RCPT
string | -$toaddr | -The address the message is being sent to |
-
None found |
reset() : boolean-
Send an SMTP RSET command.
-Abort any transaction that is currently in progress.
-Implements rfc 821: RSET
True on success.
- -None found |
sendAndMail(string $from) : boolean
- Send an SMTP SAML command.
-Starts a mail transaction from the email address specified in $from.
-Returns true if successful or false otherwise. If True
-the mail transaction is started and then one or more recipient
-commands may be called followed by a data command. This command
-will send the message to the users terminal if they are logged
-in and send them an email.
-Implements rfc 821: SAML
string | -$from | -The address the message is from |
-
None found |
verify(string $name) : boolean
- Send an SMTP VRFY command.
- - -string | -$name | -The name to verify |
-
None found |
noop() : boolean-
Send an SMTP NOOP command.
-Used to keep keep-alives alive, doesn't actually do anything
- - - -None found |
turn() : boolean-
Send an SMTP TURN command.
-This is an optional command for SMTP that this class does not support.
-This method is here to make the RFC821 Definition complete for this class
-and may be implemented in future
-Implements from rfc 821: TURN
None found |
client_send(string $data) : integer|boolean
- Send raw data to the server.
- - -string | -$data | -The data to send |
-
The number of bytes sent to the server or false on error
- -None found |
None found |
getLastReply() : string-
Get the last reply from the server.
- - - - -None found |
setVerp(boolean $enabled = false)
- Enable or disable VERP address generation.
- - -boolean | -$enabled | -- |
None found |
getVerp() : boolean-
Get VERP address generation mode.
- - - - -None found |
setDebugOutput(string $method = 'echo')
- Set debug output method.
- - -string | -$method | -The function/method to use for debugging output. |
-
None found |
getDebugOutput() : string-
Get debug output method.
- - - - -None found |
setDebugLevel(integer $level)
- Set debug output level.
- - -integer | -$level | -- |
None found |
getDebugLevel() : integer-
Get debug output level.
- - - - -None found |
setTimeout(integer $timeout)
- Set SMTP timeout.
- - -integer | -$timeout | -- |
None found |
None found |
edebug(string $str) : void
- Output debugging info via a user-selected method.
- - -string | -$str | -Debug string to output |
-
None found |
hmac(string $data, string $key) : string-
Calculate an MD5 HMAC hash.
-Works like hash_hmac('md5', $data, $key) -in case that function is not available
- -string | -$data | -The data to hash |
-
string | -$key | -The key to hash with |
-
None found |
sendHello(string $hello, string $host) : boolean-
Send an SMTP HELO or EHLO command.
-Low-level implementation used by hello()
- -string | -$hello | -The HELO string |
-
string | -$host | -The hostname to say we are |
-
None found |
sendCommand(string $command, string $commandstring, integer|array $expect) : boolean-
Send a command to an SMTP server and check its return code.
- - -string | -$command | -The command name - not sent to the server |
-
string | -$commandstring | -The actual command to send |
-
integer|array | -$expect | -One or more expected integer success codes |
-
True on success.
- -None found |
get_lines() : string-
Read the SMTP server's response.
-Either before eof or socket timeout occurs on the operation. -With SMTP we can tell if we have more lines to read if the -4th character is '-' symbol. If it is a space then we don't -need to read anything else.
- - - -None found |
Abstract class for implementing an application Controller.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
None found |
$agent : \nre\core\Agent-
Corresponding Agent
- - -None found |
$view : \nre\core\View-
View of the Controller
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
$log : \nre\core\Logger-
Logger instance
- - -None found |
$linker : \nre\core\Linker-
Linker instance
- - -None found |
load(string $controllerName)
- Load the class of a Controller.
- - -string | -$controllerName | -Name of the Controller to load |
-
None found |
factory(string $controllerName, string $layoutName, string $action, string $agent)-
Instantiate a Controller (Factory Pattern).
- - -string | -$controllerName | -Name of the Controller to instantiate |
-
string | -$layoutName | -Name of the current Layout |
-
string | -$action | -Current Action |
-
string | -$agent | -Corresponding Agent |
-
None found |
__construct(string $layoutName, string $action, \nre\core\Agent $agent)-
Construct a new application Controller.
- - -string | -$layoutName | -Name of the current Layout |
-
string | -$action | -Current Action |
-
\nre\core\Agent | -$agent | -Corresponding Agent |
-
None found |
preFilter(\nre\core\Request $request, \nre\core\Response $response)-
Prefilter that is executed before running the Controller.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
postFilter(\nre\core\Request $request, \nre\core\Response $response)-
Postfilter that is executed after running the Controller.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
run(\nre\core\Request $request, \nre\core\Response $response)-
Run the Controller.
-This method executes the Action of the Controller defined by -the current Request.
- -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
render(array $viewData = null) : string
- Generate the output.
- - -array | -$viewData | -Data to pass to the View |
-
Generated output
- -None found |
set(string $name, mixed $data)-
Set data for the View.
- - -string | -$name | -Key |
-
mixed | -$data | -Value |
-
None found |
redirect(string $url)
- Redirect to the given URL.
- - -string | -$url | -Relative URL |
-
None found |
checkModels(string $modelName) : boolean
- Check if Models of this Controller are loaded and available.
- - -string | -$modelName | -Arbitrary number of Models to check |
-
All given Models are loaded and available
- -None found |
getView() : \nre\core\View-
Get the View of the Controller
- - - - -View of the Controller
- -None found |
loadModels()-
Load the Models of this Controller.
- - - -None found |
loadView(string $layoutName, string $action)-
Load the View of this Controller.
- - -string | -$layoutName | -Name of the current Layout |
-
string | -$action | -Current Action |
-
None found |
log(string $message, integer $logMode = \nre\core\Logger::LOGMODE_AUTO)-
Log an error.
- - -string | -$message | -Error message to log |
-
integer | -$logMode | -Log mode (optional) |
-
None found |
getClassName(string $controllerName) : string
- Determine the classname for the given Controller name.
- - -string | -$controllerName | -Controller name to get classname of |
-
Classname for the Controller name
- -None found |
loadComponents()-
Load the Components of this Controller.
- - - -None found |
Abstract class for implementing an application Model.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
$db : \nre\models\DatabaseDriver-
Database connection
- - -- static - | -- - | -
---|
__construct()-
Construct a new application Model.
-TODO Catch exception
- - -None found |
load(string $modelName)
- Load the class of a Model.
- - -string | -$modelName | -Name of the Model to load |
-
None found |
factory(string $modelName)
- Instantiate a Model (Factory Pattern).
- - -string | -$modelName | -Name of the Model to instantiate |
-
None found |
loadDriver(string $driverName)
- Load the database driver.
- - -string | -$driverName | -Name of the database driver |
-
None found |
connect(string $driverName, array $config)-
Establish a connection to the database.
- - -string | -$driverName | -Name of the database driver |
-
array | -$config | -Connection settings |
-
None found |
getClassName(string $modelName) : string
- Determine the classname for the given Model name.
- - -string | -$modelName | -Model name to get classname of |
-
Classname fore the Model name
- -None found |
loadModels()-
Load the Models of this Model.
- - - -None found |
Class to format text with different syntax tags.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
$linker : \nre\core\Linker-
Linker to create links.
- - -None found |
$Media : \nre\core\Model-
Media-Model to retrieve media data
- - -- static - | -- - | -
---|
__construct(\nre\core\Linker $linker)
- Create a new text formatter.
- - -\nre\core\Linker | -$linker | -Linker to create links with |
-
None found |
Class for implementing utility methods.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
t(string $string) : string
- Mask HTML-chars for save output.
- - -string | -$string | -String to be masked |
-
Masked string
- -- static - | -- - | -
---|
htmlspecialchars_utf8(string $string) : string
- ‚htmlspecialchars‘ with support for UTF-8.
- - -string | -$string | -String to be masked |
-
Masked string
- -- static - | -- - | -
---|
shortenString(string $string, integer $length, integer $scope) : string-
Cut a string to the given length but only word boundaries.
- - -string | -$string | -String to cut |
-
integer | -$length | -Length to cut string |
-
integer | -$scope | -Maximum length to cut string regardless word boundaries |
-
Cutted string
- -- static - | -- - | -
---|
sendMail(mixed $to, string $messageAction, boolean $html = false, array $params = null, \nre\core\Linker $linker = null)-
Send an e‑mail.
- - -mixed | -$to | -One (string) or many (array) receivers |
-
string | -$messageAction | -Message Action |
-
boolean | -$html | -Whether mail should be formatted as HTML or not |
-
array | -$params | -Parameters to pass |
-
\nre\core\Linker | -$linker | -Linker instance |
-
None found |
getMimetype(string $filename, string $defaultMimetype = null) : string-
Detect Mimetype of a file.
- - -string | -$filename | -Name of file to detect Mimetype of |
-
string | -$defaultMimetype | -Default Mimetype to use |
-
Detected Mimetype of file
- -None found |
Abstract class for implementing a QuesttypeAgent.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
load(string $questtypeName)
- Load a QuesttypeAgent.
- - -string | -$questtypeName | -Name of the QuesttypeAgent to load |
-
- static - | -- - | -
---|
factory(string $questtypeName, \hhu\z\agents\Request $request, \hhu\z\agents\Response $response, \hhu\z\agents\Logger $log = null)-
Instantiate a QuesttypeAgent (Factory Pattern).
- - -string | -$questtypeName | -Name of the QuesttypeAgent to instantiate |
-
\hhu\z\agents\Request | -$request | -Current request |
-
\hhu\z\agents\Response | -$response | -Current respone |
-
\hhu\z\agents\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
checkClass(string $className, string $parentClassName)-
Check inheritance of the QuesttypeAgent-class.
- - -string | -$className | -Name of the class to check |
-
string | -$parentClassName | -Name of the parent class |
-
- static - | -- - | -
---|
saveAnswersOfCharacter(array $seminary, array $questgroup, array $quest, array $character, array $answers)-
Save the answers of a Character for a Quest.
- - -array | -$seminary | -Current Seminary data |
-
array | -$questgroup | -Current Questgroup data |
-
array | -$quest | -Current Quest data |
-
array | -$character | -Current Character data |
-
array | -$answers | -Character answers for the Quest |
-
None found |
matchAnswersOfCharacter(array $seminary, array $questgroup, array $quest, array $character, array $answers)-
Check if answers of a Character for a Quest match the correct ones.
- - -array | -$seminary | -Current Seminary data |
-
array | -$questgroup | -Current Questgroup data |
-
array | -$quest | -Current Quest data |
-
array | -$character | -Current Character data |
-
array | -$answers | -Character answers for the Quest |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new QuesttypeAgent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $questtypeName, string $agentType = null) : string-
Determine the Agent-classname for the given Questtype-name.
- - -string | -$questtypeName | -Questtype-name to get Agent-classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Questtype-name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
loadClass(string $questtypeName, string $fullClassName)-
Load the class of a QuesttypeAgent.
- - -string | -$questtypeName | -Name of the QuesttypeAgent to load |
-
string | -$fullClassName | -Name of the class to load |
-
- static - | -- - | -
---|
Abstract class for implementing an application Controller.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
None found |
None found |
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
None found |
$intermediateAgent : \nre\agents\IntermediateAgent-
IntermediateAgent instance
- - -None found |
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
getIntermediateAgent() : \nre\agents\IntermediateAgent-
Return the IntermediateAgent.
- - - - -IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new ToplevlAgent
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
\nre\core\Logger | -$log | -Logger instance |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
loadIntermediateAgent()-
Load IntermediateAgent defined by the current request.
- - - -None found |
_loadIntermediateAgent()-
Load IntermediateAgent defined by the current request.
- - - -None found |
_run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
runIntermediateAgent()-
Run IntermediateAgent.
- - - -None found |
error(\Exception $exception, integer $httpStatusCode, string $stage = self::STAGE_LOAD)-
Handle an error that occurred during -loading/cnostructing/running of the IntermediateAgent.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$httpStatusCode | -HTTP-statuscode |
-
string | -$stage | -Stage of execution |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to generate a mail receiver salutation.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to display a menu.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to display the Questgroups hierarchy path.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to display a sidebar with Seminary related information.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to display a menu with Seminary related links.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to display and manage userroles.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
user(\nre\core\Request $request, \nre\core\Response $response)-
Action: user.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to list Achievements.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to display Character groups.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to display Character groups Quests.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to list registered Characters and their data.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
character(\nre\core\Request $request, \nre\core\Response $response)-
Action: character.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to handle Charactertyes of a Seminary.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to show an error page.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to show an introduction page.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to list Quest topics.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to generate a mail-message.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to process and show media.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to display Questgroups.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
questgroup(\nre\core\Request $request, \nre\core\Response $response)-
Action: questgroup.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
edit(\nre\core\Request $request, \nre\core\Response $response)-
Action: edit.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
edittexts(\nre\core\Request $request, \nre\core\Response $response)-
Action: edittexts.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
delete(\nre\core\Request $request, \nre\core\Response $response)-
Action: delete.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to manage Questgroupshierarchy.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to display Quests.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
quest(\nre\core\Request $request, \nre\core\Response $response)-
Action: quest.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
submissions(\nre\core\Request $request, \nre\core\Response $response)-
Action: submissions.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
submission(\nre\core\Request $request, \nre\core\Response $response)-
Action: submission.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
create(\nre\core\Request $request, \nre\core\Response $response)-
Action: create.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
edit(\nre\core\Request $request, \nre\core\Response $response)-
Action: edit.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
edittask(\nre\core\Request $request, \nre\core\Response $response)-
Action: edittask.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
edittexts(\nre\core\Request $request, \nre\core\Response $response)-
Action: edittexts.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
delete(\nre\core\Request $request, \nre\core\Response $response)-
Action: delete.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to list registered seminaries.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to process and show user uploads.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to list registered users and their data.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
user(\nre\core\Request $request, \nre\core\Response $response)-
Action: user.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to handle XP-levels of a Seminary.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
getLayout(string $agentName) : string
- Get the layout if it was explicitly defined.
- - -string | -$agentName | -Agent name |
-
Layout of the IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new Agent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
Agent to return a JSON-string used by AJAX.
- - - -- author - | -
- Oliver Hanraths oliver.hanraths@uni-duesseldorf.de - |
-
---|
None found |
None found |
INLINEERROR_AGENT-
Name of BottomlevelAgent for showing inline errors
- -None found |
$controller : \nre\core\Controller-
Controller of this Agent
- - -None found |
$log : \nre\core\Logger-
Log-system
- - -None found |
None found |
$request : \nre\core\Request-
Current request
- - -None found |
$response : \nre\core\Response-
Current response
- - -None found |
None found |
$intermediateAgent : \nre\agents\IntermediateAgent-
IntermediateAgent instance
- - -None found |
run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
render(array $data = array()) : string
- Generate output of the Controller of this Agent and its -SubAgents.
- - -array | -$data | -View data |
-
Generated output
- -None found |
getIntermediateAgent() : \nre\agents\IntermediateAgent-
Return the IntermediateAgent.
- - - - -IntermediateAgent
- -None found |
load(string $agentName)
- Load the class of an Agent.
- - -string | -$agentName | -Name of the Agent to load |
-
- static - | -- - | -
---|
factory(string $agentName, \nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Instantiate an Agent (Factory Pattern).
- - -string | -$agentName | -Name of the Agent to instantiate |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -- |
\nre\core\Logger | -$log | -Log-system |
-
- static - | -- - | -
---|
index(\nre\core\Request $request, \nre\core\Response $response)-
Action: index.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
None found |
__construct(\nre\core\Request $request, \nre\core\Response $response, \nre\core\Logger $log = null)-
Construct a new AjaxAgent.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
\nre\core\Logger | -$log | -Logger instance |
-
None found |
addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
None found |
loadController()-
Load the Controller of this Agent.
- - - -None found |
log(\Exception $exception, integer $logMode)-
Log an error.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$logMode | -Log mode |
-
None found |
_addSubAgent(string $agentName)
- Load a SubAgent and add it.
- - -string | -$agentName | -Name of the Agent to load |
-
None found |
loadIntermediateAgent()-
Load IntermediateAgent defined by the current request.
- - - -None found |
_loadIntermediateAgent()-
Load IntermediateAgent defined by the current request.
- - - -None found |
_run(\nre\core\Request $request, \nre\core\Response $response) : \Exception-
Run the Controller of this Agent and its SubAgents.
- - -\nre\core\Request | -$request | -Current request |
-
\nre\core\Response | -$response | -Current response |
-
Last occurred exception of SubAgents
- -None found |
runIntermediateAgent()-
Run IntermediateAgent.
- - - -None found |
error(\Exception $exception, integer $httpStatusCode, string $stage = self::STAGE_LOAD)-
Handle an error that occurred during -loading/cnostructing/running of the IntermediateAgent.
- - -\Exception | -$exception | -Occurred exception |
-
integer | -$httpStatusCode | -HTTP-statuscode |
-
string | -$stage | -Stage of execution |
-
None found |
getAgentType() : string-
Determine the type of an Agent.
- - - - -Agent type
- -- static - | -- - | -
---|
getClassName(string $agentName, string $agentType) : string-
Determine the classname for the given Agent name.
- - -string | -$agentName | -Agent name to get classname of |
-
string | -$agentType | -Agent type of given Agent name |
-
Classname for the Agent name
- -- static - | -- - | -
---|
newSubAgent(string $agentName) : array
- Create a new SubAgent.
- - -string | -$agentName | -Agent name |
-
SubAgent
- -None found |
renderSubAgent(array $subAgent) : string
- Render a SubAgent.
- - -array | -$subAgent | -SubAgent to render |
-
Generated output
- -None found |
errorInline(array $subAgent, \nre\core\Request $request, \nre\core\Excepiton $exception) : array-
Handle the exception of a SubAgent.
- - -array | -$subAgent | -Original (Sub-) Agent |
-
\nre\core\Request | -$request | -Current request |
-
\nre\core\Excepiton | -$exception | -Occurred exception |
-
InlineError-SubAgent
- -None found |
newInlineError(string $label, \Exception $exception)-
Create a new InlineError.
- - -string | -$label | -Name of the original Agent |
-
\Exception | -$exception | -Occurred exception |
-
None found |
newInlineErrorService()-
Handle a hardcore error that could not be handled by the -system.
- - - - - -None found |
setLanguage(\nre\core\Request $request)
- Set requested language.
- - -\nre\core\Request | -$request | -Current request |
-
None found |