Open Monograph Press  3.3.0
Press Class Reference
Inheritance diagram for Press:
Context DataObject

Public Member Functions

 __construct ()
 
 getAssocType ()
 
 getDAO ()
 
 getLocalizedPageHeaderLogo ()
 
 getLocalizedPageHeaderTitle ()
 
 getPageHeaderLogo ()
 
 getPageHeaderTitle ()
 
 hasRequiredOnixHeaderFields ()
 
- Public Member Functions inherited from Context
 getAcronym ($locale)
 
 getContactEmail ()
 
 getContactName ()
 
 getDateTimeFormats ($format)
 
 getDefaultMetricType ()
 
 getDescription ($locale=null)
 
 getEnabled ()
 
 getLocalizedAcronym ()
 
 getLocalizedDateFormatLong ($locale=null)
 
 getLocalizedDateFormatShort ($locale=null)
 
 getLocalizedDateTimeFormatLong ($locale=null)
 
 getLocalizedDateTimeFormatShort ($locale=null)
 
 getLocalizedDescription ()
 
 getLocalizedFavicon ()
 
 getLocalizedName ($preferredLocale=null)
 
 getLocalizedSetting ($name, $locale=null)
 
 getLocalizedTimeFormat ($locale=null)
 
 getMetrics ($metricType=null, $columns=array(), $filter=array(), $orderBy=array(), $range=null)
 
 getMetricTypes ($withDisplayNames=false)
 
 getName ($locale=null)
 
 getPath ()
 
 getPrimaryLocale ()
 
 getSequence ()
 
 getSetting ($name, $locale=null)
 
 getSupportedFormLocaleNames ()
 
 getSupportedFormLocales ()
 
 getSupportedLocaleNames ()
 
 getSupportedLocales ()
 
 getSupportedSubmissionLocaleNames ()
 
 getSupportedSubmissionLocales ()
 
 getViews ()
 
 setContactEmail ($contactEmail)
 
 setContactName ($contactName)
 
 setDescription ($description, $locale=null)
 
 setEnabled ($enabled)
 
 setName ($name, $locale=null)
 
 setPath ($path)
 
 setPrimaryLocale ($primaryLocale)
 
 setSequence ($sequence)
 
 updateSetting ($name, $value, $type=null, $isLocalized=false)
 
- 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

Basic class describing a press.

See also
PressDAO

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

Constructor & Destructor Documentation

◆ __construct()

Press::__construct ( )

Constructor

Reimplemented from DataObject.

Definition at line 27 of file Press.inc.php.

Member Function Documentation

◆ getAssocType()

Press::getAssocType ( )

Get the association type for this context.

Returns
int

Reimplemented from Context.

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

◆ getDAO()

Press::getDAO ( )

Get the DAO for this context object.

Returns
DAO

Reimplemented from DataObject.

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

References DAORegistry\getDAO().

◆ getLocalizedPageHeaderLogo()

Press::getLocalizedPageHeaderLogo ( )

Get "localized" press page logo (if applicable).

Returns
string

Definition at line 56 of file Press.inc.php.

References DataObject\getData(), AppLocale\getLocale(), and AppLocale\getPrimaryLocale().

Referenced by getPageHeaderLogo().

◆ getLocalizedPageHeaderTitle()

Press::getLocalizedPageHeaderTitle ( )

Get "localized" press page title (if applicable). param $home boolean get homepage title

Returns
string

Definition at line 36 of file Press.inc.php.

References DataObject\getData(), AppLocale\getLocale(), and AppLocale\getPrimaryLocale().

Referenced by getPageHeaderTitle().

◆ getPageHeaderLogo()

Press::getPageHeaderLogo ( )
Deprecated:
Since OMP 3.2.1, use getLocalizedPageHeaderLogo instead.
Returns
string

Definition at line 68 of file Press.inc.php.

References getLocalizedPageHeaderLogo().

◆ getPageHeaderTitle()

Press::getPageHeaderTitle ( )
Deprecated:
Since OMP 3.2.1, use getLocalizedPageHeaderTitle instead.
Returns
string

Definition at line 48 of file Press.inc.php.

References getLocalizedPageHeaderTitle().

◆ hasRequiredOnixHeaderFields()

Press::hasRequiredOnixHeaderFields ( )

Returns true if this press contains the fields required for creating valid ONIX export metadata.

Returns
boolean

Definition at line 77 of file Press.inc.php.

References DataObject\getData().


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