How To Add a Missing Region/Province/State to Ubercart

Adding a Missing Region/Province/State to Ubercart 

The Districts of Hong Kong

According to Wikipedia:

Hong Kong in administration is divided into 3 regions and 18 districts.

The 3 regions are: Hong Kong Island (HK), Kowloon (KLN), and the New Territories (NT)

The Problem:

Our company has many customers in Hong Kong.  Unfortunately, it was impossible for them to supply a correct Billing Address or Shipping Address due to an error in Ubercart 3.x with respect to the list of available Regions in Hong Kong, which was missing Kowloon as a choice.  As a consequence of this, the GUI dropdown that our clients used to construct their Billing Address and Shipping Address only listed two of the three Regions of Hong Kong (Hong Kong Island, New Territories).  Lacking the correct choice, customers chose to leave it unselected when registering their address.  This resulted in strange shipping and billing addresses with the word Unknown appearing in them:

This situation caused considerable stress and anxiety for customers, ourselves and local delivery people because all of us rely on correct and complete delivery information to co-ordinate various aspects of deliveries (logistics, scheduling and routing).

Ubercart Database Information

Country Information

In Ubercart 3.x, country information is stored in the uc_countries table:

MariaDB [hph]> describe uc_countries;

+--------------------+------------------+------+-----+---------+-------+

| Field              | Type             | Null | Key | Default | Extra |

+--------------------+------------------+------+-----+---------+-------+

| country_id         | int(10) unsigned | NO   | PRI | NULL    |       |

| country_name       | varchar(255)     | NO   | MUL |         |       |

| country_iso_code_2 | char(2)          | NO   |     |         |       |

| country_iso_code_3 | char(3)          | NO   |     |         |       |

| version            | smallint(6)      | NO   |     | 0       |       |

+--------------------+------------------+------+-----+---------+-------+

Hong Kong Entry

The entry for Hong Kong in uc_countries contains the following data:

MariaDB [hph]> select * from uc_countries where country_name ="Hong Kong";

+------------+--------------+--------------------+--------------------+---------+

| country_id | country_name | country_iso_code_2 | country_iso_code_3 | version |

+------------+--------------+--------------------+--------------------+---------+

|        344 | Hong Kong    | HK                 | HKG                |       1 |

+------------+--------------+--------------------+--------------------+---------+

Zone Information

In Ubercart 3.x, region information related to uc_countries is stored in uc_zones:

MariaDB [hph]> describe uc_zones;

+-----------------+------------------+------+-----+---------+----------------+

| Field           | Type             | Null | Key | Default | Extra          |

+-----------------+------------------+------+-----+---------+----------------+

| zone_id         | int(10) unsigned | NO   | PRI | NULL    | auto_increment |

| zone_country_id | int(10) unsigned | NO   | MUL | 0       |                |

| zone_code       | varchar(32)      | NO   | MUL |         |                |

| zone_name       | varchar(255)     | NO   |     |         |                |

+-----------------+------------------+------+-----+---------+----------------+

Incorrect Region Entries

The stock (incomplete) entries for Hong Kong contains the following data:

MariaDB [hph]> select * from uc_zones where zone_country_id=344;

+---------+-----------------+-----------+-----------------+

| zone_id | zone_country_id | zone_code | zone_name       |

+---------+-----------------+-----------+-----------------+

|      79 |             344 | HK        | Hong Kong       |

|      80 |             344 | NT        | New Territories |

+---------+-----------------+-----------+-----------------+

There is no entry for "Kowloon", which is the problem.

Fixing the  Missing Kowloon Problem

Enabling All Future Hong Kong Orders to Offer Kowloon as a Province/State Choice:

Moving forward, all future orders should feature Kowloon as a drop-down Provice/State choice.  This can be implemented by inserting a row into the uc_zones table:

MariaDB> INSERT INTO uc_zones VALUES ("","344","KL","Kowloon");

Query OK, 1 row affected, 1 warning (0.00 sec)

The table now contains the following data:

MariaDB [hph]> select * from uc_zones where zone_country_id=344;

+---------+-----------------+-----------+------------------+

| zone_id | zone_country_id | zone_code | zone_name        |

+---------+-----------------+-----------+------------------+

|      79 |             344 | HK        | Hong Kong Island |

|      80 |             344 | NT        | New Territories  |

|    4374 |             344 | KL        | Kowloon          |

+---------+-----------------+-----------+------------------+

Which results in desired interface behavior: