Skip to content

Latest commit

 

History

History
55 lines (48 loc) · 2.49 KB

Movie.md

File metadata and controls

55 lines (48 loc) · 2.49 KB

Movie

The object to represent a movie

Property List

Data type Property Description
int ratingKey
string key The key to get details of the movie
string guid
string studio The movie studio that created the movie
string type The media type (movie)
string title The title of the movie
string titleSort The title used to sort the movie for display
string contentRating The content rating of the movie (G, PG, PG-13, etc)
string summary The summary of the movie
string audienceRating The audience rating of the movie
int viewCount The number of times this movie has been viewed
DateTime lastViewedAt The last date and time this movie was watched
int year The year the movie was released
string tagline Any tagline for the movie
string thumb Movie thumbnail
string art Movie artwork
Duration duration The duration of the movie
DateTime originallyAvilableAt The date and time of movie was originally released
DateTime addedAt The date and time the movie was added to the library
DateTime updatedAt The date and time the movie entry in the library was updated
string audienceRatingImage
string primaryExtraKey
array:string genre The genres the movie falls into
array:string director The directors for the movie
array:string writer The movie writers
array:string country The counties the movie was filmed in
array:string role The actor/actresses in the movie
Media media The media for the movie

Function List

Visibility Function (parameters,...): return
public __construct(): void
public __get(string $var): mixed
Magic getter
public __set(string $var, mixed $val): void
Magic setter
public static fromLibrary(array $library): Movie
Create a movie from the Plex API call return

Examples

Simple example which can be duplicated by just passing in true as the second parameter to the getLibrarySectionContents method.

$res = $api->getLibrarySectionContents(1);
foreach($res['Video'] as $m) {
    $movie = Movie::fromLibrary($m);
}