Composr API documentation
Back to top  

Functions

Get number of invites available for member.

get_num_invites(\MEMBER $member_id) : integer
package recommend

Parameters

$member_id

\MEMBER

Member to look for

Returns

integerNumber of invites

Whether the current member may use invites.

may_use_invites() : boolean
package recommend

Returns

booleanWhether they may

Sends out a recommendation e-mail.

send_recommendation_email(string $name, mixed $email_address, string $message, boolean $is_invite = false, \?string $recommender_email = null, \?string $subject = null, \?array $names = null) 
package recommend

Parameters

$name

string

Recommenders name

$email_address

mixed

Their e-mail address (string or array of alternates)

$message

string

The recommendation message

$is_invite

boolean

Whether this is an invitation

$recommender_email

\?string

Email address of the recommender (null: current user's)

$subject

\?string

The subject (null: default)

$names

\?array

List of names (null: use email addresses as names)