DataObject Class Reference

Inheritance diagram for DataObject:

Public Member Functions
	__construct ()
	addSupportedMetadataAdapter ($metadataAdapter)
	extractMetadata ($metadataSchema)
	getAdditionalMetadataFieldNames ()
&	getAllData ()
	getDAO ()
&	getData ($key, $locale=null)
	getHasLoadableAdapters ()
	getId ()
	getLocaleMetadataFieldNames ()
	getLocalizedData ($key, $preferredLocale=null)
	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)
	unsetData ($key, $locale=null)
	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.

Constructor & Destructor Documentation

__construct()

DataObject::__construct

(

)

Constructor

Reimplemented in PKPSubmission, Mail, CitationListTokenizerFilter, Representation, and MarkupJobInfo.

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

Member Function Documentation

addSupportedMetadataAdapter()

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

$metadataAdapter

MetadataDataObjectAdapter

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

Referenced by getSupportedExtractionAdapters(), and getSupportedInjectionAdapters().

extractMetadata()

DataObject::extractMetadata

(

$metadataSchema

)

Extract a meta-data description from this data object.

Parameters

$metadataSchema

MetadataSchema

Returns

$metadataDescription MetadataDescription

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

References getSupportedExtractionAdapters().

getAdditionalMetadataFieldNames()

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

References getMetadataFieldNames().

getAllData()

& DataObject::getAllData

(

)

Return an array with all data variables.

Returns

array

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

References $_data.

Referenced by MetadataDescription\getStatements(), MetadataDescription\setStatements(), and upcastTo().

getDAO()

DataObject::getDAO

(

)

Get DAO class name for this object.

Returns

DAO

Reimplemented in SubmissionFile, Issue, PKPSubmission, Representation, and Journal.

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

getData()

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

Get the value of a data variable.

Parameters

$key	string
$locale	string (optional)

Returns

mixed

Reimplemented in CompositeFilter.

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

Referenced by Submission\_getContextLicenseFieldValue(), Mail\addAttachment(), Mail\addBcc(), Mail\addCc(), Mail\addHeader(), Mail\addRecipient(), Mail\addReplyTo(), APP\Services\IssueService\determineAccessStatus(), Section\getAbbrev(), UserGroup\getAbbrev(), Section\getAbstractsNotRequired(), Section\getAbstractWordCount(), Issue\getAccessStatus(), Context\getAcronym(), ReviewForm\getActive(), Identity\getAffiliation(), SubmissionAgency\getAgency(), Announcement\getAnnouncementTypeName(), NavigationMenu\getAreaName(), AnnouncementType\getAssocId(), EmailTemplate\getAssocId(), ControlledVocab\getAssocId(), Announcement\getAssocId(), Query\getAssocId(), SubmissionComment\getAssocId(), AccessKey\getAssocId(), EmailLogEntry\getAssocId(), EventLogEntry\getAssocId(), ReviewForm\getAssocId(), Note\getAssocId(), SubmissionFile\getAssocId(), PKPNotification\getAssocId(), Query\getAssocType(), AnnouncementType\getAssocType(), ControlledVocab\getAssocType(), Announcement\getAssocType(), EmailLogEntry\getAssocType(), EventLogEntry\getAssocType(), ReviewForm\getAssocType(), Note\getAssocType(), PKPNotification\getAssocType(), SubmissionFile\getAssocType(), Mail\getAttachments(), AuthSource\getAuthId(), User\getAuthId(), SubmissionComment\getAuthorEmail(), SubmissionComment\getAuthorId(), SubmissionComment\getAuthorName(), PKPPublication\getAuthorString(), User\getAuthStr(), EmailLogEntry\getBccs(), Mail\getBccs(), ArticleGalley\getBestGalleyId(), IssueGalley\getBestGalleyId(), Issue\getBestIssueId(), User\getBillingAddress(), Identity\getBiography(), EmailLogEntry\getBody(), EmailTemplate\getBody(), Mail\getBody(), Version\getBuild(), ReviewerSubmission\getCancelled(), ReviewAssignment\getCancelled(), StageAssignment\getCanChangeMetadata(), EmailTemplate\getCanDisable(), SubmissionArtworkFile\getCaption(), GalleryPlugin\getCategory(), Genre\getCategory(), Mail\getCcs(), EmailLogEntry\getCcs(), SubmissionFile\getChapterId(), Language\getCode(), Currency\getCodeAlpha(), Currency\getCodeNumeric(), ReviewAssignment\getComments(), SubmissionComment\getComments(), SubmissionComment\getCommentTitle(), SubmissionComment\getCommentType(), ReviewerSubmission\getCompetingInterests(), ReviewAssignment\getCompetingInterests(), ReviewForm\getCompleteCount(), SubmissionArtworkFile\getContactAuthor(), Context\getContactEmail(), GalleryPlugin\getContactEmail(), GalleryPlugin\getContactInstitutionName(), Context\getContactName(), GalleryPlugin\getContactName(), StaticPage\getContent(), NavigationMenuItem\getContent(), Note\getContents(), IssueFile\getContentType(), Mail\getContentType(), AccessKey\getContext(), DepositPoint\getContextId(), PKPSection\getContextId(), Category\getContextId(), StaticPage\getContextId(), Genre\getContextId(), NavigationMenu\getContextId(), LibraryFile\getContextId(), UserGroup\getContextId(), NavigationMenuItem\getContextId(), Representation\getContextId(), PKPNotification\getContextId(), PKPSubmission\getContextId(), ControlledVocabEntry\getControlledVocabId(), SubmissionArtworkFile\getCopyrightOwner(), SubmissionArtworkFile\getCopyrightOwnerContactDetails(), SubscriptionType\getCost(), Identity\getCountry(), Issue\getCoverImage(), Issue\getCoverImageAltText(), SupplementaryFile\getCreator(), SubmissionArtworkFile\getCredit(), SubscriptionType\getCurrencyCodeAlpha(), SubscriptionType\getCurrencyString(), SubscriptionType\getCurrencyStringShort(), Issue\getCurrent(), Version\getCurrent(), PKPSubmission\getCurrentPublication(), DataObjectTombstone\getDataObjectId(), GalleryPlugin\getDate(), ReviewerSubmission\getDateAcknowledged(), ReviewAssignment\getDateAcknowledged(), StageAssignment\getDateAssigned(), ReviewerSubmission\getDateAssigned(), ReviewAssignment\getDateAssigned(), ReviewerSubmission\getDateCompleted(), ReviewAssignment\getDateCompleted(), ReviewerSubmission\getDateConfirmed(), ReviewAssignment\getDateConfirmed(), Note\getDateCreated(), DepositObject\getDateCreated(), PKPNotification\getDateCreated(), SupplementaryFile\getDateCreated(), Deposit\getDateCreated(), DataObjectTombstone\getDateDeleted(), ReviewerSubmission\getDateDue(), ReviewAssignment\getDateDue(), Subscription\getDateEnd(), Announcement\getDateExpire(), Version\getDateInstalled(), User\getDateLastEmail(), User\getDateLastLogin(), EventLogEntry\getDateLogged(), Note\getDateModified(), IssueFile\getDateModified(), DepositObject\getDateModified(), LibraryFile\getDateModified(), SubmissionComment\getDateModified(), Deposit\getDateModified(), SubmissionFile\getDateModified(), ReviewerSubmission\getDateNotified(), Issue\getDateNotified(), ReviewAssignment\getDateNotified(), SubmissionComment\getDatePosted(), Announcement\getDatePosted(), Issue\getDatePublished(), ReviewAssignment\getDateRated(), PKPNotification\getDateRead(), User\getDateRegistered(), ReviewAssignment\getDateReminded(), ReviewerSubmission\getDateResponseDue(), ReviewAssignment\getDateResponseDue(), EmailLogEntry\getDateSent(), Subscription\getDateStart(), PKPSubmission\getDateStatusModified(), PKPSubmission\getDateSubmitted(), Context\getDateTimeFormats(), Announcement\getDatetimePosted(), PKPFile\getDateUploaded(), LibraryFile\getDateUploaded(), User\getDateValidated(), ReviewerSubmission\getDeclined(), ReviewAssignment\getDeclined(), UserGroup\getDefault(), AuthSource\getDefault(), Journal\getDefaultMetricType(), Context\getDefaultMetricType(), Genre\getDependent(), DepositObject\getDepositId(), SubscriptionType\getDescription(), Context\getDescription(), SupplementaryFile\getDescription(), FilterGroup\getDescription(), Category\getDescription(), ReviewFormElement\getDescription(), Announcement\getDescription(), ReviewForm\getDescription(), GalleryPlugin\getDescription(), Issue\getDescription(), Announcement\getDescriptionShort(), SubmissionFile\getDirectSalesPrice(), User\getDisabled(), User\getDisabledReason(), SubscriptionType\getDisablePublicDisplay(), SubmissionDiscipline\getDiscipline(), FilterGroup\getDisplayName(), Filter\getDisplayName(), InstitutionalSubscription\getDomain(), Session\getDomain(), SubscriptionType\getDuration(), PKPSection\getEditorRestricted(), ReviewFormElement\getElementType(), Identity\getEmail(), EmailTemplate\getEmailId(), EmailTemplate\getEmailKey(), Genre\getEnabled(), Context\getEnabled(), EmailTemplate\getEnabled(), Mail\getEnvelopeSender(), EmailLogEntry\getEventType(), EventLogEntry\getEventType(), AccessKey\getExpiryDate(), Deposit\getExportDepositError(), Identity\getFamilyName(), MarkupJobInfo\getFileId(), SubmissionFile\getFileId(), ArticleGalley\getFileId(), IssueGalley\getFileId(), PKPFile\getFileSize(), LibraryFile\getFileSize(), SubmissionFile\getFileStage(), PKPFile\getFileType(), LibraryFile\getFileType(), SubscriptionType\getFormat(), SubscriptionType\getFormatString(), EmailLogEntry\getFrom(), Mail\getFrom(), EmailTemplate\getFromRoleId(), PKPPublication\getFullTitles(), Submission\getGalleys(), SubmissionFile\getGenreId(), Identity\getGivenName(), User\getGossip(), Mail\getHeaders(), Section\getHideAuthor(), Section\getHideTitle(), GalleryPlugin\getHomepage(), MarkupJobInfo\getId(), SubmissionFile\getId(), getId(), Section\getIdentifyType(), Category\getImage(), ReviewFormElement\getIncluded(), PKPAuthor\getIncludeInBrowse(), ReviewForm\getIncompleteCount(), User\getInlineHelp(), FilterGroup\getInputType(), GalleryPlugin\getInstallationInstructions(), Site\getInstalledLocales(), SubscriptionType\getInstitutional(), InstitutionalSubscription\getInstitutionMailingAddress(), InstitutionalSubscription\getInstitutionName(), InterestEntry\getInterest(), Session\getIpAddress(), InstitutionalSubscription\getIPRanges(), InstitutionalSubscription\getIPRangesString(), Representation\getIsApproved(), Query\getIsClosed(), Section\getIsInactive(), IssueFile\getIssueId(), Issue\getIssueIdentification(), PersistableFilter\getIsTemplate(), EventLogEntry\getIsTranslated(), Issue\getJournalId(), SubscriptionType\getJournalId(), Subscription\getJournalId(), Deposit\getJournalId(), DepositObject\getJournalId(), MarkupJobInfo\getJournalId(), Submission\getJournalId(), Genre\getKey(), AccessKey\getKeyHash(), SubmissionKeyword\getKeyword(), ArticleGalley\getLabel(), IssueGalley\getLabel(), SubmissionLanguage\getLanguage(), SupplementaryFile\getLanguage(), Issue\getLastModified(), ReviewAssignment\getLastModified(), PKPSubmission\getLastModified(), Deposit\getLastStatusDate(), PKPSubmission\getLatestPublication(), Version\getLazyLoad(), PKPNotification\getLevel(), ArticleGalley\getLocale(), IssueGalley\getLocale(), User\getLocales(), Submission\getLocalizedCoverImageUrl(), PKPAuthor\getLocalizedData(), PKPPublication\getLocalizedData(), Identity\getLocalizedData(), SubmissionFile\getLocalizedData(), getLocalizedData(), Context\getLocalizedDateFormatLong(), Context\getLocalizedDateFormatShort(), Context\getLocalizedDateTimeFormatLong(), Context\getLocalizedDateTimeFormatShort(), Context\getLocalizedFavicon(), Submission\getLocalizedGalleys(), Journal\getLocalizedPageHeaderLogo(), Journal\getLocalizedPageHeaderTitle(), Site\getLocalizedPageHeaderTitle(), Context\getLocalizedTimeFormat(), User\getMailingAddress(), Version\getMajor(), Subscription\getMembership(), SubscriptionType\getMembership(), NavigationMenuItemAssignment\getMenuId(), NavigationMenuItemAssignment\getMenuItemId(), EventLogEntry\getMessage(), Section\getMetaIndexed(), Section\getMetaReviewed(), Version\getMinor(), Site\getMinPasswordLength(), User\getMustChangePassword(), Language\getName(), Currency\getName(), Context\getName(), GalleryPlugin\getName(), Representation\getName(), SubscriptionType\getName(), DepositPoint\getName(), AnnouncementType\getName(), ControlledVocabEntry\getName(), Genre\getName(), LibraryFile\getName(), UserGroup\getName(), SubmissionFile\getName(), PKPFile\getNiceFileSize(), LibraryFile\getNiceFileSize(), Subscription\getNotes(), Issue\getNumber(), DataObjectTombstone\getOAIIdentifier(), DataObjectTombstone\getOAISetObjectsIds(), DepositObject\getObjectId(), DepositObject\getObjectType(), Issue\getOpenAccessDate(), Identity\getOrcid(), PKPFile\getOriginalFileName(), LibraryFile\getOriginalFileName(), FilterGroup\getOutputType(), PKPPublication\getPageArray(), EventLogEntry\getParams(), PersistableFilter\getParentFilterId(), Category\getParentId(), NavigationMenuItemAssignment\getParentId(), User\getPassword(), UserGroup\getPath(), NavigationMenuItem\getPath(), Category\getPath(), StaticPage\getPath(), Context\getPath(), SubmissionArtworkFile\getPermissionFileId(), SubmissionArtworkFile\getPermissionTerms(), UserGroup\getPermitMetadataEdit(), UserGroup\getPermitSelfRegistration(), User\getPhone(), AuthSource\getPlugin(), AuthSource\getPluginClass(), PKPSection\getPolicy(), ReviewFormElement\getPossibleResponses(), Identity\getPreferredPublicName(), PKPPublication\getPrimaryAuthor(), PKPAuthor\getPrimaryContact(), Context\getPrimaryLocale(), Site\getPrimaryLocale(), GalleryPlugin\getProduct(), Version\getProduct(), Version\getProductClassName(), Version\getProductType(), LibraryFile\getPublicAccess(), Issue\getPublished(), PKPSubmission\getPublishedPublications(), SupplementaryFile\getPublisher(), ReviewerSubmission\getQuality(), ReviewAssignment\getQuality(), ReviewFormElement\getQuestion(), Citation\getRawCitation(), Mail\getRecipients(), EmailLogEntry\getRecipients(), ReviewerSubmission\getRecommendation(), ReviewAssignment\getRecommendation(), StageAssignment\getRecommendOnly(), UserGroup\getRecommendOnly(), Site\getRedirect(), Subscription\getReferenceNumber(), GalleryPlugin\getReleaseCertifications(), GalleryPlugin\getReleaseDescription(), GalleryPlugin\getReleaseMD5(), GalleryPlugin\getReleasePackage(), Session\getRemember(), ReviewAssignment\getReminderWasAutomatic(), Representation\getRemoteURL(), NavigationMenuItem\getRemoteUrl(), Mail\getReplyTo(), Representation\getRepresentationFiles(), ReviewFormElement\getRequired(), ReviewFormResponse\getResponseType(), XSLTransformationFilter\getResultType(), ReviewAssignment\getReviewerFullName(), ReviewerSubmission\getReviewerFullName(), ReviewAssignment\getReviewerId(), ReviewerSubmission\getReviewerId(), ReviewFormResponse\getReviewFormElementId(), ReviewFormElement\getReviewFormId(), PKPSection\getReviewFormId(), ReviewAssignment\getReviewFormId(), ReviewFormResponse\getReviewId(), ReviewerSubmission\getReviewId(), ReviewAssignment\getReviewMethod(), ReviewerSubmission\getReviewMethod(), ReviewAssignment\getReviewRoundId(), Version\getRevision(), SubmissionFile\getRevision(), UserGroup\getRoleId(), SubmissionComment\getRoleId(), ReviewRound\getRound(), ReviewerSubmission\getRound(), SubmissionFile\getRound(), ReviewAssignment\getRound(), SubmissionFile\getSalesType(), Session\getSecondsCreated(), Session\getSecondsLastUsed(), EmailLogEntry\getSenderEmail(), EmailLogEntry\getSenderFullName(), EmailLogEntry\getSenderId(), Representation\getSequence(), DepositPoint\getSequence(), PKPSection\getSequence(), Genre\getSequence(), ControlledVocabEntry\getSequence(), Category\getSequence(), Query\getSequence(), ReviewFormElement\getSequence(), Citation\getSequence(), NavigationMenuItemAssignment\getSequence(), IssueGalley\getSequence(), ReviewForm\getSequence(), Context\getSequence(), NavigationMenuItem\getSequence(), Filter\getSequence(), PKPAuthor\getSequence(), SubscriptionType\getSequence(), PKPFile\getServerFileName(), LibraryFile\getServerFileName(), Session\getSessionData(), DataObjectTombstone\getSetName(), DataObjectTombstone\getSetSpec(), Context\getSetting(), AuthSource\getSettings(), PKPPublication\getShortAuthorString(), Issue\getShowNumber(), UserGroup\getShowTitle(), PKPAuthor\getShowTitle(), Issue\getShowTitle(), Issue\getShowVolume(), Issue\getShowYear(), User\getSignature(), Version\getSitewide(), Category\getSortOption(), SupplementaryFile\getSource(), SubmissionFile\getSourceFileId(), SubmissionFile\getSourceRevision(), SupplementaryFile\getSponsor(), StageAssignment\getStageId(), Query\getStageId(), ReviewRound\getStageId(), ReviewAssignment\getStageId(), ReviewerSubmission\getStageId(), PKPSubmission\getStageId(), MetadataDescription\getStatement(), MetadataDescription\getStatementTranslations(), Deposit\getStatus(), ReviewRound\getStatus(), Subscription\getStatus(), PKPSubmission\getStatus(), PKPSubmission\getStatusKey(), Subscription\getStatusString(), ReviewerSubmission\getStep(), Representation\getStoredPubId(), IssueGalley\getStoredPubId(), SubmissionFile\getStoredPubId(), Issue\getStoredPubId(), PKPPublication\getStoredPubId(), SubmissionSubject\getSubject(), SupplementaryFile\getSubject(), EmailTemplate\getSubject(), EmailLogEntry\getSubject(), Mail\getSubject(), StageAssignment\getSubmissionId(), ReviewRound\getSubmissionId(), ReviewAssignment\getSubmissionId(), LibraryFile\getSubmissionId(), SubmissionComment\getSubmissionId(), PKPAuthor\getSubmissionId(), SubmissionFile\getSubmissionId(), PKPAuthor\getSubmissionLocale(), SubmissionFile\getSubmissionLocale(), PKPSubmission\getSubmissionProgress(), Subscription\getSubscriptionTypeInstitutional(), Subscription\getSubscriptionTypeName(), Subscription\getSubscriptionTypeSummaryString(), GalleryPlugin\getSummary(), Genre\getSupplementary(), Context\getSupportedFormLocaleNames(), Context\getSupportedFormLocales(), Context\getSupportedLocaleNames(), Site\getSupportedLocales(), Context\getSupportedLocales(), Context\getSupportedSubmissionLocaleNames(), Context\getSupportedSubmissionLocales(), DepositPoint\getSwordApikey(), DepositPoint\getSwordPassword(), DepositPoint\getSwordUrl(), DepositPoint\getSwordUsername(), ControlledVocab\getSymbolic(), FilterGroup\getSymbolic(), AuthSource\getTitle(), NavigationMenu\getTitle(), StaticPage\getTitle(), Issue\getTitle(), Site\getTitle(), PKPSection\getTitle(), Category\getTitle(), Note\getTitle(), Announcement\getTitle(), NavigationMenuItem\getTitle(), NavigationMenuItemAssignment\getTitle(), ReviewForm\getTitle(), NavigationMenuItem\getTitleLocaleKey(), PKPPublication\getTitles(), EmailTemplate\getToRoleId(), NavigationMenuItem\getType(), DepositPoint\getType(), LibraryFile\getType(), PKPNotification\getType(), Announcement\getTypeId(), Subscription\getTypeId(), ReviewAssignment\getUnconsidered(), SubmissionFile\getUploaderUserId(), NavigationMenuItem\getUrl(), Identity\getUrl(), Session\getUserAgent(), Subscription\getUserEmail(), EventLogEntry\getUserEmail(), Subscription\getUserFullName(), EventLogEntry\getUserFullName(), UserGroupAssignment\getUserGroupId(), StageAssignment\getUserGroupId(), PKPAuthor\getUserGroupId(), Note\getUserId(), EventLogEntry\getUserId(), TemporaryFile\getUserId(), UserGroupAssignment\getUserId(), Subscription\getUserId(), MarkupJobInfo\getUserId(), AccessKey\getUserId(), Session\getUserId(), StageAssignment\getUserId(), PKPNotification\getUserId(), User\getUsername(), Deposit\getUUID(), ReviewFormResponse\getValue(), GalleryPlugin\getVersion(), SubmissionComment\getViewable(), SubmissionFile\getViewable(), Issue\getVolume(), MarkupJobInfo\getXmlJobId(), XSLTransformationFilter\getXSL(), XSLTransformationFilter\getXSLType(), Issue\getYear(), PKPPublication\isCCLicense(), Filter\isCompatibleWithRuntimeEnvironment(), Subscription\isExpired(), IndividualSubscription\isValid(), InstitutionalSubscription\isValid(), and Session\setUserId().

getHasLoadableAdapters()

DataObject::getHasLoadableAdapters

(

)

Get whether the object has loadable meta-data adapters

Returns

boolean

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

References $_hasLoadableAdapters.

Referenced by getSupportedExtractionAdapters(), and getSupportedInjectionAdapters().

getId()

DataObject::getId

(

)

Get ID of object.

Returns

int

Reimplemented in SubmissionFile, and MarkupJobInfo.

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

References getData().

Referenced by Submission\_getContextLicenseFieldValue(), ReviewRound\determineStatus(), ControlledVocab\enumerate(), ArticleGalley\getBestGalleyId(), IssueGalley\getBestGalleyId(), PKPSubmission\getBestId(), Issue\getBestIssueId(), Deposit\getDepositObjects(), Submission\getGalleys(), Journal\getMetrics(), Context\getMetrics(), Journal\getMetricTypes(), Context\getMetricTypes(), Issue\getNumArticles(), Query\getReplies(), Representation\getRepresentationFiles(), Role\getRoleId(), User\getSetting(), User\getSettings(), IssueGalley\getViews(), PKPSection\getViews(), Context\getViews(), PKPSubmission\getViews(), Note\markViewed(), SwordPlugin\performAutomaticDeposits(), Context\updateSetting(), and User\updateSetting().

getLocaleMetadataFieldNames()

DataObject::getLocaleMetadataFieldNames

(

)

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

Returns

array an array of field names

Reimplemented in SubmissionLanguage, SubmissionSubject, SubmissionDiscipline, SubmissionAgency, and SubmissionKeyword.

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

References getMetadataFieldNames().

getLocalizedData()

DataObject::getLocalizedData	(		$key,
			$preferredLocale = null
	)

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

Parameters

$key	string
$preferredLocale	string

Returns

mixed

Reimplemented in PKPSubmission, SubmissionFile, Identity, PKPPublication, and PKPAuthor.

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

References getData(), and AppLocale\getLocalePrecedence().

Referenced by Section\getLocalizedAbbrev(), UserGroup\getLocalizedAbbrev(), Site\getLocalizedAbout(), Context\getLocalizedAcronym(), Site\getLocalizedContactEmail(), Site\getLocalizedContactName(), StaticPage\getLocalizedContent(), NavigationMenuItem\getLocalizedContent(), Issue\getLocalizedCoverImage(), Issue\getLocalizedCoverImageAltText(), ReviewForm\getLocalizedDescription(), ReviewFormElement\getLocalizedDescription(), SubscriptionType\getLocalizedDescription(), Category\getLocalizedDescription(), Announcement\getLocalizedDescription(), Context\getLocalizedDescription(), Issue\getLocalizedDescription(), GalleryPlugin\getLocalizedDescription(), Announcement\getLocalizedDescriptionShort(), Section\getLocalizedIdentifyType(), GalleryPlugin\getLocalizedInstallationInstructions(), GalleryPlugin\getLocalizedName(), Context\getLocalizedName(), Representation\getLocalizedName(), SubscriptionType\getLocalizedName(), DepositPoint\getLocalizedName(), ControlledVocabEntry\getLocalizedName(), Genre\getLocalizedName(), LibraryFile\getLocalizedName(), UserGroup\getLocalizedName(), Site\getLocalizedPageHeaderTitle(), PKPSection\getLocalizedPolicy(), ReviewFormElement\getLocalizedPossibleResponses(), ReviewFormElement\getLocalizedQuestion(), GalleryPlugin\getLocalizedReleaseDescription(), NavigationMenuItem\getLocalizedRemoteUrl(), Context\getLocalizedSetting(), GalleryPlugin\getLocalizedSummary(), ReviewForm\getLocalizedTitle(), Issue\getLocalizedTitle(), PKPSection\getLocalizedTitle(), StaticPage\getLocalizedTitle(), Site\getLocalizedTitle(), Category\getLocalizedTitle(), Announcement\getLocalizedTitle(), NavigationMenuItem\getLocalizedTitle(), NavigationMenuItemAssignment\getLocalizedTitle(), and AnnouncementType\getLocalizedTypeName().

getMetadataFieldNames()

DataObject::getMetadataFieldNames

(

$translated = true

)

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

Parameters

$translated

boolean if true, return localized field names, otherwise return additional field names.

Reimplemented in MetadataDataObjectAdapter, and MetadataDescriptionDummyAdapter.

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

References getSupportedExtractionAdapters().

Referenced by getAdditionalMetadataFieldNames(), getLocaleMetadataFieldNames(), and getSetMetadataFieldNames().

getSetMetadataFieldNames()

DataObject::getSetMetadataFieldNames

(

$translated = true

)

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

Parameters

$translated

boolean if true, return localized field names, otherwise return additional field names.

Returns

array an array of field names

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

References getMetadataFieldNames(), and hasData().

getSupportedExtractionAdapters()

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

References $_metadataExtractionAdapters, addSupportedMetadataAdapter(), DAORegistry\getDAO(), and getHasLoadableAdapters().

Referenced by extractMetadata(), getMetadataFieldNames(), and getSupportedMetadataSchemas().

getSupportedInjectionAdapters()

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

References $_metadataInjectionAdapters, addSupportedMetadataAdapter(), DAORegistry\getDAO(), and getHasLoadableAdapters().

Referenced by injectMetadata().

getSupportedMetadataSchemas()

DataObject::getSupportedMetadataSchemas

(

)

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

Returns

array

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

References getSupportedExtractionAdapters().

hasData()

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

Check whether a value exists for a given data variable.

Parameters

$key	string
$locale	string (optional)

Returns

boolean

Reimplemented in CompositeFilter.

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

Referenced by Filter\getDisplayName(), getSetMetadataFieldNames(), Filter\isCompatibleWithRuntimeEnvironment(), and MetadataDescription\removeStatement().

injectMetadata()

DataObject::injectMetadata

(

$metadataDescription

)

Inject a meta-data description into this data object.

Parameters

$metadataDescription	MetadataDescription
$replace	boolean whether to delete existing meta-data

Returns

boolean true on success, otherwise false

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

References getSupportedInjectionAdapters().

removeSupportedMetadataAdapter()

DataObject::removeSupportedMetadataAdapter

(

$metadataSchemaName

)

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

Parameters

$metadataSchemaName

string fully qualified class name

Returns

boolean true if an adapter was removed, otherwise false.

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

setAllData()

DataObject::setAllData

(

&

$data

)

Set all data variables at once.

Parameters

$data

array

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

Referenced by MetadataDescription\setStatements().

setData()

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

$key	string
$value	mixed 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', ... )
$locale	string (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)

Reimplemented in CompositeFilter.

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

Referenced by PKPAuthor\_setShowTitle(), Mail\addAttachment(), Mail\addBcc(), Mail\addCc(), Mail\addHeader(), Mail\addRecipient(), Mail\addReplyTo(), MetadataDescription\addStatement(), MailTemplate\clearRecipients(), Filter\getDisplayName(), Submission\getGalleys(), MetadataDescription\removeStatement(), Section\setAbbrev(), UserGroup\setAbbrev(), Section\setAbstractsNotRequired(), Section\setAbstractWordCount(), Issue\setAccessStatus(), ReviewForm\setActive(), Identity\setAffiliation(), SubmissionAgency\setAgency(), NavigationMenu\setAreaName(), AnnouncementType\setAssocId(), EmailTemplate\setAssocId(), ControlledVocab\setAssocId(), Announcement\setAssocId(), Query\setAssocId(), SubmissionComment\setAssocId(), AccessKey\setAssocId(), EmailLogEntry\setAssocId(), EventLogEntry\setAssocId(), ReviewForm\setAssocId(), Note\setAssocId(), SubmissionFile\setAssocId(), PKPNotification\setAssocId(), Query\setAssocType(), AnnouncementType\setAssocType(), ControlledVocab\setAssocType(), Announcement\setAssocType(), EmailLogEntry\setAssocType(), EventLogEntry\setAssocType(), ReviewForm\setAssocType(), Note\setAssocType(), PKPNotification\setAssocType(), SubmissionFile\setAssocType(), AuthSource\setAuthId(), User\setAuthId(), SubmissionComment\setAuthorId(), User\setAuthStr(), EmailLogEntry\setBccs(), Mail\setBccs(), User\setBillingAddress(), Identity\setBiography(), EmailLogEntry\setBody(), EmailTemplate\setBody(), Mail\setBody(), Version\setBuild(), ReviewerSubmission\setCancelled(), ReviewAssignment\setCancelled(), StageAssignment\setCanChangeMetadata(), EmailTemplate\setCanDisable(), SubmissionArtworkFile\setCaption(), GalleryPlugin\setCategory(), Genre\setCategory(), Mail\setCcs(), EmailLogEntry\setCcs(), SubmissionFile\setChapterId(), Language\setCode(), Currency\setCodeAlpha(), Currency\setCodeNumeric(), ReviewAssignment\setComments(), SubmissionComment\setComments(), SubmissionComment\setCommentTitle(), SubmissionComment\setCommentType(), ReviewerSubmission\setCompetingInterests(), ReviewAssignment\setCompetingInterests(), ReviewForm\setCompleteCount(), SubmissionArtworkFile\setContactAuthor(), Context\setContactEmail(), GalleryPlugin\setContactEmail(), GalleryPlugin\setContactInstitutionName(), Context\setContactName(), GalleryPlugin\setContactName(), StaticPage\setContent(), NavigationMenuItem\setContent(), Note\setContents(), IssueFile\setContentType(), Mail\setContentType(), AccessKey\setContext(), DepositPoint\setContextId(), PKPSection\setContextId(), Category\setContextId(), StaticPage\setContextId(), Genre\setContextId(), NavigationMenu\setContextId(), LibraryFile\setContextId(), UserGroup\setContextId(), NavigationMenuItem\setContextId(), PKPNotification\setContextId(), PKPSubmission\setContextId(), ControlledVocabEntry\setControlledVocabId(), SubmissionArtworkFile\setCopyrightOwner(), SubmissionArtworkFile\setCopyrightOwnerContactDetails(), SubscriptionType\setCost(), Identity\setCountry(), Issue\setCoverImage(), Issue\setCoverImageAltText(), SupplementaryFile\setCreator(), SubmissionArtworkFile\setCredit(), SubscriptionType\setCurrencyCodeAlpha(), Issue\setCurrent(), Version\setCurrent(), DataObjectTombstone\setDataObjectId(), GalleryPlugin\setDate(), ReviewerSubmission\setDateAcknowledged(), ReviewAssignment\setDateAcknowledged(), StageAssignment\setDateAssigned(), ReviewerSubmission\setDateAssigned(), ReviewAssignment\setDateAssigned(), ReviewerSubmission\setDateCompleted(), ReviewAssignment\setDateCompleted(), ReviewerSubmission\setDateConfirmed(), ReviewAssignment\setDateConfirmed(), Note\setDateCreated(), DepositObject\setDateCreated(), PKPNotification\setDateCreated(), SupplementaryFile\setDateCreated(), Deposit\setDateCreated(), DataObjectTombstone\setDateDeleted(), ReviewerSubmission\setDateDue(), ReviewAssignment\setDateDue(), Subscription\setDateEnd(), Announcement\setDateExpire(), Version\setDateInstalled(), User\setDateLastEmail(), User\setDateLastLogin(), EventLogEntry\setDateLogged(), IssueFile\setDateModified(), Note\setDateModified(), DepositObject\setDateModified(), SubmissionComment\setDateModified(), Deposit\setDateModified(), SubmissionFile\setDateModified(), ReviewerSubmission\setDateNotified(), Issue\setDateNotified(), ReviewAssignment\setDateNotified(), SubmissionComment\setDatePosted(), Announcement\setDatePosted(), Issue\setDatePublished(), ReviewAssignment\setDateRated(), PKPNotification\setDateRead(), User\setDateRegistered(), ReviewAssignment\setDateReminded(), ReviewerSubmission\setDateResponseDue(), ReviewAssignment\setDateResponseDue(), EmailLogEntry\setDateSent(), Subscription\setDateStart(), PKPSubmission\setDateStatusModified(), PKPSubmission\setDateSubmitted(), Announcement\setDatetimePosted(), User\setDateValidated(), ReviewerSubmission\setDeclined(), ReviewAssignment\setDeclined(), UserGroup\setDefault(), AuthSource\setDefault(), Genre\setDependent(), DepositObject\setDepositId(), FilterGroup\setDescription(), SubscriptionType\setDescription(), Context\setDescription(), SupplementaryFile\setDescription(), Category\setDescription(), ReviewFormElement\setDescription(), Announcement\setDescription(), ReviewForm\setDescription(), GalleryPlugin\setDescription(), Issue\setDescription(), Announcement\setDescriptionShort(), SubmissionFile\setDirectSalesPrice(), User\setDisabled(), User\setDisabledReason(), SubscriptionType\setDisablePublicDisplay(), SubmissionDiscipline\setDiscipline(), FilterGroup\setDisplayName(), Filter\setDisplayName(), InstitutionalSubscription\setDomain(), Session\setDomain(), SubscriptionType\setDuration(), PKPSection\setEditorRestricted(), ReviewFormElement\setElementType(), Identity\setEmail(), EmailTemplate\setEmailId(), EmailTemplate\setEmailKey(), Genre\setEnabled(), Context\setEnabled(), EmailTemplate\setEnabled(), Mail\setEnvelopeSender(), EmailLogEntry\setEventType(), EventLogEntry\setEventType(), AccessKey\setExpiryDate(), Deposit\setExportDepositError(), Identity\setFamilyName(), MarkupJobInfo\setFileId(), SubmissionFile\setFileId(), ArticleGalley\setFileId(), IssueGalley\setFileId(), SubmissionFile\setFileStage(), PKPFile\setFileType(), LibraryFile\setFileType(), SubscriptionType\setFormat(), EmailLogEntry\setFrom(), Mail\setFrom(), EmailTemplate\setFromRoleId(), SubmissionFile\setGenreId(), Identity\setGivenName(), User\setGossip(), Mail\setHeaders(), Section\setHideAuthor(), Section\setHideTitle(), GalleryPlugin\setHomepage(), MarkupJobInfo\setId(), SubmissionFile\setId(), setId(), Section\setIdentifyType(), Category\setImage(), ReviewFormElement\setIncluded(), PKPAuthor\setIncludeInBrowse(), ReviewForm\setIncompleteCount(), User\setInlineHelp(), FilterGroup\setInputType(), GalleryPlugin\setInstallationInstructions(), Site\setInstalledLocales(), SubscriptionType\setInstitutional(), InstitutionalSubscription\setInstitutionMailingAddress(), InstitutionalSubscription\setInstitutionName(), InterestEntry\setInterest(), Session\setIpAddress(), InstitutionalSubscription\setIPRanges(), Representation\setIsApproved(), Query\setIsClosed(), Section\setIsInactive(), IssueFile\setIssueId(), PersistableFilter\setIsTemplate(), EventLogEntry\setIsTranslated(), Issue\setJournalId(), SubscriptionType\setJournalId(), Subscription\setJournalId(), Deposit\setJournalId(), DepositObject\setJournalId(), MarkupJobInfo\setJournalId(), Submission\setJournalId(), Genre\setKey(), AccessKey\setKeyHash(), SubmissionKeyword\setKeyword(), ArticleGalley\setLabel(), IssueGalley\setLabel(), SubmissionLanguage\setLanguage(), SupplementaryFile\setLanguage(), Issue\setLastModified(), ReviewAssignment\setLastModified(), PKPSubmission\setLastModified(), Deposit\setLastStatusDate(), Version\setLazyLoad(), PKPNotification\setLevel(), ArticleGalley\setLocale(), IssueGalley\setLocale(), User\setLocales(), User\setMailingAddress(), Version\setMajor(), Subscription\setMembership(), SubscriptionType\setMembership(), NavigationMenuItemAssignment\setMenuId(), NavigationMenuItemAssignment\setMenuItemId(), EventLogEntry\setMessage(), Section\setMetaIndexed(), Section\setMetaReviewed(), Version\setMinor(), Site\setMinPasswordLength(), User\setMustChangePassword(), Context\setName(), GalleryPlugin\setName(), Language\setName(), Currency\setName(), Representation\setName(), SubscriptionType\setName(), DepositPoint\setName(), AnnouncementType\setName(), ControlledVocabEntry\setName(), Genre\setName(), LibraryFile\setName(), UserGroup\setName(), SubmissionFile\setName(), Subscription\setNotes(), Issue\setNumber(), DataObjectTombstone\setOAIIdentifier(), DataObjectTombstone\setOAISetObjectsIds(), DepositObject\setObjectId(), DepositObject\setObjectType(), Issue\setOpenAccessDate(), Identity\setOrcid(), PKPFile\setOriginalFileName(), LibraryFile\setOriginalFileName(), FilterGroup\setOutputType(), EventLogEntry\setParams(), PersistableFilter\setParentFilterId(), Category\setParentId(), NavigationMenuItemAssignment\setParentId(), User\setPassword(), UserGroup\setPath(), NavigationMenuItem\setPath(), Category\setPath(), StaticPage\setPath(), Context\setPath(), SubmissionArtworkFile\setPermissionFileId(), SubmissionArtworkFile\setPermissionTerms(), UserGroup\setPermitMetadataEdit(), UserGroup\setPermitSelfRegistration(), User\setPhone(), AuthSource\setPlugin(), AuthSource\setPluginClass(), PKPSection\setPolicy(), ReviewFormElement\setPossibleResponses(), Identity\setPreferredPublicName(), PKPAuthor\setPrimaryContact(), Context\setPrimaryLocale(), Site\setPrimaryLocale(), GalleryPlugin\setProduct(), Version\setProduct(), Version\setProductClassName(), Version\setProductType(), LibraryFile\setPublicAccess(), Issue\setPublished(), SupplementaryFile\setPublisher(), ReviewerSubmission\setQuality(), ReviewAssignment\setQuality(), ReviewFormElement\setQuestion(), Citation\setRawCitation(), Mail\setRecipients(), EmailLogEntry\setRecipients(), ReviewerSubmission\setRecommendation(), ReviewAssignment\setRecommendation(), StageAssignment\setRecommendOnly(), UserGroup\setRecommendOnly(), Site\setRedirect(), Subscription\setReferenceNumber(), GalleryPlugin\setReleaseCertifications(), GalleryPlugin\setReleaseDescription(), GalleryPlugin\setReleaseMD5(), GalleryPlugin\setReleasePackage(), Session\setRemember(), ReviewAssignment\setReminderWasAutomatic(), Representation\setRemoteURL(), NavigationMenuItem\setRemoteUrl(), Mail\setReplyTo(), ReviewFormElement\setRequired(), ReviewFormResponse\setResponseType(), XSLTransformationFilter\setResultType(), ReviewAssignment\setReviewerFullName(), ReviewerSubmission\setReviewerFullName(), ReviewAssignment\setReviewerId(), ReviewerSubmission\setReviewerId(), ReviewFormResponse\setReviewFormElementId(), ReviewFormElement\setReviewFormId(), PKPSection\setReviewFormId(), ReviewAssignment\setReviewFormId(), ReviewFormResponse\setReviewId(), ReviewerSubmission\setReviewId(), ReviewAssignment\setReviewMethod(), ReviewerSubmission\setReviewMethod(), ReviewAssignment\setReviewRoundId(), Version\setRevision(), SubmissionFile\setRevision(), UserGroup\setRoleId(), SubmissionComment\setRoleId(), ReviewRound\setRound(), ReviewerSubmission\setRound(), SubmissionFile\setRound(), ReviewAssignment\setRound(), Filter\setRuntimeEnvironment(), SubmissionFile\setSalesType(), Session\setSecondsCreated(), Session\setSecondsLastUsed(), EmailLogEntry\setSenderId(), Representation\setSequence(), DepositPoint\setSequence(), PKPSection\setSequence(), Genre\setSequence(), ControlledVocabEntry\setSequence(), Category\setSequence(), Query\setSequence(), ReviewFormElement\setSequence(), Citation\setSequence(), NavigationMenuItemAssignment\setSequence(), IssueGalley\setSequence(), ReviewForm\setSequence(), Context\setSequence(), Filter\setSequence(), NavigationMenuItem\setSequence(), PKPAuthor\setSequence(), SubscriptionType\setSequence(), PKPFile\setServerFileName(), LibraryFile\setServerFileName(), Session\setSessionData(), DataObjectTombstone\setSetName(), DataObjectTombstone\setSetSpec(), AuthSource\setSettings(), Issue\setShowNumber(), UserGroup\setShowTitle(), Issue\setShowTitle(), Issue\setShowVolume(), Issue\setShowYear(), User\setSignature(), Version\setSitewide(), Category\setSortOption(), SupplementaryFile\setSource(), SubmissionFile\setSourceFileId(), SubmissionFile\setSourceRevision(), SupplementaryFile\setSponsor(), StageAssignment\setStageId(), Query\setStageId(), ReviewRound\setStageId(), ReviewAssignment\setStageId(), ReviewerSubmission\setStageId(), PKPSubmission\setStageId(), Deposit\setStatus(), ReviewRound\setStatus(), Subscription\setStatus(), PKPSubmission\setStatus(), ReviewerSubmission\setStep(), Representation\setStoredPubId(), IssueGalley\setStoredPubId(), SubmissionFile\setStoredPubId(), PKPSubmission\setStoredPubId(), Issue\setStoredPubId(), SubmissionSubject\setSubject(), SupplementaryFile\setSubject(), EmailTemplate\setSubject(), EmailLogEntry\setSubject(), Mail\setSubject(), StageAssignment\setSubmissionId(), ReviewRound\setSubmissionId(), ReviewAssignment\setSubmissionId(), LibraryFile\setSubmissionId(), SubmissionComment\setSubmissionId(), PKPAuthor\setSubmissionId(), SubmissionFile\setSubmissionId(), PKPAuthor\setSubmissionLocale(), SubmissionFile\setSubmissionLocale(), PKPSubmission\setSubmissionProgress(), PKPSubmission\setSubtitle(), GalleryPlugin\setSummary(), Genre\setSupplementary(), Site\setSupportedLocales(), DepositPoint\setSwordApikey(), DepositPoint\setSwordPassword(), DepositPoint\setSwordUrl(), DepositPoint\setSwordUsername(), FilterGroup\setSymbolic(), ControlledVocab\setSymbolic(), StaticPage\setTitle(), AuthSource\setTitle(), NavigationMenu\setTitle(), Issue\setTitle(), PKPSection\setTitle(), Category\setTitle(), Note\setTitle(), Announcement\setTitle(), NavigationMenuItem\setTitle(), NavigationMenuItemAssignment\setTitle(), ReviewForm\setTitle(), PKPSubmission\setTitle(), NavigationMenuItem\setTitleLocaleKey(), EmailTemplate\setToRoleId(), NavigationMenuItem\setType(), DepositPoint\setType(), LibraryFile\setType(), PKPNotification\setType(), Announcement\setTypeId(), Subscription\setTypeId(), ReviewAssignment\setUnconsidered(), SubmissionFile\setUploaderUserId(), NavigationMenuItem\setUrl(), Identity\setUrl(), Session\setUserAgent(), UserGroupAssignment\setUserGroupId(), StageAssignment\setUserGroupId(), PKPAuthor\setUserGroupId(), Note\setUserId(), EventLogEntry\setUserId(), TemporaryFile\setUserId(), UserGroupAssignment\setUserId(), Subscription\setUserId(), MarkupJobInfo\setUserId(), AccessKey\setUserId(), Session\setUserId(), StageAssignment\setUserId(), PKPNotification\setUserId(), User\setUsername(), Deposit\setUUID(), ReviewFormResponse\setValue(), GalleryPlugin\setVersion(), SubmissionComment\setViewable(), SubmissionFile\setViewable(), Issue\setVolume(), MarkupJobInfo\setXmlJobId(), XSLTransformationFilter\setXSL(), XSLTransformationFilter\setXSLFilename(), Issue\setYear(), PKPSubmission\stampLastActivity(), PKPSubmission\stampModified(), and PKPPublication\stampModified().

setHasLoadableAdapters()

DataObject::setHasLoadableAdapters

(

$hasLoadableAdapters

)

Set whether the object has loadable meta-data adapters

Parameters

$hasLoadableAdapters

boolean

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

Referenced by Representation\__construct(), and PKPSubmission\__construct().

setId()

DataObject::setId

(

$id

)

Set ID of object.

Parameters

$id

int

Reimplemented in MarkupJobInfo, and SubmissionFile.

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

References setData().

Referenced by Role\__construct(), and Role\setRoleId().

unsetData()

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

Unset an element of the data object.

Parameters

$key	string
$locale	string (optional) non-null for a single localized value. Null for a non-localized value or when unsetting all locales at once.

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

upcastTo()

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

$targetObject

DataObject The object to cast to.

Returns

DataObject The upcast target object.

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

References getAllData().

Field Documentation

$_data

array DataObject::$_data = array()

Array of object data

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

Referenced by getAllData().

$_extractionAdaptersLoaded

boolean DataObject::$_extractionAdaptersLoaded = false

whether extraction adapters have already been loaded from the database

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

$_hasLoadableAdapters

boolean DataObject::$_hasLoadableAdapters = false

whether this objects loads meta-data adapters from the database

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

Referenced by getHasLoadableAdapters().

$_injectionAdaptersLoaded

boolean DataObject::$_injectionAdaptersLoaded = false

whether injection adapters have already been loaded from the database

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

$_metadataExtractionAdapters

array DataObject::$_metadataExtractionAdapters = array()

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

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

Referenced by getSupportedExtractionAdapters().

$_metadataInjectionAdapters

array DataObject::$_metadataInjectionAdapters = array()

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

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

Referenced by getSupportedInjectionAdapters().

---

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

• DataObject.inc.php