apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: File_DeliciousLibrary_Item

Source Location: /File_DeliciousLibrary-0.1.1/DeliciousLibrary/Item.php

Class Overview


Abstract class for all items from the library


Author(s):

Variables

Methods


Child classes:

File_DeliciousLibrary_Book
Class representing books from the library
File_DeliciousLibrary_Movie
Class representing movies from the library
File_DeliciousLibrary_Music
Class representing music from the library
File_DeliciousLibrary_Game
Class representing games from the library

Inherited Variables

Inherited Methods


Class Details

[line 47]
Abstract class for all items from the library


[ Top ]


Class Variables

$recommendations = array()

[line 54]

  • Access: public

Type:   mixed


[ Top ]



Method Detail

getCoverLocation   [line 91]

string getCoverLocation( [int $size = self::COVER_SMALL])

Returns the location of the cover image for the item

Depending on the value of the parameter this method constructs the location of the file that contains the cover image associated with the item. Note that the method does not check if the image exists at the returned location.

  • Return: Location of the cover image
  • Access: public

Parameters:

int   $size   —  Size of the cover image. Can be self::COVER_LARGE; self::COVER_MEDIUM, self::COVER_PLAIN, and self::COVER_SMALL. Defaults to self::COVER_SMALL.

[ Top ]

loadInformation   [line 63]

void loadInformation( string $library, SimpleXMLElement $information)

Extracts information from an XML element and loads it into the item
  • Access: public

Parameters:

string   $library   —  Location of the XML library file
SimpleXMLElement   $information   —  XML element defining the item

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:26:37 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.