ExternalInfoPlatform
in package
Aggregate representing a configured external info platform.
Table of Contents
Properties
- $fallbackText : string
- $headline : string
- $height : int
- $id : ExternalInfoPlatformId
- $introText : string
- $linkLabel : string
- $mode : string
- $url : ExternalInfoPlatformUrl
Methods
- create() : self
- Factory to create a platform with sane defaults and validation.
- fallbackText() : string
- Fallback text when the embed cannot be displayed.
- headline() : string
- Headline used for rendering.
- height() : int
- Desired render height (min 200).
- id() : ExternalInfoPlatformId
- Identifier of the external info platform.
- introText() : string
- Intro text shown before the embed/link.
- linkLabel() : string
- Label for the link/redirect button.
- mode() : string
- Mode indicating how to render (embed|link|redirect).
- url() : ExternalInfoPlatformUrl
- Configured URL (embed/redirect target).
- __construct() : mixed
- ExternalInfoPlatform constructor (protected for factories).
Properties
$fallbackText
private
string
$fallbackText
$headline
private
string
$headline
$height
private
int
$height
$id
private
ExternalInfoPlatformId
$id
$introText
private
string
$introText
$linkLabel
private
string
$linkLabel
$mode
private
string
$mode
$url
private
ExternalInfoPlatformUrl
$url
Methods
create()
Factory to create a platform with sane defaults and validation.
public
static create(ExternalInfoPlatformId $id, ExternalInfoPlatformUrl $url, string $mode, string $headline, string $introText, string $fallbackText, string $linkLabel, int $height) : self
Parameters
- $id : ExternalInfoPlatformId
- $url : ExternalInfoPlatformUrl
- $mode : string
- $headline : string
- $introText : string
- $fallbackText : string
- $linkLabel : string
- $height : int
Return values
selffallbackText()
Fallback text when the embed cannot be displayed.
public
fallbackText() : string
Return values
stringheadline()
Headline used for rendering.
public
headline() : string
Return values
stringheight()
Desired render height (min 200).
public
height() : int
Return values
intid()
Identifier of the external info platform.
public
id() : ExternalInfoPlatformId
Return values
ExternalInfoPlatformIdintroText()
Intro text shown before the embed/link.
public
introText() : string
Return values
stringlinkLabel()
Label for the link/redirect button.
public
linkLabel() : string
Return values
stringmode()
Mode indicating how to render (embed|link|redirect).
public
mode() : string
Return values
stringurl()
Configured URL (embed/redirect target).
public
url() : ExternalInfoPlatformUrl
Return values
ExternalInfoPlatformUrl__construct()
ExternalInfoPlatform constructor (protected for factories).
protected
__construct(ExternalInfoPlatformId $id, ExternalInfoPlatformUrl $url, string $mode, string $headline, string $introText, string $fallbackText, string $linkLabel, int $height) : mixed
Parameters
- $id : ExternalInfoPlatformId
- $url : ExternalInfoPlatformUrl
- $mode : string
-
embed|link|redirect
- $headline : string
- $introText : string
- $fallbackText : string
- $linkLabel : string
- $height : int