Documentation

CRM_Core_Page_EntityPageTrait

Tags
copyright

CiviCRM LLC https://civicrm.org/licensing

Table of Contents

Properties

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

Methods

getAction()  : mixed
getContactId()  : int
Get the contact ID
getContext()  : string
Get the context we are working in
getDefaultContext()  : string|null
Explicitly declare the form context.
getEntityId()  : int|null
Get the entity id being edited.
preProcessQuickEntityPage()  : mixed
setContactId()  : mixed
Set the contact ID
getDefaultAction()  : string
isDeleteContext()  : bool
Is the form being used in the context of a deletion.
isEditContext()  : bool
Is the form being used in the context of a edit.
isViewContext()  : bool
Is the form being used in the context of a view.

Properties

$_contactID

Contact ID of the contact on the page.

public int $_contactID = \NULL

$_contactId

Contact ID of the contact on the page.

Historically pages alternate between $_contactID and $_contactId. We'll standardise on one

public int $_contactId = \NULL

$_links

The action links that we need to display for the browse screen.

public static array<string|int, mixed> $_links = \NULL

$_context

The context that we are working on.

protected string $_context

Methods

getContactId()

Get the contact ID

public getContactId() : int
Return values
int

getContext()

Get the context we are working in

public getContext() : string
Return values
string

getDefaultContext()

Explicitly declare the form context.

public getDefaultContext() : string|null
Return values
string|null

getEntityId()

Get the entity id being edited.

public getEntityId() : int|null
Return values
int|null

preProcessQuickEntityPage()

public preProcessQuickEntityPage() : mixed

setContactId()

Set the contact ID

public setContactId(mixed $contactId) : mixed
Parameters
$contactId : mixed

getDefaultAction()

protected getDefaultAction() : string
Return values
string

isDeleteContext()

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

protected isDeleteContext() : bool

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

Return values
bool

isEditContext()

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

protected isEditContext() : bool
Return values
bool

isViewContext()

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

protected isViewContext() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results