readme.md

About Zip-Calc

Zip-Calc was created to convert a PHP class written by Quixotix in 2005 from MySQL to PostgreSQL. This class calculates the distance between U.S. zip codes and also finds all of the zip codes within a 9 given radius of a known zip code.

Database

The CREATE syntax for the database table used in the example is as follows:

CREATE TABLE "public"."maps" (
    zip_code_id  SERIAL PRIMARY KEY,
    zip_code TEXT NOT NULL,
    city TEXT NOT NULL,
    county TEXT NOT NULL,
    state_name TEXT NOT NULL,
    state_prefix TEXT NOT NULL,
    area_code TEXT NOT NULL,
    time_zone TEXT NOT NULL,
    lat NUMERIC(10,7) NOT NULL,
    lon NUMERIC(10,7) NOT NULL
);

Installation

Install the project via Composer:

composer create-project austintoddj/zip-calc

Step 3: PgSQL Import

Once inside your database, import the data/maps.sql file included in the project. If you need some assistance on getting up and running with a PgSQL database, find out more on Digital Ocean.

Step 4: Update the Credentials

In the example.php file, you will need to update the $connectionString.

Step 5: Run the Example

If you followed the steps up to this point correctly, you should see the following when you access example.php from a browser:

License

Zip-Calc is open-sourced software licensed under the MIT license.