Skip to main content

GFNotificationTable

Class GFNotificationTable.

Extends WP_List_Table to display the notifications list.

Source: notification.php:1170

Details

  • Kind: class
  • Namespace: (global)
  • Extends: WP_List_Table

Properties

PropertyTypeDescription
$formarrayContains the Form Object.
$notification_eventsarrayContains the notification events for the form.
$notification_servicesarrayContains the notification services for the form.

Methods

MethodDescription
__construct()GFNotificationTable constructor.
prepare_items()Prepares the list items for displaying.
sort_notifications()Sort notifications alphabetically.
display()Displays the list table.
single_row()Builds the single row content for the list table
get_columns()Gets the column headers.
column_default()Defines the default values in a column.
column_cb()Defines a checkbox column.
column_name()Sets the column name in the list table.
column_service()Displays the content of the Service column.
column_event()Displays the content of the Event column.
no_items()Content to display if the form does not have any notifications.

Method Reference

__construct()

function __construct( $form )

GFNotificationTable constructor.

Sets required class properties and defines the list table columns.

Parameters

NameTypeDefaultDescription
$formarrayThe Form Object to use.

Since: Unknown

Source: notification.php:1225

prepare_items()

function prepare_items()

Prepares the list items for displaying.

Returns

  • void

Since: Unknown

Source: notification.php:1266

sort_notifications()

function sort_notifications( $a=[], $b=[] )

Sort notifications alphabetically.

Parameters

NameTypeDefaultDescription
$aarray[]First notification to compare.
$barray[]Second notification to compare.

Returns

  • int

Since: 2.4

Source: notification.php:1302

display()

function display()

Displays the list table.

Returns

  • void

Since: Unknown

Source: notification.php:1320

single_row()

function single_row( $item )

Builds the single row content for the list table

Parameters

NameTypeDefaultDescription
$itemobjectThe current view.

Returns

  • void

Since: Unknown

Source: notification.php:1363

get_columns()

function get_columns()

Gets the column headers.

Returns

  • array — The column headers.

Since: Unknown

Source: notification.php:1383

column_default()

function column_default( $item, $column )

Defines the default values in a column.

Parameters

NameTypeDefaultDescription
$itemobjectThe content to display.
$columnstringThe column to apply to.

Returns

  • void

Since: Unknown

Source: notification.php:1398

column_cb()

function column_cb( $item )

Defines a checkbox column.

Parameters

NameTypeDefaultDescription
$itemarrayThe column data.

Returns

  • void

Since: Unknown

Source: notification.php:1414

column_name()

function column_name( $item )

Sets the column name in the list table.

Parameters

NameTypeDefaultDescription
$itemarrayThe column data.

Returns

  • void

Since: Unknown

Source: notification.php:1454

column_service()

function column_service( $notification )

Displays the content of the Service column.

Parameters

NameTypeDefaultDescription
$notificationarrayThe Notification Object.

Returns

  • void

Since: Unknown

Source: notification.php:1518

column_event()

function column_event( $notification )

Displays the content of the Event column.

Parameters

NameTypeDefaultDescription
$notificationarrayThe Notification Object.

Returns

  • void

Since: Unknown

Source: notification.php:1545

no_items()

function no_items()

Content to display if the form does not have any notifications.

Returns

  • void

Since: Unknown

Source: notification.php:1557