Skip to content

Latest commit

 

History

History
1842 lines (963 loc) · 45.2 KB

class.CountyCore.md

File metadata and controls

1842 lines (963 loc) · 45.2 KB
Raw

Class CountyCore

  • Class name: CountyCore
  • Parent class: ObjectModel
  • Warning: this class is deprecated. This means that this class will likely be removed in a future version.
  • Source: classes/County.php line 31

Contents

Constants

Properties

Methods

Constants

USE_BOTH_TAX

const USE_BOTH_TAX = 0
  • Warning: this constant is deprecated. This means that this constant will likely be removed in a future version.
  • Source: classes/County.php line 54.

USE_COUNTY_TAX

const USE_COUNTY_TAX = 1
  • Warning: this constant is deprecated. This means that this constant will likely be removed in a future version.
  • Source: classes/County.php line 55.

USE_STATE_TAX

const USE_STATE_TAX = 2
  • Warning: this constant is deprecated. This means that this constant will likely be removed in a future version.
  • Source: classes/County.php line 56.

Properties

$_cache_county_zipcode

protected mixed $_cache_county_zipcode = array()
  • Visibility: protected
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • This property is static.
  • Source: classes/County.php line 52.

$_cache_get_counties

protected mixed $_cache_get_counties = array()
  • Visibility: protected
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • This property is static.
  • Source: classes/County.php line 51.

$active

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

$definition

public mixed $definition = array('table' => 'county', 'primary' => 'id_county', 'fields' => array('name' => array('type' => self::TYPE_STRING, 'validate' => 'isGenericName', 'required' => true, 'size' => 64), 'id_state' => array('type' => self::TYPE_INT, 'validate' => 'isUnsignedId'), 'active' => array('type' => self::TYPE_BOOL, 'validate' => 'isBool')))
  • 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/County.php line 41.

$id

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

$id_state

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

$name

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

$webserviceParameters

protected mixed $webserviceParameters = array('fields' => array('id_state' => array('xlink_resource' => 'states')))
  • Visibility: protected
  • Warning: this property is deprecated. This means that this property will likely be removed in a future version.
  • Source: classes/County.php line 58.

$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

protected integer $id_shop = 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

addZipCodes

mixed CountyCore::addZipCodes($zip_codes)
  • Visibility: public
  • Warning: this method is deprecated. This means that this method will likely be removed in a future version.
  • Source: classes/County.php line 90

Arguments

  • $zip_codes mixed

associateTo

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

This function associate an item to its context

Arguments

  • $id_shops integer|array

breakDownZipCode

mixed CountyCore::breakDownZipCode($zip_codes)
  • Visibility: public
  • Warning: this method is deprecated. This means that this method will likely be removed in a future version.
  • Source: classes/County.php line 108

Arguments

  • $zip_codes mixed

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

delete

mixed CountyCore::delete()
  • Visibility: public
  • Warning: this method is deprecated. This means that this method will likely be removed in a future version.
  • Source: classes/County.php line 64

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.

deleteZipCodeByIdCounty

mixed CountyCore::deleteZipCodeByIdCounty($id_county)
  • 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/County.php line 144

Arguments

  • $id_county mixed

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

getAssociatedShops

array ObjectModelCore::getAssociatedShops()

Gets the list of associated shop IDs

getCounties

mixed CountyCore::getCounties($id_state)
  • 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/County.php line 72

Arguments

  • $id_state mixed

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

array ObjectModelCore::getFieldsLang()

Prepare multilang fields

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.

getIdCountyByNameAndIdState

mixed CountyCore::getIdCountyByNameAndIdState($name, $id_state)
  • 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/County.php line 153

Arguments

  • $name mixed
  • $id_state mixed

getIdCountyByZipCode

mixed CountyCore::getIdCountyByZipCode($id_state, $zip_code)
  • 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/County.php line 117

Arguments

  • $id_state mixed
  • $zip_code mixed

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|null ObjectModelCore::getWebserviceObjectList(string $sql_join, string $sql_filter, string $sql_sort, string $sql_limit)

Returns webservice object list.

Arguments

  • $sql_join string
  • $sql_filter string
  • $sql_sort string
  • $sql_limit string

getWebserviceParameters

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

Returns webservice parameters of this object.

Arguments

  • $ws_params_attribute_name string|null

getZipCodes

mixed CountyCore::getZipCodes()
  • Visibility: public
  • Warning: this method is deprecated. This means that this method will likely be removed in a future version.
  • Source: classes/County.php line 81

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

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.

isZipCodePresent

mixed CountyCore::isZipCodePresent($zip_code)
  • Visibility: public
  • Warning: this method is deprecated. This means that this method will likely be removed in a future version.
  • Source: classes/County.php line 135

Arguments

  • $zip_code mixed

isZipCodeRangePresent

mixed CountyCore::isZipCodeRangePresent($zip_codes)
  • Visibility: public
  • Warning: this method is deprecated. This means that this method will likely be removed in a future version.
  • Source: classes/County.php line 126

Arguments

  • $zip_codes mixed

makeTranslationFields

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

Arguments

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

removeZipCodes

mixed CountyCore::removeZipCodes($zip_codes)
  • Visibility: public
  • Warning: this method is deprecated. This means that this method will likely be removed in a future version.
  • Source: classes/County.php line 99

Arguments

  • $zip_codes mixed

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

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

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

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

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