API Documentation
\
DevOwl
Freemium
RealProductManagerWpClient
announcement
client
license
rest
view
RealUtils
cross
view
MatthiasWeb
RealMediaLibrary
api
attachment
base
comp
complexquery
exception
folder
lite
comp
folder
order
rest
usersettings
metadata
order
overrides
interfce
comp
folder
order
rest
usersettings
rest
usersettings
view
Utils

\DevOwl\RealProductManagerWpClient\announcementAnnouncement

Represent an announcement model.

Summary

Methods
Properties
Constants
getPluginConstantPrefix()
setupConstants()
isVisible()
isDismissed()
getPool()
getId()
getProduct()
getProductVariant()
getGraphicUrl()
getGraphicUrlRetina()
getGraphicFileLink()
getTitle()
getText()
isDismissible()
getData()
getSeverity()
getVisibility()
fromResponse()
No public properties found
VISIBILITY_GLOBAL
VISIBILITY_LOCAL
No protected methods found
No protected properties found
N/A
__construct()
$pool
$id
$graphicUrl
$graphicUrlRetina
$graphicFileLink
$title
$text
$dismissible
$data
$severity
$visibility
N/A

Constants

VISIBILITY_GLOBAL

VISIBILITY_GLOBAL ='global'

VISIBILITY_LOCAL

VISIBILITY_LOCAL ='local'

Properties

$id

$id :integer

ID.

Type

integer

$graphicUrl

$graphicUrl :string

Full URL to graphic file, can be `null`.

Type

string

$graphicUrlRetina

$graphicUrlRetina :string

Full URL to retina graphic file, can be `null`.

Type

string

$graphicFileLink

$graphicFileLink :string

Link for graphic file, can be `null`.

Type

string

$title

$title :string

Title, can be `null`.

Type

string

$text

$text :string

Text, can be `null`.

Type

string

$dismissible

$dismissible :boolean

Can the notice be dismissed?

Type

boolean

$data

$data :array

Additional data, not yet in use.

Type

array

$severity

$severity :string

Severity of the notice, can be `warning|info|success|error`.

Type

string

$visibility

$visibility :string

Visibility, can be `global|local`.

Type

string

Methods

getPluginConstantPrefix()

getPluginConstantPrefix(): string

Get the prefix of this package so we can utils package natively.

Returns

string

setupConstants()

setupConstants()

Make sure the RPM_WP_CLIENT constants are available.

isVisible()

isVisible()

Determine if notice is visible on current page.

isDismissed()

isDismissed()

Check if this announcement is already dismissed and should no longer be visible.

getPool()

getPool()

Self-explanatory.

getId()

getId()

Self-explanatory.

getProduct()

getProduct()

Self-explanatory.

getProductVariant()

getProductVariant()

Self-explanatory.

getGraphicUrl()

getGraphicUrl()

Self-explanatory.

getGraphicUrlRetina()

getGraphicUrlRetina()

Self-explanatory.

getGraphicFileLink()

getGraphicFileLink()

Self-explanatory.

getTitle()

getTitle()

Self-explanatory.

getText()

getText()

Self-explanatory.

isDismissible()

isDismissible()

Self-explanatory.

getData()

getData()

Self-explanatory.

getSeverity()

getSeverity()

Self-explanatory.

getVisibility()

getVisibility()

Self-explanatory.

__construct()

__construct(\DevOwl\RealProductManagerWpClient\announcement\AnnouncementPool  $pool,string  $id,string  $graphicUrl = null,string  $graphicUrlRetina = null,string  $graphicFileLink = null,string  $title = null,string  $text = null,string  $dismissible = true,string  $data = array(),string  $severity = 'info',string  $visibility = 'local')

C'tor.

Parameters

\DevOwl\RealProductManagerWpClient\announcement\AnnouncementPool $pool
string $id
string $graphicUrl
string $graphicUrlRetina
string $graphicFileLink
string $title
string $text
string $dismissible
string $data
string $severity
string $visibility