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:
mdb_base

class mdb_config

Configuration class for imdbphp You should override the settings in here by creating an ini file in the conf folder.

Authors:
Izzy (izzysoft AT qumran DOT org)
Version:
$Revision: 690 $ $Date: 2014-08-05 09:29:19 +0200 (Di, 05. Aug 2014) $
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$default_agent
Set the default user agent (if none is detected)
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.
string$language
Tell IMDB which is the preferred language.
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.
integer$pilot_imdbfill
If the Pilot classes miss certain data (i.
boolean$storecache
Store the pages retrieved for later use?
boolean$usecache
Use a cached page to retrieve the information if available?
boolean$usezip
Use zip compression for caching the retrieved html-files?

Constructor Summary
void mdb_config([string $iniFile])
Initialize the 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?


default_agent

string $default_agent

Set the default user agent (if none is detected)


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.


language

string $language

Tell IMDB which is the preferred language. Any valid language code can be used here (e.g. en-US, de, pt-BR). If this option is specified, the Accept-Language header with this value will be included in the requests.


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_imdbfill

integer $pilot_imdbfill

If the Pilot classes miss certain data (i.e. it does not provide that datatype at all, as it is e.g. with MPAA/FSK), should the API try to substitute them via the IMDB class? To define this, you should use the following constants:


storecache

boolean $storecache

Store the pages retrieved for later use?


usecache

boolean $usecache

Use a cached page to retrieve the information if available?


usezip

boolean $usezip

Use zip compression for caching the retrieved html-files?


Constructor Detail

mdb_config()

void mdb_config([string $iniFile])

Initialize the class

Parameters:
iniFile - A config file containing any config overrides

 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 Stephane GALLAND (under the GNU General Public License)