Online Resources & Support


How to Schedule Free Installation


Free installation is included with every software license purchase of PHP Store Locator Script. Installation service is available 7 days a week with typical installation completion time within 24-48 hours. To schedule a free installation please visit your order detail page and click the “Schedule a Free Installation” link. Alternatively you may send a email to support@storelocatorscript.com with the required information below to create a installation support ticket.

Required Installation Information:

  • Order Number
  • Hosting Control Panel Credentials (used to manage MySQL)
  • FTP/SFTP (or SSH) Login Credentials (used to upload software files)

 

Optional Information:

  • You may optionally include a CSV file of locations to be imported after installation.
  • We’ll batch geocode the location in the CSV and import them after installation.
    (limit 1 CSV import per license, max 20k rows)

 

How to Purchase & Download


You can purchase and download the PHP Store Locator Script 24/7 on our home page. Instant download is available on the order detail page directly after purchase. You may also schedule a free installation directly after purchase from the order detail page by clicking the “Schedule Free Installation” link.  Having trouble purchasing? Please click here to create a support ticket.

Software Requirements


The PHP Store Locator script is designed to work with todays most popular shared hosting packages and dedicated servers. Listed below are the minimum server (hosting) requirements for the software. Please contact your host provider or server administrator with the requirements below for verification. Please do not hesitate to contact us with any questions regarding the software. Did you know? Every software purchase includes free installation. Should your organization need a stateless installation to be deployed over a cluster of server instances please contact us for further information.

  • PHP 5.3 (or greater)
    – PHP mysqli extension
    – PHP mbstring extension
  • Mysql 5 (or greater)
    – 1 database is required
  • Linux Server/Hosting
    – Windows IIS installation is possible but not recommended.

Installation Guide


Free installation is included with every license purchase (learn more). PHP Store Locator script includes a installation wizard

How to Install

  • Purchase & Download Software Zip file
  • Unzip file to local machine
  • Upload unzip files to web server
  • Load http://example.com/installation/install.php in web browser
  • Follow directions on web page to complete installation

For maximum security the software application files are stored below the document root folder with the public file folder named “public_html” which matches the most common shared hosting cPanel/WHM scenario. However, the layout can be easily be changed for a sub-folder installation. If you need to install to a sub-folder and do not have base PHP/MySQL knowledge please schedule a free installation.

User Guide


How to Login to Admin Panel:

  1. Open Web Browser
  2. Navigate to http://example.com/admin/ where “example.com” is your website
  3. Enter in administrative credentials and click submit.
    Default Credentials:
    Username: admin@admin.com
    Password: admin

How to Create/Manage Admin Users:

  1. Login to Admin Panel (see above)
  2. Click on “Users” icon/link from left navigation menu
  3. To Create a User > Click “Create User” button
  4. To Edit User > Click “Settings” icon in row > Select Edit or Delete

How to Create/Manage Store Listings:

Note: The software will auto geocode store listing addresses when adding/editing listings in admin panel.

  1. Login to Admin Panel (see above)
  2. Click on “Stores” icon/link from left navigation menu
  3. To Create a Store > Click “Add Store” button
  4. To Edit Store > Click “Settings” icon in row > Select Edit or Delete

How to Import Store Listings:

Note: The CSV import feature will not geocode locations data. Please schedule a free import service for batch geocoding.
  1. Login to Admin Panel (see above)
  2. Click on “Stores” icon/link from left navigation menu
  3. Click “Download Sample CSV” button to download sample CSV
  4. Modify and/or Create CSV locally to match sample CSV columns
  5. Save and Upload CSV by clicking the “Upload & Import CSV” button

How to Change Control Panel Logo:

  1. Login to Admin Panel (see above)
  2. Click “Settings” icon/link from left navigation menu
  3. Click “Edit” icon in “Control Panel Logo URL” row

How to Edit Map Settings:

  1. Login to Admin Panel (see above)
  2. Click “Settings” icon/link from left navigation menu
  3. Click “Edit” icon in the “Map Settings” row you wish to edit
  4. Edit JSON setting value (optionally you can verify JSON at http://pro.jsonlint.com)
  5. Click “Save” to commit changes

How to Edit Default Country & Max Search Radius:

  1. Login to Admin Panel (see above)
  2. Click “Settings” icon/link from left navigation menu
  3. Click “Edit” icon in the “Search Settings” row you wish to edit

Developer Guide


PHP Store Locator is built with modern OOP MVC architecture using the FuelPHP framework. The application’s file/folder layout matches FuelPHP with the locator source files located under the /fuel/app/ folder. The software supports multiple environments via the FuelPHP Fuel::$env (FUEL_ENV for Apache Env) variable located under the /fuel/app/config folder. By default the software’s installation wizard will create the database config files under /fuel/app/config/development.

The software uses a JSON API to fetch/obtain all search results using the fuel/app/classes/controller/api/search.php controller file. The following endpoints are implemented by default:

  • POST /api/search/index (optional params: “name”, “iso2”, “latitude”, “longitude”) — Search Store Listings
  • POST /api/search/countries — Obtain List of Countries
  • POST /api/search/us_states — Obtain List of US States
  • POST /api/search/store (required params: “id” store id) — Obtain Store Information by ID
  • POST /api/search/map_data — Obtain Highlight Data
  • POST /api/search/map_settings — Obtain Map JSON Settings

Theme files are located in in folder paths noted below. The front-end and administration panel have separate themes.

  • Front-End Theme:
    – Protected Files: /fuel/app/themes/default/
    – Public Files: /public_html/themes/default
  • Admin-Panel Theme:
    – Protected Files: /fuel/app/themes/admin/
    – Public Files: /public_html/themes/admin

The software uses a theme manager package to automatically combine and minimize theme assets such as JS and CSS files. The software cache of those files is located in the /public_html/assets/cache folder. Modifications/customizations are 100% allowed. Should you have any questions about the development layout and/or general customizing questions please do not hesitate to contact us today.

Search Widget Example:

Widget Source:
http://codepen.io/anon/pen/gavEZz?editors=101
Widget Example:
http://s.codepen.io/boomerang/82e2e748baa5e90dd5c116504ecd62eb1445638450918/index.html?editors=101

Embed into Webpage Example:

Embed Example: http://jsfiddle.net/9Jx33/