$user $user : \Blackpulp\MinistryPlatform\CoreTool\Blackpulp\MinistryPlatform\User User object for the current user. Type \Blackpulp\MinistryPlatform\CoreTool\Blackpulp\MinistryPlatform\User
$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_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
__construct() __construct() Create the base coreTool object Set all query params as properties, create an MP instance so hitting the MP API is quicker to do
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
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
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
getQueryString() getQueryString() : string Gets the Stores the grid's query string, if any. Returns string