Empyr Documentation
\
Linusx
Empyr
Controllers
Exceptions
Facades
Providers

\Linusx\Empyr\ControllersEmpyrFundraiser

Class EmpyrFundraiser.

Summary

Methods
Properties
Constants
__construct()
fundraiser()
search()
donations()
summary()
userFundraiserTotals()
join()
leave()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct(array  $data = array())

Empyr Fundraisers Methods.

Parameters

array $data

Data to set field with.

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

fundraiser()

fundraiser(array  $options = array()) : boolean|mixed

Returns details of a fundraiser.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed

search()

search(array  $options = array()) : boolean|mixed

Searches for fundraisers.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed

donations()

donations(array  $options = array()) : boolean|mixed

Returns a list of donations.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed

summary()

summary(array  $options = array()) : boolean|mixed

Returns earnings/donations summary information for a given fundraiser.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed

userFundraiserTotals()

userFundraiserTotals(array  $options = array()) : boolean|mixed

Returns a list of fundraiser user totals.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed

join()

join(array  $options = array()) : boolean|mixed

Will join the logged in user to this fundraiser.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed

leave()

leave(array  $options = array()) : boolean|mixed

Will cause the currently logged in user to leave a fundraiser.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed