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

MoviePilot
Class pilot

- mdb_config
-

class pilot
extends movie_base

Accessing MoviePilot information

Authors:
Izzy (izzysoft AT qumran DOT org)
Version:
$Revision: 481 $ $Date: 2011-10-12 12:45:48 +0200 (Mi, 12. Okt 2011) $
Copyright:
(c) 2009 by Itzchak Rehberg and IzzySoft

Constructor Summary
void pilot(string $id)
Initialize class

Method Summary
array alsoknow()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill > BASIC_ACCESS
string aspect_ratio()
If pilot_imdbfill is set at least to BASIC_ACCESS, it will be retrieved from IMDB.
array awards()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
array cast()
Get the actors
private void castlist()
Obtain all cast data
array colors()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill > BASIC_ACCESS
string comment()
Get movie main comment (from title page)
array comment_split()
Get movie main comment (from title page - split-up variant)
array composer()
Obtain the composer(s) ("Original Music by...")
array country()
Get country of production
array crazy_credits()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
array creator()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
array director()
Get the director(s) of the movie
array distCompany()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
array episodes()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
array extReviews()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
string genre()
There is not really a main genre on the IMDB sites (yet), so this simply returns the first one
array genres()
Get all genres the movie is registered for
array goofs()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
private boolean invalidPage(string $wt)
Check if we have valid page content
boolean is_serial()
Try to figure out if this is a movie or part of a serie
array keywords()
Get the keywords for the movie
array keywords_all()
Get the full keywords for the movie Just for compatibility with the IMDB class - result here is identical with pilot::keywords
string language()
There is not really a main language on the IMDB sites (yet), so this simply returns the first oneNo data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill > BASIC_ACCESS
array languages()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill > BASIC_ACCESS
array languages_detailed()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill > BASIC_ACCESS
array locations()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
string main_url()
Set up the URL to the movie title page
array mainPictures()
Get URLs for the pictures on the main page
private string mid(string $input)
Create a valid IMDBID
array movieconnection()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
string movietype()
No data available at MoviePilot. If pilot_imdbfill is set at least to BASIC_ACCESS, it will be retrieved from IMDB.
array movieTypes()
No data available at MoviePilot. If pilot_imdbfill is set at least to BASIC_ACCESS, it will be retrieved from IMDB.
array mpaa()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill > NO_ACCESS
array mpaa_hist()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
string mpaa_reason()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
array officialSites()
URLs of Official Sites
private void openpage(string $wt, [string $type])
Load an Pilot page into the corresponding property (variable)
array otherCompany()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
array parentalGuide()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
mixed photo([boolean $thumb])
Get cover photo
mixed photo_localurl([boolean $thumb])
Get the URL for the movies cover photo
array plot()
No data available at MoviePilot. If pilot_imdbfill is set to FULL_ACCESS, we will automatically retrieve this data from the IMDB site configured. Otherwise we fake some data using pilot::plotoutline(), resulting in a single record (if any) available there.
array plot_split()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
string plotoutline()
Get the main Plot outline for the movie
array prodCompany()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
void prodNotes()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
array producer()
Obtain the producer(s)
array quotes()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
string rating()
Get movie rating
array releaseInfo()
Obtain Release Info (if any)
mixed runtime()
Get overall runtime (first one mentioned on title page)
array runtimes()
Retrieve language specific runtimes
boolean savephoto(string $path, [boolean $thumb])
Save the photo to disk
integer seasons()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
protected string set_pagename(string $wt)
Define page urls
void setid(string $id)
Setup class for a new IMDB id
array sound()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill > BASIC_ACCESS
array soundtrack()
Usually, the credits array should hold [0] written by, [1] performed by. But IMDB does not always stick to that - so in many cases it holds [0] performed by, [1] courtesy of
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
array specialCompany()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
string storyline()
Get the Storyline for the movie
string synopsis()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
string tagline()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
array taglines()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
private boolean thumbphoto()
Setup cover photo (thumbnail and big variant)
string title()
Get movie title
integer top250()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
mixed trailers([boolean $full])
Get the trailer URLs for a given movie
array trivia()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
void videosites()
No data available at MoviePilot. AutoRetrieval from IMDB with pilot_imdbfill set to FULL_ACCESS
string votes()
Return votes for this movie
array writing()
Get the writer(s)
string year()
Get year
array yearspan()
Get range of years for e.

Methods inherited from class movie_base and not overridden
reset_vars

Methods inherited from class mdb_base and not overridden
cache_read, cache_write, get_pilot_imdbfill(), getWebPage, imdbid, monthNo, purge, set_pilot_imdbfill

Constructor Detail

pilot()

void pilot(string $id)

Initialize class

Parameters:
id - IMDBID to use for data retrieval

Method Detail

alsoknow()

array alsoknow()

Get movies alternative names

Returns:
aka array[0..n] of array[title,year,country,comment]; searching on akas.imdb.com will add "lang" (2-char language code) to the array for localized names, "comment" will hold additional countries listed along for these as well as comments: As these things are quite mixed up on the imdb sites, it's hard to tell what is an additional country and what is a comment...
Version:
no data available
See also:
MoviePilot page / (TitlePage)

aspect_ratio()

string aspect_ratio()

Aspect Ratio of movie screen

Returns:
ratio
To Do:
  • Check if this is available from pilot directly
See also:
IMDB page / (TitlePage)

awards()

array awards()

Get the complete awards for the movie

Returns:
awards array[festivalName]['entries'][0..n] of array[year,won,category,award,people]
See also:
IMDB page /awards

cast()

array cast()

Get the actors

Returns:
cast (array[0..n] of arrays[imdb,name,role,thumb,photo])
See also:
MoviePilot page /fullcredits

castlist()

private void castlist()

Obtain all cast data


colors()

array colors()

Get colors

Returns:
colors (array[0..1] of strings)
See also:
MoviePilot page / (TitlePage)

comment()

string comment()

Get movie main comment (from title page)

Returns:
comment full text of movie comment from the movies main page
See also:
MoviePilot page / (TitlePage)

comment_split()

array comment_split()

Get movie main comment (from title page - split-up variant)

Returns:
comment array[string title, string date, array author, string comment]; author: array[string url, string name]
Version:
not yet available
See also:
MoviePilot page / (TitlePage)

composer()

array composer()

Obtain the composer(s) ("Original Music by...")

Returns:
composer (array[0..n] of arrays[imdb,name,role])
See also:
MoviePilot page /fullcredits

country()

array country()

Get country of production

Returns:
country (array[0..n] of string)
See also:
MoviePilot page / (TitlePage)

crazy_credits()

array crazy_credits()

Get the Crazy Credits

Returns:
crazy_credits (array[0..n] of string)
See also:
MoviePilot page /crazycredits

creator()

array creator()

Get the creator of a movie (most likely for seasons only)

Returns:
creator (array[0..n] of array[name,imdb])
See also:
MoviePilot page / (TitlePage)

director()

array director()

Get the director(s) of the movie

Returns:
director (array[0..n] of arrays[imdb,name,role])
See also:
MoviePilot page /fullcredits

distCompany()

array distCompany()

Info about distributors

Returns:
[0..n] of array (name,url,notes)
See also:
MoviePilot page /companycredits

episodes()

array episodes()

Get the series episode(s)

Returns:
episodes (array[0..n] of array[0..m] of array[imdbid,title,airdate,plot])
See also:
MoviePilot page /episodes

extReviews()

array extReviews()

Get list of external reviews (if any)

Returns:
[0..n] of array [url, desc] (or empty array if no data)
See also:
MoviePilot page /externalreviews

genre()

string genre()

Get the movies main genre Since IMDB.COM does not really now a "Main Genre", this simply means the first mentioned genre will be returned.

Returns:
genre first of the genres listed on the movies main page
Version:
does currently not match the IMDB genres (hopefully will in the future)
See also:
MoviePilot page / (TitlePage)

genres()

array genres()

Get all genres the movie is registered for

Returns:
genres (array[0..n] of strings)
Version:
does currently not match the IMDB genres (hopefully will in the future)
See also:
MoviePilot page / (TitlePage)

goofs()

array goofs()

Get the goofs

Returns:
goofs (array[0..n] of array[type,content]
See also:
MoviePilot page /goofs

invalidPage()

private boolean invalidPage(string $wt)

Check if we have valid page content

Parameters:
wt - internal name of the page
Returns:
invalid

is_serial()

boolean is_serial()

Try to figure out if this is a movie or part of a serie

Returns:
See also:
IMDB page / (TitlePage)

keywords()

array keywords()

Get the keywords for the movie

Returns:
keywords
See also:
MoviePilot page / (TitlePage)

keywords_all()

array keywords_all()

Get the full keywords for the movie Just for compatibility with the IMDB class - result here is identical with pilot::keywords

Returns:
keywords
See also:
MoviePilot page / (TitlePage)

language()

string language()

Get movies original language

Returns:
language
See also:
MoviePilot page / (TitlePage)

languages()

array languages()

Get all langauges this movie is available in

Returns:
languages (array[0..n] of strings)
See also:
MoviePilot page / (TitlePage)

languages_detailed()

array languages_detailed()

Get all languages this movie is available in, including details

Returns:
languages (array[0..n] of array[string name, string code, string comment], code being the ISO-Code)
See also:
IMDB page / (TitlePage)

locations()

array locations()

Obtain filming locations

Returns:
locations array[0..n] of array[name,url] with name being the name of the location, and url a relative URL to list other movies sharing this location
See also:
IMDB page /locations

main_url()

string main_url()

Set up the URL to the movie title page

Returns:
url full URL to the current movies main page

mainPictures()

array mainPictures()

Get URLs for the pictures on the main page

Returns:
[0..n] of [imgsrc, imglink, bigsrc], where
  • imgsrc is the URL of the thumbnail IMG as displayed on main page
  • imglink is the link to the page with the "big image" (empty here - just for compatibility with the imdb class)
  • bigsrc is the URL of the "big size" image itself

mid()

private string mid(string $input)

Create a valid IMDBID

Parameters:
input - value to check
Returns:
imdbid either valid IMDBID (7 digit), or empty string

movieconnection()

array movieconnection()

Get connected movie information

Returns:
connections (versionOf, editedInto, followedBy, spinOff, spinOffFrom, references, referenced, features, featured, spoofs, spoofed - each an array of mid, name, year, comment or an empty array if no connections of that type)
See also:
MoviePilot page /movieconnection

movietype()

string movietype()

Get movie type

Returns:
movietype (TV series, Movie, ...)
See also:
IMDB page / (TitlePage)

movieTypes()

array movieTypes()

Get movie types (if any specified)

Returns:
[0..n] of strings (or empty array if no movie types specified)
See also:
MoviePilot page / (TitlePage)

mpaa()

array mpaa()

Get the MPAA data (also known as PG or FSK)

Returns:
mpaa (array[country]=rating)
See also:
MoviePilot page / (TitlePage)

mpaa_hist()

array mpaa_hist()

Get the MPAA data (also known as PG or FSK) - including historical data

Returns:
mpaa (array[country][0..n]=rating)
See also:
MoviePilot page / (TitlePage)

mpaa_reason()

string mpaa_reason()

Find out the reason for the MPAA rating

Returns:
reason why the movie was rated such
See also:
MoviePilot page / (TitlePage)

officialSites()

array officialSites()

URLs of Official Sites

Returns:
[0..n] of url, name
Version:
no complete data available here, but we can get the homepage
See also:
MoviePilot page (Title)

openpage()

private void openpage(string $wt, [string $type])

Load an Pilot page into the corresponding property (variable)

Parameters:
wt - internal name of the page
type - whether its a "movie" (default) or a "person"

otherCompany()

array otherCompany()

Info about other companies

Returns:
[0..n] of array (name,url,notes)
See also:
MoviePilot page /companycredits

parentalGuide()

array parentalGuide()

Detailed Parental Guide

Returns:
of strings; keys: Alcohol, Sex, Violence, Profanity, Frightening - and maybe more; values: arguments for the rating
See also:
MoviePilot page /parentalguide

photo()

mixed photo([boolean $thumb])

Get cover photo

Parameters:
thumb - get the thumbnail (about 60x45px, default) or the original variant (FALSE).
Returns:
photo (string url if found, FALSE otherwise)
See also:
MoviePilot page / (TitlePage)

photo_localurl()

mixed photo_localurl([boolean $thumb])

Get the URL for the movies cover photo

Parameters:
thumb - get the thumbnail (about 60x45, default) or the original variant (FALSE)
Returns:
url (string URL or FALSE if none)
See also:
MoviePilot page / (TitlePage)

plot()

array plot()

Get the movies plot(s)

Returns:
plot (array[0..n] of strings)
See also:
MoviePilot page (Titlepage)

plot_split()

array plot_split()

Get the movie plot(s) - split-up variant

Returns:
array[0..n] of array[string plot,array author] - where author consists of string name and string url
See also:
MoviePilot page (Titlepage)

plotoutline()

string plotoutline()

Get the main Plot outline for the movie

Returns:
plotoutline
See also:
MoviePilot page / (TitlePage)

prodCompany()

array prodCompany()

Info about Production Companies

Returns:
[0..n] of array (name,url,notes)
See also:
MoviePilot page /companycredits

prodNotes()

void prodNotes()

For not-yet completed movies, we can get the production state

See also:
MoviePilot page / (TitlePage)

producer()

array producer()

Obtain the producer(s)

Returns:
producer (array[0..n] of arrays[imdb,name,role])
See also:
MoviePilot page /fullcredits

quotes()

array quotes()

Get the quotes for a given movie

Returns:
quotes (array[0..n] of string)
See also:
MoviePilot page /quotes

rating()

string rating()

Get movie rating

Returns:
rating current rating as given by MoviePilot site
See also:
MoviePilot page / (TitlePage)

releaseInfo()

array releaseInfo()

Obtain Release Info (if any)

Returns:
release_info array[0..n] of strings (country,day,month,mon, year,comment) - "month" is the month name, "mon" the number
Version:
no complete data available
See also:
MoviePilot page (Titlepage)

runtime()

mixed runtime()

Get overall runtime (first one mentioned on title page)

Returns:
string runtime in minutes (if set), NULL otherwise
See also:
MoviePilot page / (TitlePage)

runtimes()

array runtimes()

Retrieve language specific runtimes

Returns:
runtimes (array[0..n] of array[time,country,comment])
Version:
this is a fake
See also:
MoviePilot page / (TitlePage)

savephoto()

boolean savephoto(string $path, [boolean $thumb])

Save the photo to disk

Parameters:
path - where to store the file
thumb - get the thumbnail (about 60x45px, default) or the original variant (FALSE)
Returns:
success
See also:
MoviePilot page / (TitlePage)

seasons()

integer seasons()

Get the number of seasons or 0 if not a series

Returns:
seasons number of seasons
See also:
MoviePilot page / (TitlePage)

set_pagename()

protected string set_pagename(string $wt)

Define page urls

Parameters:
wt - internal name of the page
Returns:
urlname page URL

setid()

void setid(string $id)

Setup class for a new IMDB id

Parameters:
id - IMDBID of the requested movie

sound()

array sound()

Get sound formats

Returns:
sound (array[0..n] of strings)
See also:
MoviePilot page / (TitlePage)

soundtrack()

array soundtrack()

Get the soundtrack listing

Returns:
soundtracks (array[0..n] of array(soundtrack,array[0..n] of credits)
See also:
MoviePilot page /soundtrack

specialCompany()

array specialCompany()

Info about Special Effects companies

Returns:
[0..n] of array (name,url,notes)
See also:
MoviePilot page /companycredits

storyline()

string storyline()

Get the Storyline for the movie

Returns:
storyline
See also:
IMDB page / (TitlePage)

synopsis()

string synopsis()

Get the movies synopsis

Returns:
synopsis
See also:
MoviePilot page /synopsis

tagline()

string tagline()

Get the main tagline for the movie

Returns:
tagline
Version:
no data available
See also:
MoviePilot page / (TitlePage)

taglines()

array taglines()

Get all available taglines for the movie

Returns:
taglines (array[0..n] of strings)
See also:
MoviePilot page /taglines

thumbphoto()

private boolean thumbphoto()

Setup cover photo (thumbnail and big variant)

Returns:
success (TRUE if found, FALSE otherwise)
See also:
MoviePilot page / (TitlePage)

title()

string title()

Get movie title

Returns:
title movie title (name)
See also:
MoviePilot page / (TitlePage)

top250()

integer top250()

Find the position of a movie in the top 250 ranked movies

Returns:
position a number between 1..250 if the movie is listed, 0 otherwise

trailers()

mixed trailers([boolean $full])

Get the trailer URLs for a given movie

Parameters:
full - Retrieve all available data (TRUE), or stay compatible with previous IMDBPHP versions (FALSE, Default)
Returns:
trailers either array[0..n] of string ($full=FALSE), or array[0..n] of array[lang,title,url,restful_url ($full=TRUE)
See also:
MoviePilot page /trailers

trivia()

array trivia()

Get the trivia info

Returns:
trivia (array[0..n] string
See also:
MoviePilot page /trivia

videosites()

void videosites()

Get the off-site videos and trailer URLs

See also:
IMDB page /videosites

votes()

string votes()

Return votes for this movie

Returns:
votes count of votes for this movie
Version:
no data provided, so we fake some
See also:
MoviePilot page / (TitlePage)

writing()

array writing()

Get the writer(s)

Returns:
writers (array[0..n] of arrays[imdb,name,role])
See also:
MoviePilot page /fullcredits

year()

string year()

Get year

Returns:
year
See also:
MoviePilot page / (TitlePage)

yearspan()

array yearspan()

Get range of years for e.g. series spanning multiple years This is just here for compatibility with the IMDB class - so for now start==end

Returns:
yearspan [start,end] (if there was no range, start==end)
See also:
MoviePilot page / (TitlePage)

 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)