trait CRM_Core_Page_EntityPageTrait

Properties

protected int $_id The id of the contact.
protected int $_action The mode of operation for this page
protected string $_context The context that we are working on.
int $_contactID Contact ID of the contact on the page.
int $_contactId Contact ID of the contact on the page.
int $_permission
$_links The action links that we need to display for the browse screen.

Methods

int|null
getEntityId()

Get the entity id being edited.

string
getContext()

Get the context we are working in

int
getContactId()

Get the contact ID

setContactId($contactId)

Set the contact ID

getAction()

No description

string|null
getDefaultContext()

Explicitly declare the form context.

preProcessQuickEntityPage()

No description

bool
isDeleteContext()

Is the form being used in the context of a deletion.

bool
isViewContext()

Is the form being used in the context of a view.

bool
isEditContext()

Is the form being used in the context of a edit.

Details

at line 98
int|null getEntityId()

Get the entity id being edited.

Return Value

int|null

at line 107
string getContext()

Get the context we are working in

Return Value

string

at line 116
int getContactId()

Get the contact ID

Return Value

int

at line 125
setContactId($contactId)

Set the contact ID

Parameters

$contactId

at line 130
getAction()

at line 139
string|null getDefaultContext()

Explicitly declare the form context.

Return Value

string|null

at line 143
preProcessQuickEntityPage()

at line 168
protected bool isDeleteContext()

Is the form being used in the context of a deletion.

(For some reason rather than having separate forms Civi overloads one form).

Return Value

bool

at line 177
protected bool isViewContext()

Is the form being used in the context of a view.

Return Value

bool

at line 186
protected bool isEditContext()

Is the form being used in the context of a edit.

Return Value

bool