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

Public Member Functions

 getAnnouncementTypeName ()
 
 getAssocId ()
 
 getAssocType ()
 
 getDateExpire ()
 
 getDatePosted ()
 
 getDatetimePosted ()
 
 getDescription ($locale)
 
 getDescriptionShort ($locale)
 
 getLocalizedDescription ()
 
 getLocalizedDescriptionShort ()
 
 getLocalizedTitle ()
 
 getLocalizedTitleFull ()
 
 getTitle ($locale)
 
 getTypeId ()
 
 PKPAnnouncement ()
 
 setAssocId ($assocId)
 
 setAssocType ($assocType)
 
 setDateExpire ($dateExpire)
 
 setDatePosted ($datePosted)
 
 setDatetimePosted ($datetimePosted)
 
 setDescription ($description, $locale)
 
 setDescriptionShort ($descriptionShort, $locale)
 
 setTitle ($title, $locale)
 
 setTypeId ($typeId)
 
- 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

Basic class describing a announcement.

See Also
AnnouncementDAO, PKPAnnouncementDAO

Definition at line 24 of file PKPAnnouncement.inc.php.

Member Function Documentation

PKPAnnouncement::getAnnouncementTypeName ( )

Get the announcement type name of the announcement.

Returns
string

Definition at line 87 of file PKPAnnouncement.inc.php.

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

Referenced by getLocalizedTitleFull().

PKPAnnouncement::getAssocId ( )

Get assoc ID for this annoucement.

Returns
int

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

References DataObject\getData().

PKPAnnouncement::getAssocType ( )

Get assoc type for this annoucement.

Returns
int

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

References DataObject\getData().

PKPAnnouncement::getDateExpire ( )

Get announcement expiration date.

Returns
date (YYYY-MM-DD)

Definition at line 189 of file PKPAnnouncement.inc.php.

References DataObject\getData().

PKPAnnouncement::getDatePosted ( )

Get announcement posted date.

Returns
date (YYYY-MM-DD)

Definition at line 205 of file PKPAnnouncement.inc.php.

References DataObject\getData().

PKPAnnouncement::getDatetimePosted ( )

Get announcement posted datetime.

Returns
datetime (YYYY-MM-DD HH:MM:SS)

Definition at line 213 of file PKPAnnouncement.inc.php.

References DataObject\getData().

PKPAnnouncement::getDescription (   $locale)

Get announcement description.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

PKPAnnouncement::getDescriptionShort (   $locale)

Get announcement brief description.

Parameters
$localestring
Returns
string

Definition at line 146 of file PKPAnnouncement.inc.php.

References DataObject\getData().

PKPAnnouncement::getLocalizedDescription ( )

Get localized full description

Returns
string

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

References DataObject\getLocalizedData().

PKPAnnouncement::getLocalizedDescriptionShort ( )

Get localized short description

Returns
string

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

References DataObject\getLocalizedData().

PKPAnnouncement::getLocalizedTitle ( )

Get localized announcement title

Returns
string

Definition at line 96 of file PKPAnnouncement.inc.php.

References DataObject\getLocalizedData().

Referenced by getLocalizedTitleFull().

PKPAnnouncement::getLocalizedTitleFull ( )

Get full localized announcement title including type name

Returns
string

Definition at line 104 of file PKPAnnouncement.inc.php.

References getAnnouncementTypeName(), and getLocalizedTitle().

PKPAnnouncement::getTitle (   $locale)

Get announcement title.

Parameters
$locale
Returns
string

Definition at line 120 of file PKPAnnouncement.inc.php.

References DataObject\getData().

PKPAnnouncement::getTypeId ( )

Get the announcement type of the announcement.

Returns
int

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

References DataObject\getData().

PKPAnnouncement::PKPAnnouncement ( )

Constructor

Definition at line 28 of file PKPAnnouncement.inc.php.

PKPAnnouncement::setAssocId (   $assocId)

Set assoc ID for this annoucement.

Parameters
$assocIdint

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

References DataObject\setData().

PKPAnnouncement::setAssocType (   $assocType)

Set assoc type for this annoucement.

Parameters
$assocTypeint

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

References DataObject\setData().

PKPAnnouncement::setDateExpire (   $dateExpire)

Set announcement expiration date.

Parameters
$dateExpiredate (YYYY-MM-DD)

Definition at line 197 of file PKPAnnouncement.inc.php.

References DataObject\setData().

PKPAnnouncement::setDatePosted (   $datePosted)

Set announcement posted date.

Parameters
$datePosteddate (YYYY-MM-DD)

Definition at line 221 of file PKPAnnouncement.inc.php.

References DataObject\setData().

PKPAnnouncement::setDatetimePosted (   $datetimePosted)

Set announcement posted datetime.

Parameters
$datetimePosteddate (YYYY-MM-DD HH:MM:SS)

Definition at line 229 of file PKPAnnouncement.inc.php.

References DataObject\setData().

PKPAnnouncement::setDescription (   $description,
  $locale 
)

Set announcement description.

Parameters
$descriptionstring
$localestring

Definition at line 181 of file PKPAnnouncement.inc.php.

References DataObject\setData().

PKPAnnouncement::setDescriptionShort (   $descriptionShort,
  $locale 
)

Set announcement brief description.

Parameters
$descriptionShortstring
$localestring

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

References DataObject\setData().

PKPAnnouncement::setTitle (   $title,
  $locale 
)

Set announcement title.

Parameters
$titlestring
$localestring

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

References DataObject\setData().

PKPAnnouncement::setTypeId (   $typeId)

Set the announcement type of the announcement.

Parameters
$typeIdint

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

References DataObject\setData().


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