Public Member Functions

PublicationFormat Class Reference

A publication format for a monograph. More...

List of all members.

Public Member Functions

 _checkRequiredFieldsAssigned ()
 getBackMatter ()
 getCalculatedFileSize ()
 getCountryManufactureCode ()
 getEntryKey ()
 getFileSize ()
 getFrontMatter ()
 getHeight ()
 getHeightUnitCode ()
 getIdentificationCodes ()
 getImprint ()
 getIsApproved ()
 getIsAvailable ()
 getLocalizedName ()
 getMarkets ()
 getMonographId ()
 getName ()
 getNameForONIXCode ()
 getPhysicalFormat ()
 getProductAvailabilityCode ()
 getProductCompositionCode ()
 getProductFormDetailCode ()
 getPublicationDates ()
 getReturnableIndicatorCode ()
 getSalesRights ()
 getSeq ()
 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)
 setName ($name)
 setPhysicalFormat ($physicalFormat)
 setProductAvailabilityCode ($productAvailabilityCode)
 setProductCompositionCode ($productCompositionCode)
 setProductFormDetailCode ($productFormDetailCode)
 setReturnableIndicatorCode ($returnableIndicatorCode)
 setSeq ($seq)
 setTechnicalProtectionCode ($technicalProtectionCode)
 setThickness ($thickness)
 setThicknessUnitCode ($thicknessUnitCode)
 setWeight ($weight)
 setWeightUnitCode ($weightUnitCode)
 setWidth ($width)
 setWidthUnitCode ($widthUnitCode)

Detailed Description

A publication format for a monograph.

See also:
PublicationFormatDAO

Definition at line 18 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 539 of file PublicationFormat.inc.php.

References getCalculatedFileSize(), 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 433 of file PublicationFormat.inc.php.

PublicationFormat.getCalculatedFileSize (  ) 

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

Returns:
string

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

References getMonographId().

Referenced by _checkRequiredFieldsAssigned().

PublicationFormat.getCountryManufactureCode (  ) 

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

Returns:
string

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

PublicationFormat.getEntryKey (  ) 

Get the ONIX code for this publication format

Returns:
string

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

Referenced by getNameForONIXCode().

PublicationFormat.getFileSize (  ) 

Get the file size of the monograph format.

Returns:
string

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

Referenced by _checkRequiredFieldsAssigned().

PublicationFormat.getFrontMatter (  ) 

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

Returns:
string

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

PublicationFormat.getHeight (  ) 

Get the height of the monograph format.

Returns:
string

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

PublicationFormat.getHeightUnitCode (  ) 

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

Returns:
string

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

PublicationFormat.getIdentificationCodes (  ) 

Get the IdentificationCode objects for this format.

Returns:
DAOResultFactory IdentificationCode

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

Referenced by hasNeededONIXFields().

PublicationFormat.getImprint (  ) 

Get the imprint brand name for a publication format.

Returns:
string

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

PublicationFormat.getIsApproved (  ) 

get approved flag

Returns:
int

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

PublicationFormat.getIsAvailable (  ) 

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

Returns:
int

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

PublicationFormat.getLocalizedName (  ) 

Get "localized" format name (if applicable).

Returns:
string

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

PublicationFormat.getMarkets (  ) 

Get the Market objects for this format.

Returns:
Array Market

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

Referenced by hasNeededONIXFields().

PublicationFormat.getMonographId (  ) 

get monograph id

Returns:
int

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

Referenced by getCalculatedFileSize().

PublicationFormat.getName (  ) 

Get the format name (if applicable).

Returns:
string

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

PublicationFormat.getNameForONIXCode (  ) 

Get the human readable name for this ONIX code

Returns:
string

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

References getEntryKey().

PublicationFormat.getPhysicalFormat (  ) 

get physical format flag

Returns:
int

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

Referenced by _checkRequiredFieldsAssigned().

PublicationFormat.getProductAvailabilityCode (  ) 

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

Returns:
string

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

PublicationFormat.getProductCompositionCode (  ) 

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

Returns:
string

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

PublicationFormat.getProductFormDetailCode (  ) 

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

Returns:
string

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

PublicationFormat.getPublicationDates (  ) 

Get the PublicationDate objects for this format.

Returns:
Array PublicationDate

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

PublicationFormat.getReturnableIndicatorCode (  ) 

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

Returns:
string

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

PublicationFormat.getSalesRights (  ) 

Get the SalesRights objects for this format.

Returns:
DAOResultFactory SalesRights

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

PublicationFormat.getSeq (  ) 

Get sequence of format in format listings for the monograph.

Returns:
float

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

PublicationFormat.getTechnicalProtectionCode (  ) 

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

Returns:
string

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

PublicationFormat.getThickness (  ) 

Get the thickness of the monograph format.

Returns:
string

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

PublicationFormat.getThicknessUnitCode (  ) 

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

Returns:
string

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

PublicationFormat.getWeight (  ) 

Get the weight of the monograph format.

Returns:
string

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

PublicationFormat.getWeightUnitCode (  ) 

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

Returns:
string

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

PublicationFormat.getWidth (  ) 

Get the width of the monograph format.

Returns:
string

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

PublicationFormat.getWidthUnitCode (  ) 

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

Returns:
string

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

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

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

PublicationFormat.PublicationFormat (  ) 

Constructor.

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

PublicationFormat.setBackMatter ( $  backMatter  ) 

Set the back matter page count for a publication format.

Parameters:
string $backMatter

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

PublicationFormat.setCountryManufactureCode ( $  countryManufactureCode  ) 

Set the country of manufacture code for a publication format.

Parameters:
string $countryManufactureCode

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

PublicationFormat.setEntryKey ( $  entryKey  ) 

Sets the ONIX code for the publication format

Parameters:
string $code

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

PublicationFormat.setFileSize ( $  fileSize  ) 

Set the file size of the publication format.

Parameters:
string $fileSize

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

PublicationFormat.setFrontMatter ( $  frontMatter  ) 

Set the front matter page count for a publication format.

Parameters:
string $frontMatter

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

PublicationFormat.setHeight ( $  height  ) 

Set the height of a publication format.

Parameters:
string $height

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

PublicationFormat.setHeightUnitCode ( $  heightUnitCode  ) 

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

Parameters:
string $heightUnitCode

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

PublicationFormat.setImprint ( $  imprint  ) 

Set the imprint brand name for a publication format.

Parameters:
string $imprint

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

PublicationFormat.setIsApproved ( $  approved  ) 

set approved flag

Parameters:
$approved int

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

PublicationFormat.setIsAvailable ( $  isAvailable  ) 

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

Parameters:
$isAvailable int

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

PublicationFormat.setMonographId ( $  monographId  ) 

set monograph id.

Parameters:
$monographId int

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

PublicationFormat.setName ( $  name  ) 

Set name.

Parameters:
$name string
$locale 

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

PublicationFormat.setPhysicalFormat ( $  physicalFormat  ) 

set physical format flag

Parameters:
$physicalFormat int

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

PublicationFormat.setProductAvailabilityCode ( $  productAvailabilityCode  ) 

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

Parameters:
string $productAvailabilityCode

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

PublicationFormat.setProductCompositionCode ( $  productCompositionCode  ) 

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

Parameters:
string $productCompositionCode

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

PublicationFormat.setProductFormDetailCode ( $  productFormDetailCode  ) 

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

Parameters:
string $productFormDetailCode

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

PublicationFormat.setReturnableIndicatorCode ( $  returnableIndicatorCode  ) 

Set the return code for a publication format.

Parameters:
string $returnableIndicatorCode

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

PublicationFormat.setSeq ( $  seq  ) 

Set sequence of format in format listings for the monograph.

Parameters:
$sequence float

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

PublicationFormat.setTechnicalProtectionCode ( $  technicalProtectionCode  ) 

Set the technical protection code for a publication format.

Parameters:
string $technicalProtectionCode

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

PublicationFormat.setThickness ( $  thickness  ) 

Set the thickness of a publication format.

Parameters:
string $thinkness

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

PublicationFormat.setThicknessUnitCode ( $  thicknessUnitCode  ) 

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

Parameters:
string $thicknessUnitCode

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

PublicationFormat.setWeight ( $  weight  ) 

Set the weight for a publication format.

Parameters:
string $weight

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

PublicationFormat.setWeightUnitCode ( $  weightUnitCode  ) 

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

Parameters:
string $weightUnitCode

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

PublicationFormat.setWidth ( $  width  ) 

Set the width of a publication format.

Parameters:
string $width

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

PublicationFormat.setWidthUnitCode ( $  widthUnitCode  ) 

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

Parameters:
string $widthUnitCode

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

The documentation for this class was generated from the following file:
Generated on Mon Sep 17 2012 13:58:58 for Open Monograph Press by  doxygen 1.7.1