Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
JSONMessage Class Reference

Public Member Functions

 getAdditionalAttributes ()
 
 getContent ()
 
 getElementId ()
 
 getEvent ()
 
 getStatus ()
 
 getString ()
 
 JSONMessage ($status=true, $content= '', $elementId= '0', $additionalAttributes=null)
 
 setAdditionalAttributes ($additionalAttributes)
 
 setContent ($content)
 
 setElementId ($elementId)
 
 setEvent ($eventName, $eventData=null)
 
 setStatus ($status)
 

Public Attributes

 $_additionalAttributes
 
 $_content
 
 $_elementId
 
 $_event
 
 $_status
 

Detailed Description

Class to represent a JSON (Javascript Object Notation) message.

Definition at line 18 of file JSONMessage.inc.php.

Member Function Documentation

JSONMessage::getAdditionalAttributes ( )

Get the additionalAttributes array

Returns
array

Definition at line 143 of file JSONMessage.inc.php.

JSONMessage::getContent ( )

Get the content string

Returns
mixed

Definition at line 87 of file JSONMessage.inc.php.

JSONMessage::getElementId ( )

Get the elementId string

Returns
string

Definition at line 103 of file JSONMessage.inc.php.

JSONMessage::getEvent ( )

Get the event to trigger with this JSON message

Returns
array

Definition at line 135 of file JSONMessage.inc.php.

JSONMessage::getStatus ( )

Get the status string

Returns
string

Definition at line 70 of file JSONMessage.inc.php.

JSONMessage::getString ( )

Construct a JSON string to use for AJAX communication

Returns
string

Definition at line 160 of file JSONMessage.inc.php.

Referenced by PluginGridHandler\_showUploadPluginForm(), LibraryFileGridHandler\addFile(), CatalogEntryTabHandler\catalogMetadata(), SettingsHandler\categories(), ManageCatalogHandler\category(), UserGridHandler\disableUser(), CategoryCategoryGridHandler\editCategory(), PressGridHandler\editContext(), ContributorGridHandler\editContributor(), UserGridHandler\editDisableUser(), UserGridHandler\editEmail(), LibraryFileGridHandler\editFile(), GenreGridHandler\editGenre(), SubmissionChecklistGridHandler\editItem(), PreparedEmailsGridHandler\editPreparedEmail(), SeriesGridHandler\editSeries(), SponsorGridHandler\editSponsor(), UserGridHandler\editUser(), UserGroupGridHandler\editUserGroup(), WorkflowHandler\expedite(), SubmissionMetadataHandler\fetch(), SelectMonographHandler\fetch(), DistributionSettingsTabHandler\getPaymentFormContents(), ApprovedProofFilesGridHandler\getRequestArgs(), SubmissionInformationCenterHandler\metadata(), PKPSubmissionInformationCenterHandler\metadata(), AnnouncementGridHandler\moreInformation(), CatalogEntryTabHandler\publicationMetadata(), PKPSubmissionHandler\saveStep(), EditorReviewFilesGridHandler\selectFiles(), FinalDraftFilesGridHandler\selectFiles(), UserGridHandler\sendEmail(), SettingsHandler\series(), ManageCatalogHandler\series(), WebsiteSettingsTabHandler\showFileUploadForm(), AdminSettingsTabHandler\showFileUploadForm(), PKPSubmissionHandler\step(), CategoryCategoryGridHandler\updateCategory(), UserGroupGridHandler\updateUserGroup(), and PKPSubmissionInformationCenterHandler\viewNotes().

JSONMessage::JSONMessage (   $status = true,
  $content = '',
  $elementId = '0',
  $additionalAttributes = null 
)

Constructor.

Parameters
$statusboolean The status of an event (e.g. false if form validation fails).
$contentMixed The message to be delivered back to the calling script.
$elementIdstring The DOM element to be replaced.
$additionalAttributesarray Additional data to be returned.

Definition at line 56 of file JSONMessage.inc.php.

JSONMessage::setAdditionalAttributes (   $additionalAttributes)

Set the additionalAttributes array

Parameters
$additionalAttributesarray

Definition at line 151 of file JSONMessage.inc.php.

JSONMessage::setContent (   $content)

Set the content data

Parameters
$contentmixed

Definition at line 95 of file JSONMessage.inc.php.

JSONMessage::setElementId (   $elementId)

Set the elementId string

Parameters
$elementIdstring

Definition at line 111 of file JSONMessage.inc.php.

JSONMessage::setEvent (   $eventName,
  $eventData = null 
)

Set the event to trigger with this JSON message

Parameters
$eventNamestring
$eventDatastring

Definition at line 121 of file JSONMessage.inc.php.

JSONMessage::setStatus (   $status)

Set the status string

Parameters
$statusstring

Definition at line 78 of file JSONMessage.inc.php.

Member Data Documentation

array JSONMessage::$_additionalAttributes

Set of additional attributes for special cases.

Definition at line 47 of file JSONMessage.inc.php.

Mixed JSONMessage::$_content

The message to be delivered back to the calling script.

Definition at line 29 of file JSONMessage.inc.php.

string JSONMessage::$_elementId

ID for DOM element that will be replaced.

Definition at line 35 of file JSONMessage.inc.php.

array JSONMessage::$_event

A JS event generated on the server side.

Definition at line 41 of file JSONMessage.inc.php.

string JSONMessage::$_status

The status of an event (e.g. false if form validation fails).

Definition at line 23 of file JSONMessage.inc.php.


The documentation for this class was generated from the following file: