Skip to content

Latest commit

 

History

History
1621 lines (837 loc) · 38.9 KB

class.PaymentCCCore.md

File metadata and controls

1621 lines (837 loc) · 38.9 KB
Raw

Class PaymentCCCore

Contents

Properties

Methods

Properties

$amount

public mixed $amount
  • Visibility: public
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • Source: classes/PaymentCC.php line 37.

$card_brand

public mixed $card_brand
  • Visibility: public
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • Source: classes/PaymentCC.php line 40.

$card_expiration

public mixed $card_expiration
  • Visibility: public
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • Source: classes/PaymentCC.php line 41.

$card_holder

public mixed $card_holder
  • Visibility: public
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • Source: classes/PaymentCC.php line 42.

$card_number

public mixed $card_number
  • Visibility: public
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • Source: classes/PaymentCC.php line 39.

$date_add

public mixed $date_add
  • Visibility: public
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • Source: classes/PaymentCC.php line 43.

$definition

public mixed $definition = array('table' => 'payment_cc', 'primary' => 'id_payment_cc')
  • Visibility: public
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • This property is static.
  • Source: classes/PaymentCC.php line 51.

$fieldsRequired

protected mixed $fieldsRequired = array('id_currency', 'amount')
  • Visibility: protected
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • Source: classes/PaymentCC.php line 45.

$fieldsSize

protected mixed $fieldsSize = array('transaction_id' => 254, 'card_number' => 254, 'card_brand' => 254, 'card_expiration' => 254, 'card_holder' => 254)
  • Visibility: protected
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • Source: classes/PaymentCC.php line 46.

$fieldsValidate

protected mixed $fieldsValidate = array('id_order' => 'isUnsignedId', 'id_currency' => 'isUnsignedId', 'amount' => 'isPrice', 'transaction_id' => 'isAnything', 'card_number' => 'isAnything', 'card_brand' => 'isAnything', 'card_expiration' => 'isAnything', 'card_holder' => 'isAnything')
  • Visibility: protected
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • Source: classes/PaymentCC.php line 47.

$id_currency

public mixed $id_currency
  • Visibility: public
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • Source: classes/PaymentCC.php line 36.

$id_order

public mixed $id_order
  • Visibility: public
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • Source: classes/PaymentCC.php line 35.

$transaction_id

public mixed $transaction_id
  • Visibility: public
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • Source: classes/PaymentCC.php line 38.

$conversion_rate

public mixed $conversion_rate

$order_reference

public mixed $order_reference

$payment_method

public mixed $payment_method

$db

protected \Db $db = false

$def

protected array $def

$fieldsRequiredDatabase

protected mixed $fieldsRequiredDatabase = null

$fieldsRequiredLang

protected mixed $fieldsRequiredLang = array()

$fieldsSizeLang

protected mixed $fieldsSizeLang = array()

$fieldsValidateLang

protected mixed $fieldsValidateLang = array()

$get_shop_from_context

protected mixed $get_shop_from_context = true

$id

public integer $id

$id_lang

protected integer $id_lang = null

$id_shop

protected mixed $id_shop = null

$id_shop_list

public mixed $id_shop_list = null

$identifier

protected mixed $identifier

$image_dir

protected string $image_dir = null

$image_format

protected string $image_format = 'jpg'

$table

protected mixed $table

$tables

protected mixed $tables = array()

$update_fields

protected array $update_fields = null

$webserviceParameters

protected array $webserviceParameters = array()

Methods

__construct

mixed ObjectModelCore::__construct(integer $id, integer $id_lang, integer $id_shop)

Build object

Arguments

  • $id integer - Existing object id in order to load object (optional)
  • $id_lang integer - Required if object is multilingual (optional)
  • $id_shop integer - ID shop for objects with multishop on langs

add

mixed PaymentCCCore::add($autodate, $nullValues)
  • Visibility: public
  • Warning: this method is deprecated. This means that this method will likely be removed in a future version.
  • Source: classes/PaymentCC.php line 61

Arguments

  • $autodate mixed
  • $nullValues mixed

addFieldsRequiredDatabase

mixed ObjectModelCore::addFieldsRequiredDatabase($fields)

Arguments

  • $fields mixed

associateTo

boolean ObjectModelCore::associateTo(integer|array $id_shops)

This function associate an item to its context

Arguments

  • $id_shops integer|array

clearCache

mixed ObjectModelCore::clearCache($all)

Arguments

  • $all mixed

delete

boolean ObjectModelCore::delete()

Delete current object from database

deleteImage

boolean ObjectModelCore::deleteImage($force_delete)

Delete images associated with the object

Arguments

  • $force_delete mixed

deleteSelection

boolean ObjectModelCore::deleteSelection(array $selection)

Delete several objects from database

Arguments

  • $selection array

displayFieldName

mixed ObjectModelCore::displayFieldName($field, $class, $htmlentities, \Context $context)

Arguments

  • $field mixed
  • $class mixed
  • $htmlentities mixed
  • $context Context

duplicateObject

\new ObjectModelCore::duplicateObject()

Duplicate current object to database

duplicateShops

mixed ObjectModelCore::duplicateShops($id)

Arguments

  • $id mixed

existsInDatabase

boolean ObjectModelCore::existsInDatabase(integer $id_entity, string $table)

Specify if an ObjectModel is already in database

Arguments

  • $id_entity integer
  • $table string

formatFields

array ObjectModelCore::formatFields(integer $type, integer $id_lang)

Arguments

  • $type integer - FORMAT_COMMON or FORMAT_LANG or FORMAT_SHOP
  • $id_lang integer - If this parameter is given, only take lang fields

formatValue

mixed ObjectModelCore::formatValue(mixed $value, integer $type, $with_quotes)

Format a data

Arguments

  • $value mixed
  • $type integer
  • $with_quotes mixed

getAssociatedShops

array ObjectModelCore::getAssociatedShops()

Get the list of associated id_shop

getByInvoiceId

\Collection OrderPaymentCore::getByInvoiceId($id_invoice)

Get Order Payments By Invoice ID

Arguments

  • $id_invoice mixed - Invoice ID

getByOrderId

array PaymentCCCore::getByOrderId(integer $id_order)

Get the detailed payment of an order

  • Visibility: public
  • This method is static.
  • Warning: this method is deprecated. This means that this method will likely be removed in a future version.
  • Source: classes/PaymentCC.php line 74

Arguments

  • $id_order integer

getByOrderReference

array OrderPaymentCore::getByOrderReference(integer $order_reference)

Get the detailed payment of an order

Arguments

  • $order_reference integer

getDefinition

array ObjectModelCore::getDefinition(string $class, string $field)

Get object definition

Arguments

  • $class string - Name of object
  • $field string - Name of field if we want the definition of one field only

getFieldByLang

mixed ObjectModelCore::getFieldByLang($field_name, null $id_lang)

Return the field value for the specified language if the field is multilang, else the field value.

Arguments

  • $field_name mixed
  • $id_lang null

getFields

array ObjectModelCore::getFields()

Prepare fields for ObjectModel class (add, update) All fields are verified (pSQL, intval.

..)

getFieldsLang

array ObjectModelCore::getFieldsLang()

Prepare multilang fields

getFieldsRequiredDatabase

mixed ObjectModelCore::getFieldsRequiredDatabase($all)

Arguments

  • $all mixed

getFieldsShop

array ObjectModelCore::getFieldsShop()

Prepare fields for multishop Fields are not validated here, we considere they are already validated in getFields() method, this not the best solution but this is the only one possible for retro compatibility.

getOrderInvoice

mixed OrderPaymentCore::getOrderInvoice(integer $id_order)

Return order invoice object linked to the payment

Arguments

  • $id_order integer - Order Id

getTranslationsFields

mixed ObjectModelCore::getTranslationsFields($fields_array)

Arguments

  • $fields_array mixed

getValidationRules

array ObjectModelCore::getValidationRules(string $class)

Returns object validation rules (fields validity)

Arguments

  • $class string - Child class name for static use (optional)

getWebserviceObjectList

mixed ObjectModelCore::getWebserviceObjectList($sql_join, $sql_filter, $sql_sort, $sql_limit)

Arguments

  • $sql_join mixed
  • $sql_filter mixed
  • $sql_sort mixed
  • $sql_limit mixed

getWebserviceParameters

mixed ObjectModelCore::getWebserviceParameters($ws_params_attribute_name)

Arguments

  • $ws_params_attribute_name mixed

hasMultishopEntries

boolean ObjectModelCore::hasMultishopEntries()

Check if there is more than one entries in associated shop table for current entity

hydrate

mixed ObjectModelCore::hydrate(array $data, integer $id_lang)

Fill an object with given data. Data must be an array with this syntax: array(objProperty => value, objProperty2 => value, etc.)

Arguments

  • $data array
  • $id_lang integer

hydrateCollection

array ObjectModelCore::hydrateCollection(string $class, array $datas, integer $id_lang)

Fill (hydrate) a list of objects in order to get a collection of these objects

Arguments

  • $class string - Class of objects to hydrate
  • $datas array - List of data (multi-dimensional array)
  • $id_lang integer

isAssociatedToShop

boolean ObjectModelCore::isAssociatedToShop(integer $id_shop)

Check if current object is associated to a shop

Arguments

  • $id_shop integer

isCurrentlyUsed

boolean ObjectModelCore::isCurrentlyUsed(string $table, boolean $has_active_column)

This method is allow to know if a entity is currently used

Arguments

  • $table string - name of table linked to entity
  • $has_active_column boolean - true if the table has an active column

isLangMultishop

mixed ObjectModelCore::isLangMultishop()

isMultishop

mixed ObjectModelCore::isMultishop()

makeTranslationFields

mixed ObjectModelCore::makeTranslationFields($fields, $fields_array, $id_language)

Arguments

  • $fields mixed
  • $fields_array mixed
  • $id_language mixed

save

boolean ObjectModelCore::save(boolean $null_values, boolean $autodate)

Save current object to database (add or update)

Arguments

  • $null_values boolean
  • $autodate boolean

setDefinitionRetrocompatibility

mixed ObjectModelCore::setDefinitionRetrocompatibility()

Retrocompatibility for classes without $definition static Remove this in 1.6 !

setFieldsToUpdate

mixed ObjectModelCore::setFieldsToUpdate(array $fields)

Set a list of specific fields to update array(field1 => true, field2 => false, langfield1 => array(1 => true, 2 => false))

Arguments

  • $fields array

toggleStatus

boolean ObjectModelCore::toggleStatus()

Toggle object status in database

update

boolean ObjectModelCore::update(boolean $null_values)

Update current object to database

Arguments

  • $null_values boolean

updateMultishopTable

boolean ObjectModelCore::updateMultishopTable(string $classname, array $data, string $where, string $specific_where)

Update a table and splits the common datas and the shop datas

Arguments

  • $classname string
  • $data array
  • $where string
  • $specific_where string - Only executed for common table

validateControler

mixed ObjectModelCore::validateControler($htmlentities)

TODO: refactor rename all calls to this to validateController

Arguments

  • $htmlentities mixed

validateController

mixed ObjectModelCore::validateController($htmlentities)

Arguments

  • $htmlentities mixed

validateField

boolean|string ObjectModelCore::validateField(string $field, mixed $value, integer $id_lang)

Validate a single field

Arguments

  • $field string - Field name
  • $value mixed - Field value
  • $id_lang integer

validateFields

boolean|string ObjectModelCore::validateFields(boolean $die, boolean $error_return)

Check for fields validity before database interaction

Arguments

  • $die boolean
  • $error_return boolean

validateFieldsLang

boolean|string ObjectModelCore::validateFieldsLang(boolean $die, boolean $error_return)

Check for multilingual fields validity before database interaction

Arguments

  • $die boolean
  • $error_return boolean

validateFieldsRequiredDatabase

mixed ObjectModelCore::validateFieldsRequiredDatabase($htmlentities)

Arguments

  • $htmlentities mixed