\Components\Commerce\Affiliates \Components\Commerce\Affiliates\Administrators \Components\Commerce\Affiliates\Commissions \Components\Commerce\Affiliates\Payments \Components\Commerce\Configuration\PaymentMethods \Components\Commerce\Configuration\ShippingMethods \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\RecurringSales \Components\Commerce\RecurringSales\StoredCards \Components\Commerce\Sales \Components\Commerce\Sales\Items \Components\Commerce\Sales\Receipts \Components\Commerce\Sales\Receipts\Allocations \Components\Customers\Contacts \Components\Customers\Contacts\Relationships \Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups \Components\Customers\Groups\Contacts \Components\Marketing\EmailMarketing \Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Locations \Components\Settings\Administrators \Components\Settings\Domains \Components\Website\Analytics\Sessions \Components\Website\Comments \Components\Website\Designs \Components\Website\Media \Components\Website\Pages \Components\Website\Pages\Forms \Components\Website\Posts \Components\Website\Posts\Categories \Framework\Architecture\PublicAssets \Framework\Assets\CSS \Framework\Assets\JavaScript \Framework\Caching\FileBased \Framework\Data\Util \Framework\Database\MainConnection \Framework\Date \Framework\DOM\Renderer \Framework\HTML\Converters \Framework\HTML\Highlighter \Framework\HTML\JavaScript \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages \Framework\Network\CIDR \Framework\Network\DNS \Framework\Network\GeoIP \Framework\Random \Framework\System\FileNames \Framework\System\FileSystem \Framework\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','every two months','quarterly','half yearly','yearly''weekly','fortnightly','monthly','every two months','quarterly','half yearly','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)