Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
DataObject Class Reference
Inheritance diagram for DataObject:
AccessKey AuthSource BaseEmailTemplate Category Chapter Citation CodelistItem Comment Context ControlledVocab ControlledVocabEntry Currency DataObjectTombstone EmailLogEntry EventLogEntry Filter FilterGroup FooterCategory FooterLink Genre IdentificationCode Identity Language LibraryFile Mail Market MetadataDescription ONIXCodelistItem PKPAnnouncement PKPAnnouncementType PKPFile PKPGift PKPRole PKPSection PKPSocialMedia Process PublicationDate Representation Representative ReviewAssignment ReviewForm ReviewFormElement ReviewFormResponse ReviewRound SalesRights Session Signoff Site Spotlight StageAssignment Submission SubmissionComment UserGroup 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)
 

Public Attributes

 $_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 262 of file DataObject.inc.php.

DataObject::DataObject ( )

Constructor.

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

References getData().

DataObject::extractMetadata (   $metadataSchema)

Extract a meta-data description from this data object.

Parameters
$metadataSchemaMetadataSchema
Returns
$metadataDescription MetadataDescription

Definition at line 456 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 418 of file DataObject.inc.php.

& DataObject::getAllData ( )

Return an array with all data variables.

Returns
array

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

Referenced by getId().

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

Get the value of a data variable.

Parameters
$keystring
$localestring (optional)
Returns
mixed

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

Referenced by PublicationFormat\_checkRequiredFieldsAssigned(), Citation\addError(), PlainTextReferencesListFilter\addTemplateVars(), ArtworkFile\ArtworkFile(), DataObject(), UserGroup\getAbbrev(), Submission\getAbstract(), ReviewForm\getActive(), Process\getAdditionalData(), Identity\getAffiliation(), SubmissionAgency\getAgency(), Market\getAgentId(), PKPAnnouncement\getAnnouncementTypeName(), IsbndbNlm30CitationSchemaFilter\getApiKey(), WorldcatNlm30CitationSchemaFilter\getApiKey(), PKPAnnouncementType\getAssocId(), ControlledVocab\getAssocId(), PKPAnnouncement\getAssocId(), Signoff\getAssocId(), Spotlight\getAssocId(), BaseEmailTemplate\getAssocId(), PKPGift\getAssocId(), ReviewForm\getAssocId(), AccessKey\getAssocId(), SubmissionComment\getAssocId(), SubmissionFile\getAssocId(), EmailLogEntry\getAssocId(), EventLogEntry\getAssocId(), BaseEmailTemplate\getAssocType(), PKPGift\getAssocType(), PKPAnnouncementType\getAssocType(), ControlledVocab\getAssocType(), PKPAnnouncement\getAssocType(), Signoff\getAssocType(), Spotlight\getAssocType(), ReviewForm\getAssocType(), EmailLogEntry\getAssocType(), EventLogEntry\getAssocType(), SubmissionFile\getAssocType(), PublishedMonograph\getAudience(), PublishedMonograph\getAudienceRangeExact(), PublishedMonograph\getAudienceRangeFrom(), PublishedMonograph\getAudienceRangeQualifier(), PublishedMonograph\getAudienceRangeTo(), AuthSource\getAuthId(), PKPUser\getAuthId(), SubmissionComment\getAuthorEmail(), SubmissionComment\getAuthorId(), SubmissionComment\getAuthorName(), PKPUser\getAuthStr(), PublicationFormat\getBackMatter(), PKPUser\getBillingAddress(), Identity\getBiography(), Comment\getBody(), Version\getBuild(), PKPGift\getBuyerEmail(), PKPGift\getBuyerFirstName(), PKPGift\getBuyerFullName(), PKPGift\getBuyerLastName(), PKPGift\getBuyerMiddleName(), PKPGift\getBuyerUserId(), ReviewAssignment\getCancelled(), BaseEmailTemplate\getCanDisable(), Genre\getCategory(), FooterLink\getCategoryId(), ChapterAuthor\getChapterId(), Comment\getChildCommentCount(), Comment\getChildren(), ParaciteRawCitationNlm30CitationSchemaFilter\getCitationModule(), TemplateBasedReferencesListFilter\getCitationOutputFilterInstance(), Submission\getCitations(), Citation\getCitationState(), PKPSocialMedia\getCode(), ONIXCodelistItem\getCode(), IdentificationCode\getCode(), CodelistItem\getCode(), Language\getCode(), Currency\getCodeAlpha(), Currency\getCodeNumeric(), ReviewAssignment\getComments(), SubmissionComment\getComments(), Submission\getCommentsStatus(), Submission\getCommentsToEditor(), SubmissionComment\getCommentTitle(), SubmissionComment\getCommentType(), ReviewAssignment\getCompetingInterests(), AccessKey\getContext(), FooterCategory\getContextId(), FooterLink\getContextId(), PKPSection\getContextId(), PKPSocialMedia\getContextId(), Genre\getContextId(), LibraryFile\getContextId(), UserGroup\getContextId(), Submission\getContextId(), ControlledVocabEntry\getControlledVocabId(), Submission\getCopyrightNotice(), Market\getCountriesExcluded(), SalesRights\getCountriesExcluded(), Market\getCountriesIncluded(), SalesRights\getCountriesIncluded(), Identity\getCountry(), PublicationFormat\getCountryManufactureCode(), Submission\getCoverageChron(), Submission\getCoverageGeo(), Submission\getCoverageSample(), PublishedMonograph\getCoverImage(), Submission\getCoverPageAltText(), Market\getCurrencyCode(), Version\getCurrent(), DataObjectTombstone\getDataObjectId(), Market\getDate(), Signoff\getDateAcknowledged(), ReviewAssignment\getDateAcknowledged(), StageAssignment\getDateAssigned(), ReviewAssignment\getDateAssigned(), Signoff\getDateCompleted(), ReviewAssignment\getDateCompleted(), ReviewAssignment\getDateConfirmed(), DataObjectTombstone\getDateDeleted(), ReviewAssignment\getDateDue(), PKPAnnouncement\getDateExpire(), Market\getDateFormat(), Version\getDateInstalled(), PKPUser\getDateLastEmail(), PKPUser\getDateLastLogin(), EventLogEntry\getDateLogged(), LibraryFile\getDateModified(), Comment\getDateModified(), SubmissionComment\getDateModified(), SubmissionFile\getDateModified(), Signoff\getDateNotified(), ReviewAssignment\getDateNotified(), Comment\getDatePosted(), SubmissionComment\getDatePosted(), PKPAnnouncement\getDatePosted(), Submission\getDatePublished(), ReviewAssignment\getDateRated(), PKPUser\getDateRegistered(), ReviewAssignment\getDateReminded(), ReviewAssignment\getDateResponseDue(), Market\getDateRole(), EmailLogEntry\getDateSent(), Submission\getDateStatusModified(), Submission\getDateSubmitted(), PKPAnnouncement\getDatetimePosted(), PKPGift\getDatetimeRedeemed(), Signoff\getDateUnderway(), PKPFile\getDateUploaded(), LibraryFile\getDateUploaded(), PKPUser\getDateValidated(), ReviewAssignment\getDeclined(), UserGroup\getDefault(), AuthSource\getDefault(), Genre\getDependent(), Context\getDescription(), FooterCategory\getDescription(), FilterGroup\getDescription(), Category\getDescription(), Spotlight\getDescription(), Series\getDescription(), ReviewForm\getDescription(), PKPAnnouncement\getDescription(), PKPAnnouncement\getDescriptionShort(), Genre\getDesignation(), SubmissionFile\getDirectSalesPrice(), PKPUser\getDisabled(), PKPUser\getDisabledReason(), SubmissionDiscipline\getDiscipline(), Submission\getDiscipline(), Market\getDiscount(), FilterGroup\getDisplayName(), PKPSection\getEditorRestricted(), ReviewFormElement\getElementType(), PubmedNlm30CitationSchemaFilter\getEmail(), CrossrefNlm30CitationSchemaFilter\getEmail(), Representative\getEmail(), Identity\getEmail(), BaseEmailTemplate\getEmailId(), BaseEmailTemplate\getEmailKey(), Genre\getEnabled(), Context\getEnabled(), BaseEmailTemplate\getEnabled(), PublicationFormat\getEntryKey(), Mail\getEnvelopeSender(), EmailLogEntry\getEventType(), EventLogEntry\getEventType(), AccessKey\getExpiryDate(), Representative\getFax(), PKPUser\getFax(), Series\getFeatured(), SubmissionFile\getFileId(), Signoff\getFileId(), Submission\getFileName(), Signoff\getFileRevision(), PKPFile\getFileSize(), LibraryFile\getFileSize(), PublicationFormat\getFileSize(), SubmissionFile\getFileStage(), PKPFile\getFileType(), LibraryFile\getFileType(), Identity\getFirstName(), BaseEmailTemplate\getFromRoleId(), PublicationFormat\getFrontMatter(), Identity\getFullName(), PKPUser\getGender(), SubmissionFile\getGenreId(), PKPGift\getGiftAssocId(), PKPGift\getGiftNote(), PKPGift\getGiftNoteTitle(), PKPGift\getGiftType(), PKPUser\getGossip(), PublicationFormat\getHeight(), Submission\getHeight(), PublicationFormat\getHeightUnitCode(), Submission\getHideAuthor(), Submission\getHideCoverPageAbstract(), Submission\getHideCoverPageToc(), Category\getImage(), Series\getImage(), PublicationFormat\getImprint(), ReviewFormElement\getIncluded(), PKPSocialMedia\getIncludeInCatalog(), Identity\getInitials(), PKPUser\getInlineHelp(), FilterGroup\getInputType(), Site\getInstalledLocales(), EmailLogEntry\getIPAddress(), EventLogEntry\getIPAddress(), Session\getIpAddress(), PublicationFormat\getIsApproved(), PublicationFormat\getIsAvailable(), Representative\getIsSupplier(), EventLogEntry\getIsTranslated(), Genre\getKey(), AccessKey\getKeyHash(), SubmissionKeyword\getKeyword(), SubmissionLanguage\getLanguage(), Submission\getLanguage(), ReviewAssignment\getLastModified(), Submission\getLastModified(), Identity\getLastName(), Version\getLazyLoad(), Submission\getLocale(), PKPGift\getLocale(), PKPUser\getLocales(), Submission\getLocalizedData(), PKPUser\getMailingAddress(), Version\getMajor(), EventLogEntry\getMessage(), TemplateBasedReferencesListFilter\getMetadataSchema(), Identity\getMiddleName(), Version\getMinor(), Site\getMinPasswordLength(), Representative\getMonographId(), Chapter\getMonographId(), PKPUser\getMustChangePassword(), Language\getName(), Currency\getName(), Representation\getName(), PKPAnnouncementType\getName(), ControlledVocabEntry\getName(), Genre\getName(), Representative\getName(), LibraryFile\getName(), UserGroup\getName(), SubmissionFile\getName(), PKPFile\getNiceFileSize(), LibraryFile\getNiceFileSize(), PKPGift\getNotes(), DataObjectTombstone\getOAIIdentifier(), DataObjectTombstone\getOAISetObjectsIds(), Process\getObliterated(), PKPFile\getOriginalFileName(), LibraryFile\getOriginalFileName(), Submission\getOriginalFileName(), Site\getOriginalStyleFilename(), FilterGroup\getOutputType(), Submission\getPages(), EventLogEntry\getParams(), Comment\getParentCommentId(), Category\getParentId(), PKPUser\getPassword(), PKPSection\getPath(), FooterCategory\getPath(), UserGroup\getPath(), Category\getPath(), Context\getPath(), UserGroup\getPermitSelfRegistration(), Representative\getPhone(), PKPUser\getPhone(), PublicationFormat\getPhysicalFormat(), PKPSocialMedia\getPlatform(), AuthSource\getPlugin(), AuthSource\getPluginClass(), ReviewFormElement\getPossibleResponses(), Comment\getPosterEmail(), Comment\getPosterIP(), Comment\getPosterName(), Series\getPrefix(), Submission\getPrefix(), Category\getPressId(), Spotlight\getPressId(), Market\getPrice(), Market\getPriceTypeCode(), PKPAuthor\getPrimaryContact(), Context\getPrimaryLocale(), Site\getPrimaryLocale(), Process\getProcessType(), Version\getProduct(), PublicationFormat\getProductAvailabilityCode(), Version\getProductClassName(), PublicationFormat\getProductCompositionCode(), PublicationFormat\getProductFormDetailCode(), Version\getProductType(), Market\getPublicationFormatId(), SalesRights\getPublicationFormatId(), IdentificationCode\getPublicationFormatId(), ReviewAssignment\getQuality(), ReviewFormElement\getQuestion(), PKPGift\getRecipientEmail(), PKPGift\getRecipientFirstName(), PKPGift\getRecipientFullName(), PKPGift\getRecipientLastName(), PKPGift\getRecipientMiddleName(), PKPGift\getRecipientUserId(), ReviewAssignment\getRecommendation(), Site\getRedirect(), Market\getRegionsExcluded(), SalesRights\getRegionsExcluded(), Market\getRegionsIncluded(), SalesRights\getRegionsIncluded(), Session\getRemember(), ReviewAssignment\getReminderWasAutomatic(), ReviewAssignment\getReplaced(), Representative\getRepresentativeIdType(), Representative\getRepresentativeIdValue(), ReviewFormElement\getRequired(), ReviewFormResponse\getResponseType(), XSLTransformationFilter\getResultType(), PublicationFormat\getReturnableIndicatorCode(), ReviewAssignment\getReviewerFullName(), ReviewAssignment\getReviewerId(), ReviewFormResponse\getReviewFormElementId(), ReviewFormElement\getReviewFormId(), ReviewAssignment\getReviewFormId(), ReviewFormResponse\getReviewId(), ReviewAssignment\getReviewMethod(), ReviewAssignment\getReviewRoundId(), Version\getRevision(), SubmissionFile\getRevision(), Submission\getRights(), Representative\getRole(), UserGroup\getRoleId(), SubmissionComment\getRoleId(), SubmissionComment\getRoleName(), ReviewRound\getRound(), SubmissionFile\getRound(), ReviewAssignment\getRound(), SalesRights\getROWSetting(), SubmissionFile\getSalesType(), Identity\getSalutation(), Session\getSecondsCreated(), Session\getSecondsLastUsed(), Monograph\getSectionId(), EmailLogEntry\getSenderEmail(), EmailLogEntry\getSenderFullName(), EmailLogEntry\getSenderId(), Representation\getSeq(), ControlledVocabEntry\getSequence(), Genre\getSequence(), ReviewFormElement\getSequence(), ReviewForm\getSequence(), PKPAuthor\getSequence(), Chapter\getSequence(), Context\getSequence(), Series\getSequence(), Monograph\getSeriesAbbrev(), Monograph\getSeriesPosition(), Monograph\getSeriesTitle(), PKPFile\getServerFileName(), LibraryFile\getServerFileName(), Session\getSessionData(), DataObjectTombstone\getSetName(), DataObjectTombstone\getSetSpec(), AuthSource\getSettings(), Submission\getShowCoverPage(), PKPAuthor\getShowTitle(), UserGroup\getShowTitle(), PKPUser\getSignature(), Version\getSitewide(), Genre\getSortable(), Submission\getSource(), SubmissionFile\getSourceFileId(), SubmissionFile\getSourceRevision(), Submission\getSponsor(), ReviewRound\getStageId(), StageAssignment\getStageId(), ReviewAssignment\getStageId(), Submission\getStageId(), MetadataDescription\getStatements(), PKPGift\getStatus(), ReviewRound\getStatus(), Submission\getStatus(), Representation\getStoredPubId(), Submission\getStoredPubId(), SubmissionSubject\getSubject(), Submission\getSubject(), Submission\getSubjectClass(), PKPAuthor\getSubmissionId(), StageAssignment\getSubmissionId(), ReviewRound\getSubmissionId(), ReviewAssignment\getSubmissionId(), LibraryFile\getSubmissionId(), Comment\getSubmissionId(), SubmissionComment\getSubmissionId(), Representation\getSubmissionId(), SubmissionFile\getSubmissionId(), Submission\getSubmissionProgress(), Chapter\getSubtitle(), Series\getSubtitle(), Submission\getSubtitle(), Identity\getSuffix(), Market\getSupplierId(), Context\getSupportedFormLocaleNames(), Context\getSupportedLocaleNames(), Site\getSupportedLocales(), Nlm30CitationSchemaFilter\getSupportedPublicationTypes(), Context\getSupportedSubmissionLocaleNames(), Monograph\getSupportingAgencies(), ControlledVocab\getSymbolic(), FilterGroup\getSymbolic(), Signoff\getSymbolic(), Market\getTaxRateCode(), Market\getTaxTypeCode(), PublicationFormat\getTechnicalProtectionCode(), ONIXCodelistItem\getText(), CodelistItem\getText(), PublicationFormat\getThickness(), PublicationFormat\getThicknessUnitCode(), Process\getTimeStarted(), AuthSource\getTitle(), FooterCategory\getTitle(), PKPSection\getTitle(), Chapter\getTitle(), FooterLink\getTitle(), Category\getTitle(), Spotlight\getTitle(), PKPAnnouncement\getTitle(), ReviewForm\getTitle(), Comment\getTitle(), Submission\getTitle(), BaseEmailTemplate\getToRoleId(), SalesRights\getType(), LibraryFile\getType(), Submission\getType(), PKPAnnouncement\getTypeId(), ReviewAssignment\getUnconsidered(), SubmissionFile\getUploaderUserId(), FooterLink\getUrl(), Representative\getUrl(), Identity\getUrl(), Comment\getUser(), Session\getUserAgent(), EventLogEntry\getUserEmail(), EventLogEntry\getUserFullName(), PKPAuthor\getUserGroupId(), StageAssignment\getUserGroupId(), Signoff\getUserGroupId(), SubmissionFile\getUserGroupId(), EventLogEntry\getUserId(), TemporaryFile\getUserId(), AccessKey\getUserId(), Session\getUserId(), StageAssignment\getUserId(), Signoff\getUserId(), Submission\getUserId(), PKPUser\getUsername(), ReviewFormResponse\getValue(), IdentificationCode\getValue(), SubmissionComment\getViewable(), SubmissionFile\getViewable(), PublicationFormat\getWeight(), PublicationFormat\getWeightUnitCode(), PublicationFormat\getWidth(), Submission\getWidth(), PublicationFormat\getWidthUnitCode(), Monograph\getWorkType(), XSLTransformationFilter\getXSL(), XSLTransformationFilter\getXSLType(), EmailTemplate\isCustomTemplate(), PlainTextReferencesListFilter\process(), Mail\setBody(), ArtworkFile\setCaption(), Mail\setCcs(), ArtworkFile\setChapterId(), Mail\setContentType(), ArtworkFile\setCopyrightOwner(), ArtworkFile\setCopyrightOwnerContactDetails(), ArtworkFile\setCredit(), PublicationDate\setDate(), PublicationDate\setDateFormat(), Mail\setEnvelopeSender(), Mail\setFrom(), Mail\setHeaders(), EmailTemplate\setLocale(), ArtworkFile\setPermissionFileId(), ArtworkFile\setPermissionTerms(), Mail\setPrivateParams(), Mail\setRecipients(), PublicationDate\setRole(), Mail\setSubject(), EmailTemplate\setSubject(), Session\setUserId(), and Filter\supportsAsInput().

DataObject::getHasLoadableAdapters ( )

Get whether the object has loadable meta-data adapters

Returns
boolean

Definition at line 252 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 409 of file DataObject.inc.php.

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 368 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 390 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 314 of file DataObject.inc.php.

Referenced by getSupportedMetadataSchemas().

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 334 of file DataObject.inc.php.

DataObject::getSupportedMetadataSchemas ( )

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

Returns
array

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

References getSupportedExtractionAdapters().

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

Check whether a value exists for a given data variable.

Parameters
$keystring
$localestring (optional)
Returns
boolean

Definition at line 159 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 429 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 295 of file DataObject.inc.php.

DataObject::setAllData ( $data)

Set all data variables at once.

Parameters
$dataarray

Definition at line 180 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 129 of file DataObject.inc.php.

Referenced by PKPAuthor\_setShowTitle(), Mail\getBccs(), EmailTemplate\getBody(), ArtworkFile\getCaption(), Mail\getCcs(), ArtworkFile\getChapterId(), ArtworkFile\getContactAuthor(), Mail\getContentType(), ArtworkFile\getCopyrightOwner(), ArtworkFile\getCopyrightOwnerContactDetails(), ArtworkFile\getCredit(), Citation\getErrors(), Mail\getFrom(), SeriesEditorSubmission\getGalleys(), Mail\getHeaders(), EmailTemplate\getLocale(), ArtworkFile\getPermissionFileId(), ArtworkFile\getPermissionTerms(), PublicationDate\getPublicationFormatId(), Mail\getRecipients(), Mail\getReplyTo(), PublicationDate\getRole(), EmailTemplate\getSubject(), Mail\getSubject(), PKPSubmissionNlm30XmlFilter\PKPSubmissionNlm30XmlFilter(), UserGroup\setAbbrev(), Submission\setAbstract(), ReviewForm\setActive(), Process\setAdditionalData(), Identity\setAffiliation(), SubmissionAgency\setAgency(), Market\setAgentId(), PKPAnnouncementType\setAssocId(), ControlledVocab\setAssocId(), PKPAnnouncement\setAssocId(), Signoff\setAssocId(), Spotlight\setAssocId(), BaseEmailTemplate\setAssocId(), PKPGift\setAssocId(), ReviewForm\setAssocId(), AccessKey\setAssocId(), SubmissionComment\setAssocId(), SubmissionFile\setAssocId(), EmailLogEntry\setAssocId(), EventLogEntry\setAssocId(), BaseEmailTemplate\setAssocType(), PKPGift\setAssocType(), PKPAnnouncementType\setAssocType(), ControlledVocab\setAssocType(), PKPAnnouncement\setAssocType(), Signoff\setAssocType(), Spotlight\setAssocType(), ReviewForm\setAssocType(), EmailLogEntry\setAssocType(), EventLogEntry\setAssocType(), SubmissionFile\setAssocType(), PublishedMonograph\setAudience(), PublishedMonograph\setAudienceRangeExact(), PublishedMonograph\setAudienceRangeFrom(), PublishedMonograph\setAudienceRangeQualifier(), PublishedMonograph\setAudienceRangeTo(), AuthSource\setAuthId(), PKPUser\setAuthId(), SubmissionComment\setAuthorId(), PKPUser\setAuthStr(), PublicationFormat\setBackMatter(), PKPUser\setBillingAddress(), Identity\setBiography(), Comment\setBody(), Version\setBuild(), PKPGift\setBuyerEmail(), PKPGift\setBuyerFirstName(), PKPGift\setBuyerLastName(), PKPGift\setBuyerMiddleName(), PKPGift\setBuyerUserId(), ReviewAssignment\setCancelled(), BaseEmailTemplate\setCanDisable(), Genre\setCategory(), FooterLink\setCategoryId(), ChapterAuthor\setChapterId(), Comment\setChildCommentCount(), Comment\setChildren(), Submission\setCitations(), Citation\setCitationState(), Submission\setCleanTitle(), IdentificationCode\setCode(), PKPSocialMedia\setCode(), ONIXCodelistItem\setCode(), Language\setCode(), CodelistItem\setCode(), Currency\setCodeAlpha(), Currency\setCodeNumeric(), ReviewAssignment\setComments(), SubmissionComment\setComments(), Submission\setCommentsStatus(), Submission\setCommentsToEditor(), SubmissionComment\setCommentTitle(), SubmissionComment\setCommentType(), ReviewAssignment\setCompetingInterests(), Context\setContactEmail(), Context\setContactName(), AccessKey\setContext(), FooterCategory\setContextId(), FooterLink\setContextId(), PKPSection\setContextId(), PKPSocialMedia\setContextId(), Genre\setContextId(), LibraryFile\setContextId(), UserGroup\setContextId(), Submission\setContextId(), ControlledVocabEntry\setControlledVocabId(), Submission\setCopyrightNotice(), Market\setCountriesExcluded(), SalesRights\setCountriesExcluded(), Market\setCountriesIncluded(), SalesRights\setCountriesIncluded(), Identity\setCountry(), PublicationFormat\setCountryManufactureCode(), Submission\setCoverageChron(), Submission\setCoverageGeo(), Submission\setCoverageSample(), PublishedMonograph\setCoverImage(), Submission\setCoverPageAltText(), Market\setCurrencyCode(), Version\setCurrent(), DataObjectTombstone\setDataObjectId(), Market\setDate(), Signoff\setDateAcknowledged(), ReviewAssignment\setDateAcknowledged(), StageAssignment\setDateAssigned(), ReviewAssignment\setDateAssigned(), Signoff\setDateCompleted(), ReviewAssignment\setDateCompleted(), ReviewAssignment\setDateConfirmed(), DataObjectTombstone\setDateDeleted(), ReviewAssignment\setDateDue(), PKPAnnouncement\setDateExpire(), Market\setDateFormat(), Version\setDateInstalled(), PKPUser\setDateLastEmail(), PKPUser\setDateLastLogin(), EventLogEntry\setDateLogged(), Comment\setDateModified(), SubmissionComment\setDateModified(), Signoff\setDateNotified(), ReviewAssignment\setDateNotified(), Comment\setDatePosted(), SubmissionComment\setDatePosted(), PKPAnnouncement\setDatePosted(), ReviewAssignment\setDateRated(), PKPUser\setDateRegistered(), ReviewAssignment\setDateReminded(), ReviewAssignment\setDateResponseDue(), Market\setDateRole(), EmailLogEntry\setDateSent(), Submission\setDateStatusModified(), Submission\setDateSubmitted(), PKPAnnouncement\setDatetimePosted(), PKPGift\setDatetimeRedeemed(), Signoff\setDateUnderway(), PKPUser\setDateValidated(), ReviewAssignment\setDeclined(), UserGroup\setDefault(), AuthSource\setDefault(), Genre\setDependent(), FilterGroup\setDescription(), Context\setDescription(), FooterCategory\setDescription(), Category\setDescription(), Spotlight\setDescription(), Series\setDescription(), ReviewForm\setDescription(), PKPAnnouncement\setDescription(), PKPAnnouncement\setDescriptionShort(), Genre\setDesignation(), SubmissionFile\setDirectSalesPrice(), PKPUser\setDisabled(), PKPUser\setDisabledReason(), SubmissionDiscipline\setDiscipline(), Submission\setDiscipline(), Market\setDiscount(), FilterGroup\setDisplayName(), PKPSection\setEditorRestricted(), ReviewFormElement\setElementType(), CrossrefNlm30CitationSchemaFilter\setEmail(), Representative\setEmail(), Identity\setEmail(), BaseEmailTemplate\setEmailId(), BaseEmailTemplate\setEmailKey(), Genre\setEnabled(), Context\setEnabled(), BaseEmailTemplate\setEnabled(), PublicationFormat\setEntryKey(), EmailLogEntry\setEventType(), EventLogEntry\setEventType(), AccessKey\setExpiryDate(), Representative\setFax(), PKPUser\setFax(), Series\setFeatured(), SubmissionFile\setFileId(), Signoff\setFileId(), Submission\setFileName(), Signoff\setFileRevision(), PublicationFormat\setFileSize(), SubmissionFile\setFileStage(), PKPFile\setFileType(), LibraryFile\setFileType(), Identity\setFirstName(), BaseEmailTemplate\setFromRoleId(), PublicationFormat\setFrontMatter(), PKPUser\setGender(), SubmissionFile\setGenreId(), PKPGift\setGiftAssocId(), PKPGift\setGiftNote(), PKPGift\setGiftNoteTitle(), PKPGift\setGiftType(), PKPUser\setGossip(), PublicationFormat\setHeight(), Submission\setHeight(), PublicationFormat\setHeightUnitCode(), Submission\setHideAuthor(), Submission\setHideCoverPageAbstract(), Submission\setHideCoverPageToc(), Category\setImage(), Series\setImage(), PublicationFormat\setImprint(), ReviewFormElement\setIncluded(), PKPSocialMedia\setIncludeInCatalog(), Identity\setInitials(), PKPUser\setInlineHelp(), FilterGroup\setInputType(), Site\setInstalledLocales(), EmailLogEntry\setIPAddress(), EventLogEntry\setIPAddress(), Session\setIpAddress(), PublicationFormat\setIsApproved(), PublicationFormat\setIsAvailable(), Representative\setIsSupplier(), EventLogEntry\setIsTranslated(), Genre\setKey(), AccessKey\setKeyHash(), SubmissionKeyword\setKeyword(), SubmissionLanguage\setLanguage(), Submission\setLanguage(), ReviewAssignment\setLastModified(), Submission\setLastModified(), Identity\setLastName(), Version\setLazyLoad(), Submission\setLocale(), PKPGift\setLocale(), PKPUser\setLocales(), PKPUser\setMailingAddress(), Version\setMajor(), EventLogEntry\setMessage(), Identity\setMiddleName(), Version\setMinor(), Site\setMinPasswordLength(), Representative\setMonographId(), Chapter\setMonographId(), PKPUser\setMustChangePassword(), Context\setName(), Language\setName(), Currency\setName(), Representation\setName(), PKPAnnouncementType\setName(), ControlledVocabEntry\setName(), Genre\setName(), LibraryFile\setName(), Representative\setName(), UserGroup\setName(), SubmissionFile\setName(), PKPGift\setNotes(), DataObjectTombstone\setOAIIdentifier(), DataObjectTombstone\setOAISetObjectsIds(), Process\setObliterated(), PKPFile\setOriginalFileName(), LibraryFile\setOriginalFileName(), Submission\setOriginalFileName(), Site\setOriginalStyleFilename(), FilterGroup\setOutputType(), Submission\setPages(), EventLogEntry\setParams(), Comment\setParentCommentId(), Category\setParentId(), PKPUser\setPassword(), FooterCategory\setPath(), PKPSection\setPath(), UserGroup\setPath(), Category\setPath(), Context\setPath(), UserGroup\setPermitSelfRegistration(), Representative\setPhone(), PKPUser\setPhone(), PublicationFormat\setPhysicalFormat(), PKPSocialMedia\setPlatform(), AuthSource\setPlugin(), AuthSource\setPluginClass(), ReviewFormElement\setPossibleResponses(), Comment\setPosterEmail(), Comment\setPosterIP(), Comment\setPosterName(), Series\setPrefix(), Submission\setPrefix(), Category\setPressId(), Spotlight\setPressId(), Market\setPrice(), Market\setPriceTypeCode(), PKPAuthor\setPrimaryContact(), Context\setPrimaryLocale(), Site\setPrimaryLocale(), Process\setProcessType(), Version\setProduct(), PublicationFormat\setProductAvailabilityCode(), Version\setProductClassName(), PublicationFormat\setProductCompositionCode(), PublicationFormat\setProductFormDetailCode(), Version\setProductType(), Market\setPublicationFormatId(), SalesRights\setPublicationFormatId(), IdentificationCode\setPublicationFormatId(), PublicationDate\setPublicationformatId(), ReviewAssignment\setQuality(), ReviewFormElement\setQuestion(), PKPGift\setRecipientEmail(), PKPGift\setRecipientFirstName(), PKPGift\setRecipientLastName(), PKPGift\setRecipientMiddleName(), PKPGift\setRecipientUserId(), ReviewAssignment\setRecommendation(), Site\setRedirect(), Market\setRegionsExcluded(), SalesRights\setRegionsExcluded(), Market\setRegionsIncluded(), SalesRights\setRegionsIncluded(), Session\setRemember(), ReviewAssignment\setReminderWasAutomatic(), ReviewAssignment\setReplaced(), Representative\setRepresentativeIdType(), Representative\setRepresentativeIdValue(), ReviewFormElement\setRequired(), ReviewFormResponse\setResponseType(), XSLTransformationFilter\setResultType(), PublicationFormat\setReturnableIndicatorCode(), ReviewAssignment\setReviewerFullName(), ReviewAssignment\setReviewerId(), ReviewFormResponse\setReviewFormElementId(), ReviewFormElement\setReviewFormId(), ReviewAssignment\setReviewFormId(), ReviewFormResponse\setReviewId(), ReviewAssignment\setReviewMethod(), ReviewAssignment\setReviewRoundId(), Version\setRevision(), SubmissionFile\setRevision(), Submission\setRights(), Representative\setRole(), UserGroup\setRoleId(), SubmissionComment\setRoleId(), ReviewRound\setRound(), ReviewAssignment\setRound(), SalesRights\setROWSetting(), SubmissionFile\setSalesType(), Identity\setSalutation(), Session\setSecondsCreated(), Session\setSecondsLastUsed(), EmailLogEntry\setSenderId(), Representation\setSeq(), ControlledVocabEntry\setSequence(), Genre\setSequence(), ReviewFormElement\setSequence(), ReviewForm\setSequence(), PKPAuthor\setSequence(), Chapter\setSequence(), Context\setSequence(), Series\setSequence(), Monograph\setSeriesAbbrev(), Monograph\setSeriesId(), Monograph\setSeriesPosition(), Monograph\setSeriesTitle(), PKPFile\setServerFileName(), LibraryFile\setServerFileName(), Session\setSessionData(), DataObjectTombstone\setSetName(), DataObjectTombstone\setSetSpec(), AuthSource\setSettings(), Submission\setShowCoverPage(), UserGroup\setShowTitle(), PKPUser\setSignature(), Version\setSitewide(), Genre\setSortable(), Submission\setSource(), SubmissionFile\setSourceFileId(), SubmissionFile\setSourceRevision(), Submission\setSponsor(), StageAssignment\setStageId(), ReviewRound\setStageId(), ReviewAssignment\setStageId(), Submission\setStageId(), PKPGift\setStatus(), ReviewRound\setStatus(), Submission\setStatus(), Representation\setStoredPubId(), Submission\setStoredPubId(), SubmissionSubject\setSubject(), Submission\setSubject(), Submission\setSubjectClass(), StageAssignment\setSubmissionId(), PKPAuthor\setSubmissionId(), ReviewRound\setSubmissionId(), ReviewAssignment\setSubmissionId(), Representation\setSubmissionId(), LibraryFile\setSubmissionId(), Comment\setSubmissionId(), SubmissionComment\setSubmissionId(), SubmissionFile\setSubmissionId(), Submission\setSubmissionProgress(), Chapter\setSubtitle(), Series\setSubtitle(), Submission\setSubtitle(), Identity\setSuffix(), Market\setSupplierId(), Site\setSupportedLocales(), Monograph\setSupportingAgencies(), FilterGroup\setSymbolic(), ControlledVocab\setSymbolic(), Signoff\setSymbolic(), Market\setTaxRateCode(), Market\setTaxTypeCode(), PublicationFormat\setTechnicalProtectionCode(), ONIXCodelistItem\setText(), CodelistItem\setText(), PublicationFormat\setThickness(), PublicationFormat\setThicknessUnitCode(), Process\setTimeStarted(), AuthSource\setTitle(), PKPSection\setTitle(), FooterCategory\setTitle(), Chapter\setTitle(), FooterLink\setTitle(), Category\setTitle(), Spotlight\setTitle(), PKPAnnouncement\setTitle(), ReviewForm\setTitle(), Comment\setTitle(), Submission\setTitle(), BaseEmailTemplate\setToRoleId(), SalesRights\setType(), LibraryFile\setType(), Submission\setType(), PKPAnnouncement\setTypeId(), ReviewAssignment\setUnconsidered(), SubmissionFile\setUploaderUserId(), FooterLink\setUrl(), Representative\setUrl(), Identity\setUrl(), Comment\setUser(), Session\setUserAgent(), PKPAuthor\setUserGroupId(), StageAssignment\setUserGroupId(), Signoff\setUserGroupId(), SubmissionFile\setUserGroupId(), EventLogEntry\setUserId(), TemporaryFile\setUserId(), AccessKey\setUserId(), Session\setUserId(), StageAssignment\setUserId(), Signoff\setUserId(), Submission\setUserId(), PKPUser\setUsername(), IdentificationCode\setValue(), ReviewFormResponse\setValue(), SubmissionComment\setViewable(), PublishedMonograph\setViews(), PublicationFormat\setWeight(), PublicationFormat\setWeightUnitCode(), PublicationFormat\setWidth(), Submission\setWidth(), PublicationFormat\setWidthUnitCode(), Monograph\setWorkType(), XSLTransformationFilter\setXSL(), and XSLTransformationFilter\setXSLFilename().

DataObject::setHasLoadableAdapters (   $hasLoadableAdapters)

Set whether the object has loadable meta-data adapters

Parameters
$hasLoadableAdaptersboolean

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

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

DataObject::setId (   $id)

Set ID of object.

Parameters
$idint

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

Referenced by PKPRole\PKPRole(), PKPFile\setFileId(), and PKPRole\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.

Our implementation also implies that the target has to inherit from the source object and thereby implicitly from DataObject.

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.

Member Data Documentation

DataObject::$_data = array()

Array of object data

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

boolean DataObject::$_extractionAdaptersLoaded = false

whether extraction adapters have already been loaded from the database

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

boolean DataObject::$_hasLoadableAdapters = false

whether this objects loads meta-data adapters from the database

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

boolean DataObject::$_injectionAdaptersLoaded = false

whether injection adapters have already been loaded from the database

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

array DataObject::$_metadataExtractionAdapters = array()

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

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

array DataObject::$_metadataInjectionAdapters = array()

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

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


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