API Documentation
\
Blackpulp
MinistryPlatform
CoreTool
Laravel

\Blackpulp\MinistryPlatform\CoreToolBase

This class handles the base setup for setting up a Core Tool.

Summary

Methods
Properties
Constants
__construct()
getSelection()
setSelection()
getUser()
setUser()
getPageId()
getRecordId()
getRecordDescription()
getSelectionId()
getSelectionCount()
getPagination()
getSortOrder()
getQueryString()
getViewId()
No public properties found
No constants found
No protected methods found
$domain
$user_guid
$user
$page_id
$record_id
$record_description
$selection_id
$selection_count
$pagination
$sort_order
$query_string
$view_id
$selection
N/A
No private methods found
No private properties found
N/A

Properties

$domain

$domain : string

Church's domain GUID

Type

string

$user_guid

$user_guid : string

Current user's User_GUID

Type

string

$user

$user : \Blackpulp\MinistryPlatform\CoreTool\Blackpulp\MinistryPlatform\User

User object for the current user.

Type

\Blackpulp\MinistryPlatform\CoreTool\Blackpulp\MinistryPlatform\User

$page_id

$page_id : integer

ID of the current page.

Type

integer

$record_id

$record_id : integer

Record ID.

If the tool is launched from an open record, this will be that record's ID. If launched from the grid, this value will always be -1.

Type

integer

$record_description

$record_description : string

Brief description of the current record.

Type

string

$selection_id

$selection_id : integer

ID of the active selection.

Type

integer

$selection_count

$selection_count : integer

Number of records present in the active selection.

Type

integer

$pagination

$pagination : integer

The current page of the grid view.

This may be deprecated since MP 2.0 uses lazy loading and doesn't offer a paginated grid view.

Type

integer

$sort_order

$sort_order : string

Stores the sort order, if any

Type

string

$query_string

$query_string : string

Stores the grid's query string, if any

Type

string

$view_id

$view_id : integer

Store's the active view_id, if any

Type

integer

$selection

$selection : array

Array of the user's current selection

Type

array

Methods

__construct()

__construct(\Blackpulp\MinistryPlatform\MinistryPlatform  $mp)

Create the base coreTool object

Set all query params as properties, create an MP instance so hitting the MP API is quicker to do

Parameters

\Blackpulp\MinistryPlatform\MinistryPlatform $mp

getSelection()

getSelection() : array

Gets the Array of the user's current selection.

Returns

array

setSelection()

setSelection()

Retrieves the current selection - if one exists

getUser()

getUser() : \Blackpulp\MinistryPlatform\CoreTool\Blackpulp\MinistryPlatform\User

Gets the User object for the current user.

Returns

\Blackpulp\MinistryPlatform\CoreTool\Blackpulp\MinistryPlatform\User

setUser()

setUser(\Blackpulp\MinistryPlatform\CoreTool\Blackpulp\MinistryPlatform\User  $user) : self

Sets the User object for the current user.

Parameters

\Blackpulp\MinistryPlatform\CoreTool\Blackpulp\MinistryPlatform\User $user

the user

Returns

self

getPageId()

getPageId() : integer

Gets the ID of the current page.

Returns

integer

getRecordId()

getRecordId() : integer

Gets the Record ID If the tool is launched from an open record, this will be that record's ID If launched from the grid, this value will always be -1.

Returns

integer

getRecordDescription()

getRecordDescription() : string

Gets the Brief description of the current record.

Returns

string

getSelectionId()

getSelectionId() : integer

Gets the ID of the active selection.

Returns

integer

getSelectionCount()

getSelectionCount() : integer

Gets the Number of records present in the active selection.

Returns

integer

getPagination()

getPagination() : integer

Gets the The current page of the grid view This may be deprecated since MP 2.0 uses lazy loading and doesn't offer a paginated grid view.

Returns

integer

getSortOrder()

getSortOrder() : string

Gets the Stores the sort order, if any.

Returns

string

getQueryString()

getQueryString() : string

Gets the Stores the grid's query string, if any.

Returns

string

getViewId()

getViewId() : integer

Gets the Store's the active view_id, if any.

Returns

integer