Overview   Package   Tree   Index 
IMDBPHP
PREV  NEXT Frames  No Frame 
SUMMARY:  FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

MDBApi
Class mdb_config

Direct Known Subclasses:
imdbsearch, mdb_base, pilotsearch

class mdb_config

Configuration part of the IMDB classes

Authors:
Izzy (izzysoft AT qumran DOT org)
Version:
$Revision: 415 $ $Date: 2010-10-10 22:21:44 +0200 (So, 10. Okt 2010) $
Copyright:
(c) 2002-2004 by Giorgos Giagas and (c) 2004-2008 by Itzchak Rehberg and IzzySoft

Field Summary
integer$cache_expire
Cache expiration - cache files older than this value (in seconds) will be automatically deleted.
string$cachedir
Directory to store the cache files.
boolean$converttozip
Convert non-zip cache-files to zip (check file permissions!
boolean$debug
Enable debug mode?
string$force_agent
Enforce the use of a special user agent
string$imdb_img_url
Where the local IMDB images reside (look for the "showtimes/" directory) This should be either a relative, an absolute, or an URL including the protocol (e.
boolean$imdb_utf8recode
Try to recode all non-UTF-8 content to UTF-8?
string$imdbsite
IMDB server to use.
integer$maxresults
Limit for the result set of searches.
string$photodir
Where to store images retrieved from the IMDB site by the method photo_localurl().
string$photoroot
URL corresponding to photodir, i.
string$pilot_apikey
The MoviePilot API requires an API key.
string$pilotsite
MoviePilot server to use.
string$searchvariant
Moviename search variant.
boolean$storecache
Store the pages retrieved for later use?
boolean$trigger_referer
Trigger the HTTP referer This is required in some places.
boolean$usecache
Use a cached page to retrieve the information if available?
string$user_agent
Set the default user agent (if none is detected)
boolean$usezip
Use zip compression for caching the retrieved html-files?

Constructor Summary
void mdb_config()
Constructor and only method of this base class.


Field Detail

cache_expire

integer $cache_expire

Cache expiration - cache files older than this value (in seconds) will be automatically deleted.


cachedir

string $cachedir

Directory to store the cache files. This must be writable by the web server. It doesn't need to be under documentroot.


converttozip

boolean $converttozip

Convert non-zip cache-files to zip (check file permissions!)?


debug

boolean $debug

Enable debug mode?


force_agent

string $force_agent

Enforce the use of a special user agent


imdb_img_url

string $imdb_img_url

Where the local IMDB images reside (look for the "showtimes/" directory) This should be either a relative, an absolute, or an URL including the protocol (e.g. when a different server shall deliver them)


imdb_utf8recode

boolean $imdb_utf8recode

Try to recode all non-UTF-8 content to UTF-8? As the name suggests, this only should concern IMDB classes.


imdbsite

string $imdbsite

IMDB server to use. choices are www.imdb.<lang> with <lang> being one of de|es|fr|it|pt, uk.imdb.com, and akas.imdb.com - the localized ones are only qualified to find the movies IMDB ID (with the imdbsearch class; akas.imdb.com will be the best place to search as it has all AKAs) -- but parsing (with the imdb class) for most of the details will fail for most of the details.


maxresults

integer $maxresults

Limit for the result set of searches. Use 0 for no limit, or the number of maximum entries you wish. Default (when commented out) is 20.


photodir

string $photodir

Where to store images retrieved from the IMDB site by the method photo_localurl(). This needs to be under documentroot to be able to display them on your pages.


photoroot

string $photoroot

URL corresponding to photodir, i.e. the URL to the images, i.e. start at your servers DOCUMENT_ROOT when specifying absolute path


pilot_apikey

string $pilot_apikey

The MoviePilot API requires an API key. We initialize it empty here, so it is left to you to set it from your own script files (or in your own configuration defined by the constant IMDBPHP_CONFIG)


pilotsite

string $pilotsite

MoviePilot server to use. choices are <lang>.moviepilot.com - where <lang> is one of es|fr|pl|uk - , and www.moviepilot.de for German. More may follow sometimes in the future. So it is really intended for chosing the language of the desired content.


searchvariant

string $searchvariant

Moviename search variant. There are different ways of searching for a movie name, with slightly differing result sets. Set the variant you prefer, either "sevec", "moonface", or "izzy". The latter one is the default if you comment out this setting or use an empty string.


storecache

boolean $storecache

Store the pages retrieved for later use?


trigger_referer

boolean $trigger_referer

Trigger the HTTP referer This is required in some places. However, if you think you need to disable this behaviour, do it here.


usecache

boolean $usecache

Use a cached page to retrieve the information if available?


user_agent

string $user_agent

Set the default user agent (if none is detected)


usezip

boolean $usezip

Use zip compression for caching the retrieved html-files?


Constructor Detail

mdb_config()

void mdb_config()

Constructor and only method of this base class. There's no need to call this yourself - you should just place your configuration data here.


 Overview   Package   Tree   Index 
IMDBPHP
PREV  NEXT Frames  No Frame 
SUMMARY:  FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

Submit a bug

This document was generated by phpdocgen 0.17-rc3.
Copyright © 2002-03 Stéphane GALLAND (under the GNU General Public License)