Components \ commerce \ affiliates administrators commissions payments \ configuration paymentmethods \ shippingmethods \ methods delivery discounts \ products brands categories \ recurringsales storedcards \ sales items \ receipts allocations \ customers \ contacts passwords referrertypes \ relationships types \ groups contacts \ marketing \ emailmarketing \ sends contacts unsubscribers \ events attendees locations \ reminders \ automation eventremindertrigger \ settings administrators components configurationitems cpanel customfields \ developer scheduledtasks threads domains \ website \ analytics sessions comments \ designs generator media pages \ posts categories Framework \ architecture publicassets \ assets css javascript \ caching filebased \ components textualids \ data util \ database mainconnection date \ dom currentcontext renderer \ html converters highlighter javascript \ http redirection request session useragent \ i18n companytypes countries languages \ network cidr dns geoip random \ reflection api \ system filenames filesystem toasts
.
.
.
quick access
\ methods

\Components\Commerce\RecurringSales::

Class Methods

The following static methods are available on this class:
string configGetValue($strConfigId)
Description
Retrieves the value of a config item for the current component
Parameters
$strConfigId
string
Return
Config item value
bool delete($strKeyValue, $bDeleteMedia, $strReason)
Description
Deletes an entity and triggers the pre/post component events
Parameters
$strKeyValue
string
$bDeleteMedia
bool
$strReason
mixed
Return
bool
array get($strKey)
Description
Returns an entity
Parameters
$strKey
mixed
Value of the primary key
{Array} getAll($arrProperties)
Description
Return all entities in the database.
Parameters
$arrProperties
mixed
Return
Array of RecurringSales
mixed getColumn($strKey, $strColumn)
Description
Returns a single column of an entity
Parameters
$strKey
string
$strColumn
string
Return
mixed
int getCount($arrFilter)
Description
Returns a count of all rows in the data adapter
Parameters
$arrFilter
array
Return
int
string mediaFolderGet($strKey)
Description
Returns the media folder for this data adapter
Parameters
$strKey
mixed
Return
Folder
mixed save($arrEntity, $strReason)
Description
Saves an entity and triggers the pre/post component events
Parameters
$arrEntity
array
$strReason
string
Return
mixed
mixed saveColumn($strKeyValue, $strColumn, $strValue, $strReason)
Description
Changes a column of an existing entity Supports primary keys spanning on several columns if passing $strKeyValue as an associative arry
Parameters
$strKeyValue
string
$strColumn
string
$strValue
string
$strReason
string
Return
Id
array search($strSearch, $arrProperties)
Description
Performs a search
Parameters
$strSearch
string
$arrProperties
mixed
Return
array

Database Fields

The following fields are used when retrieving and saving entities.
administrator_id
int (11)
affiliate_id
int unsigned (10)
contact_company
varchar (127)
contact_email
varchar (127)
contact_first_name
varchar (63)
contact_id
int (10)
contact_last_name
varchar (63)
contact_type
enum ('Individual','Company')
Default value: Individual
recurring_sale_comment
text
recurring_sale_country_id
varchar (3)
Default value: AUS
recurring_sale_created_by_sale_item
int unsigned (10)
recurring_sale_creation_datetime
datetime
recurring_sale_currency_id
varchar (3)
Default value: AUD
recurring_sale_id
int unsigned (10)
recurring_sale_payment_method_id
int (11)
recurring_sale_run_balance
decimal (10,4)
recurring_sale_run_count
int unsigned (10)
recurring_sale_run_last
datetime
recurring_sale_run_next
datetime
recurring_sale_run_next_override
datetime
recurring_sale_run_total
decimal unsigned (10,4)
recurring_sale_schedule_interval
enum ('weekly','fortnightly','monthly','quarterly','yearly')
recurring_sale_shipping_method_data
text
recurring_sale_shipping_method_id
int (11)
recurring_sale_status
enum ('active','paused','complete','deleted')
Default value: active
recurring_sale_terminated_datetime
datetime
recurring_sale_total
decimal unsigned (10,4)