SoftwareFileAccesses

addApostrophe(string $dbColumn, string $newField) _v5

Allows you to have an apostrophe separated content in the results that are returned.
PARAMETERS:
$dbColumn = String, The column name of the record.
$newField = String, New field name
RETURN VALUE:
VOID

addConditionalContent(string $cField, string $cValue, string $cTilde, string $cContent) _v5

Allows you to have dynamic data displayed in the results for each record that has a column that matches a specific value. If the value of the $cField column equals $cValue then $cContent is replaced with the value of $cTilde for that record inside the results returned. If $cField does not match $cValue then $cTilde is replaced with a blank value
PARAMETERS:
$cField = String, The name of the column in the database to use to compare against value.
$cValue = String, The compare value.
$cTilde = String, The title of the tilde used in the string used for formatting the results (exa: ~mytilde~).
$cContent = String, The content that replaces the tilde in the records that contain a match.
RETURN VALUE:
VOID

addDate(string $dbColumn, string $nDate) _v5

Allows you to have a timestamp value to be formatted as a date in the results that are returned.
PARAMETERS:
$dbColumn = String, The column name of the record that contains a time stamp.
$nDate = string, The format of the date to return.Follows the same format as the date() php function.
RETURN VALUE:
VOID

addDateAgo(string $dbColumn, int $abbr = -1) _v5

Creates dates like for example X days ago
PARAMETERS:
$dbColumn = String, The column name of the records that contains the timestamp.
$abbr = int, abbreviation.
RETURN VALUE:
VOID

addMethod(string $fField, string $fName) _v5

Adds a method to be called and used to get the value for a column field in the results. The value returned by the method is used.
PARAMETERS:
$fField = String, The name of the column that should use the method to get it's value.
$fName = String, The name of the method belonging to the object that should be called.
RETURN VALUE:
VOID

addMoney(string $dbColumn) _v5

Allows you to have a money formatted in the results that are returned.
PARAMETERS:
$dbColumn = String, The column name of the record that contains a number to be formatted as money.
RETURN VALUE:
VOID

addPhone(string $dbColumn, string $phoneFormat = "(###) ###-####") _v5

Allows you to have a phone number formatted in the results that are returned.
PARAMETERS:
$dbColumn = String, The column name of the record that contains a phone number.
$phoneFormat = string, The format of the phone number to return.
RETURN VALUE:
VOID

addSmartDate(string $dbColumn, int $displayType = 1, int $showTime = -1, int $showYear = -1, int $abbrMonth = 1, int $abbrDay = 0, int $abbrOther = 0, int $relType = 1) _v5

Allows creating a smart date.
PARAMETERS:
$dbColumn = String, The column name of the records that contains the timestamp.
$displayType = int, display type.
$showTime = int, -1 don't show time
$showYear = int, -1 don't show year
$abbrMonth = int, Month abbreviation.
$abbrDay = int, Day abbreviation.
$abbrOther = int, other abbreviation.
$relType = int, relType.
RETURN VALUE:
VOID

addValueLabel(string $dbColumn, array $labelArray) _v5

This method allows you to have a column that contains integers replaced with value of an array where they key of the array matches the value of the integer in the column.
PARAMETERS:
$dbColumn = String, The column name of the records that contain an integers that should have their values replaced.
$labelArray = array, An array where the key of the array maps to the value inside the results column. The value of that array is then used in place of the value in the column wherever the column value matches a key in the array. If the value of the column does not have a corresponding key in the array then the column value is used without being substituted.
RETURN VALUE:
VOID

cacheOn() _v5

Turn cache on
PARAMETERS:
None
RETURN VALUE:
void

canDeleteAll(bool $allowDeleteAll = true, string $url = "", string $containerID = "div1361") _v5

Give/deny permission to everyone to page records.
PARAMETERS:
$allowDeleteAll = Bool, true to allow, false otherwise.
$url = String, Delete URL.
$containerID = String, div container id attribute.
RETURN VALUE:
VOID

canEditAll(bool $allowEditAll = true, string $editOffHTML = "", string $editOnHTML = "") _v5

Allow/deny all members to edit HTML content.
PARAMETERS:
$allowDeleteAll = Bool, true to allow, false otherwise.
$editOffHTML = String, content as text.
$editOnHTML = String, content as HTML.
RETURN VALUE:
VOID

canMemberDelete(int $memberID, string $url = "", string $containerID = "div1364") _v5

Allow a member to delete records for a page.
PARAMETERS:
$memberID = int, Member id.
$url = String, delete record URL.
$containerID = String, div container id attribute.
RETURN VALUE:
VOID

canMemberEdit(int $memberID, string $editOffHTML, string $editOnHTML = "") _v5

Allow/deny a member to edit HTML content.
PARAMETERS:
$memberID = int, Member ID.
$editOffHTML = String, content as text.
$editOnHTML = String, content as HTML.
RETURN VALUE:
VOID

cloneObject() _v5

Clone the loaded object.
PARAMETERS:
NONE
RETURN VALUE:
VOID

convertNoResults(string $content) _v5

Convert tilde codes for no results misc page to values
PARAMETERS:
$content = String, no results page HTML content.
RETURN VALUE:
String = Converted HTML content

getArray(string $dbColumn = "", string $whereQuery = "", string $orderQuery = "") _v5

Returns results as an array. If cache is on; it copies the array to the cache
PARAMETERS:
$dbColumn = String, Column name
$whereQuery = String, SQL where query
$orderQuery = String, SQL order query
RETURN VALUE:
Array = results array

getCheckbox(string $dbColumn, string $inputName, bool $allChecked = false, string $whereQuery = "", string $orderQuery = "") _v5

Gets html for column values as checkboxes.
PARAMETERS:
$dbColumn = String, Column title
$inputName = String, checkbox input attribute
$allChecked = bool, true to default all checkboxes as checked, false otherwise
$whereQuery = String, SQL where query
$orderQuery = String, SQL order query
RETURN VALUE:
String = checkboxes HTML ordered as $orderQuery

getCount() _v5

Returns the number of results found once the object has been loaded.
PARAMETERS:
NONE
RETURN VALUE:
int = Number of results

getDatabaseName() _v5

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

getIDArray(string $idTitle = null) _v5

Returns an array of results from the database table where id=$idTitle.
PARAMETERS:
$idTitle = String, column id title
RETURN VALUE:
array = results array

getObjects(string $query) _v5

Get all objects without needing the following code:
$this->setResultLimit(0);
$this->useObjectsOn();
$this->query($query);
$this->getResults();
PARAMETERS:
$query = String, SQL query
RETURN VALUE:
the results as objects
$this->getResults();

getOptions(string $dbColumn = "", string $whereQuery = "", string $orderQuery = "") _v5

Displays the returned results as select options HTML
PARAMETERS:
$dbColumn = String, Column name
$whereQuery = String, SQL where query
$orderQuery = String, SQL order query
RETURN VALUE:
String = select options HTML tags

getOptionsInnerJoinTable(string $tableName, $whereQuery = "") _v5

Inner joins current table to another table ($tableName) and display the results as select options html
PARAMETERS:
$tableName = String, table name
$whereQuery = String, SQL where query
RETURN VALUE:
String = select options HTML

getPages(string $filename, string $pTitle = "", string $ajaxDivID = "") _v5

Returns a string of links to pages providing a pagination index for the results. If the results only contains 1 page then this message returns a blank string.
PARAMETERS:
$filename = String, The name of the filename that the pagination links should point to.
$pTitle = String, The title that should appear before the links if there is more than one page (if only 1 page the results returned is blank),
$ajaxDivID = String, load container div id attribute.
RETURN VALUE:
String = links to pages providing a pagination index as HTML

getResultLimit() _v5

Gets the maximum results that are allowed per a page.
PARAMETERS:
NONE
RETURN VALUE:
int = the maximum results that are allowed per a page. If 0 is returned it means that there is no limit and all of the results are returned on the first page.

getResults( _v5

Returns an array of the results found. This is normally only used when objects are turned on (useObjectsOn())
PARAMETERS:
NONE
RETURN VALUE:
array = Results found.

getSum(string $whereQuery, string $dbColumn) _v5

Gets sum number of fields returned from a query.
PARAMETERS:
$whereQuery = String, SQL where query.
$dbColumn = String, Column name that contains the values which we want to get the SUM for
RETURN VALUE:
int = Sum result

getTable(string $trTemplate = "") _v5

Returns a formatted string of the results.
PARAMETERS:
$trTemplate = String, The formatting to use for each row of data returned. ~COLUMNNAME~ can be used to specify where a value should appear in the results. For example 100 would be replaced by the value of the id column in the results. If left blank returns a table tr for each row that contains all of the columns in the database table.
RETURN VALUE:
String = formatted string as used in trTemplate

getTotal(string $whereQuery) _v5

Gets total number of records returned from a query.
PARAMETERS:
$whereQuery = SQL where query.
RETURN VALUE:
int = Number of records

getValue(int $itemID, string $dbColumn) _v5

Returns the value of a specific column for the specified id.
PARAMETERS:
$itemID = int, the record ID
$dbColumn = string, column name
RETURN VALUE:
string: 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

hideAllFields() _v5

Allows you hide all fields from the results
PARAMETERS:
NONE
RETURN VALUE:
VOID

hideField($fieldTitle) _v5

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

hideField($fieldTitle) _v5

Allows you hide a column from the results
PARAMETERS:
$fieldTitle = String, The column title.
RETURN VALUE:
VOID

loadAll() _v5

Loads all of the records in the database table.
PARAMETERS:
NONE
RETURN VALUE:
VOID

loadCustomQuery(string $query) _v5

Loads the results from a mysql query statement.
PARAMETERS:
$query = String, The mysql query to use to select the results from the database table.
RETURN VALUE:
VOID

query(string $query) _v5

Loads the results from a mysql query statement.
PARAMETERS:
$query = String, mysql query statement
RETURN VALUE:
VOID

setNoResultsHTML(string $noResultsHTML) _v5

Sets HTML content for no results.
PARAMETERS:
$noResultsHTML = String, no results HTML content.
RETURN VALUE:
void

setPage(int $nPage) _v5

Defines which page of results should be returned when using a method that returns the results.
PARAMETERS:
$nPage = int, page number
RETURN VALUE:
VOID

setPageNumberHTML(string $pageNumberHTML) _v5

Sets page number HTML content.
PARAMETERS:
$pageNumberHTML = String, Page Number HTML content.
RETURN VALUE:
VOID

setPageNumberTRHTML(string $pageNumberTRHTML) _v5

Sets HTML for page number item.
PARAMETERS:
$pageNumberTRHTML = String, HTML content for page number item.
RETURN VALUE:
void

setResultLimit(int $nResultLimit) _v5

The amount of results to return per a page.
PARAMETERS:
$nResultLimit = int, defining the amount of results to display on each page. If set to 0 returns all the results on a single page.
RETURN VALUE:
VOID

setTotalShowPages(int $totalShowPages) _v5

The max number pages.
PARAMETERS:
$totalShowPages = int, number of pages (Default 10).
RETURN VALUE:
VOID

setVisitorMemberID(int $memberID) _v5

Sets current visitor member id
PARAMETERS:
$memberID = int, Member id.
RETURN VALUE:
VOID

showAllFields() _v5

Allows you show all fields to the results
PARAMETERS:
NONE
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

showField($fieldTitle) _v5

Allows you show a column to the results
PARAMETERS:
$fieldTitle = String, The column title.
RETURN VALUE:
VOID

useObjectsOff() _v5

Turns off using objects for storing/retrieving values from the results. By default using objects is turned off.
PARAMETERS:
NONE
RETURN VALUE:
VOID

useObjectsOn(\WMT\SQL\Result $emptyResultObject) _v5

Turns on using objects for storing/retrieving values from the results. By default using objects is turned off.
PARAMETERS:
NONE
RETURN VALUE:
VOID

__construct(\WMT\MySQL $mysqli, \WMT\Format\Number $formatNumber, string $databaseTable = "") _v5

PARAMETERS:
$databaseTable = String, If $databaseTable is specified then it opens for the specified database table.
RETURN VALUE:
void

<?php
 include("admin/load/nosession.php");
 $softwarefileaccesses->