Buy Now
Related Links
Announcements
PHP Store Locator Script is on sale for $99.95 $74.95 until August 1st. buy now »
PHP Store Locator Documentation

Document Sections

  1. Downloading and Installation
    1. Purchasing and Downloading Software
    2. How to Schedule a Free Installation
    3. Installing Software
  2. Manage Store/Dealer Locations
    1. Creating New Store Location
    2. Editing Store Location
    3. Adding/Editing Store Weekly Ad
  3. Using Bulk CSV Insert Utility
  4. Managing General Settings
  5. Customizing Look and Feel of Software
    1. Translating Software to Another Language
    2. Modifying Front-End Template Files
  6. Reporting a Software Fault (Bug)

Section 1 – Downloading and Installation

1.1 Purchasing and Downloading Software –
To download PHP Store Locator Script you must first purchase a license by clicking the buy now button on http://storelocatorscript.com or by visiting our shopping cart directly at http://phpscriptindex.com.

On completion of purchase you will find a direct download link on your order detail page. You can view this page at https://www.phpscriptindex.com/cart.php?act=viewOrders. An email with download and purchase information will be sent immediately after purchase.

1.2 How to Schedule a Free Installation –
Free installation is available with every license purchase.  Please view the following article on how to schedule a free installation after purchase at http://phpscriptindex.com/support/viewq.php?qid=26.  A software installation wizard has been created to simplify the installation process if you decide to precede with the installation your self.

1.3 Installing Software –

How to install PHP Store Locator

  1. Download software zip file to local computer (see above)
  2. Unzip files to local computer
  3. Using FTP software login to your website server (contact hosting company if you are unsure what FTP is)
  4. Browse to the web directory you wish to install software to
  5. Upload all files/folders to website server (this may take a few minutes depending on your connection)
  6. Check FTP software log to ensure all files where successfully uploaded. If not re-upload failed files
  7. Open a web browser and navigate to the website URL where software files are uploaded
    E.g. http://www.<yoursite>.com/<subdirectory>/
  8. The installation wizard will redirect you to the start of the installation
    E.g. http://www.<yoursite>.com/<subdirectory>/installfiles/install.php
  9. Read and review the whole software license agreement and check agree to continue as shown in figure 1.1

    Figure 1.1 – Step 1 of installation wizard

  10. If prompted to please contact host provider to adjust your PHP configuration to meet software requirements and refresh to continue as shown in figure 1.2

    Figure 1.2 – Step 2 of installation wizard will good file permissions

  11. If prompted to please adjust any file permissions listed in red text and refresh to continue as shown in figure 1.3

    Figure 1.3 – Step 3 of installation wizard will good file permissions


  1. Enter MySQL database information and continue as shown in figure 1.4. If you are unsure what your MySQL database information is, please contact your web host provider.

    Figure 1.4 – Step 4 of installation wizard. MySQL database information

  1. Installation is now complete. Follow in screen instructions on how to set your Google Map API and Google AJAX API keys.

Section 2 – Manage Store/Dealer Locations

2.1 Creating New Store Locations –

How to create a new store location

  1. Login to software administration panel (admin panel is located ‘sladmin’ directory)
    E.g. http://<yoursite>.com/<subdirectory>/sladmin/index.php 
  2. Click on Add Dealer/Store from left navigation menu
  3. Complete form and submit to save
    Please Note: Latitude and longitude information are fetched automatically on submit of web form. If your address is not found or you would like to enter this information your self you will need to uncheck the ‘Fetch lat…’. Then enter the property latitude and longitude information. Latitude and longitude are required.
  4. Store location will now be displayed

2.2 Editing Store Location –

How to edit a store location

  1. Login to software administration panel (admin panel is located ‘sladmin’ directory)
    E.g. http://<yoursite>.com/<subdirectory>/sladmin/index.php 
  2. Click on Manage Dealers/Stores from left navigation menu
  3. Browse to store you wish to edit and click the edit button as shown in figure 2.1

    Figure 2.1 – Image of edit store button

  4. Update store information and submit to save
    Please Note: Latitude and longitude information are fetched automatically on submit of web form. If your address is not found or you would like to enter this information your self you will need to uncheck the ‘Fetch lat…’. Then enter the property latitude and longitude information. Latitude and longitude are required.

2.3 Adding/Editing Store Weekly Ad –

How to add/edit store weekly ad

  1. Login to software administration panel (admin panel is located ‘sladmin’ directory)
    E.g. http://<yoursite>.com/<subdirectory>/sladmin/index.php 
  2. Click on Manage Dealer/Stores from left navigation menu
  3. Browse to store you wish to manage and click the weekly ad button as shown in figure 2.2

    Figure 2.2 – Image of weekly ad button

  4. Toggling the Display weekly ad checkbox will cause the weekly ad link to be displayed/not displayed
  5. Use WYSIWYG editor to create weekly ad and submit to save as shown in figure 2.3

    Figure 2.3 – Image of weekly ad WYSIWYG editor

Section 3 – Using Bulk CSV Insert Utility

Using the bulk insert utility site administrators can import a CSV (comma separated value) file to insert or update listings. This utility can be used when setting up the software to import a large amount of locations (e.g. exported from another system).

Below are directions on how to download a sample CSV file. In the file the first row contains the column names separated by a comma (e.g. CSV file).  A new line exists for each new store. The line contains the information separated with commas (again e.g. CSV file). If column information is not supplied (blank) a comma will still be present telling the software to skip that column. The id column is only needed when you are updating store locations already in the database. The software will match the store location based on the id column them override the information with the supplied information.

Caution: The column information cannot contain a comma character. Be care full when exporting CSV files using MS Excel. It will export a comma character in the information with a double quote around the information (e.g. GOOD: this is some info, this is another column info | e.g. BAD: “this, is some info”, this another, is another column info). The software will separate the line into columns based on the comma character.

Please note: This utility uses a different method to fetch latitude and longitude information then the normal create store feature. Some international addresses will not have latitude and longitude information (e.g. United Kingdom) available. Use the normal create store feature or supply the latitude and longitude information in the CSV file for those addresses.

How to download sample CSV file

  1. Login to software administration panel (admin panel is located ‘sladmin’ directory)
    E.g. http://<yoursite>.com/<subdirectory>/sladmin/index.php
  2. Click on Import Dealers/Stores from left navigation menu
  3. Right click Download Example CSV File as select Save As
  4. Open file in any simple text editor (e.g. Notepad)
  5. The first row in the file will have the column titles

How to create a CSV file

  1. Download sample CSV file (see directions above)
  2. Open file in any simple text editor (e.g. Notepad)
  3. Delete all lines under first row
  4. Create a new line with store information separated by a comma and based on the columns in the first row
  5. Check for extra blank lines at end of file
  6. Save and exit

How to import CSV file

  1. Login to software administration panel (admin panel is located ‘sladmin’ directory)
    E.g. http://<yoursite>.com/<subdirectory>/sladmin/index.php

    Please note: It is strongly recommended that you backup database before using this utility. Incase you make a mistake.
  2. Click on Import Dealers/Stores from left navigation menu
  3. Click Browse button
  4. Select CSV file
  5. Click Open button
  6. Check Skip First Line in CSV File (if needed)
  7. Click Upload File button
  8. On load of page select Import Action as show in figure 3.1

    Figure 3.1 – Example of import action on step two of import CSV

  9. Click Delete CSV file when completed (if needed)
  10. Click Perform Import Action button to start import

Section 4 – Managing General Settings

General settings will allow the site administrator to update the administration login information (username, password), Google Map API Key, Google AJAX API Key, default page title, meta keywords, meta description, email, phone, skin template (if more than one exits in skins folder), default country, and results metrics (show results with in (x) amount of mi/km.

How to update general settings

  1. Login to software administration panel (admin panel is located ‘sladmin’ directory)
    E.g. http://<yoursite>.com/<subdirectory>/sladmin/index.php
  2. Click on General Settings from the left navigation menu
  3. Edit information and submit to save

Google Map API Key: http://www.google.com/apis/maps/signup.html
Google AJAX API Key: http://code.google.com/apis/ajaxsearch/signup.html


Section 5 – Customizing Look and Feel of Software

Customizing the look and feel of the software is allowed under the software license agreement. The software uses template and language files that are not encoded and can be modified. The software application files (PHP) are encoded and cannot be modified. Files that are encoded are done so to enforce our code copyright.

    1. Translating Software to Another Language –

You can modify the default language of the software by modifying the language files. These files contain an array of variables that store text verbiage used by the software. The front end language file is located in the ‘lang/en/langfile’ folder named ‘langfile.php’. The administration panel language file is located in the ‘sladmin/lang/en/’ folder named ‘adminLang.php’. You can modify these files using any simple text editor (e.g. Notepad). Do not modify these files in MS Front Page, MS Work or any other editor that will erase PHP code. Only modify the text between the double quotes in the files.

5.2 Modifying Front-End Template Files –
You can customize the front end look and feel by modifying the software’s template and CSS files. These files are located in the ‘skins’ folder. The software comes with one default layout called silver. The template files contain HTML and XTemplate variables. See XTemplate’s online Wiki page if you require knowledge of how XTemplate parses.  You can modify these files using any simple text editor (e.g. Notepad). Do not modify these files in MS Front Page, MS Work or any other editor that will erase/add unneeded HTML code. Do note remove HTML comments these are used by XTemplate.


Section 6 – Reporting a Software Fault (Bug)

To report a software fault (bug) please see a email with a screen shot (if available) of the issue/notice to info@storelocatorscript.com. All updates upgrades will be noted under announcements on http://storelocatorscript.com