Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PublicationFormat Class Reference
Inheritance diagram for PublicationFormat:
Representation DataObject

Public Member Functions

 _checkRequiredFieldsAssigned ()
 
 getBackMatter ()
 
 getCalculatedFileSize ()
 
 getCountryManufactureCode ()
 
 getEntryKey ()
 
 getFileSize ()
 
 getFrontMatter ()
 
 getHeight ()
 
 getHeightUnitCode ()
 
 getIdentificationCodes ()
 
 getImprint ()
 
 getIsApproved ()
 
 getIsAvailable ()
 
 getMarkets ()
 
 getMonographId ()
 
 getNameForONIXCode ()
 
 getPhysicalFormat ()
 
 getPressId ()
 
 getProductAvailabilityCode ()
 
 getProductCompositionCode ()
 
 getProductFormDetailCode ()
 
 getPublicationDates ()
 
 getReturnableIndicatorCode ()
 
 getSalesRights ()
 
 getTechnicalProtectionCode ()
 
 getThickness ()
 
 getThicknessUnitCode ()
 
 getWeight ()
 
 getWeightUnitCode ()
 
 getWidth ()
 
 getWidthUnitCode ()
 
 hasNeededONIXFields ()
 
 PublicationFormat ()
 
 setBackMatter ($backMatter)
 
 setCountryManufactureCode ($countryManufactureCode)
 
 setEntryKey ($entryKey)
 
 setFileSize ($fileSize)
 
 setFrontMatter ($frontMatter)
 
 setHeight ($height)
 
 setHeightUnitCode ($heightUnitCode)
 
 setImprint ($imprint)
 
 setIsApproved ($approved)
 
 setIsAvailable ($isAvailable)
 
 setMonographId ($monographId)
 
 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 ()
 
 getLocalizedName ()
 
 getName ()
 
 getSeq ()
 
 getStoredPubId ($pubIdType)
 
 getSubmissionId ()
 
 Representation ()
 
 setName ($name, $locale=null)
 
 setSeq ($seq)
 
 setStoredPubId ($pubIdType, $pubId)
 
 setSubmissionId ($submissionId)
 
- Public Member Functions inherited from DataObject
 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)
 

Additional Inherited Members

- Public Attributes 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.

Member Function Documentation

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 493 of file PublicationFormat.inc.php.

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

Referenced by hasNeededONIXFields().

PublicationFormat::getBackMatter ( )

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

Returns
string

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

References DataObject\getData().

PublicationFormat::getCalculatedFileSize ( )

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

Returns
string

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

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

Referenced by _checkRequiredFieldsAssigned().

PublicationFormat::getCountryManufactureCode ( )

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

Returns
string

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

References DataObject\getData().

PublicationFormat::getEntryKey ( )

Get the ONIX code for this publication format

Returns
string

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

References DataObject\getData().

Referenced by getNameForONIXCode().

PublicationFormat::getFileSize ( )

Get the file size of the monograph format.

Returns
string

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

References DataObject\getData().

Referenced by _checkRequiredFieldsAssigned().

PublicationFormat::getFrontMatter ( )

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

Returns
string

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

References DataObject\getData().

PublicationFormat::getHeight ( )

Get the height of the monograph format.

Returns
string

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

References DataObject\getData().

PublicationFormat::getHeightUnitCode ( )

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

Returns
string

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

References DataObject\getData().

PublicationFormat::getIdentificationCodes ( )

Get the IdentificationCode objects for this format.

Returns
DAOResultFactory IdentificationCode

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

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

Referenced by hasNeededONIXFields().

PublicationFormat::getImprint ( )

Get the imprint brand name for a publication format.

Returns
string

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

References DataObject\getData().

PublicationFormat::getIsApproved ( )

get approved flag

Returns
int

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

References DataObject\getData().

PublicationFormat::getIsAvailable ( )

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

Returns
int

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

References DataObject\getData().

PublicationFormat::getMarkets ( )

Get the Market objects for this format.

Returns
Array Market

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

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

Referenced by hasNeededONIXFields().

PublicationFormat::getMonographId ( )

Get monograph id

Returns
int

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

Referenced by getCalculatedFileSize().

PublicationFormat::getNameForONIXCode ( )

Get the human readable name for this ONIX code

Returns
string

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

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

PublicationFormat::getPhysicalFormat ( )

get physical format flag

Returns
bool

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

References DataObject\getData().

Referenced by _checkRequiredFieldsAssigned().

PublicationFormat::getPressId ( )

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

Returns
int

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

References Representation\getContextId().

PublicationFormat::getProductAvailabilityCode ( )

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

Returns
string

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

References DataObject\getData().

PublicationFormat::getProductCompositionCode ( )

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

Returns
string

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

References DataObject\getData().

PublicationFormat::getProductFormDetailCode ( )

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

Returns
string

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

References DataObject\getData().

PublicationFormat::getPublicationDates ( )

Get the PublicationDate objects for this format.

Returns
Array PublicationDate

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

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

PublicationFormat::getReturnableIndicatorCode ( )

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

Returns
string

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

References DataObject\getData().

PublicationFormat::getSalesRights ( )

Get the SalesRights objects for this format.

Returns
DAOResultFactory SalesRights

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

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

PublicationFormat::getTechnicalProtectionCode ( )

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

Returns
string

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

References DataObject\getData().

PublicationFormat::getThickness ( )

Get the thickness of the monograph format.

Returns
string

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

References DataObject\getData().

PublicationFormat::getThicknessUnitCode ( )

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

Returns
string

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

References DataObject\getData().

PublicationFormat::getWeight ( )

Get the weight of the monograph format.

Returns
string

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

References DataObject\getData().

PublicationFormat::getWeightUnitCode ( )

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

Returns
string

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

References DataObject\getData().

PublicationFormat::getWidth ( )

Get the width of the monograph format.

Returns
string

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

References DataObject\getData().

PublicationFormat::getWidthUnitCode ( )

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

Returns
string

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

References DataObject\getData().

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 471 of file PublicationFormat.inc.php.

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

PublicationFormat::PublicationFormat ( )

Constructor.

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

PublicationFormat::setBackMatter (   $backMatter)

Set the back matter page count for a publication format.

Parameters
string$backMatter

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

References DataObject\setData().

PublicationFormat::setCountryManufactureCode (   $countryManufactureCode)

Set the country of manufacture code for a publication format.

Parameters
string$countryManufactureCode

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

References DataObject\setData().

PublicationFormat::setEntryKey (   $entryKey)

Sets the ONIX code for the publication format

Parameters
string$code

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

References DataObject\setData().

PublicationFormat::setFileSize (   $fileSize)

Set the file size of the publication format.

Parameters
string$fileSize

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

References DataObject\setData().

PublicationFormat::setFrontMatter (   $frontMatter)

Set the front matter page count for a publication format.

Parameters
string$frontMatter

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

References DataObject\setData().

PublicationFormat::setHeight (   $height)

Set the height of a publication format.

Parameters
string$height

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

References DataObject\setData().

PublicationFormat::setHeightUnitCode (   $heightUnitCode)

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

Parameters
string$heightUnitCode

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

References DataObject\setData().

PublicationFormat::setImprint (   $imprint)

Set the imprint brand name for a publication format.

Parameters
string$imprint

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

References DataObject\setData().

PublicationFormat::setIsApproved (   $approved)

set approved flag

Parameters
$approvedint

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

References DataObject\setData().

PublicationFormat::setIsAvailable (   $isAvailable)

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

Parameters
$isAvailableint

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

References DataObject\setData().

PublicationFormat::setMonographId (   $monographId)

Set monograph id.

Parameters
$monographIdint

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

PublicationFormat::setPhysicalFormat (   $physicalFormat)

set physical format flag

Parameters
$physicalFormatbool

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

References DataObject\setData().

PublicationFormat::setProductAvailabilityCode (   $productAvailabilityCode)

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

Parameters
string$productAvailabilityCode

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

References DataObject\setData().

PublicationFormat::setProductCompositionCode (   $productCompositionCode)

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

Parameters
string$productCompositionCode

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

References DataObject\setData().

PublicationFormat::setProductFormDetailCode (   $productFormDetailCode)

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

Parameters
string$productFormDetailCode

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

References DataObject\setData().

PublicationFormat::setReturnableIndicatorCode (   $returnableIndicatorCode)

Set the return code for a publication format.

Parameters
string$returnableIndicatorCode

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

References DataObject\setData().

PublicationFormat::setTechnicalProtectionCode (   $technicalProtectionCode)

Set the technical protection code for a publication format.

Parameters
string$technicalProtectionCode

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

References DataObject\setData().

PublicationFormat::setThickness (   $thickness)

Set the thickness of a publication format.

Parameters
string$thinkness

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

References DataObject\setData().

PublicationFormat::setThicknessUnitCode (   $thicknessUnitCode)

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

Parameters
string$thicknessUnitCode

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

References DataObject\setData().

PublicationFormat::setWeight (   $weight)

Set the weight for a publication format.

Parameters
string$weight

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

References DataObject\setData().

PublicationFormat::setWeightUnitCode (   $weightUnitCode)

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

Parameters
string$weightUnitCode

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

References DataObject\setData().

PublicationFormat::setWidth (   $width)

Set the width of a publication format.

Parameters
string$width

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

References DataObject\setData().

PublicationFormat::setWidthUnitCode (   $widthUnitCode)

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

Parameters
string$widthUnitCode

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

References DataObject\setData().


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