MemberVariable

Database Table: membervars
Extends: Result
Extends: AbstractDatabase

MemberVariable 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

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

getDefaultValueHTML() _v5

Replaces ~defaultvalue~ tilde code with member variable default value
PARAMETERS:
NONE
RETURN VALUE:
String = $defaultValueHTML after converting the default value tilde code

getFieldTypeString() _v5

Get field type for the loaded member variable
PARAMETERS:
NONE
RETURN VALUE:
String = field type for the loaded member variable like (text/textarea/options etc)

getID() _v5

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

getInput($miscTRMemberVar, $member = null) _v5

Gets HTML input field for the loaded member variable
PARAMETERS:
$miscTRMemberVar = string, HTML template of the member variable field
$member = object, load member's default value if the field value is empty
RETURN VALUE:
String = HTML input field for the loaded member variable

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

getLocationHTML() _v5

Gets where the member variable will show (in join page or in profile or settings)
PARAMETERS:
NONE
RETURN VALUE:
String = HTML badge containing list of locations where the member variable will show

getMembershipsHTML() _v5

Gets loaded member variable HTML row including title and access memberships
PARAMETERS:
NONE
RETURN VALUE:
string = loaded member variable HTML row including title and access memberships

getOnCreateString() _v5

Checks if the member variable is set to show on join page
PARAMETERS:
NONE
RETURN VALUE:
String = text specifying if the member variable is set to show on the join page

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

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

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.

setDefaultValueHTML(string $html) _v5

Set HTML for the default value for the loaded member variable
PARAMETERS:
$html = string, HTML for the member variable default value
RETURN VALUE:
VOID

setMembershipsHTML(string $html, array $membershipTitleArr) _v5

Set HTML for the memberships list for the loaded member variable
PARAMETERS:
$html = string, HTML for the member variable membership access list
$membershipTitleArr = array, memberships title
RETURN VALUE:
VOID

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

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

settingPreloadDefault(bool $preloadDefault = true) _v5

Change settings for member variable preload default
PARAMETERS:
$preloadDefault = bool, true to preload default, 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

MemberVariable PHP Variables

🔎︎ %l4610%

Columns in the membervars Database Table:

id title description fieldtype oncreate defaultvalue selectoptions dorder membership passup location required

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>213</tr>";
 $content .= "<tr><td>title<td>~title~</tr>";
 $content .= "<tr><td>description<td>~description~</tr>";
 $content .= "<tr><td>fieldtype<td>~fieldtype~</tr>";
 $content .= "<tr><td>oncreate<td>~oncreate~</tr>";
 $content .= "<tr><td>defaultvalue<td>~defaultvalue~</tr>";
 $content .= "<tr><td>selectoptions<td>~selectoptions~</tr>";
 $content .= "<tr><td>dorder<td>~dorder~</tr>";
 $content .= "<tr><td>membership<td>~membership~</tr>";
 $content .= "<tr><td>passup<td>~passup~</tr>";
 $content .= "<tr><td>location<td>~location~</tr>";
 $content .= "<tr><td>required<td>~required~</tr>";
 $content .= "</table>";

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


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

 $membervariable = new MemberVariable();  //Create object
 $membervariable->loadID($id);
 $converted = $membervariable->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"] = "SMALLINT UNSIGNED NOT NULL AUTO_INCREMENT";
 $valueArray["title"] = "VARCHAR(100) NOT NULL";
 $valueArray["description"] = "TEXT NOT NULL";
 $valueArray["fieldtype"] = "TINYINT NOT NULL DEFAULT 1";
 $valueArray["oncreate"] = "BIT(1) NOT NULL DEFAULT 0";
 $valueArray["defaultvalue"] = "TEXT NOT NULL";
 $valueArray["selectoptions"] = "TEXT NOT NULL";
 $valueArray["dorder"] = "TINYINT UNSIGNED NOT NULL";
 $valueArray["membership"] = "SMALLINT UNSIGNED NOT NULL DEFAULT 0";
 $valueArray["passup"] = "TINYINT UNSIGNED NOT NULL DEFAULT 0";
 $valueArray["location"] = "TINYINT NOT NULL DEFAULT 0";
 $valueArray["required"] = "BIT(1) NOT NULL DEFAULT 0";

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


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

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

 echo $membervariable->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
 $membervariable = new MemberVariable();
 $membervariable->loadID($id);
 
// Delete and echo if success or failure
 if ($membervariable->deletThis()) echo "Success";
 else echo "Failure";

Home | Partnership | Testimonials

Privacy/Terms | About Us | Contact Us

MemberVariable

MemberVariable 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

getDatabaseName() v5

getDefaultTRHTML() v5

getDefaultValueHTML() v5

getFieldTypeString() v5

getID() v5

getInput($miscTRMemberVar, $member = null) v5

getJSON(bool $returnArr = false) v5

getLocationHTML() v5

getMembershipsHTML() v5

getOnCreateString() v5

getValue(string $fieldName = "value") v5

hasField(string $fieldName) v5

hideAllFields() v5

hideField($fieldTitle) v5

isLoaded() v5

loadFirstID() v5

loadID(int $id) v5

save(array $fieldValues) v5

setDefaultValueHTML(string $html) v5

setMembershipsHTML(string $html, array $membershipTitleArr) v5

setMyMemberID(int $memberID) v5

setRestoreID(int $id) v5

settingHTTPS(bool $useHTTPS = true) v5

settingPreloadDefault(bool $preloadDefault = true) v5

settingSiteURL(string $siteURL) v5

showAllFields() v5

showField($fieldTitle) v5