PHP Class Imdb\Config

Author: Izzy (izzysoft AT qumran DOT org)
Datei anzeigen Open project: tboothman/imdbphp Class Usage Examples

Public Properties

Property Type Description
$cache_expire integer If 0 cached pages will never expire
$cachedir string Directory to store cached pages. This must be writable by the web server. It doesn't need to be under documentroot.
$converttozip boolean Convert non-zip cache-files to zip (check file permissions!)?
$debug boolean Enable debug mode?
$default_agent string Set the default user agent (if none is detected)
$force_agent string Enforce the use of a special user agent
$imdb_img_url string 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)
$imdbsite IMDB domain to use.
$language string If this option is specified, a Accept-Language header with this value will be included in requests to IMDb.
$photodir string This needs to be under documentroot to be able to display them on your pages.
$photoroot string URL corresponding to photodir, i.e. the URL to the images, i.e. start at your servers DOCUMENT_ROOT when specifying absolute path
$storecache boolean Store the pages retrieved for later use?
$throwHttpExceptions boolean Throw exceptions when a request to fetch some content fails?
$usecache boolean Use cached pages if available?
$usezip boolean Use zip compression for caching the retrieved html-files?

Public Methods

Method Description
__construct ( string $iniFile = null ) Constructor

Method Details

__construct() public method

Constructor
public __construct ( string $iniFile = null )
$iniFile string *optional* Path to a config file containing any config overrides

Property Details

$cache_expire public_oe property

If 0 cached pages will never expire
public int $cache_expire
return integer

$cachedir public_oe property

Directory to store cached pages. This must be writable by the web server. It doesn't need to be under documentroot.
public string $cachedir
return string

$converttozip public_oe property

Convert non-zip cache-files to zip (check file permissions!)?
public bool $converttozip
return boolean

$debug public_oe property

Enable debug mode?
public bool $debug
return boolean

$default_agent public_oe property

Set the default user agent (if none is detected)
public string $default_agent
return string

$force_agent public_oe property

Enforce the use of a special user agent
public string $force_agent
return string

$imdb_img_url public_oe property

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)
public string $imdb_img_url
return string

$imdbsite public_oe property

IMDB domain to use.
public $imdbsite

$language public_oe property

If this option is specified, a Accept-Language header with this value will be included in requests to IMDb.
public string $language
return string

$photodir public_oe property

This needs to be under documentroot to be able to display them on your pages.
public string $photodir
return string

$photoroot public_oe property

URL corresponding to photodir, i.e. the URL to the images, i.e. start at your servers DOCUMENT_ROOT when specifying absolute path
public string $photoroot
return string

$storecache public_oe property

Store the pages retrieved for later use?
public bool $storecache
return boolean

$throwHttpExceptions public_oe property

Throw exceptions when a request to fetch some content fails?
public bool $throwHttpExceptions
return boolean

$usecache public_oe property

Use cached pages if available?
public bool $usecache
return boolean

$usezip public_oe property

Use zip compression for caching the retrieved html-files?
public bool $usezip
return boolean