common.sample.php File Reference

Sample main configuration file. More...


Enumerations

enum  temp_dir

Functions

 GetIncludes ($dir)

Variables

 $table_prefix = ""
 $user = "fr"
 $password = "fr"
 $db = "freerealty"
 $server = "localhost"
 $openadmin = "$user"
 $openpassword = "$password"
 $require_admin = "y"
 $hide ['user'] = "n"
 $hide ['pw'] = "n"
 $auth_user = array ("joe", "user")
 $auth_pw = array ("joe_pw", "user_pw")
 $log_level ['user'] = "2"
 $log_level ['query'] = "2"
 $log_level ['view'] = "3"
 $noimage = "N"
 $friendlyurl = 'y'
 $agentfeature = "Y"
 $baseurl = "http://www.yoursite.com"
 $yourname = "Your Name"
 $youremail = "Your Name"
 $imageloc = "images"
 $images_use = "db"
 $install_path = "/var/www/htdocs/fr"
 $includes = "$install_path/includes"
 $properties_per_page = 10
 $local_404 = "propview.php"
 $refer_404 = "index.php"
 $linefeeds = "Y"
 $max_agent_images = 1
 $agent_feature = "Y"
 $limit = "4"
 $max_agent_upload = 1000000
 $yahoomaps = "Y"
 $friendmail = "Y"
 $max_images = 6
 $show_tour = "Y"
 $price_range = 'Y'
 $show_near = 'Y'
 $show_fp = 'Y'
 $near_fp_count = "3"
 $max_prop_upload = 10000000
 $use_country = "N"
 $show_created = 'n'
 $show_updated = 'n'
 $inc = GetIncludes($includes)


Detailed Description

This file can be used by copying or renaming it to common.php. Nearly all changes will take place in this file. Please read through this file to figure out which settings are correct for your installation

Enumeration Type Documentation

enum temp_dir

Define temp_dir as /tmp for unix users. Windows users can easily change this to C:\temp setting true at the end makes it case insensitive


Function Documentation

GetIncludes ( dir  ) 

This function is in testing- contributed by Martin Purcell Tweaks by Patrick Fleming. This function reads through the includes directory automatically pulling in files that end in php


Variable Documentation

$agent_feature = "Y"

can agents decide to feature a property? 'Y' on 'N'

$agentfeature = "Y"

Allow agents to be displayed similar to property feature code

$db = "freerealty"

Database name

$friendlyurl = 'y'

Setting friendlyurl allows you to use the htaccess file and make more search engine friendly links appear on the main page

$friendmail = "Y"

use email-a-friend option? 'Y' or 'N'

$hide['pw'] = "n"

Hide password on input screens

$hide['user'] = "n"

Hide the user login, puts astertisks on the login screen

$imageloc = "images"

The name of the images folder- only used if the images are stored in folders

$images_use = "db"

Set to db for database, folders for folders

$inc = GetIncludes($includes)

The last part of using the includes directory, finalizes pulling in this directory

$install_path = "/var/www/htdocs/fr"

Set the path and the include path- the install_path is *very* important, things break if it's not set

$limit = "4"

Set the number of properties included in the feature code- this keeps the listings from running off the bottom of the browser window

$linefeeds = "Y"

AGENT ADMINISTRATION use linefeed in description fields 'Y' or 'N'

$local_404 = "propview.php"

Not Found errors coming from within your site go here

$log_level['view'] = "3"

view 0 for none, 1 for admin,2 for auth_users, 3 for agents

$log_level['query'] = "2"

query 0 for none, 1 for delete, 2 for update, 3 for insert

$log_level['user'] = "2"

user 0 for none, 1 for agents, 2 for auth_users, 3 for admin

$max_agent_images = 1

maximum number of images for a given agent

$max_agent_upload = 1000000

How large can an agent image be? (n bytes)- this is also limited by the maximum upload size set in php.ini

$max_images = 6

maximum numer of images for one property. Once this number is hit no new images may be added to a listing

$max_prop_upload = 10000000

max size of property images (in bytes)- also limited by php.ini settings

$near_fp_count = "3"

How many nearby or floorplans should we save? Default is 3 in the function.

$noimage = "N"

Allow listings without photos to show up in feature code
Set to "Y" featured listings on the front page will have a noimage replacement, a generic gif

$openadmin = "$user"

FreeRealty admin user name defaults to mysql database user Change to something else if you don't want to use the database user name FreeRealty username, currently defaults to the data base user name.

$openpassword = "$password"

FreeRealty password, currently defaults to database password, change if you don't want to log in using the database password

$password = "fr"

Database password

$price_range = 'Y'

Use price range field ie for rentals? 'Y' or 'N' allows the additional/ optional fields price_low and price_hi

$properties_per_page = 10

Maximum number of properties to list at once:

$refer_404 = "index.php"

Not Found errors from external links go here

$require_admin = "y"

Require admin to setup user accounts

$server = "localhost"

Machine the server is running on- localhost is usually fine

$show_created = 'n'

display the created and/or updated dates?

$show_fp = 'Y'

Use the floorplan code 'Y' or 'N'. Set to 'Y' adds links to listings with similar floorplans

$show_near = 'Y'

Use the nearby property code 'Y' or 'N'. Set to 'Y' adds links to nearby listings

$show_tour = "Y"

use virtual tour URL? 'Y' or 'N'

$table_prefix = ""

Defaults to no prefix. This allows you to use the same database for more than one installation, especially helpful on a shared host

$use_country = "N"

use country? 'Y' or 'N' Adds the country field to listings

$user = "fr"

Database user name

$yahoomaps = "Y"

use yahoo maps? 'Y' or 'N' - for more fun try 'G' ;)


Generated on Sat Mar 3 12:47:09 2007 for FreeRealty Real Estate Listing Scripts by  doxygen 1.4.7