Inheritance diagram for PublicationFormat:

Public Member Functions
	__construct ()

	_checkRequiredFieldsAssigned ()

	getBackMatter ()

	getBestId ()

	getCalculatedFileSize ()

	getCountryManufactureCode ()

	getDimensions ()

	getEntryKey ()

	getFileSize ()

	getFrontMatter ()

	getHeight ()

	getHeightUnitCode ()

	getIdentificationCodes ()

	getImprint ()

	getIsAvailable ()

	getMarkets ()

	getNameForONIXCode ()

	getPhysicalFormat ()

	getPressId ()

	getProductAvailabilityCode ()

	getProductCompositionCode ()

	getProductFormDetailCode ()

	getPublicationDates ()

	getReturnableIndicatorCode ()

	getSalesRights ()

	getTechnicalProtectionCode ()

	getThickness ()

	getThicknessUnitCode ()

	getWeight ()

	getWeightUnitCode ()

	getWidth ()

	getWidthUnitCode ()

	hasNeededONIXFields ()

	setBackMatter ($backMatter)

	setCountryManufactureCode ($countryManufactureCode)

	setEntryKey ($entryKey)

	setFileSize ($fileSize)

	setFrontMatter ($frontMatter)

	setHeight ($height)

	setHeightUnitCode ($heightUnitCode)

	setImprint ($imprint)

	setIsAvailable ($isAvailable)

	setPhysicalFormat ($physicalFormat)

	setProductAvailabilityCode ($productAvailabilityCode)

	setProductCompositionCode ($productCompositionCode)

	setProductFormDetailCode ($productFormDetailCode)

	setReturnableIndicatorCode ($returnableIndicatorCode)

	setTechnicalProtectionCode ($technicalProtectionCode)

	setThickness ($thickness)

	setThicknessUnitCode ($thicknessUnitCode)

	setWeight ($weight)

	setWeightUnitCode ($weightUnitCode)

	setWidth ($width)

	setWidthUnitCode ($widthUnitCode)

Public Member Functions inherited from Representation
	getContextId ()

	getDAO ()

	getIsApproved ()

	getLocalizedName ()

	getName ($locale)

	getRemoteURL ()

	getRepresentationFiles ($fileStage=null)

	getSequence ()

	getStoredPubId ($pubIdType)

	setIsApproved ($isApproved)

	setName ($name, $locale=null)

	setRemoteURL ($remoteURL)

	setSequence ($seq)

	setStoredPubId ($pubIdType, $pubId)

Public Member Functions inherited from DataObject
	addSupportedMetadataAdapter ($metadataAdapter)

	extractMetadata ($metadataSchema)

	getAdditionalMetadataFieldNames ()

&	getAllData ()

&	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)

Additional Inherited Members
Data Fields inherited from DataObject
	$_data = array()

	$_extractionAdaptersLoaded = false

	$_hasLoadableAdapters = false

	$_injectionAdaptersLoaded = false

	$_metadataExtractionAdapters = array()

	$_metadataInjectionAdapters = array()

Detailed Description

A publication format for a monograph.

See also: PublicationFormatDAO

Definition at line 19 of file PublicationFormat.inc.php.

Constructor & Destructor Documentation

◆ __construct()

PublicationFormat::__construct ( )

Constructor.

Reimplemented from Representation.

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

Member Function Documentation

◆ _checkRequiredFieldsAssigned()

PublicationFormat::_checkRequiredFieldsAssigned ( )

Internal function to provide some validation for the ONIX export by checking the required ONIX fields associated with this format.

Returns: array

Definition at line 473 of file PublicationFormat.inc.php.

References getCalculatedFileSize(), DataObject\getData(), getFileSize(), and getPhysicalFormat().

Referenced by hasNeededONIXFields().

◆ getBackMatter()

PublicationFormat::getBackMatter ( )

Get the page count for the back matter section of a publication format.

Returns: string

Definition at line 368 of file PublicationFormat.inc.php.

References DataObject\getData().

◆ getBestId()

PublicationFormat::getBestId ( )

Return the "best" publication format ID – If a public ID is set, use it; otherwise use the internal ID.

Returns: string

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

References DataObject\getData(), and DataObject\getId().

◆ getCalculatedFileSize()

PublicationFormat::getCalculatedFileSize ( )

Get the file size of the monograph format based on calculated sizes for approved proof files.

Returns: string

Definition at line 253 of file PublicationFormat.inc.php.

References PKPServices\get(), DAORegistry\getDAO(), DataObject\getData(), and DataObject\getId().

Referenced by _checkRequiredFieldsAssigned().

◆ getCountryManufactureCode()

PublicationFormat::getCountryManufactureCode ( )

Get the country of manufacture code that this format was manufactured in.

Returns: string

Definition at line 84 of file PublicationFormat.inc.php.

References DataObject\getData().

◆ getDimensions()

PublicationFormat::getDimensions ( )

Return the format's physical dimensions

Returns: string

Definition at line 505 of file PublicationFormat.inc.php.

References getHeight(), getHeightUnitCode(), getPhysicalFormat(), getThickness(), getThicknessUnitCode(), getWidth(), and getWidthUnitCode().

◆ getEntryKey()

PublicationFormat::getEntryKey ( )

Get the ONIX code for this publication format

Returns: string

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

References DataObject\getData().

Referenced by getNameForONIXCode().

◆ getFileSize()

PublicationFormat::getFileSize ( )

Get the file size of the monograph format.

Returns: string

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

References DataObject\getData().

Referenced by _checkRequiredFieldsAssigned().

◆ getFrontMatter()

PublicationFormat::getFrontMatter ( )

Get the page count for the front matter section of a publication format.

Returns: string

Definition at line 352 of file PublicationFormat.inc.php.

References DataObject\getData().

◆ getHeight()

PublicationFormat::getHeight ( )

Get the height of the monograph format.

Returns: string

Definition at line 116 of file PublicationFormat.inc.php.

References DataObject\getData().

Referenced by getDimensions().

◆ getHeightUnitCode()

PublicationFormat::getHeightUnitCode ( )

Get the height unit (ONIX value) of the monograph format (List50).

Returns: string

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

References DataObject\getData().

Referenced by getDimensions().

◆ getIdentificationCodes()

PublicationFormat::getIdentificationCodes ( )

Get the IdentificationCode objects for this format.

Returns: DAOResultFactory IdentificationCode

Definition at line 293 of file PublicationFormat.inc.php.

References DAORegistry\getDAO(), and DataObject\getId().

Referenced by hasNeededONIXFields().

◆ getImprint()

PublicationFormat::getImprint ( )

Get the imprint brand name for a publication format.

Returns: string

Definition at line 384 of file PublicationFormat.inc.php.

References DataObject\getData().

◆ getIsAvailable()

PublicationFormat::getIsAvailable ( )

Get whether or not this format is available in the catalog.

Returns: int

Definition at line 432 of file PublicationFormat.inc.php.

References DataObject\getData().

◆ getMarkets()

PublicationFormat::getMarkets ( )

Get the Market objects for this format.

Returns: DAOResultFactory Market

Definition at line 311 of file PublicationFormat.inc.php.

References DAORegistry\getDAO(), and DataObject\getId().

Referenced by hasNeededONIXFields().

◆ getNameForONIXCode()

PublicationFormat::getNameForONIXCode ( )

Get the human readable name for this ONIX code

Returns: string

Definition at line 74 of file PublicationFormat.inc.php.

References DAORegistry\getDAO(), and getEntryKey().

◆ getPhysicalFormat()

PublicationFormat::getPhysicalFormat ( )

get physical format flag

Returns: bool

Definition at line 42 of file PublicationFormat.inc.php.

References DataObject\getData().

Referenced by _checkRequiredFieldsAssigned(), and getDimensions().

◆ getPressId()

PublicationFormat::getPressId ( )

Get the press id from the monograph assigned to this publication format.

Returns: int

Definition at line 497 of file PublicationFormat.inc.php.

References Representation\getContextId().

◆ getProductAvailabilityCode()

PublicationFormat::getProductAvailabilityCode ( )

Get the product availability code (ONIX value) for this format (List65).

Returns: string

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

References DataObject\getData().

◆ getProductCompositionCode()

PublicationFormat::getProductCompositionCode ( )

Get the product composition code (ONIX value) used for this format (List2).

Returns: string

Definition at line 336 of file PublicationFormat.inc.php.

References DataObject\getData().

◆ getProductFormDetailCode()

PublicationFormat::getProductFormDetailCode ( )

Get the product form detail code (ONIX value) for the format used for this format (List151).

Returns: string

Definition at line 320 of file PublicationFormat.inc.php.

References DataObject\getData().

◆ getPublicationDates()

PublicationFormat::getPublicationDates ( )

Get the PublicationDate objects for this format.

Returns: Array PublicationDate

Definition at line 302 of file PublicationFormat.inc.php.

References DAORegistry\getDAO(), and DataObject\getId().

◆ getReturnableIndicatorCode()

PublicationFormat::getReturnableIndicatorCode ( )

Get the return code for a physical publication format (List66).

Returns: string

Definition at line 416 of file PublicationFormat.inc.php.

References DataObject\getData().

◆ getSalesRights()

PublicationFormat::getSalesRights ( )

Get the SalesRights objects for this format.

Returns: DAOResultFactory SalesRights

Definition at line 284 of file PublicationFormat.inc.php.

References DAORegistry\getDAO(), and DataObject\getId().

◆ getTechnicalProtectionCode()

PublicationFormat::getTechnicalProtectionCode ( )

Get the technical protection code for a digital publication format (List144).

Returns: string

Definition at line 400 of file PublicationFormat.inc.php.

References DataObject\getData().

◆ getThickness()

PublicationFormat::getThickness ( )

Get the thickness of the monograph format.

Returns: string

Definition at line 180 of file PublicationFormat.inc.php.

References DataObject\getData().

Referenced by getDimensions().

◆ getThicknessUnitCode()

PublicationFormat::getThicknessUnitCode ( )

Get the thickness unit code (ONIX value) of the monograph format (List50).

Returns: string

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

References DataObject\getData().

Referenced by getDimensions().

◆ getWeight()

PublicationFormat::getWeight ( )

Get the weight of the monograph format.

Returns: string

Definition at line 212 of file PublicationFormat.inc.php.

References DataObject\getData().

◆ getWeightUnitCode()

PublicationFormat::getWeightUnitCode ( )

Get the weight unit code (ONIX value) of the monograph format (List95).

Returns: string

Definition at line 228 of file PublicationFormat.inc.php.

References DataObject\getData().

◆ getWidth()

PublicationFormat::getWidth ( )

Get the width of the monograph format.

Returns: string

Definition at line 148 of file PublicationFormat.inc.php.

References DataObject\getData().

Referenced by getDimensions().

◆ getWidthUnitCode()

PublicationFormat::getWidthUnitCode ( )

Get the width unit code (ONIX value) of the monograph format (List50).

Returns: string

Definition at line 164 of file PublicationFormat.inc.php.

References DataObject\getData().

Referenced by getDimensions().

◆ hasNeededONIXFields()

PublicationFormat::hasNeededONIXFields ( )

Check to see if this publication format has everything it needs for valid ONIX export Ideally, do this with a DOMDocument schema validation. We do it this way for now because of a potential issue with libxml2: http://stackoverflow.com/questions/6284827

Returns: String

Definition at line 451 of file PublicationFormat.inc.php.

References _checkRequiredFieldsAssigned(), getIdentificationCodes(), and getMarkets().

◆ setBackMatter()

PublicationFormat::setBackMatter ( $backMatter )

Set the back matter page count for a publication format.

Parameters

$backMatter string

Definition at line 376 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setCountryManufactureCode()

PublicationFormat::setCountryManufactureCode ( $countryManufactureCode )

Set the country of manufacture code for a publication format.

Parameters

$countryManufactureCode string

Definition at line 92 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setEntryKey()

PublicationFormat::setEntryKey ( $entryKey )

Sets the ONIX code for the publication format

Parameters

$code string

Definition at line 66 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setFileSize()

PublicationFormat::setFileSize ( $fileSize )

Set the file size of the publication format.

Parameters

$fileSize string

Definition at line 276 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setFrontMatter()

PublicationFormat::setFrontMatter ( $frontMatter )

Set the front matter page count for a publication format.

Parameters

$frontMatter string

Definition at line 360 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setHeight()

PublicationFormat::setHeight ( $height )

Set the height of a publication format.

Parameters

$height string

Definition at line 124 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setHeightUnitCode()

PublicationFormat::setHeightUnitCode ( $heightUnitCode )

Set the height unit (ONIX value) for a publication format.

Parameters

$heightUnitCode string

Definition at line 140 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setImprint()

PublicationFormat::setImprint ( $imprint )

Set the imprint brand name for a publication format.

Parameters

$imprint string

Definition at line 392 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setIsAvailable()

PublicationFormat::setIsAvailable ( $isAvailable )

Set whether or not this format is available in the catalog.

Parameters

$isAvailable int

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

References DataObject\setData().

◆ setPhysicalFormat()

PublicationFormat::setPhysicalFormat ( $physicalFormat )

set physical format flag

Parameters

$physicalFormat bool

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

References DataObject\setData().

◆ setProductAvailabilityCode()

PublicationFormat::setProductAvailabilityCode ( $productAvailabilityCode )

Set the product availability code (ONIX value) for a publication format.

Parameters

$productAvailabilityCode string

Definition at line 108 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setProductCompositionCode()

PublicationFormat::setProductCompositionCode ( $productCompositionCode )

Set the product composition code (ONIX value) for a publication format.

Parameters

$productCompositionCode string

Definition at line 344 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setProductFormDetailCode()

PublicationFormat::setProductFormDetailCode ( $productFormDetailCode )

Set the product form detail code (ONIX value) for a publication format.

Parameters

$productFormDetailCode string

Definition at line 328 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setReturnableIndicatorCode()

PublicationFormat::setReturnableIndicatorCode ( $returnableIndicatorCode )

Set the return code for a publication format.

Parameters

$returnableIndicatorCode string

Definition at line 424 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setTechnicalProtectionCode()

PublicationFormat::setTechnicalProtectionCode ( $technicalProtectionCode )

Set the technical protection code for a publication format.

Parameters

$technicalProtectionCode string

Definition at line 408 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setThickness()

PublicationFormat::setThickness ( $thickness )

Set the thickness of a publication format.

Parameters

$thickness string

Definition at line 188 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setThicknessUnitCode()

PublicationFormat::setThicknessUnitCode ( $thicknessUnitCode )

Set the thickness unit code (ONIX value) for a publication format.

Parameters

$thicknessUnitCode string

Definition at line 204 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setWeight()

PublicationFormat::setWeight ( $weight )

Set the weight for a publication format.

Parameters

$weight string

Definition at line 220 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setWeightUnitCode()

PublicationFormat::setWeightUnitCode ( $weightUnitCode )

Set the weight unit code (ONIX value) for a publication format.

Parameters

$weightUnitCode string

Definition at line 236 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setWidth()

PublicationFormat::setWidth ( $width )

Set the width of a publication format.

Parameters

$width string

Definition at line 156 of file PublicationFormat.inc.php.

References DataObject\setData().

◆ setWidthUnitCode()

PublicationFormat::setWidthUnitCode ( $widthUnitCode )

Set the width unit code (ONIX value) for a publication format.

Parameters

$widthUnitCode string

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

References DataObject\setData().

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

PublicationFormat.inc.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _checkRequiredFieldsAssigned()

◆ getBackMatter()

◆ getBestId()

◆ getCalculatedFileSize()

◆ getCountryManufactureCode()

◆ getDimensions()

◆ getEntryKey()

◆ getFileSize()

◆ getFrontMatter()

◆ getHeight()

◆ getHeightUnitCode()

◆ getIdentificationCodes()

◆ getImprint()

◆ getIsAvailable()

◆ getMarkets()

◆ getNameForONIXCode()

◆ getPhysicalFormat()

◆ getPressId()

◆ getProductAvailabilityCode()

◆ getProductCompositionCode()

◆ getProductFormDetailCode()

◆ getPublicationDates()

◆ getReturnableIndicatorCode()

◆ getSalesRights()

◆ getTechnicalProtectionCode()

◆ getThickness()

◆ getThicknessUnitCode()

◆ getWeight()

◆ getWeightUnitCode()

◆ getWidth()

◆ getWidthUnitCode()

◆ hasNeededONIXFields()

◆ setBackMatter()

◆ setCountryManufactureCode()

◆ setEntryKey()

◆ setFileSize()

◆ setFrontMatter()

◆ setHeight()

◆ setHeightUnitCode()

◆ setImprint()

◆ setIsAvailable()

◆ setPhysicalFormat()

◆ setProductAvailabilityCode()

◆ setProductCompositionCode()

◆ setProductFormDetailCode()

◆ setReturnableIndicatorCode()

◆ setTechnicalProtectionCode()

◆ setThickness()

◆ setThicknessUnitCode()

◆ setWeight()

◆ setWeightUnitCode()

◆ setWidth()

◆ setWidthUnitCode()