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

Public Member Functions

 getCode ()
 
 getContextId ()
 
 getIncludeInCatalog ()
 
 getLocalizedPlatform ()
 
 getPlatform ($locale)
 
 PKPSocialMedia ()
 
 replaceCodeVars ()
 
 setCode ($code)
 
 setContextId ($contextId)
 
 setIncludeInCatalog ($includeInCatalog)
 
 setPlatform ($platform, $locale)
 
- 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

Describes basic PKPSocialMedia properties.

See Also
PKPSocialMediaDAO

Definition at line 17 of file PKPSocialMedia.inc.php.

Member Function Documentation

PKPSocialMedia::getCode ( )

Get media block code.

Returns
string

Definition at line 45 of file PKPSocialMedia.inc.php.

References DataObject\getData().

Referenced by SocialMedia\replaceCodeVars().

PKPSocialMedia::getContextId ( )

Get ID of context.

Returns
int

Definition at line 29 of file PKPSocialMedia.inc.php.

References DataObject\getData().

PKPSocialMedia::getIncludeInCatalog ( )

Get whether or not this should be included on a submission's catalog page.

Returns
boolean

Definition at line 61 of file PKPSocialMedia.inc.php.

References DataObject\getData().

PKPSocialMedia::getLocalizedPlatform ( )

Get localized platform name.

Returns
string

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

References DataObject\getLocalizedData().

PKPSocialMedia::getPlatform (   $locale)

Get media platform.

Parameters
$localestring
Returns
string

Definition at line 86 of file PKPSocialMedia.inc.php.

References DataObject\getData().

PKPSocialMedia::PKPSocialMedia ( )

Constructor.

Definition at line 21 of file PKPSocialMedia.inc.php.

PKPSocialMedia::replaceCodeVars ( )

Replace various variables in the code template with data relevant to the assigned submission.

Definition at line 103 of file PKPSocialMedia.inc.php.

PKPSocialMedia::setCode (   $code)

Set media block code.

Parameters
$pathstring

Definition at line 53 of file PKPSocialMedia.inc.php.

References DataObject\setData().

Referenced by SocialMedia\replaceCodeVars().

PKPSocialMedia::setContextId (   $contextId)

Set ID of context.

Parameters
$contextIdint

Definition at line 37 of file PKPSocialMedia.inc.php.

References DataObject\setData().

PKPSocialMedia::setIncludeInCatalog (   $includeInCatalog)

Set whether or not this should be included on a submission's catalog page.

Parameters
$pathstring

Definition at line 69 of file PKPSocialMedia.inc.php.

References DataObject\setData().

PKPSocialMedia::setPlatform (   $platform,
  $locale 
)

Set media platform.

Parameters
$titlestring
$localestring

Definition at line 95 of file PKPSocialMedia.inc.php.

References DataObject\setData().


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