API Documentation
\
Blackpulp
MinistryPlatform
CoreTool

\Blackpulp\MinistryPlatformFindContact

This class handles the process of finding a Contact.

Summary

Methods
Properties
Constants
__construct()
getMatches()
getNumberOfMatches()
getUserAndAuthenticate()
No public properties found
No constants found
setMatches()
$first_name
$last_name
$email
$phone
$dob
$matches
$number_of_matches
N/A
No private methods found
No private properties found
N/A

Properties

$first_name

$first_name : string

first name

Type

string

$last_name

$last_name : string

last name

Type

string

$email

$email : string

e-mail address

Type

string

$phone

$phone : string

phone number

Type

string

$dob

$dob : string

Date of Birth

The DOB of the person who should be matched.

Type

string

$number_of_matches

$number_of_matches : integer

Number of Matches

Type

integer

Methods

__construct()

__construct(string  $first_name, string  $last_name, string  $email = '', string  $phone = '', string  $dob = null)

Construct Method

Parameters

string $first_name
string $last_name
string $email
string $phone
string $dob

getNumberOfMatches()

getNumberOfMatches() : integer

Gets the Number of Matches.

Returns

integer

getUserAndAuthenticate()

getUserAndAuthenticate() : \Blackpulp\MinistryPlatform\MinistryPlatform\Blackpulp\User

Authenticate a uniquely matched user.

As long as there is exactly one match and that match has a valid User Account, go ahead and process authentication for them.

Returns

\Blackpulp\MinistryPlatform\MinistryPlatform\Blackpulp\User

setMatches()

setMatches(string  $sp = "api_blackpulp_FindMatchingContact",   $user_fields = array()) : $this

Sets the $matches and $number_of_matches properties

Executes the FindMatchingContact stored procedure via MinistryPlatform. Also allows users to override the default stored procedure and the parameters passed to the stored procedure.

Parameters

string $sp

The name of the "Find Matching Contacts" Stored Procedure
$user_fields

Returns

$this