Skip to content

Latest commit

 

History

History
2030 lines (1079 loc) · 49 KB

class.ConfigurationCore.md

File metadata and controls

2030 lines (1079 loc) · 49 KB
Raw

Class ConfigurationCore

2007-2015 PrestaShop

NOTICE OF LICENSE

This source file is subject to the Open Software License (OSL 3.0) that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://opensource.org/licenses/osl-3.0.php If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

DISCLAIMER

Do not edit or add to this file if you wish to upgrade PrestaShop to newer versions in the future. If you wish to customize PrestaShop for your needs please refer to http://www.prestashop.com for more information.

Contents

Properties

Methods

Properties

$_cache

protected array $_cache = array()

$date_add

public string $date_add

$date_upd

public string $date_upd

$definition

public mixed $definition = array('table' => 'configuration', 'primary' => 'id_configuration', 'multilang' => true, 'fields' => array('name' => array('type' => self::TYPE_STRING, 'validate' => 'isConfigName', 'required' => true, 'size' => 254), 'id_shop_group' => array('type' => self::TYPE_NOTHING, 'validate' => 'isUnsignedId'), 'id_shop' => array('type' => self::TYPE_NOTHING, 'validate' => 'isUnsignedId'), 'value' => array('type' => self::TYPE_STRING), 'date_add' => array('type' => self::TYPE_DATE, 'validate' => 'isDate'), 'date_upd' => array('type' => self::TYPE_DATE, 'validate' => 'isDate')))

$id

public mixed $id

$id_shop

public mixed $id_shop

$id_shop_group

public mixed $id_shop_group

$name

public string $name

$types

protected array $types = array()

$value

public string $value

$webserviceParameters

protected mixed $webserviceParameters = array('fields' => array('value' => array()))

$cache_objects

protected boolean $cache_objects = true

$db

protected \Db $db = false

$def

protected array $def

$fieldsRequired

protected array $fieldsRequired = array()

$fieldsRequiredDatabase

protected array $fieldsRequiredDatabase = null

$fieldsRequiredLang

protected array $fieldsRequiredLang = array()

$fieldsSize

protected array $fieldsSize = array()

$fieldsSizeLang

protected array $fieldsSizeLang = array()

$fieldsValidate

protected array $fieldsValidate = array()

$fieldsValidateLang

protected array $fieldsValidateLang = array()

$force_id

public boolean $force_id = false

$get_shop_from_context

protected boolean $get_shop_from_context = true

$id_lang

protected integer $id_lang = null

$id_shop_list

public array $id_shop_list = null

$identifier

protected string $identifier

$image_dir

protected string $image_dir = null

$image_format

protected String $image_format = 'jpg'

$loaded_classes

protected array $loaded_classes = array()

Holds compiled definitions of each ObjectModel class.

Values are assigned during object initialization.

$table

protected string $table

$tables

protected array $tables = array()

$update_fields

protected array $update_fields = null

Methods

__construct

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

Builds the object

Arguments

  • $id integer|null - If specified, loads and existing object from DB (optional).
  • $id_lang integer|null - Required if object is multilingual (optional).
  • $id_shop integer|null - ID shop for objects with multishop tables.

add

boolean ObjectModelCore::add(boolean $auto_date, boolean $null_values)

Adds current object to the database

Arguments

  • $auto_date boolean
  • $null_values boolean

addFieldsRequiredDatabase

boolean ObjectModelCore::addFieldsRequiredDatabase(array $fields)

Sets required field for this class in the database.

Arguments

  • $fields array

associateTo

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

This function associate an item to its context

Arguments

  • $id_shops integer|array

cacheFieldsRequiredDatabase

mixed ObjectModelCore::cacheFieldsRequiredDatabase(boolean $all)

Caches data about required objects fields in memory

Arguments

  • $all boolean - If true, caches required fields of all object classes.

clearCache

mixed ObjectModelCore::clearCache(boolean $all)

Clears cache entries that have this object's ID.

Arguments

  • $all boolean - If true, clears cache for all objects

clearConfigurationCacheForTesting

mixed ConfigurationCore::clearConfigurationCacheForTesting()

WARNING: For testing only. Do NOT rely on this method, it may be removed at any time.

configurationIsLoaded

mixed ConfigurationCore::configurationIsLoaded()

delete

boolean ObjectModelCore::delete()

Deletes current object from database

deleteByName

boolean ConfigurationCore::deleteByName(string $key)

Delete a configuration key in database (with or without language management)

Arguments

  • $key string - Key to delete

deleteFromContext

mixed ConfigurationCore::deleteFromContext(string $key)

Delete configuration key from current context.

Arguments

  • $key string

deleteImage

boolean ObjectModelCore::deleteImage(boolean $force_delete)

Delete images associated with the object

Arguments

  • $force_delete boolean

deleteSelection

boolean ObjectModelCore::deleteSelection(array $ids)

Deletes multiple objects from the database at once

Arguments

  • $ids array - Array of objects IDs.

disableCache

mixed ObjectModelCore::disableCache()

Disables object caching

displayFieldName

string ObjectModelCore::displayFieldName(string $field, string $class, boolean $htmlentities, \Context|null $context)

Returns field name translation

Arguments

  • $field string - Field name
  • $class string - ObjectModel class name
  • $htmlentities boolean - If true, applies htmlentities() to result string
  • $context Context|null - Context object

duplicateObject

\ObjectModel|false ObjectModelCore::duplicateObject()

Takes current object ID, gets its values from database, saves them in a new row and loads newly saved values as a new object.

duplicateShops

boolean|void ObjectModelCore::duplicateShops($id)

Copies shop association data from object with specified ID.

Arguments

  • $id mixed

enableCache

mixed ObjectModelCore::enableCache()

Enables object caching

existsInDatabase

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

Checks if an object exists in database.

Arguments

  • $id_entity integer
  • $table string

formatFields

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

Formats values of each fields.

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, boolean $with_quotes, boolean $purify, boolean $allow_null)

Formats a value

Arguments

  • $value mixed
  • $type integer
  • $with_quotes boolean
  • $purify boolean
  • $allow_null boolean

get

string ConfigurationCore::get(string $key, integer $id_lang, $id_shop_group, $id_shop)

Get a single configuration value (in one language only)

Arguments

  • $key string - Key wanted
  • $id_lang integer - Language ID
  • $id_shop_group mixed
  • $id_shop mixed

getAssociatedShops

array ObjectModelCore::getAssociatedShops()

Gets the list of associated shop IDs

getDefinition

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

Returns object definition

Arguments

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

getFieldByLang

mixed ObjectModelCore::getFieldByLang(string $field_name, integer|null $id_lang)

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

Arguments

  • $field_name string
  • $id_lang integer|null

getFields

array ObjectModelCore::getFields()

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

..)

getFieldsLang

boolean|array ConfigurationCore::getFieldsLang()

getFieldsRequiredDatabase

array|null ObjectModelCore::getFieldsRequiredDatabase(boolean $all)

Returns an array of required fields

Arguments

  • $all boolean - If true, returns required fields of all object classes.

getFieldsShop

array ObjectModelCore::getFieldsShop()

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

getGlobalValue

mixed ConfigurationCore::getGlobalValue($key, $id_lang)

Arguments

  • $key mixed
  • $id_lang mixed

getIdByName

integer ConfigurationCore::getIdByName(string $key, integer $id_shop_group, integer $id_shop)

Return ID a configuration key

Arguments

  • $key string
  • $id_shop_group integer
  • $id_shop integer

getInt

array ConfigurationCore::getInt(string $key, integer $id_shop_group, integer $id_shop)

Get a single configuration value (in multiple languages)

Arguments

  • $key string - Key wanted
  • $id_shop_group integer
  • $id_shop integer

getMultiShopValues

array ConfigurationCore::getMultiShopValues(string $key, integer $id_lang)

Get a single configuration value for all shops

Arguments

  • $key string - Key wanted
  • $id_lang integer

getMultiple

array ConfigurationCore::getMultiple(array $keys, integer $id_lang, integer $id_shop_group, integer $id_shop)

Get several configuration values (in one language only)

Arguments

  • $keys array - Keys wanted
  • $id_lang integer - Language ID
  • $id_shop_group integer
  • $id_shop integer

getRepositoryClassName

mixed ObjectModelCore::getRepositoryClassName()

Returns the name of the repository class for this entity.

If unspecified, a generic repository will be used for the entity.

getTranslationsFields

array ObjectModelCore::getTranslationsFields(array $fields_array)

Arguments

  • $fields_array array

getValidationRules

array ObjectModelCore::getValidationRules(string $class)

Returns object validation rules (fields validity)

Arguments

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

getWebserviceObjectList

array ConfigurationCore::getWebserviceObjectList($sql_join, $sql_filter, $sql_sort, $sql_limit)

This method is override to allow TranslatedConfiguration entity

Arguments

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

getWebserviceParameters

array ObjectModelCore::getWebserviceParameters(string|null $ws_params_attribute_name)

Returns webservice parameters of this object.

Arguments

  • $ws_params_attribute_name string|null

hasContext

mixed ConfigurationCore::hasContext(string $key, integer $id_lang, integer $context)

Check if configuration var is defined in given context

Arguments

  • $key string
  • $id_lang integer
  • $context integer

hasKey

boolean ConfigurationCore::hasKey(string $key, integer $id_lang, integer $id_shop_group, integer $id_shop)

Check if key exists in configuration

Arguments

  • $key string
  • $id_lang integer
  • $id_shop_group integer
  • $id_shop integer

hasMultishopEntries

boolean ObjectModelCore::hasMultishopEntries()

Checks if there is more than one entry in associated shop table for current object.

hydrate

mixed ObjectModelCore::hydrate(array $data, integer|null $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|null

hydrateCollection

array ObjectModelCore::hydrateCollection(string $class, array $datas, integer|null $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|null

isAssociatedToShop

boolean ObjectModelCore::isAssociatedToShop(integer|null $id_shop)

Checks if current object is associated to a shop.

Arguments

  • $id_shop integer|null

isCurrentlyUsed

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

Checks if an object type exists in the database.

Arguments

  • $table string|null - Name of table linked to entity
  • $has_active_column boolean - True if the table has an active column

isLangKey

boolean ConfigurationCore::isLangKey(string $key)

Check if a key was loaded as multi lang

Arguments

  • $key string

isLangMultishop

boolean ObjectModelCore::isLangMultishop()

Checks if the object is both multi-language and multi-shop.

isMultiShopField

boolean ObjectModelCore::isMultiShopField(string $field)

Checks if a field is a multi-shop field.

Arguments

  • $field string

isMultishop

boolean ObjectModelCore::isMultishop()

Checks if object is multi-shop object.

isOverridenByCurrentContext

mixed ConfigurationCore::isOverridenByCurrentContext($key)

Arguments

  • $key mixed

loadConfiguration

mixed ConfigurationCore::loadConfiguration()

Load all configuration data

makeTranslationFields

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

Arguments

  • $fields array
  • $fields_array array
  • $id_language integer

save

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

Saves current object to database (add or update)

Arguments

  • $null_values boolean
  • $auto_date boolean

set

mixed ConfigurationCore::set(string $key, mixed $values, integer $id_shop_group, integer $id_shop)

Set TEMPORARY a single configuration value (in one language only)

Arguments

  • $key string - Key wanted
  • $values mixed - $values is an array if the configuration is multilingual, a single string else.
  • $id_shop_group integer
  • $id_shop integer

setDefinitionRetrocompatibility

mixed ObjectModelCore::setDefinitionRetrocompatibility()

Retrocompatibility for classes without $definition static

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

sqlRestriction

string ConfigurationCore::sqlRestriction(integer $id_shop_group, integer $id_shop)

Add SQL restriction on shops for configuration table

Arguments

  • $id_shop_group integer
  • $id_shop integer

toggleStatus

boolean ObjectModelCore::toggleStatus()

Toggles object status in database

update

boolean ObjectModelCore::update(boolean $null_values)

Updates the current object in the database

Arguments

  • $null_values boolean

updateGlobalValue

boolean ConfigurationCore::updateGlobalValue(string $key, mixed $values, boolean $html)

Update configuration key for global context only

Arguments

  • $key string
  • $values mixed
  • $html boolean

updateMultishopTable

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

Updates 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

updateValue

boolean ConfigurationCore::updateValue(string $key, mixed $values, boolean $html, integer $id_shop_group, integer $id_shop)

Update configuration key and value into database (automatically insert if key does not exist)

Values are inserted/updated directly using SQL, because using (Configuration) ObjectModel may not insert values correctly (for example, HTML is escaped, when it should not be).

Arguments

  • $key string - Key
  • $values mixed - $values is an array if the configuration is multilingual, a single string else.
  • $html boolean - Specify if html is authorized in value
  • $id_shop_group integer
  • $id_shop integer

validateControler

array ObjectModelCore::validateControler(boolean $htmlentities)

Arguments

  • $htmlentities boolean

validateController

array ObjectModelCore::validateController(boolean $htmlentities)

Validates submitted values and returns an array of errors, if any.

Arguments

  • $htmlentities boolean - If true, uses htmlentities() for field name translations in errors.

validateField

true|string ObjectModelCore::validateField(string $field, mixed $value, integer|null $id_lang, array $skip, boolean $human_errors)

Validate a single field

Arguments

  • $field string - Field name
  • $value mixed - Field value
  • $id_lang integer|null - Language ID
  • $skip array - Array of fields to skip.
  • $human_errors boolean - If true, uses more descriptive, translatable error strings.

validateFields

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

Checks if object field values are valid before database interaction

Arguments

  • $die boolean
  • $error_return boolean

validateFieldsLang

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

Checks if multilingual object field values are valid before database interaction.

Arguments

  • $die boolean
  • $error_return boolean

validateFieldsRequiredDatabase

array ObjectModelCore::validateFieldsRequiredDatabase(boolean $htmlentities)

Validate required fields.

Arguments

  • $htmlentities boolean