OpenEstate-PHP-Export 2.0-beta2 API
\
Gettext
Extractors
Generators
Languages
Exporter
Utils
OpenEstate
PhpExport
Action
Filter
Html
Order
Provider
Session
Theme
View
PHPMailer
PHPMailer
TrueBV
Exception

\OpenEstate\PhpExport\ActionAddFavorite

Add an object ID to the list of favored objects.

Summary

Methods
Properties
Constants
__construct()
__destruct()
execute()
getName()
getParameters()
getUrl()
$objectIdParameter
NAME
No protected methods found
No protected properties found
N/A
No private methods found
$name
N/A

Constants

NAME

NAME

Action name.

Properties

$objectIdParameter

$objectIdParameter : string

Parameter name for the object ID.

Type

string

$name

$name : string

Internal name of this action.

Type

string

Methods

__construct()

__construct(string  $name = self::NAME)

AddFavorite constructor.

Parameters

string $name

internal name

__destruct()

__destruct()

AbstractAction destructor.

execute()

execute(\OpenEstate\PhpExport\Environment  $env) : mixed

Execute this action.

Parameters

\OpenEstate\PhpExport\Environment $env

export environment

Returns

mixed —

action result

getName()

getName() : string

Get the internal action name.

Returns

string —

action name

getParameters()

getParameters(\OpenEstate\PhpExport\Environment  $env, integer|string|null  $objectId = null) : array

Get parameter values for this action.

Parameters

\OpenEstate\PhpExport\Environment $env

export environment
integer|string|null $objectId

object ID, that is added to the list of favorites

Returns

array —

associative array with parameter values

getUrl()

getUrl(\OpenEstate\PhpExport\Environment  $env, integer|string|null  $objectId = null) : string

Get url for this action.

Parameters

\OpenEstate\PhpExport\Environment $env

export environment
integer|string|null $objectId

object ID, that is added to the list of favorites

Returns

string —

url