BLUE CRYSTAL GROUP

 

0BIcons

 

  

Icons

Works on PMD:  Version 1-1-8 &  UP

Release date:  11/15/09

Author:  Blue Crystal Group

 

      Description:  Listings can display characteristics of the services they offer with icons

 

Terms:

·         You can not re-sell this modification or use it as a base for other modifications and sell it.

·         You are free to modify this code for your own purposes. You may install this mod on one instance of phpmydirectory for which you hold a valid phpmydirectory license. 

·         You have 180 days of support and you can download upgrades for 180 days

·         You can buy the new version of the mod for 50% of the current cost of it.

 

DISCLAIMER:  Blue Crystal does not warrant the merchantability of this modification, and all liability is limited to any amount paid. Installation of this modification is done at your own risk. Backup your scripts before making changes to them.

 

Mod Package

 

You need some knowledge of FTP, HTML and PHP to do the installation. If you prefer it, Blue Crystal can do the installation for you.              Order Professional Installation

 

The zip file you have received has two folders:

 

Modified code   - The modified code is code from PMD that has been changed.  You can upload the contents of this folder if you have not made any change to your own files.

 

New code - The New Code are new files that will have to be uploaded as part of the installation.

 

 

Integration

 

Please read the entire set of instructions before doing the install.

 

INTEGRATION

To integrate the changes, you will have to take the modified code from the files sent and merge it with your existing code. 

The modified code is mostly added code so most of the time you just have to copy additional lines of code that you will find in the “modified code” folder and copy it on place into your own files.

 

LOADER

Some of the modified files have a “loader”.   The loader are lines of code is used for some of the Blue Crystal modification to facilitate the integration of code and if you already have a Blue Crystal modification, you may already have installed the loader in some scripts.   If you have, do not repeat the code.  The loader.php code needs to be called only once.

 

The BCG loader lines are similar to these:

 

/**** BCG mod loader STARTS HERE ****/

$filename='';   // The filename may vary

$methodName='require_once';

require_once(PMDROOT.'/bcg/loader.php');

/**** BCG mod loader  ENDS HERE ****/

 

INTEGRATION

To copy the modified code from the distribution folder to your files in the staging directory, open each file on the modified code folder and  Look for the blocks of code marked as BCG mods:

 

//  BCG         mod starts

...

//  BCG mod  ends:

In the template files, the added code is marked as follows:

 

<!-- BCG job mod starts here ->>

...

....

<!-- BCG Job mod ends here ->>

 

While doing the update consider these:

 

·         Most scripts only require adding a few lines of code 

·         PMD base code does change and you will find that your code does not match line by line the code we sent. When copying the modified lines of code, first see in which line number they are in our delivered code and what lines are before and after the modified code and  then, locate the before an after lines on the original code.

·         All modified code will have a line with BCG on it so you can search for BCG and will

·         Most modifications include adding new lines of code as opposed to changing existing lines.  If some lines need to be changed or deleted, that will be clearly stated in the modified code.

 

For instance to integrate listing.php

Open your own listing.php file

Look for the lines:

 if($listing['www_allow'] AND !empty($listing['www'])) {

        if ($_GET['action'] == 'print') {

             $template_content->set('www',$listing['www']);

   

Insert the following lines before the above listed lines

 

/**** BCG LOADER STARTS HERE ****/

/*********************************/

/*********************************/

$filename='';

$methodName='require_once';

require(PMDROOT.'/bcg/loader.php');

/*********************************/

// YOU MUST HAVE ONLY ONE LOADER PER SCRIPT.  IT WILL LOAD ALL BCG MODS 

//**** BCG LOADER ENDS HERE ****/

 

http://manual.phpmydirectory.com/tip.png

Using a Compare and Merge Tool

A good way to see the differences between the modified code and your code is to use a compare and merge tool to merge your current files with the modification files

 

1.

Download  from your site the files listed in the modified-files folder that we are seding into a folder on your home computer.

 

2.

Extract the modified files from the modification zip file.

 And put them in another folder

3.

Use  the compare and merge tool to compare the files in the two folders.

 

4.

The tool will determine the differences and you may reviews these to make the needed changes.

 

5.

Re-upload the merged files and continue with the upgrade process as normal.

 

Compare and Merge Tools

WinMerge - Windows / Free

 

Beyond Compare - Windows / Linux - Low price

 

Araxis Merge - Windows/Mac - Higher price, more features

 

 

Steps to do the integration

 

1. - Extract the contents of the zip file to new folder.

            We'll refer to this folder as the distribution folder

2. – Create a folder that we will call the “staging folder”

 

3.-  Download from your site to the staging folder, all the files that exist in modified folder that you will find in the distribution folder

 

4.- Copy the code from each of the modified files to your own files as per the integration guidelines above

 

5.- Make sure you have a copy of your production system  files

 

6.- Copy the files from the modified-files folder in your staging area to your main folder

5.- Copy the contents of the  new-files directory to your main folder

For steps 5 and 6 consider that the template files are included on the template/default folder. If you are using other folder name for your template, you must upload the template files to that folder

7.- Execute the installation script

 

            You will find the installation script on the chart of modified code below.

 

The install script will ask you for a license number. The license is a number of the form 999-9999-9999-9999 and is unique by domain.

 

You will find your license number on the receipt you received when you purchased the modification or you can find it on your order history on the Blue Crystal web.

 

License number on your order history (example)

 

 

If you get and error message, please send Blue Crystal a copy of the message you received and stop the installation

 

 

 

 

Installation script :   http://your-url/bcg_icons_install.php  

 

The modified files for this mod are listed on the "modified files" folder

 

6BConfiguring and using the Icons mod

 

1,- Membership Configuration

You can set what membership levels will have the option of icons:

Go to the Control Panel then click on Configuration and them memberships.

 

You should see a row for Icons where you can specify what membership levels will have access to the feature

 

2.- Configuration of options

You can access the Icons option configuration as follows:

In the PMD control panel go to configuration, then click on settings and then look for the BCG icons tab

 

In configuration:

Select Setup and Settings

 

 

 

Then select BCG Icons on the Navigation panel:

 

 

 

 

 

 

These fields allow you to control how are the icons going to be displayed.

You may want to keep the size of the icons small for the listing results page.

 

 

2.- Uploading  your icons:

 

Icons are stored in folders under the folder files/icons where you can upload your icons using FTP

 

We included the folder payment_Methods as a sample

 

You can add other folders with any icon you prefer.  To do so follow these guidelines:

Folder Names

·         Must be self descriptive.             

·         Use an Underscore (‘_’) to connect more than word if needed.

·         Avoid abbreviations and acronyms (Unless they are well know by your users)

 

Icon

·         Icons can be any graphic type: jpg,  gif, pngetc

·         Icon names must be self descriptive

·         Use an Underscore (‘_’) to connect words on names with multiple words. ( The ‘_’ will be removed for display)

·         The Icons can be resized by the system but it is not recommended.  You must load the icons with the size you want them to appear on the main listing.   Icons size varies but a size of around 50 X 50 pixels are a recommend size.     A typical credit card icon is sized at 60 X 35

 

 

Contacting Blue Crystal Group

 

 

Should you have any issues with the software, questions or concerns,  the quickest way to contact us is by means of our Forum

http://bluecrystalgroup.com/support/forum

 

or by e-mail to support@bluecrystalgroup.com

 

We’ll get back to you inside a business day.