AutoResponder

An object for adding, viewing, editing and deleting a specific auto responder email message.

Database Table: emailautoresponders
Extends: Result
Extends: AbstractDatabase

AutoResponder PHP Methods

add(array $fieldValues) _v5

Adds a new record.
PARAMETERS:
$fieldValues = Array of the values for each column when adding the record (Associative array with key = field name & value = field value).
RETURN VALUE:
int = id of the new record.
0 = if fails

checkLoaded() _v5

Checks if record is loaded. throwing an error if the record failed to load successfully.
PARAMETERS:
NONE
RETURN VALUE:
VOID

convertHTML(string $htmlContent = "", string $prefix = "", bool $urlEncode = false) _v5

Converts ~~ variables in the $htmlContent that is provided and returns the converted content. The title of the ~~ variables are converted by the content from the column in the database with the matching title.
PARAMETERS:
$htmlContent = String, HTML content body to convert.
$prefix= String, tilde code prefix if any.
$urlEncode = Bool, true if you want to apply URL encode to the content, false otherwise
RETURN VALUE:
String = Converted HTML

delete(string $restoreQuery = "") _v5

Deletes the loaded record from the database.
PARAMETERS:
$restoreQuery = FOR INTERNAL USE. FOR TYPICAL USAGE LEAVE THIS BLANK. The restore query to pass along when deleting an object with dependencies.
RETURN VALUE:
VOID

duplicate(array $newValues = null) _v5

Creates a duplicate record in the database of the current object
PARAMETERS:
$newValues = array, associative array with field name as key and field value as array value containing the new values if any
RETURN VALUE:
int = the id of the new record.

function load(string $queryWhere) _v5

Loads values for the record matching the criteria specified by $queryWhere. If the there is more than one record returned from the query then only the first record is loaded.
PARAMETERS:
$queryWhere = String, SQL where query.
RETURN VALUE:
Bool = true, if success, false otherwise

getBody(\WMT\SQL\Member\Member $member, \WMT\SQL\Contact\Contact $contact) _v5

Get AR message body for the loaded message.
PARAMETERS:
$member = object, Member (to convert tilde codes in subject)
$contact = object, contact (to convert tilde codes in subject)
RETURN VALUE:
String = body content

getDatabaseName() _v5

Returns object's database table name
PARAMETERS:
NONE
RETURN VALUE:
String = Database name

getDefaultTRHTML() _v5

Returns the default html code for a tr row with all of the fields from the database in it as ~~ vars
PARAMETERS:
NONE
RETURN VALUE:
String = the default HTML code for a tr row with all of the fields from the database in it as ~~ vars

getID() _v5

Sets object ID
PARAMETERS:
NONE
RETURN VALUE:
int = ID

getJSON(bool $returnArr = false) _v5

Get JSON array for the loaded record.
PARAMETERS:
Bool = true if want to return JSON, false otherwise
RETURN VALUE:
Object Array or JSON encoded version of the array

getSubject(\WMT\SQL\Member\Member $member, \WMT\SQL\Contact\Contact $contact) _v5

Get AR message subject for the loaded message.
PARAMETERS:
$member = object, Member (to convert tilde codes in subject)
$contact = object, contact (to convert tilde codes in subject)
RETURN VALUE:
String = Subject

getValue(string $fieldName = "value") _v5

Returns the value from a specific column for this record.
PARAMETERS:
$fieldName = String, field name.
RETURN VALUE:
Field value

hasField(string $fieldName) _v5

Checks if the field shown or hidden
PARAMETERS:
$fieldName= String, Field title.
RETURN VALUE:
Bool= True if the field show is true, false otherwise

hideAllFields() _v5

hides all fields(columns)
PARAMETERS:
NONE
RETURN VALUE:
VOID

hideField($fieldTitle) _v5

Hides specific field title by its column title
PARAMETERS:
$fieldTitle = String, Field title.
RETURN VALUE:
VOID

isLoaded() _v5

Checks if an object is loaded correctly (can be used to check if ID exists).
PARAMETERS:
NONE
RETURN VALUE:
Bool = True if the object loaded successfully, false otherwise

loadDoubleOptin(\WMT\SQL\Contact\Contact $contact, \WMT\SQL\Member\Member $member, int $contactGroupID) _v5

Load double optin email to Autoresponder body and subject.
PARAMETERS:
$contact = object, contact object.
$member = object, member object.
$contactGroupID = int, contact group ID (contactgroups.id)
RETURN VALUE:
VOID.

loadFirstID() _v5

Get object's first id
PARAMETERS:
NONE
RETURN VALUE:
int = First ID

loadID(int $id) _v5

Loads values for the record with the id specified.
PARAMETERS:
$id = int, record ID.
RETURN VALUE:
Bool = true, if success, false otherwise

loadMember(int $memberID) _v5

Load admin messages to member's AR messages. This feature overwrites member's edits.
PARAMETERS:
$memberID = int, member ID (members.id)
RETURN VALUE:
bool = True if loaded successfully, false otherwise

loadMessage(int $day, int $memberID, int $group) _v5

Load a single message from admin messages to member's AR messages. This feature overwrites member's edits.
PARAMETERS:
$memberID = int, member ID (members.id)
$day = int, folow up day
$group = int, contact group ID (contactgroups.id)
RETURN VALUE:
int = AR message id

loadMessageID(int $autoResponderID) _v5

Load a single message by its ID.
PARAMETERS:
$autoResponderID = int, Message ID
RETURN VALUE:
int = AR message id

save(array $fieldValues) _v5

Saves the record with the new values specified in the $fieldValuesarray.
PARAMETERS:
$fieldValues = Array of the values for each column when adding the record (Associative array with key = field name & value = field value).
RETURN VALUE:
Bool = True on success, False otherwise.

setMyMemberID(int $memberID) _v5

Sets member's ID
PARAMETERS:
$memberID = int, member id
RETURN VALUE:
VOID

setRestoreID(int $id) _v5

Sets restor point ID
PARAMETERS:
$id = int, restore ID
RETURN VALUE:
VOID

settingCanEditAR(bool $canEditAR = true) _v5

Enable/Disable members to edit AR messages.
PARAMETERS:
$canEditAR = bool, true to allow edit, false otherwise.
RETURN VALUE:
VOID.

settingHTTPS(bool $useHTTPS = true) _v5

Sets site to use https or http
PARAMETERS:
$useHTTPS = True if https on, false otherwise (default true).
RETURN VALUE:
VOID

settingLockAdminEmails(bool $lockAdminEmails = true) _v5

Lock/unlock admin emails. if email is locked members won't be able to edit them.
PARAMETERS:
$lockAdminEmails = bool, true to lock the emails, false otherwise.
RETURN VALUE:
VOID.

settingSiteURL(string $siteURL) _v5

Sets Site Domain
PARAMETERS:
$siteURL = String, site URL
RETURN VALUE:
VOID

showAllFields() _v5

Show all fields(columns)
PARAMETERS:
NONE
RETURN VALUE:
VOID

showField($fieldTitle) _v5

Shows specific field title by its column title
PARAMETERS:
$fieldTitle = String, Field title.
RETURN VALUE:
VOID

AutoResponder PHP Variables

$body _v5

String = Autoresponder email body content

$subject _v5

String = Autoresponder Subject

Columns in the emailautoresponders Database Table:

id subject body day member contactgroup countdown textbody allowdownlinecopy active calendar membership ishtml isadmin

Code Example

Use the code below to view a record in an html page:

<?php
// ###PUT YOUR CONTENT BELOW###
 $id = 1;  // The ID of the record being retrieved

// The HTML Code that we will convert the ~~ values inside of it
 $content = "<table>"; 
 $content .= "<tr><td>id<td>246</tr>";
 $content .= "<tr><td>subject<td>~subject~</tr>";
 $content .= "<tr><td>body<td>~body~</tr>";
 $content .= "<tr><td>day<td>~day~</tr>";
 $content .= "<tr><td>member<td>~member~</tr>";
 $content .= "<tr><td>contactgroup<td>~contactgroup~</tr>";
 $content .= "<tr><td>countdown<td>~countdown~</tr>";
 $content .= "<tr><td>textbody<td>~textbody~</tr>";
 $content .= "<tr><td>allowdownlinecopy<td>~allowdownlinecopy~</tr>";
 $content .= "<tr><td>active<td>~active~</tr>";
 $content .= "<tr><td>calendar<td>~calendar~</tr>";
 $content .= "<tr><td>membership<td>~membership~</tr>";
 $content .= "<tr><td>ishtml<td>~ishtml~</tr>";
 $content .= "<tr><td>isadmin<td>~isadmin~</tr>";
 $content .= "</table>";

// ###PUT YOUR CONTENT ABOVE###


 include("admin/load/nosession.php");

 $autoresponder = new AutoResponder();  //Create object
 $autoresponder->loadID($id);
 $converted = $autoresponder->convertHTML($content);  //Convert ~~ Codes

 echo $converted;  // Display results

Use the code below to add a record:

// ###PUT YOUR CONTENT BELOW###
 $id = 1;  // The ID of the record being retrieved

// The values to use for creating a new record
 $valueArray = array();
 $valueArray["id"] = "0";
 $valueArray["subject"] = "VARCHAR(100) NOT NULL";
 $valueArray["body"] = "TEXT NOT NULL";
 $valueArray["day"] = "SMALLINT NOT NULL";
 $valueArray["member"] = "INT UNSIGNED NOT NULL";
 $valueArray["contactgroup"] = "INT UNSIGNED NOT NULL DEFAULT 1";
 $valueArray["countdown"] = "BIT(1) NOT NULL DEFAULT 0";
 $valueArray["textbody"] = "TEXT NOT NULL";
 $valueArray["allowdownlinecopy"] = "BIT(1) NOT NULL DEFAULT 0";
 $valueArray["active"] = "BIT(1) NOT NULL DEFAULT 1";
 $valueArray["calendar"] = "INT UNSIGNED NOT NULL DEFAULT 0";
 $valueArray["membership"] = "SMALLINT UNSIGNED NOT NULL DEFAULT 0";
 $valueArray["ishtml"] = "BOOL NOT NULL DEFAULT 0";
 $valueArray["isadmin"] = "BIT(1) DEFAULT 0";

// ###PUT YOUR CONTENT ABOVE###


 include("admin/load/nosession.php");

 $autoresponder = new AutoResponder();  //Create object
 $autoresponder->add($valueArray);  // Add the record

 echo $autoresponder->getID();  // Echo the id of the newly created record

Use the code below to delete a record:

// ###PUT YOUR CONTENT BELOW###
 $id = 1;  // The ID of the record being deleted
// ###PUT YOUR CONTENT ABOVE###


 include("admin/load/nosession.php");

// Create object
 $autoresponder = new AutoResponder();
 $autoresponder->loadID($id);
 
// Delete and echo if success or failure
 if ($autoresponder->deletThis()) echo "Success";
 else echo "Failure";

Home | Partnership | Testimonials

Privacy/Terms | About Us | Contact Us

AutoResponder

AutoResponder PHP Methods

add(array $fieldValues) v5

checkLoaded() v5

convertHTML(string $htmlContent = "", string $prefix = "", bool $urlEncode = false) v5

delete(string $restoreQuery = "") v5

duplicate(array $newValues = null) v5

function load(string $queryWhere) v5

getBody(\WMT\SQL\Member\Member $member, \WMT\SQL\Contact\Contact $contact) v5

getDatabaseName() v5

getDefaultTRHTML() v5

getID() v5

getJSON(bool $returnArr = false) v5

getSubject(\WMT\SQL\Member\Member $member, \WMT\SQL\Contact\Contact $contact) v5

getValue(string $fieldName = "value") v5

hasField(string $fieldName) v5

hideAllFields() v5

hideField($fieldTitle) v5

isLoaded() v5

loadDoubleOptin(\WMT\SQL\Contact\Contact $contact, \WMT\SQL\Member\Member $member, int $contactGroupID) v5

loadFirstID() v5

loadID(int $id) v5

loadMember(int $memberID) v5

loadMessage(int $day, int $memberID, int $group) v5

loadMessageID(int $autoResponderID) v5

save(array $fieldValues) v5

setMyMemberID(int $memberID) v5

setRestoreID(int $id) v5

settingCanEditAR(bool $canEditAR = true) v5

settingHTTPS(bool $useHTTPS = true) v5

settingLockAdminEmails(bool $lockAdminEmails = true) v5

settingSiteURL(string $siteURL) v5

showAllFields() v5

showField($fieldTitle) v5