Open Journal Systems  3.0.0
 All Data Structures Namespaces Functions Variables Groups Pages
DataObject Class Reference
Inheritance diagram for DataObject:
AccessKey Announcement AnnouncementType AuthSource BaseEmailTemplate Citation Context ControlledVocab ControlledVocabEntry Currency DataObjectTombstone EmailLogEntry EventLogEntry ExternalFeed Filter FilterGroup GalleryPlugin Genre Identity Issue Language LibraryFile Mail MetadataDescription Note PKPFile PKPGift PKPNotification PKPSection Process Query Representation ReviewAssignment ReviewForm ReviewFormElement ReviewFormResponse ReviewRound Role Session Site StageAssignment Submission SubmissionComment Subscription SubscriptionType UserGroup UserGroupAssignment Version

Public Member Functions

 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
 getSupportedExtractionAdapters ()
 
 getSupportedInjectionAdapters ()
 
 getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata ($metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
 upcastTo ($targetObject)
 

Data Fields

 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Any class with an associated DAO should extend this class.

See Also
Core

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

Member Function Documentation

DataObject::addSupportedMetadataAdapter (   $metadataAdapter)

Add a meta-data adapter that will be supported by this application entity. Only one adapter per schema can be added.

Parameters
$metadataAdapterMetadataDataObjectAdapter

Definition at line 258 of file DataObject.inc.php.

DataObject::DataObject ( )

Constructor.

Definition at line 58 of file DataObject.inc.php.

DataObject::extractMetadata (   $metadataSchema)

Extract a meta-data description from this data object.

Parameters
$metadataSchemaMetadataSchema
Returns
$metadataDescription MetadataDescription

Definition at line 452 of file DataObject.inc.php.

DataObject::getAdditionalMetadataFieldNames ( )

Retrieve the names of additional meta-data properties that need to be persisted.

Returns
array an array of field names

Definition at line 414 of file DataObject.inc.php.

& DataObject::getAllData ( )

Return an array with all data variables.

Returns
array

Definition at line 175 of file DataObject.inc.php.

& DataObject::getData (   $key,
  $locale = null 
)

Get the value of a data variable.

Parameters
$keystring
$localestring (optional)
Returns
mixed

Definition at line 100 of file DataObject.inc.php.

Referenced by Citation\addError(), PlainTextReferencesListFilter\addTemplateVars(), Section\getAbbrev(), UserGroup\getAbbrev(), Submission\getAbstract(), Section\getAbstractsNotRequired(), Section\getAbstractWordCount(), PublishedArticle\getAccessStatus(), Issue\getAccessStatus(), ReviewForm\getActive(), Process\getAdditionalData(), Identity\getAffiliation(), SubmissionAgency\getAgency(), Announcement\getAnnouncementTypeName(), IsbndbNlm30CitationSchemaFilter\getApiKey(), WorldcatNlm30CitationSchemaFilter\getApiKey(), AnnouncementType\getAssocId(), ControlledVocab\getAssocId(), Announcement\getAssocId(), Query\getAssocId(), BaseEmailTemplate\getAssocId(), PKPGift\getAssocId(), SubmissionComment\getAssocId(), AccessKey\getAssocId(), ReviewForm\getAssocId(), SubmissionFile\getAssocId(), EmailLogEntry\getAssocId(), EventLogEntry\getAssocId(), Note\getAssocId(), PKPNotification\getAssocId(), Query\getAssocType(), BaseEmailTemplate\getAssocType(), PKPGift\getAssocType(), AnnouncementType\getAssocType(), ControlledVocab\getAssocType(), Announcement\getAssocType(), ReviewForm\getAssocType(), EmailLogEntry\getAssocType(), EventLogEntry\getAssocType(), Note\getAssocType(), PKPNotification\getAssocType(), SubmissionFile\getAssocType(), AuthSource\getAuthId(), PKPUser\getAuthId(), SubmissionComment\getAuthorEmail(), SubmissionComment\getAuthorId(), SubmissionComment\getAuthorName(), PKPUser\getAuthStr(), EmailLogEntry\getBccs(), PKPUser\getBillingAddress(), Identity\getBiography(), EmailLogEntry\getBody(), Version\getBuild(), PKPGift\getBuyerEmail(), PKPGift\getBuyerFirstName(), PKPGift\getBuyerFullName(), PKPGift\getBuyerLastName(), PKPGift\getBuyerMiddleName(), PKPGift\getBuyerUserId(), ReviewAssignment\getCancelled(), BaseEmailTemplate\getCanDisable(), GalleryPlugin\getCategory(), Genre\getCategory(), EmailLogEntry\getCcs(), ParaciteRawCitationNlm30CitationSchemaFilter\getCitationModule(), TemplateBasedReferencesListFilter\getCitationOutputFilterInstance(), Submission\getCitations(), Citation\getCitationState(), Language\getCode(), Currency\getCodeAlpha(), Currency\getCodeNumeric(), ReviewAssignment\getComments(), SubmissionComment\getComments(), Submission\getCommentsToEditor(), SubmissionComment\getCommentTitle(), SubmissionComment\getCommentType(), Author\getCompetingInterests(), ReviewAssignment\getCompetingInterests(), ReviewForm\getCompleteCount(), GalleryPlugin\getContactEmail(), GalleryPlugin\getContactInstitutionName(), GalleryPlugin\getContactName(), Note\getContents(), IssueFile\getContentType(), AccessKey\getContext(), PKPSection\getContextId(), Genre\getContextId(), LibraryFile\getContextId(), UserGroup\getContextId(), Submission\getContextId(), PKPNotification\getContextId(), ControlledVocabEntry\getControlledVocabId(), Submission\getCopyrightHolder(), Submission\getCopyrightNotice(), Submission\getCopyrightYear(), SubscriptionType\getCost(), Identity\getCountry(), Submission\getCoverage(), Issue\getCoverPageAltText(), Submission\getCoverPageAltText(), Issue\getCoverPageDescription(), SupplementaryFile\getCreator(), SubscriptionType\getCurrencyCodeAlpha(), SubscriptionType\getCurrencyString(), SubscriptionType\getCurrencyStringShort(), Issue\getCurrent(), Version\getCurrent(), Article\getCurrentRound(), DataObjectTombstone\getDataObjectId(), GalleryPlugin\getDate(), ReviewAssignment\getDateAcknowledged(), StageAssignment\getDateAssigned(), ReviewAssignment\getDateAssigned(), ReviewAssignment\getDateCompleted(), ReviewAssignment\getDateConfirmed(), Note\getDateCreated(), PKPNotification\getDateCreated(), SupplementaryFile\getDateCreated(), DataObjectTombstone\getDateDeleted(), ReviewAssignment\getDateDue(), Subscription\getDateEnd(), Announcement\getDateExpire(), Version\getDateInstalled(), PKPUser\getDateLastEmail(), PKPUser\getDateLastLogin(), EventLogEntry\getDateLogged(), Note\getDateModified(), IssueFile\getDateModified(), LibraryFile\getDateModified(), SubmissionComment\getDateModified(), SubmissionFile\getDateModified(), Issue\getDateNotified(), ReviewAssignment\getDateNotified(), SubmissionComment\getDatePosted(), Announcement\getDatePosted(), Issue\getDatePublished(), Submission\getDatePublished(), ReviewAssignment\getDateRated(), PKPNotification\getDateRead(), PKPUser\getDateRegistered(), ReviewAssignment\getDateReminded(), ReviewAssignment\getDateResponseDue(), EmailLogEntry\getDateSent(), Subscription\getDateStart(), Submission\getDateStatusModified(), Submission\getDateSubmitted(), Announcement\getDatetimePosted(), PKPGift\getDatetimeRedeemed(), PKPFile\getDateUploaded(), LibraryFile\getDateUploaded(), PKPUser\getDateValidated(), ReviewAssignment\getDeclined(), UserGroup\getDefault(), AuthSource\getDefault(), Genre\getDependent(), Context\getDescription(), FilterGroup\getDescription(), SupplementaryFile\getDescription(), SubscriptionType\getDescription(), Announcement\getDescription(), ReviewForm\getDescription(), GalleryPlugin\getDescription(), Issue\getDescription(), Announcement\getDescriptionShort(), Genre\getDesignation(), SubmissionFile\getDirectSalesPrice(), PKPUser\getDisabled(), PKPUser\getDisabledReason(), SubscriptionType\getDisablePublicDisplay(), SubmissionDiscipline\getDiscipline(), Submission\getDiscipline(), ExternalFeed\getDisplayBlock(), ExternalFeed\getDisplayHomepage(), FilterGroup\getDisplayName(), InstitutionalSubscription\getDomain(), Session\getDomain(), SubscriptionType\getDuration(), SubscriptionType\getDurationYearsMonths(), PKPSection\getEditorRestricted(), ReviewFormElement\getElementType(), PubmedNlm30CitationSchemaFilter\getEmail(), CrossrefNlm30CitationSchemaFilter\getEmail(), Identity\getEmail(), BaseEmailTemplate\getEmailId(), BaseEmailTemplate\getEmailKey(), Genre\getEnabled(), Context\getEnabled(), BaseEmailTemplate\getEnabled(), EmailLogEntry\getEventType(), EventLogEntry\getEventType(), AccessKey\getExpiryDate(), Article\getFastTracked(), SubmissionFile\getFileId(), IssueGalley\getFileId(), Issue\getFileName(), Submission\getFileName(), PKPFile\getFileSize(), LibraryFile\getFileSize(), SubmissionFile\getFileStage(), PKPFile\getFileType(), LibraryFile\getFileType(), Identity\getFirstName(), SubscriptionType\getFormat(), SubscriptionType\getFormatString(), EmailLogEntry\getFrom(), BaseEmailTemplate\getFromRoleId(), Identity\getFullName(), PublishedArticle\getGalleys(), ArticleGalley\getGalleyType(), PKPUser\getGender(), SubmissionFile\getGenreId(), PKPGift\getGiftAssocId(), PKPGift\getGiftNote(), PKPGift\getGiftNoteTitle(), PKPGift\getGiftType(), PKPUser\getGossip(), Issue\getHeight(), Submission\getHeight(), Section\getHideAbout(), Section\getHideAuthor(), Submission\getHideAuthor(), Submission\getHideCoverPageAbstract(), Issue\getHideCoverPageArchives(), Issue\getHideCoverPageCover(), Submission\getHideCoverPageToc(), Section\getHideTitle(), GalleryPlugin\getHomepage(), ExternalFeed\getId(), Section\getIdentifyType(), ReviewFormElement\getIncluded(), PKPAuthor\getIncludeInBrowse(), ReviewForm\getIncompleteCount(), Identity\getInitials(), PKPUser\getInlineHelp(), FilterGroup\getInputType(), GalleryPlugin\getInstallationInstructions(), Site\getInstalledLocales(), SubscriptionType\getInstitutional(), InstitutionalSubscription\getInstitutionMailingAddress(), InstitutionalSubscription\getInstitutionName(), InterestEntry\getInterest(), EmailLogEntry\getIPAddress(), EventLogEntry\getIPAddress(), Session\getIpAddress(), InstitutionalSubscription\getIPRanges(), InstitutionalSubscription\getIPRangesString(), Representation\getIsApproved(), Query\getIsClosed(), IssueFile\getIssueId(), PublishedArticle\getIssueId(), Issue\getIssueIdentification(), EventLogEntry\getIsTranslated(), Issue\getJournalId(), Subscription\getJournalId(), SubscriptionType\getJournalId(), ExternalFeed\getJournalId(), Article\getJournalId(), Genre\getKey(), AccessKey\getKeyHash(), SubmissionKeyword\getKeyword(), IssueGalley\getLabel(), ArticleGalley\getLabel(), SubmissionLanguage\getLanguage(), SupplementaryFile\getLanguage(), Submission\getLanguage(), Issue\getLastModified(), ReviewAssignment\getLastModified(), Submission\getLastModified(), Identity\getLastName(), Version\getLazyLoad(), PKPNotification\getLevel(), Submission\getLicenseURL(), ExternalFeed\getLimitItems(), IssueGalley\getLocale(), ArticleGalley\getLocale(), PKPGift\getLocale(), Submission\getLocale(), PKPUser\getLocales(), Submission\getLocalizedData(), PublishedArticle\getLocalizedGalleys(), PKPUser\getMailingAddress(), Version\getMajor(), Subscription\getMembership(), SubscriptionType\getMembership(), EventLogEntry\getMessage(), TemplateBasedReferencesListFilter\getMetadataSchema(), Section\getMetaIndexed(), Section\getMetaReviewed(), Identity\getMiddleName(), Version\getMinor(), Site\getMinPasswordLength(), PKPUser\getMustChangePassword(), Currency\getName(), Language\getName(), GalleryPlugin\getName(), Representation\getName(), AnnouncementType\getName(), SubscriptionType\getName(), ControlledVocabEntry\getName(), Genre\getName(), LibraryFile\getName(), UserGroup\getName(), SubmissionFile\getName(), PKPFile\getNiceFileSize(), LibraryFile\getNiceFileSize(), SubscriptionType\getNonExpiring(), Subscription\getNotes(), PKPGift\getNotes(), Issue\getNumber(), DataObjectTombstone\getOAIIdentifier(), DataObjectTombstone\getOAISetObjectsIds(), Process\getObliterated(), Issue\getOpenAccessDate(), Identity\getOrcid(), PKPFile\getOriginalFileName(), LibraryFile\getOriginalFileName(), Issue\getOriginalFileName(), Submission\getOriginalFileName(), Site\getOriginalStyleFilename(), Issue\getOriginalStyleFileName(), FilterGroup\getOutputType(), Submission\getPages(), EventLogEntry\getParams(), PKPUser\getPassword(), UserGroup\getPath(), Context\getPath(), UserGroup\getPermitSelfRegistration(), PKPUser\getPhone(), AuthSource\getPlugin(), AuthSource\getPluginClass(), Section\getPolicy(), ReviewFormElement\getPossibleResponses(), Submission\getPrefix(), PKPAuthor\getPrimaryContact(), Context\getPrimaryLocale(), Site\getPrimaryLocale(), Process\getProcessType(), GalleryPlugin\getProduct(), Version\getProduct(), Version\getProductClassName(), Version\getProductType(), Issue\getPublished(), PublishedArticle\getPublishedArticleId(), SupplementaryFile\getPublisher(), ReviewAssignment\getQuality(), ReviewFormElement\getQuestion(), ExternalFeed\getRecentItems(), PKPGift\getRecipientEmail(), PKPGift\getRecipientFirstName(), PKPGift\getRecipientFullName(), PKPGift\getRecipientLastName(), PKPGift\getRecipientMiddleName(), EmailLogEntry\getRecipients(), PKPGift\getRecipientUserId(), ReviewAssignment\getRecommendation(), Site\getRedirect(), Subscription\getReferenceNumber(), GalleryPlugin\getReleaseCertifications(), GalleryPlugin\getReleaseDescription(), GalleryPlugin\getReleaseMD5(), GalleryPlugin\getReleasePackage(), Session\getRemember(), ReviewAssignment\getReminderWasAutomatic(), Representation\getRemoteURL(), ReviewAssignment\getReplaced(), ReviewFormElement\getRequired(), ReviewFormResponse\getResponseType(), XSLTransformationFilter\getResultType(), ReviewAssignment\getReviewerFullName(), ReviewAssignment\getReviewerId(), ReviewFormResponse\getReviewFormElementId(), ReviewFormElement\getReviewFormId(), PKPSection\getReviewFormId(), ReviewAssignment\getReviewFormId(), ReviewFormResponse\getReviewId(), ReviewAssignment\getReviewMethod(), ReviewAssignment\getReviewRoundId(), Version\getRevision(), SubmissionFile\getRevision(), Submission\getRights(), UserGroup\getRoleId(), SubmissionComment\getRoleId(), ReviewRound\getRound(), SubmissionFile\getRound(), ReviewAssignment\getRound(), SubmissionFile\getSalesType(), Identity\getSalutation(), Session\getSecondsCreated(), Session\getSecondsLastUsed(), Article\getSectionAbbrev(), Article\getSectionId(), Article\getSectionTitle(), EmailLogEntry\getSenderEmail(), EmailLogEntry\getSenderFullName(), EmailLogEntry\getSenderId(), Representation\getSequence(), PKPSection\getSequence(), ControlledVocabEntry\getSequence(), Genre\getSequence(), PublishedArticle\getSequence(), ReviewFormElement\getSequence(), Query\getSequence(), ExternalFeed\getSequence(), IssueGalley\getSequence(), PKPAuthor\getSequence(), ReviewForm\getSequence(), Context\getSequence(), SubscriptionType\getSequence(), PKPFile\getServerFileName(), LibraryFile\getServerFileName(), Session\getSessionData(), DataObjectTombstone\getSetName(), DataObjectTombstone\getSetSpec(), AuthSource\getSettings(), Issue\getShowCoverPage(), Submission\getShowCoverPage(), Issue\getShowNumber(), PKPAuthor\getShowTitle(), UserGroup\getShowTitle(), Issue\getShowTitle(), Issue\getShowVolume(), Issue\getShowYear(), PKPUser\getSignature(), Version\getSitewide(), Genre\getSortable(), SupplementaryFile\getSource(), Submission\getSource(), SubmissionFile\getSourceFileId(), SubmissionFile\getSourceRevision(), SupplementaryFile\getSponsor(), Submission\getSponsor(), ReviewRound\getStageId(), StageAssignment\getStageId(), Query\getStageId(), ReviewAssignment\getStageId(), Submission\getStageId(), MetadataDescription\getStatements(), PKPGift\getStatus(), ReviewRound\getStatus(), Subscription\getStatus(), Submission\getStatus(), Subscription\getStatusString(), Representation\getStoredPubId(), IssueGalley\getStoredPubId(), Submission\getStoredPubId(), Issue\getStoredPubId(), Issue\getStyleFileName(), SubmissionSubject\getSubject(), SupplementaryFile\getSubject(), EmailLogEntry\getSubject(), Submission\getSubject(), PKPAuthor\getSubmissionId(), ReviewRound\getSubmissionId(), StageAssignment\getSubmissionId(), ReviewAssignment\getSubmissionId(), LibraryFile\getSubmissionId(), SubmissionComment\getSubmissionId(), Representation\getSubmissionId(), SubmissionFile\getSubmissionId(), Submission\getSubmissionProgress(), Subscription\getSubscriptionTypeInstitutional(), Subscription\getSubscriptionTypeName(), Subscription\getSubscriptionTypeSummaryString(), Submission\getSubtitle(), Identity\getSuffix(), GalleryPlugin\getSummary(), Genre\getSupplementary(), Context\getSupportedFormLocaleNames(), Context\getSupportedLocaleNames(), Site\getSupportedLocales(), Nlm30CitationSchemaFilter\getSupportedPublicationTypes(), Context\getSupportedSubmissionLocaleNames(), ControlledVocab\getSymbolic(), FilterGroup\getSymbolic(), Process\getTimeStarted(), AuthSource\getTitle(), Issue\getTitle(), PKPSection\getTitle(), Note\getTitle(), Announcement\getTitle(), ReviewForm\getTitle(), ExternalFeed\getTitle(), Submission\getTitle(), BaseEmailTemplate\getToRoleId(), PKPNotification\getType(), LibraryFile\getType(), Submission\getType(), SubscriptionType\getTypeId(), Announcement\getTypeId(), Subscription\getTypeId(), ReviewAssignment\getUnconsidered(), SubmissionFile\getUploaderUserId(), ExternalFeed\getUrl(), Identity\getUrl(), Session\getUserAgent(), Subscription\getUserEmail(), EventLogEntry\getUserEmail(), Subscription\getUserFullName(), EventLogEntry\getUserFullName(), PKPAuthor\getUserGroupId(), StageAssignment\getUserGroupId(), SubmissionFile\getUserGroupId(), Note\getUserId(), EventLogEntry\getUserId(), TemporaryFile\getUserId(), Subscription\getUserId(), AccessKey\getUserId(), Session\getUserId(), StageAssignment\getUserId(), PKPNotification\getUserId(), PKPUser\getUsername(), ReviewFormResponse\getValue(), GalleryPlugin\getVersion(), SubmissionComment\getViewable(), SubmissionFile\getViewable(), Issue\getVolume(), Issue\getWidth(), Submission\getWidth(), XSLTransformationFilter\getXSL(), XSLTransformationFilter\getXSLType(), Issue\getYear(), EmailTemplate\isCustomTemplate(), Subscription\isExpired(), Subscription\isNonExpiring(), IndividualSubscription\isValid(), InstitutionalSubscription\isValid(), PlainTextReferencesListFilter\process(), Mail\setBody(), SubmissionArtworkFile\setCaption(), Mail\setCcs(), SubmissionArtworkFile\setContactAuthor(), Mail\setContentType(), SubmissionArtworkFile\setCopyrightOwner(), SubmissionArtworkFile\setCopyrightOwnerContactDetails(), SubmissionArtworkFile\setCredit(), Mail\setFrom(), Mail\setHeaders(), EmailTemplate\setLocale(), SubmissionArtworkFile\setPermissionFileId(), SubmissionArtworkFile\setPermissionTerms(), Mail\setPrivateParams(), Mail\setRecipients(), EmailTemplate\setSubject(), Mail\setSubject(), Session\setUserId(), SubmissionArtworkFile\SubmissionArtworkFile(), Filter\supportsAsInput(), and UserGroupAssignment\UserGroupAssignment().

DataObject::getHasLoadableAdapters ( )

Get whether the object has loadable meta-data adapters

Returns
boolean

Definition at line 248 of file DataObject.inc.php.

DataObject::getLocaleMetadataFieldNames ( )

Retrieve the names of translated meta-data properties that need to be persisted.

Returns
array an array of field names

Definition at line 405 of file DataObject.inc.php.

& DataObject::getLocalizedData (   $key)

Get a piece of data for this object, localized to the current locale if possible.

Parameters
$keystring
Returns
mixed

Definition at line 71 of file DataObject.inc.php.

Referenced by Section\getLocalizedAbbrev(), UserGroup\getLocalizedAbbrev(), Identity\getLocalizedAffiliation(), Identity\getLocalizedBiography(), Author\getLocalizedCompetingInterests(), Issue\getLocalizedCoverPageAltText(), Issue\getLocalizedCoverPageDescription(), SupplementaryFile\getLocalizedCreator(), ReviewForm\getLocalizedDescription(), SupplementaryFile\getLocalizedDescription(), Announcement\getLocalizedDescription(), Issue\getLocalizedDescription(), GalleryPlugin\getLocalizedDescription(), Announcement\getLocalizedDescriptionShort(), Issue\getLocalizedFileName(), PKPUser\getLocalizedGossip(), Issue\getLocalizedHeight(), Section\getLocalizedIdentifyType(), GalleryPlugin\getLocalizedInstallationInstructions(), GalleryPlugin\getLocalizedName(), Representation\getLocalizedName(), ControlledVocabEntry\getLocalizedName(), Genre\getLocalizedName(), UserGroup\getLocalizedName(), LibraryFile\getLocalizedName(), SubmissionFile\getLocalizedName(), Issue\getLocalizedOriginalFileName(), Site\getLocalizedPageHeaderTitleType(), Section\getLocalizedPolicy(), ReviewFormElement\getLocalizedPossibleResponses(), SupplementaryFile\getLocalizedPublisher(), ReviewFormElement\getLocalizedQuestion(), GalleryPlugin\getLocalizedReleaseDescription(), Issue\getLocalizedShowCoverPage(), PKPUser\getLocalizedSignature(), SupplementaryFile\getLocalizedSource(), SupplementaryFile\getLocalizedSponsor(), SupplementaryFile\getLocalizedSubject(), GalleryPlugin\getLocalizedSummary(), ReviewForm\getLocalizedTitle(), Issue\getLocalizedTitle(), PKPSection\getLocalizedTitle(), Announcement\getLocalizedTitle(), ExternalFeed\getLocalizedTitle(), AnnouncementType\getLocalizedTypeName(), Issue\getLocalizedWidth(), SubscriptionType\getSubscriptionTypeDescription(), and SubscriptionType\getSubscriptionTypeName().

DataObject::getMetadataFieldNames (   $translated = true)

Retrieve the names of meta-data properties of this data object.

Parameters
$translatedboolean if true, return localized field names, otherwise return additional field names.

Definition at line 364 of file DataObject.inc.php.

DataObject::getSetMetadataFieldNames (   $translated = true)

Retrieve the names of meta-data properties that need to be persisted (i.e. that have data).

Parameters
$translatedboolean if true, return localized field names, otherwise return additional field names.
Returns
array an array of field names

Definition at line 386 of file DataObject.inc.php.

DataObject::getSupportedExtractionAdapters ( )

Get all meta-data extraction adapters that support this data object. This includes adapters loaded from the database.

Returns
array

Definition at line 310 of file DataObject.inc.php.

DataObject::getSupportedInjectionAdapters ( )

Get all meta-data injection adapters that support this data object. This includes adapters loaded from the database.

Returns
array

Definition at line 330 of file DataObject.inc.php.

DataObject::getSupportedMetadataSchemas ( )

Returns all supported meta-data schemas which are supported by extractor adapters.

Returns
array

Definition at line 349 of file DataObject.inc.php.

DataObject::hasData (   $key,
  $locale = null 
)

Check whether a value exists for a given data variable.

Parameters
$keystring
$localestring (optional)
Returns
boolean

Definition at line 162 of file DataObject.inc.php.

Referenced by Filter\supportsAsInput().

DataObject::injectMetadata (   $metadataDescription)

Inject a meta-data description into this data object.

Parameters
$metadataDescriptionMetadataDescription
$replaceboolean whether to delete existing meta-data
Returns
boolean true on success, otherwise false

Definition at line 425 of file DataObject.inc.php.

DataObject::removeSupportedMetadataAdapter (   $metadataSchemaName)

Remove all adapters for the given meta-data schema (if it exists).

Parameters
$metadataSchemaNamestring fully qualified class name
Returns
boolean true if an adapter was removed, otherwise false.

Definition at line 291 of file DataObject.inc.php.

DataObject::setAllData ( $data)

Set all data variables at once.

Parameters
$dataarray

Definition at line 183 of file DataObject.inc.php.

DataObject::setData (   $key,
  $value,
  $locale = null 
)

Set the value of a new or existing data variable. NB: Passing in null as a value will unset the data variable if it already existed.

Parameters
$keystring
$valuemixed can be either a single value or an array of of localized values in the form: array( 'fr_FR' => 'en fran├žais', 'en_US' => 'in English', ... )
$localestring (optional) non-null for a single localized value. Null for a non-localized value or when setting all locales at once (see comment for $value parameter)

Definition at line 132 of file DataObject.inc.php.

Referenced by PKPAuthor\_setShowTitle(), Mail\getBccs(), EmailTemplate\getBody(), SubmissionArtworkFile\getCaption(), Mail\getCcs(), SubmissionArtworkFile\getChapterId(), SubmissionArtworkFile\getContactAuthor(), Mail\getContentType(), SubmissionArtworkFile\getCopyrightOwner(), SubmissionArtworkFile\getCopyrightOwnerContactDetails(), SubmissionArtworkFile\getCredit(), Citation\getErrors(), Mail\getFrom(), Mail\getHeaders(), EmailTemplate\getLocale(), SubmissionArtworkFile\getPermissionFileId(), SubmissionArtworkFile\getPermissionTerms(), Mail\getRecipients(), EmailTemplate\getSubject(), Mail\getSubject(), UserGroupAssignment\getUserGroupId(), UserGroupAssignment\getUserId(), PKPSubmissionNlm30XmlFilter\PKPSubmissionNlm30XmlFilter(), Section\setAbbrev(), UserGroup\setAbbrev(), Submission\setAbstract(), Section\setAbstractsNotRequired(), Section\setAbstractWordCount(), PublishedArticle\setAccessStatus(), Issue\setAccessStatus(), ReviewForm\setActive(), Process\setAdditionalData(), Identity\setAffiliation(), SubmissionAgency\setAgency(), AnnouncementType\setAssocId(), ControlledVocab\setAssocId(), Announcement\setAssocId(), Query\setAssocId(), BaseEmailTemplate\setAssocId(), PKPGift\setAssocId(), SubmissionComment\setAssocId(), AccessKey\setAssocId(), ReviewForm\setAssocId(), SubmissionFile\setAssocId(), EmailLogEntry\setAssocId(), EventLogEntry\setAssocId(), Note\setAssocId(), PKPNotification\setAssocId(), Query\setAssocType(), BaseEmailTemplate\setAssocType(), PKPGift\setAssocType(), AnnouncementType\setAssocType(), ControlledVocab\setAssocType(), Announcement\setAssocType(), ReviewForm\setAssocType(), EmailLogEntry\setAssocType(), EventLogEntry\setAssocType(), Note\setAssocType(), PKPNotification\setAssocType(), SubmissionFile\setAssocType(), AuthSource\setAuthId(), PKPUser\setAuthId(), SubmissionComment\setAuthorId(), PKPUser\setAuthStr(), EmailLogEntry\setBccs(), PKPUser\setBillingAddress(), Identity\setBiography(), EmailLogEntry\setBody(), Version\setBuild(), PKPGift\setBuyerEmail(), PKPGift\setBuyerFirstName(), PKPGift\setBuyerLastName(), PKPGift\setBuyerMiddleName(), PKPGift\setBuyerUserId(), ReviewAssignment\setCancelled(), BaseEmailTemplate\setCanDisable(), GalleryPlugin\setCategory(), Genre\setCategory(), EmailLogEntry\setCcs(), Submission\setCitations(), Citation\setCitationState(), Submission\setCleanTitle(), Language\setCode(), Currency\setCodeAlpha(), Currency\setCodeNumeric(), ReviewAssignment\setComments(), SubmissionComment\setComments(), Submission\setCommentsToEditor(), SubmissionComment\setCommentTitle(), SubmissionComment\setCommentType(), Author\setCompetingInterests(), ReviewAssignment\setCompetingInterests(), ReviewForm\setCompleteCount(), Context\setContactEmail(), GalleryPlugin\setContactEmail(), GalleryPlugin\setContactInstitutionName(), Context\setContactName(), GalleryPlugin\setContactName(), Note\setContents(), IssueFile\setContentType(), AccessKey\setContext(), PKPSection\setContextId(), Genre\setContextId(), LibraryFile\setContextId(), UserGroup\setContextId(), Submission\setContextId(), PKPNotification\setContextId(), ControlledVocabEntry\setControlledVocabId(), Submission\setCopyrightHolder(), Submission\setCopyrightNotice(), Submission\setCopyrightYear(), SubscriptionType\setCost(), Identity\setCountry(), Submission\setCoverage(), Issue\setCoverPageAltText(), Submission\setCoverPageAltText(), Issue\setCoverPageDescription(), SupplementaryFile\setCreator(), SubscriptionType\setCurrencyCodeAlpha(), Issue\setCurrent(), Version\setCurrent(), Article\setCurrentRound(), DataObjectTombstone\setDataObjectId(), GalleryPlugin\setDate(), ReviewAssignment\setDateAcknowledged(), StageAssignment\setDateAssigned(), ReviewAssignment\setDateAssigned(), ReviewAssignment\setDateCompleted(), ReviewAssignment\setDateConfirmed(), Note\setDateCreated(), PKPNotification\setDateCreated(), SupplementaryFile\setDateCreated(), DataObjectTombstone\setDateDeleted(), ReviewAssignment\setDateDue(), Subscription\setDateEnd(), Announcement\setDateExpire(), Version\setDateInstalled(), PKPUser\setDateLastEmail(), PKPUser\setDateLastLogin(), EventLogEntry\setDateLogged(), Note\setDateModified(), IssueFile\setDateModified(), SubmissionComment\setDateModified(), Issue\setDateNotified(), ReviewAssignment\setDateNotified(), SubmissionComment\setDatePosted(), Announcement\setDatePosted(), Issue\setDatePublished(), ReviewAssignment\setDateRated(), PKPNotification\setDateRead(), PKPUser\setDateRegistered(), ReviewAssignment\setDateReminded(), ReviewAssignment\setDateResponseDue(), EmailLogEntry\setDateSent(), Subscription\setDateStart(), Submission\setDateStatusModified(), Submission\setDateSubmitted(), Announcement\setDatetimePosted(), PKPGift\setDatetimeRedeemed(), PKPUser\setDateValidated(), ReviewAssignment\setDeclined(), UserGroup\setDefault(), AuthSource\setDefault(), Genre\setDependent(), FilterGroup\setDescription(), Context\setDescription(), SubscriptionType\setDescription(), SupplementaryFile\setDescription(), Announcement\setDescription(), ReviewForm\setDescription(), GalleryPlugin\setDescription(), Issue\setDescription(), Announcement\setDescriptionShort(), Genre\setDesignation(), SubmissionFile\setDirectSalesPrice(), PKPUser\setDisabled(), PKPUser\setDisabledReason(), SubscriptionType\setDisablePublicDisplay(), SubmissionDiscipline\setDiscipline(), Submission\setDiscipline(), ExternalFeed\setDisplayBlock(), ExternalFeed\setDisplayHomepage(), FilterGroup\setDisplayName(), InstitutionalSubscription\setDomain(), Session\setDomain(), SubscriptionType\setDuration(), PKPSection\setEditorRestricted(), ReviewFormElement\setElementType(), CrossrefNlm30CitationSchemaFilter\setEmail(), Identity\setEmail(), BaseEmailTemplate\setEmailId(), BaseEmailTemplate\setEmailKey(), Genre\setEnabled(), Context\setEnabled(), BaseEmailTemplate\setEnabled(), EmailLogEntry\setEventType(), EventLogEntry\setEventType(), AccessKey\setExpiryDate(), Article\setFastTracked(), SubmissionFile\setFileId(), IssueGalley\setFileId(), Issue\setFileName(), Submission\setFileName(), SubmissionFile\setFileStage(), PKPFile\setFileType(), LibraryFile\setFileType(), Identity\setFirstName(), SubscriptionType\setFormat(), EmailLogEntry\setFrom(), BaseEmailTemplate\setFromRoleId(), PublishedArticle\setGalleys(), ArticleGalley\setGalleyType(), PKPUser\setGender(), SubmissionFile\setGenreId(), PKPGift\setGiftAssocId(), PKPGift\setGiftNote(), PKPGift\setGiftNoteTitle(), PKPGift\setGiftType(), PKPUser\setGossip(), Issue\setHeight(), Submission\setHeight(), Section\setHideAbout(), Section\setHideAuthor(), Submission\setHideAuthor(), Submission\setHideCoverPageAbstract(), Issue\setHideCoverPageArchives(), Issue\setHideCoverPageCover(), Submission\setHideCoverPageToc(), Section\setHideTitle(), GalleryPlugin\setHomepage(), ExternalFeed\setId(), Section\setIdentifyType(), ReviewFormElement\setIncluded(), PKPAuthor\setIncludeInBrowse(), ReviewForm\setIncompleteCount(), Identity\setInitials(), PKPUser\setInlineHelp(), FilterGroup\setInputType(), GalleryPlugin\setInstallationInstructions(), Site\setInstalledLocales(), SubscriptionType\setInstitutional(), InstitutionalSubscription\setInstitutionMailingAddress(), InstitutionalSubscription\setInstitutionName(), InterestEntry\setInterest(), EmailLogEntry\setIPAddress(), EventLogEntry\setIPAddress(), Session\setIpAddress(), InstitutionalSubscription\setIPRanges(), Representation\setIsApproved(), Query\setIsClosed(), IssueFile\setIssueId(), PublishedArticle\setIssueId(), EventLogEntry\setIsTranslated(), Issue\setJournalId(), Subscription\setJournalId(), SubscriptionType\setJournalId(), ExternalFeed\setJournalId(), Article\setJournalId(), Genre\setKey(), AccessKey\setKeyHash(), SubmissionKeyword\setKeyword(), IssueGalley\setLabel(), ArticleGalley\setLabel(), SubmissionLanguage\setLanguage(), SupplementaryFile\setLanguage(), Submission\setLanguage(), Issue\setLastModified(), ReviewAssignment\setLastModified(), Submission\setLastModified(), Identity\setLastName(), Version\setLazyLoad(), PKPNotification\setLevel(), Submission\setLicenseURL(), ExternalFeed\setLimitItems(), IssueGalley\setLocale(), ArticleGalley\setLocale(), PKPGift\setLocale(), Submission\setLocale(), PKPUser\setLocales(), PKPUser\setMailingAddress(), Version\setMajor(), Subscription\setMembership(), SubscriptionType\setMembership(), EventLogEntry\setMessage(), Section\setMetaIndexed(), Section\setMetaReviewed(), Identity\setMiddleName(), Version\setMinor(), Site\setMinPasswordLength(), PKPUser\setMustChangePassword(), Context\setName(), GalleryPlugin\setName(), Currency\setName(), Language\setName(), Representation\setName(), AnnouncementType\setName(), ControlledVocabEntry\setName(), SubscriptionType\setName(), Genre\setName(), LibraryFile\setName(), UserGroup\setName(), SubmissionFile\setName(), SubscriptionType\setNonExpiring(), Subscription\setNotes(), PKPGift\setNotes(), Issue\setNumber(), DataObjectTombstone\setOAIIdentifier(), DataObjectTombstone\setOAISetObjectsIds(), Process\setObliterated(), Issue\setOpenAccessDate(), Identity\setOrcid(), PKPFile\setOriginalFileName(), LibraryFile\setOriginalFileName(), Issue\setOriginalFileName(), Submission\setOriginalFileName(), Site\setOriginalStyleFilename(), Issue\setOriginalStyleFileName(), FilterGroup\setOutputType(), Submission\setPages(), EventLogEntry\setParams(), PKPUser\setPassword(), UserGroup\setPath(), Context\setPath(), UserGroup\setPermitSelfRegistration(), PKPUser\setPhone(), AuthSource\setPlugin(), AuthSource\setPluginClass(), Section\setPolicy(), ReviewFormElement\setPossibleResponses(), Submission\setPrefix(), PKPAuthor\setPrimaryContact(), Context\setPrimaryLocale(), Site\setPrimaryLocale(), Process\setProcessType(), GalleryPlugin\setProduct(), Version\setProduct(), Version\setProductClassName(), Version\setProductType(), Issue\setPublished(), PublishedArticle\setPublishedArticleId(), SupplementaryFile\setPublisher(), ReviewAssignment\setQuality(), ReviewFormElement\setQuestion(), ExternalFeed\setRecentItems(), PKPGift\setRecipientEmail(), PKPGift\setRecipientFirstName(), PKPGift\setRecipientLastName(), PKPGift\setRecipientMiddleName(), EmailLogEntry\setRecipients(), PKPGift\setRecipientUserId(), ReviewAssignment\setRecommendation(), Site\setRedirect(), Subscription\setReferenceNumber(), GalleryPlugin\setReleaseCertifications(), GalleryPlugin\setReleaseDescription(), GalleryPlugin\setReleaseMD5(), GalleryPlugin\setReleasePackage(), Session\setRemember(), ReviewAssignment\setReminderWasAutomatic(), Representation\setRemoteURL(), ReviewAssignment\setReplaced(), ReviewFormElement\setRequired(), ReviewFormResponse\setResponseType(), XSLTransformationFilter\setResultType(), ReviewAssignment\setReviewerFullName(), ReviewAssignment\setReviewerId(), ReviewFormResponse\setReviewFormElementId(), ReviewFormElement\setReviewFormId(), PKPSection\setReviewFormId(), ReviewAssignment\setReviewFormId(), ReviewFormResponse\setReviewId(), ReviewAssignment\setReviewMethod(), ReviewAssignment\setReviewRoundId(), Version\setRevision(), SubmissionFile\setRevision(), Submission\setRights(), UserGroup\setRoleId(), SubmissionComment\setRoleId(), ReviewRound\setRound(), ReviewAssignment\setRound(), SubmissionFile\setSalesType(), Identity\setSalutation(), Session\setSecondsCreated(), Session\setSecondsLastUsed(), Article\setSectionAbbrev(), Article\setSectionId(), Article\setSectionTitle(), EmailLogEntry\setSenderId(), Representation\setSequence(), PKPSection\setSequence(), ControlledVocabEntry\setSequence(), Genre\setSequence(), PublishedArticle\setSequence(), ReviewFormElement\setSequence(), Query\setSequence(), ExternalFeed\setSequence(), IssueGalley\setSequence(), PKPAuthor\setSequence(), ReviewForm\setSequence(), Context\setSequence(), SubscriptionType\setSequence(), PKPFile\setServerFileName(), LibraryFile\setServerFileName(), Session\setSessionData(), DataObjectTombstone\setSetName(), DataObjectTombstone\setSetSpec(), AuthSource\setSettings(), Issue\setShowCoverPage(), Submission\setShowCoverPage(), Issue\setShowNumber(), UserGroup\setShowTitle(), Issue\setShowTitle(), Issue\setShowVolume(), Issue\setShowYear(), PKPUser\setSignature(), Version\setSitewide(), Genre\setSortable(), SupplementaryFile\setSource(), Submission\setSource(), SubmissionFile\setSourceFileId(), SubmissionFile\setSourceRevision(), SupplementaryFile\setSponsor(), Submission\setSponsor(), StageAssignment\setStageId(), ReviewRound\setStageId(), Query\setStageId(), ReviewAssignment\setStageId(), Submission\setStageId(), PKPGift\setStatus(), ReviewRound\setStatus(), Subscription\setStatus(), Submission\setStatus(), Representation\setStoredPubId(), IssueGalley\setStoredPubId(), Submission\setStoredPubId(), Issue\setStoredPubId(), Issue\setStyleFileName(), SubmissionSubject\setSubject(), SupplementaryFile\setSubject(), EmailLogEntry\setSubject(), Submission\setSubject(), StageAssignment\setSubmissionId(), PKPAuthor\setSubmissionId(), ReviewRound\setSubmissionId(), ReviewAssignment\setSubmissionId(), LibraryFile\setSubmissionId(), Representation\setSubmissionId(), SubmissionComment\setSubmissionId(), SubmissionFile\setSubmissionId(), Submission\setSubmissionProgress(), Submission\setSubtitle(), Identity\setSuffix(), GalleryPlugin\setSummary(), Genre\setSupplementary(), Site\setSupportedLocales(), FilterGroup\setSymbolic(), ControlledVocab\setSymbolic(), Process\setTimeStarted(), AuthSource\setTitle(), Issue\setTitle(), PKPSection\setTitle(), Note\setTitle(), Announcement\setTitle(), ReviewForm\setTitle(), ExternalFeed\setTitle(), Submission\setTitle(), BaseEmailTemplate\setToRoleId(), PKPNotification\setType(), LibraryFile\setType(), Submission\setType(), SubscriptionType\setTypeId(), Announcement\setTypeId(), Subscription\setTypeId(), ReviewAssignment\setUnconsidered(), SubmissionFile\setUploaderUserId(), ExternalFeed\setUrl(), Identity\setUrl(), Session\setUserAgent(), PKPAuthor\setUserGroupId(), StageAssignment\setUserGroupId(), SubmissionFile\setUserGroupId(), Note\setUserId(), EventLogEntry\setUserId(), TemporaryFile\setUserId(), Subscription\setUserId(), AccessKey\setUserId(), Session\setUserId(), StageAssignment\setUserId(), PKPNotification\setUserId(), PKPUser\setUsername(), ReviewFormResponse\setValue(), GalleryPlugin\setVersion(), SubmissionComment\setViewable(), Issue\setVolume(), Issue\setWidth(), Submission\setWidth(), XSLTransformationFilter\setXSL(), XSLTransformationFilter\setXSLFilename(), and Issue\setYear().

DataObject::setHasLoadableAdapters (   $hasLoadableAdapters)

Set whether the object has loadable meta-data adapters

Parameters
$hasLoadableAdaptersboolean

Definition at line 240 of file DataObject.inc.php.

Referenced by Representation\Representation(), and Submission\Submission().

DataObject::setId (   $id)

Set ID of object.

Parameters
$idint

Definition at line 199 of file DataObject.inc.php.

Referenced by Role\Role(), PKPFile\setFileId(), and Role\setRoleId().

DataObject::upcastTo (   $targetObject)

Upcast this data object to the target object.

We use the DataObject's getAllData() and setAllData() interface to upcast objects. This means that if the default implementations of these methods do not provide data that is adequate for upcasting between objects of the same inheritance hierarchy then objects that need more complicated casting behavior must override these methods.

Note: Data in the target object will be overwritten. We do not clone the target object before we upcast.

Parameters
$targetObjectDataObject The object to cast to.
Returns
DataObject The upcast target object.

Definition at line 224 of file DataObject.inc.php.

Field Documentation

array DataObject::$_data = array()

Array of object data

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

boolean DataObject::$_extractionAdaptersLoaded = false

whether extraction adapters have already been loaded from the database

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

boolean DataObject::$_hasLoadableAdapters = false

whether this objects loads meta-data adapters from the database

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

boolean DataObject::$_injectionAdaptersLoaded = false

whether injection adapters have already been loaded from the database

Definition at line 53 of file DataObject.inc.php.

array DataObject::$_metadataExtractionAdapters = array()

an array of meta-data extraction adapters (one per supported schema)

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

array DataObject::$_metadataInjectionAdapters = array()

an array of meta-data injection adapters (one per supported schema)

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


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