API Documentation
\
Blackpulp
MinistryPlatform
CoreTool

\Blackpulp\MinistryPlatformRecurringRecord

This class handles recurring record interactions.

Summary

Methods
Properties
Constants
__construct()
create()
getFirstDate()
getSeriesDescription()
getSeriesDetails()
setSeriesDetails()
getRecord()
setRecord()
getCsvSubTabIds()
setCsvSubTabIds()
getSubTabSourceRecordId()
setSubTabSourceRecordId()
getPattern()
setPattern()
getFrequency()
setFrequency()
getStartBy()
setStartBy()
getEndBy()
setEndBy()
getEndAfter()
setEndAfter()
getSpecificDay()
setSpecificDay()
getOrderDay()
setOrderDay()
getSpecificMonth()
setSpecificMonth()
getSunday()
setSunday()
getMonday()
setMonday()
getTuesday()
setTuesday()
getWednesday()
setWednesday()
getThursday()
setThursday()
getFriday()
setFriday()
getSaturday()
setSaturday()
No public properties found
No constants found
No protected methods found
$record
$csv_sub_tab_ids
$sub_tab_source_record_id
$pattern
$frequency
$start_by
$end_by
$end_after
$specific_day
$order_day
$specific_month
$sunday
$monday
$tuesday
$wednesday
$thursday
$friday
$saturday
$series_id
$message
$first_date
$series_details
$series_description
N/A
No private methods found
No private properties found
N/A

Properties

$csv_sub_tab_ids

$csv_sub_tab_ids : string

A comma separated list of sub_page_ids that should be copied

Type

string

$sub_tab_source_record_id

$sub_tab_source_record_id : integer

This is the primary key value for the record which serves as the model containing sub tab data to be copied into the recurrence * series members.

Type

integer

$pattern

$pattern : integer

The interval of the recurrence (Daily = 1, Weekly = 2, Monthly = 3, Yearly = 4)

Type

integer

$frequency

$frequency : integer

The integer value of the frequency for the specified pattern. A value of 0 for the *daily* pattern indicates weekdays only.

Type

integer

$start_by

$start_by : \Blackpulp\MinistryPlatform\datetime

The date on which to begin the recurrence.

Type

\Blackpulp\MinistryPlatform\datetime

$end_by

$end_by : \Blackpulp\MinistryPlatform\datetime

The date on which to terminate the recurrence.

Type

\Blackpulp\MinistryPlatform\datetime

$end_after

$end_after : integer

Explicit number of occurrences after which to terminate the series.

Type

integer

$specific_day

$specific_day : integer

The numeric value of a specific day being targeted.

Type

integer

$order_day

$order_day : integer

The nth week of a month/year. 1-5 are accepted values, use 5 for "last".

Type

integer

$specific_month

$specific_month : integer

The month of hte year the recurrence will occur. Acceptable numbers are 1-12.

Type

integer

$sunday

$sunday : boolean

Recurring series will occur on the specific day of the week.

Type

boolean

$monday

$monday : boolean

Recurring series will occur on the specific day of the week.

Type

boolean

$tuesday

$tuesday : boolean

Recurring series will occur on the specific day of the week.

Type

boolean

$wednesday

$wednesday : boolean

Recurring series will occur on the specific day of the week.

Type

boolean

$thursday

$thursday : boolean

Recurring series will occur on the specific day of the week.

Type

boolean

$friday

$friday : boolean

Recurring series will occur on the specific day of the week.

Type

boolean

$saturday

$saturday : boolean

Recurring series will occur on the specific day of the week.

Type

boolean

$series_id

$series_id : integer

The Series ID returned from the API call

Type

integer

$message

$message : string

The message returned from the most recent API call.

Type

string

$first_date

$first_date : \Blackpulp\MinistryPlatform\datetime

The first date in the recurring series.

Type

\Blackpulp\MinistryPlatform\datetime

$series_details

$series_details : array

All details for the current series

Type

array

$series_description

$series_description : string

Value returned from MinistryPlatform that describes the created series.

Type

string

Methods

getFirstDate()

getFirstDate() : string

Retrieve the first date in the current series.

Returns

string

getSeriesDescription()

getSeriesDescription() : string

Return the description of the current series.

Returns

string

getSeriesDetails()

getSeriesDetails() : array

Return an array of dates representing each instance of the current series.

Returns

array —

The array contains Carbon objects

getCsvSubTabIds()

getCsvSubTabIds() : string

Gets the A comma separated list of sub_page_ids that should be copied.

Returns

string

setCsvSubTabIds()

setCsvSubTabIds(string  $csv_sub_tab_ids) : self

Sets the A comma separated list of sub_page_ids that should be copied.

Parameters

string $csv_sub_tab_ids

the csv sub tab ids

Returns

self

getSubTabSourceRecordId()

getSubTabSourceRecordId() : integer

Gets the This is the primary key value for the record which serves as the model containing sub tab data to be copied into the recurrence * series members.

Returns

integer

setSubTabSourceRecordId()

setSubTabSourceRecordId(integer  $sub_tab_source_record_id) : self

Sets the This is the primary key value for the record which serves as the model containing sub tab data to be copied into the recurrence * series members.

Parameters

integer $sub_tab_source_record_id

the sub tab source record id

Returns

self

getPattern()

getPattern() : \Blackpulp\MinistryPlatform\[type]

Gets the The interval of the recurrence (Daily = 1, Weekly = 2, Monthly = 3, Yearly = 4).

Returns

\Blackpulp\MinistryPlatform\[type]

setPattern()

setPattern(\Blackpulp\MinistryPlatform\[type]  $pattern) : self

Sets the The interval of the recurrence (Daily = 1, Weekly = 2, Monthly = 3, Yearly = 4).

Parameters

\Blackpulp\MinistryPlatform\[type] $pattern

the pattern

Returns

self

getFrequency()

getFrequency() : integer

Gets the The integer value of the frequency for the specified pattern. A value of 0 for the *daily* pattern indicates weekdays only.

Returns

integer

setFrequency()

setFrequency(integer  $frequency) : self

Sets the The integer value of the frequency for the specified pattern. A value of 0 for the *daily* pattern indicates weekdays only.

Parameters

integer $frequency

the frequency

Returns

self

getStartBy()

getStartBy() : \Blackpulp\MinistryPlatform\datetime

Gets the The date on which to begin the recurrence.

Returns

\Blackpulp\MinistryPlatform\datetime

setStartBy()

setStartBy(\Blackpulp\MinistryPlatform\datetime  $start_by) : self

Sets the The date on which to begin the recurrence.

Parameters

\Blackpulp\MinistryPlatform\datetime $start_by

the start by

Returns

self

getEndBy()

getEndBy() : \Blackpulp\MinistryPlatform\datetime

Gets the The date on which to terminate the recurrence.

Returns

\Blackpulp\MinistryPlatform\datetime

setEndBy()

setEndBy(\Blackpulp\MinistryPlatform\datetime  $end_by) : self

Sets the The date on which to terminate the recurrence.

Parameters

\Blackpulp\MinistryPlatform\datetime $end_by

the end by

Returns

self

getEndAfter()

getEndAfter() : integer

Gets the Explicit number of occurrences after which to terminate the series.

Returns

integer

setEndAfter()

setEndAfter(integer  $end_after) : self

Sets the Explicit number of occurrences after which to terminate the series.

Parameters

integer $end_after

the end after

Returns

self

getSpecificDay()

getSpecificDay() : integer

Gets the The numeric value of a specific day being targeted.

Returns

integer

setSpecificDay()

setSpecificDay(integer  $specific_day) : self

Sets the The numeric value of a specific day being targeted.

Parameters

integer $specific_day

the specific day

Returns

self

getOrderDay()

getOrderDay() : integer

Gets the The nth week of a month/year. 1-5 are accepted values, use 5 for "last".

Returns

integer

setOrderDay()

setOrderDay(integer  $order_day) : self

Sets the The nth week of a month/year. 1-5 are accepted values, use 5 for "last".

Parameters

integer $order_day

the order day

Returns

self

getSpecificMonth()

getSpecificMonth() : integer

Gets the The month of hte year the recurrence will occur. Acceptable numbers are 1-12.

Returns

integer

setSpecificMonth()

setSpecificMonth(integer  $specific_month) : self

Sets the The month of hte year the recurrence will occur. Acceptable numbers are 1-12.

Parameters

integer $specific_month

the specific month

Returns

self

getSunday()

getSunday() : boolean

Gets the Recurring series will occur on the specific day of the week.

Returns

boolean

setSunday()

setSunday(boolean  $sunday) : self

Sets the Recurring series will occur on the specific day of the week.

Parameters

boolean $sunday

the sunday

Returns

self

getMonday()

getMonday() : mixed

Gets the value of monday.

Returns

mixed

setMonday()

setMonday(mixed  $monday) : self

Sets the value of monday.

Parameters

mixed $monday

the monday

Returns

self

getTuesday()

getTuesday() : mixed

Gets the value of tuesday.

Returns

mixed

setTuesday()

setTuesday(mixed  $tuesday) : self

Sets the value of tuesday.

Parameters

mixed $tuesday

the tuesday

Returns

self

getWednesday()

getWednesday() : mixed

Gets the value of wednesday.

Returns

mixed

setWednesday()

setWednesday(mixed  $wednesday) : self

Sets the value of wednesday.

Parameters

mixed $wednesday

the wednesday

Returns

self

getThursday()

getThursday() : mixed

Gets the value of thursday.

Returns

mixed

setThursday()

setThursday(mixed  $thursday) : self

Sets the value of thursday.

Parameters

mixed $thursday

the thursday

Returns

self

getFriday()

getFriday() : mixed

Gets the value of friday.

Returns

mixed

setFriday()

setFriday(mixed  $friday) : self

Sets the value of friday.

Parameters

mixed $friday

the friday

Returns

self

getSaturday()

getSaturday() : mixed

Gets the value of saturday.

Returns

mixed

setSaturday()

setSaturday(mixed  $saturday) : self

Sets the value of saturday.

Parameters

mixed $saturday

the saturday

Returns

self