ePages 6.11.0 - DE_EPAGES/Shop/API/Table/RegionCountry.pm

Package DE_EPAGES::Shop::API::Table::RegionCountry

interface for table RegionCountry

@EXPORT_OK
InsertRegionCountry
DeleteRegionCountry
GetAllPKeyRegionCountries
ExistsRegionCountry
GetPKeyRegionCountriesByRegionID
GetInfoRegionCountriesByRegionID
GetPKeyRegionCountriesByCountryID
GetInfoRegionCountriesByCountryID

Functions

DeleteRegionCountry
ExistsRegionCountry
GetAllPKeyRegionCountries
GetInfoRegionCountriesByCountryID
GetInfoRegionCountriesByRegionID
GetPKeyRegionCountriesByCountryID
GetPKeyRegionCountriesByRegionID
InsertRegionCountry
OnDeleteCountry

DeleteRegionCountry

Deletes a(n) RegionCountry.

Syntax
DeleteRegionCountry($RegionID, $CountryID);
DeleteRegionCountry($hRegionCountry); # if $hRegionCountry includes RegionID, CountryID
Input
$RegionID (int)
region id (part of primary key)
$CountryID (int)
country identifier - iso num code (part of primary key)

ExistsRegionCountry

Returns true if the RegionCountry exists.

Syntax
$exists = ExistsRegionCountry($RegionID, $CountryID);
Input
$RegionID (int)
region id
$CountryID (int)
country identifier - iso num code
Return
$exists (boolean)
1/0 the RegionCountry exists (yes/no)

GetAllPKeyRegionCountries

Returns all RegionCountry identifiers.

Syntax
$ahRegionCountryIDs = GetAllPKeyRegionCountries();
Return
$ahRegionCountryIDs (reference to array of hashes)
with following keys:
  • RegionID - region id - int
  • CountryID - country identifier - iso num code - int

GetInfoRegionCountriesByCountryID

Returns objects of RegionCountry by alternate key CountryID.

Syntax
$ahRegionCountries = GetInfoRegionCountriesByCountryID($CountryID);
Input
$CountryID (int)
country identifier - iso num code
Return
$ahRegionCountries (reference to array of hashes)
with following keys:
  • RegionID - region id (part of primary key)- int
  • CountryID - country identifier - iso num code (part of primary key)- int

GetInfoRegionCountriesByRegionID

Returns objects of RegionCountry by primary key element RegionID.

Syntax
$ahRegionCountries = GetInfoRegionCountriesByRegionID($RegionID);
Input
$RegionID (int)
region id
Return
$ahRegionCountries (reference to array of hashes)
with following keys:
  • RegionID - region id (part of primary key)- int
  • CountryID - country identifier - iso num code (part of primary key)- int

GetPKeyRegionCountriesByCountryID

Returns primary keys of RegionCountry by alternate key CountryID.

Syntax
$ahKeys = GetPKeyRegionCountriesByCountryID($CountryID);
Input
$CountryID (int)
country identifier - iso num code
Return
$ahKeys (reference to array of hashes)
with following keys:
  • RegionID - region id - int
  • CountryID - country identifier - iso num code - int

GetPKeyRegionCountriesByRegionID

Returns primary keys of RegionCountry by primary key element RegionID.

Syntax
$ahKeys = GetPKeyRegionCountriesByRegionID($RegionID);
Input
$RegionID (int)
region id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • RegionID - region id - int
  • CountryID - country identifier - iso num code - int

InsertRegionCountry

Creates an entry of RegionCountry.

Syntax
InsertRegionCountry($hRegionCountry);
Input
$hRegionCountry (reference to hash)
with following keys:
  • RegionID - region id (part of primary key)- int
  • CountryID - country identifier - iso num code (part of primary key)- int

OnDeleteCountry

Deletes RegionCountry of this model when a(n) Country is deleted.

Syntax
OnDeleteCountry($hParams);
Input
$hParams (ref.hash.*)
primary key of object Country, key is
  • CountryID