UNB Components Code Reference

UnbUi class

Contains methods to print out HTML controls that form the UI of UNB components.

Public methods

S BeginForm Prints the opening tag of the HTML form and the URL key hidden field.
S ButtonCode Prints the input button to mark text as code in the message content text field.
S ButtonEm Prints the input button to emphasise text in the message content text field.
S ButtonIndent Prints the input button to indent text in the message content text field.
S ButtonLink Prints the input button to add a link in the message content text field.
S ButtonOl Prints the input button to make an ordered list in the message content text field.
S ButtonQuote Prints the input button to quote text in the message content text field.
S Buttons Prints all input buttons to format text in the message content text field.
S ButtonStrike Prints the input button to strike out text in the message content text field.
S ButtonStrong Prints the input button to strongly emphasise text in the message content text field.
S ButtonUl Prints the input button to make an unordered list in the message content text field.
S CanAlterMsg Gets a value indicating whether a particular message (revision) can be altered.
S CanReplyMsg Gets a value indicating whether a particular message (revision) can be replied to.
S CanSeeSubject Gets a value indicating whether the subject of a particular message revision is accessible.
S Captcha Prints the image and input element for the CAPTCHA test.
S DateTime Gets a formatted date time value.
S EndForm Prints the closing tag of the HTML form.
S FormHandlerFieldsXML Formats and prints all form handler fields as an XML document.
S FormMsgRev Prints the message ID and revision number to be submitted with the form.
S FormReplyToMsg Prints the in-reply-to message ID to be submitted with the form.
S FormTag Prints the tag ID to be submitted with the form.
S FormUrlKey Prints the URL key to be submitted with the form.
S FormUser Prints the user ID to be submitted with the form.
S GetFormErrorMessage Gets the form handler error message, if an error has occured.
S GetFormHandler Gets the form handler instance.
S GetFormHandlerFields Gets form handler return fields.
S GetMsgAlterAccessKeys Gets a message's alter access keys as multi-line string.
S GetMsgReadAccessKeys Gets a message's read access keys as multi-line string.
S GetMsgReplyAccessKeys Gets a message's reply access keys as multi-line string.
S GetMsgRev Gets a message revision by its message ID and revision number for altering or replying to it.
S GetQuotedMsg Gets a quoted message content.
S GetQuotedSubject Gets a quoted message subject.
S GetTagReadAccessKeys Gets a tag's read access keys as multi-line string.
S GetTagUseAccessKeys Gets a tag's use access keys as multi-line string.
S GetUserAdditionalKeys Gets a user's additional keys as multi-line string.
S GetUserList Gets a multi-line string of user names from a list of user IDs.
S Init Initialises the UNB components.
S IsCaptchaEnabled Gets a value indicating whether the CAPTCHA validation shall be used.
S IsFormError Gets a value indicating whether an error has occured during form handling.
S IsFormSuccess Gets a value indicating whether the form handling has been successfully completed.
S IsMsgOwner Gets a value indicating whether the current session user is the owner of a particular message.
S MsgAlterAccessList Prints the input element for the message alter access list.
S MsgApproveRevLink Prints the HTML link to approve a message revision.
S MsgAttach Prints the input element for the message file attachment.
S MsgClearRatingLink Prints the HTML link to clear a message rating.
S MsgContent Prints the input element for the message content.
S MsgDEP Prints the input element for the message discussion entry point (DEP) flag.
S MsgLockRevLink Prints the HTML link to lock a message revision.
S MsgModerateMsg Prints the input elements for the message moderation flags.
S MsgPageName Prints the input element for the message page name.
S MsgRateLink Prints the HTML link to rate a message.
S MsgRating Prints the HTML code to visualise a message rating.
S MsgReadAccessList Prints the input element for the message read access list.
S MsgReplyAccessList Prints the input element for the message reply access list.
S MsgSubject Prints the input element for the message subject.
S MsgSummary Prints the input element for the message change summary.
S MsgTags Prints the list of available tags to be set for the message.
S MsgTree Prints a message reference tree.
S MsgUnlockRevLink Prints the HTML link to unlock a message revision.
S ParentTag Prints the input element for the parent tag selection.
S RedirectAndExit Redirects the browser to another URL and terminates programme execution.
S RelativeTime Gets a relative time description.
S ReportError Reports an error message.
S ReportInfo Reports an information message.
S ReportSuccess Reports a success message.
S TagDescription Prints the input element for the tag description.
S TagFlags Prints the input elements for the tag flags.
S TagName Prints the input element for the tag name.
S TagReadAccessList Prints the input element for the tag read access list.
S TagUseAccessList Prints the input element for the tag use access list.
S UserAdditionalKeysList Prints the input element for the user additional keys list.
S UserAddVcardEntry Prints the input element for a new user vcard entry.
S UserAdministrator Prints the input element for the user's Administrator privilege.
S UserAlterVcardEntry Prints the input element for a user vcard entry.
S UserCurrentPassword Prints the input element for the current user login password validation.
S UserDisplayName Prints the input element for the user display name.
S UserLoginName Prints the input element for the user login name.
S UserLoginPassword Prints the input element for the user login password.
S UserModerator Prints the input element for the user's Moderator privilege.
S UserRepeatPassword Prints the input element for the user login password repetition.
S UserResetAutologinPassword Prints the input element for the option to reset the user's autologin password.
S UserResetAutologinPasswordLink Prints the HTML link to approve a message revision.
S UserTrusted Prints the input element for the user's Trusted privilege.
S UserVcardTypes Prints the input element for a new user vcard entry type.

Private methods

S CombineTimeUnits No description available.
S EnsureHandleForm Ensures that the form has been handled.
S FormHandlerFieldsXML_rec No description available.
S GetId Does centralised HTML input element ID checking.
S GetValue No description available.
S InsertDefaultMessage Prints JavaScript code to handle a default message for empty input fields and a dedicated hidden input field that tells the form handler to ignore the default message and that the input field is actually empty.
S MsgTags_ListTags No description available.
S TranslateTimeUnit No description available.

Private fields

formFields  –  default: null
formHandler  –  default: null

Implementation file: ui.class.php, line 23

© 2010 Yves Goergen. UNB Components Homepage. Reference generated on 2010-03-07.