BLUE CRYSTAL GROUP

Contents

Claim Listing mod. 1

Mod Package. 1

Modified code. 2

Installation and Set UP. 2

Verifying the Installation. 7

Using the Claim listing mod. 9

Contacting Blue Crystal Group. 11

 

Claim Listing mod

 

  

Claim Listing

 

Works on PMD:  Version 1.1.8 & Up

Release date:  11-19-09

Author:  Blue Crystal group

 

      Description:  Allows visitors to claim listings

 

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

 

Terms:  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. 

 

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.  Also backup your configuration files.

 

 

Mod Package

 

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 make 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.

 

 

Modified code

 

 

 

Script / template

loader

Notes

 

Root directory

 

 

 

listing.php

Yes

 

 

Cp

 

 

 

cp/template/default/admin_header.tpl

No

 

 

Template

 

 

 

template/default/listing_default.tpl

No

Membership level used for Claimlisting

 

If you installed another modification from Blue Crystal Group the change to listing.php might be already there.

 

 

Installation and Set UP

 

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

 

2.- Upload the contents of the new-files folder to the root directory of your site.

 

            It you have certain Blue Crystal Modifications; the upload may tell you that there are already files with the same names on your site. Go ahead and override those file with the new copies.

 

 

4.- Execute the install.php script

 

with   http://your_URl/bcg_install_claimlisting.php

 

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)

 

 

 

 

The system should respond with :

 

Install Done

 

If the response is any other than that, please send Blue Crystal a copy of the message you received and stop the installation

 

 

5.- Merge with your own the contents of the modified files

 

5.1 Dowload listing.php

 

 

The BCG loader is used for some of the Blue Crystal modification and if you have a already a Blue Crystal modification, you may already have installed the  loader in some scripts.   If you have, do not repeat the lines of 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 ****/

 

You must include these on listing.php lines as shown below

 

 

 

if ($config_memberships[$f['membership']]['set_documents'] > "0") {

  $free_documents=$config_memberships[$f['membership']]['set_documents']......                                                    

  echo '<tr><td valign=middle height=21>[<a href=".......

  }

 

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

$filename='';

$methodName='require_once';

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

 

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

 

echo '<form name="regform" id="regform" action="admin_edit_listing.php?id.....

echo "<tr><td colspan=2><br><br><b>Statistics</b><hr size=\"1\"></td></tr.....

 

 

5.2 Download   template/your_template/ listing_defaults.tpl   (Where  ‘x’ is the membership where you want to put the modification)

 

Put the following lines where you want the Claim Listing message to appear

 

 

<!-- CLAIMLISTING MOD STARTS-->

                <?php

                require_once(PMDROOT.'/bcg/claimlisting/claimlisting.config.php');

                if(substr($ownerLogin,0,5)==substr($generic_user,0,5)){

                ?>

                <div style="width:200px;margin:auto;">

                <?php

                echo $claim_message.'<br/>';

                echo '<a href="bcg_claim_request.php?listing_id='.$_GET['id'].'">'.$claimTextLink.'</a>';

                ?>

                </div>

                <?php } ?>

                <!-- CLAIMLISTING MOD ENDS-->                                                                   

 

 

REMOVE THE “Claim Listing”  from PMD

 

You can see the enclosed template/default/listing_default.tpl as a guide

 

5.3. Download   cp/template/default/admin_header.tpl

 

Around line 128 you will find the following lines

            <a href="./admin_maintenance.php"><?php echo $lang['admin_general_menu_maintenance']; ?></a>

        <?php } ?>

 

Insert  the new lines as follows

 

            <a href="./admin_maintenance.php"><?php echo $lang['admin_general_menu_maintenance']; ?></a>

            <!--//BCG MOD CLAIMLISTING START HERE//-->

        </div>

        <a href="#"><?php echo $lang['admin_general_menu_blue_crystal']; ?></a>

        <div>

                                                <a href="./admin_claimlisting.php"><?php echo $lang['admin_general_menu_claimlisting']; ?></a>

            <!--//BCG MOD CLAIMLISTING ENDS HERE//-->

        <?php } ?>

 

 

If your cp/template/default/admin_header.tpl looks different , send it to bluecrystal@bluecrystal-cias.com  to have it updated

 


Upload all the files that you have modified

 

Installation is complete

 

 

 

Verifying the Installation

 

 

Enter o locate a test user with a users that starts with “login”

Create a listing at for membership level  1 for the user you created

Make you sure put the code for the mod on listing_1.tpl template

 

Display the listing page for the listing you just entered

You should see a message like “Claim this listing”

 

 

Click on the link and provide the information requested. Enter your own e-mail (or an e-mail that can get to you):

 

 

Submit the form.

The e-mail that you provided on the form should receive an e-mail informing you that your request has been received.

The Admin should received an e-mail as well

Sign up as Admin and in the Navigation pane, you should see a menu option that says Claim Listing

Click on that Claim Process option

 

You should see a listing where the info you provided on the form is listed:

 

 

Click on the “Approve” button.

You, as a requested, should receive an e-mail saying that your request has been approved.

Go to main page of the directory and click on login.

Sign up as a user with user name and password provided

Go to edit listings. You should see the listing under the user name that requested it.

 

 

Using the Claim listing mod

 

 

The system recognizes the listings that can be “taken over” or  “Claimed”  by their user ID.  A common user Id must be set for all those listings created by the webmaster and that are susceptible to be taken over.    The mod compares the first 5 characters of the user id with a user id set up in the configuration file, if they are the same, the system will display the invitation to take over the listing.

 

The configuration file is on  /bcg/claimlisting/claimlisting.config.php

The user id that Is preset is ‘login’ so any user id that start with ‘login’  (like login1234 or login33456) will be considered for taking over

You can change the default user id if you wish,

 

If you have uploaded your listings with the PMD import tool, the names of the listing owners could have been assigned as login_nnnn, in this case you should  want to put ‘login” as the user id name on the configuration file.

 

E-mails

The content of e-mails sent to the users of the system can be modified and edited by the administrator of the site.

The e-mails are in the bcg/claimlisting/config.php file

 

The text of the e-mails can be changed by the user and they can include some values from the user record like login, firmname, password.

In order to include those values in the e-mails you will enclose the field name between stars like this:

 

*login*,* firmname*,*password*

 

The default  e-mails are:

 

$claimRequestSubjectEmail="Claim Listing Request";

 

$claimRequestEmail ="Greetings *login*,  <br />

 

Your listing claim request for *firmname* will processed and we'll get back to you";

 

$claimApprovedSubjectEmail="Claim Listing Approved";

$claimApprovedEmail ="Greetings *login*, <br /> ,

Your listing claim has been approved. <br />

We look forward to working with you.  If your listing is a free listing or a paid listing with no due invoices, it is now available for viewing and searching.<br /><br />

You can edit your records at any time, using your login and password.<br /><br />

 

Your registration information is below:<br />

 

Login: *login*<br />

Password: *password* <br />

Thank You,<br />

Support<br />";

$claimDeniedSubjectEmail="Claim Listing Denied";

$claimDeniedEmail ="Greetings *login*, <br /> <br />

Your claim listing was not approved. <br />

Listing Title: *firmname*<br />

Possible reasons:<br />

-Unable to very identity.<br />

-Listing already claimed<br /><br />

Thank You, <br />

Support<br />";

 

Operation:

The “claimant” will make click on the invitation and enter some basic info including a user id and password.  The “claimant”  receives and e-mail and so the admin.

The admin will have a screen where the request can be approved or denied.  In either case, the “claimant” receives an e-mail.

If the request is approved by the admin the system automatically creates a user record with the information provided by the claimant and the listing is transferred to the user.  From that point on, the listing is just one more listing entered by a user.

 

Sample Screens

 

 

 

 

 

 

 

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.