Class: File_DeliciousLibrary

Source Location: /File_DeliciousLibrary-0.1.1/DeliciousLibrary.php

Class Overview

Main application class for parsing the library database of the Delicious Library Software

Author(s):

Martin Jansen <mj at php.net>

Inherited Variables

Inherited Methods

Class Details

[line 52]
Main application class for parsing the library database of the Delicious Library Software

Author: Martin Jansen <mj@php.net>
License: BSD

[ Top ]

Class Variables

$include =

[line 76]

Determines which sort of items to include in the parsing result

This variable holds a bitmask made up of the INCLUDE_* class constants. By default it is set to INCLUDE_BOOKS | INCLUDE_MOVIES | INCLUDE_MUSIC | INCLUDE_GAMES, i.e. all items will be included. If you e.g. only wish to include books and games use

$parser->include = File_DeliciousLibrary::INCLUDE_BOOKS | File_DeliciousLibrary::INCLUDE_GAMES

before calling $parser->parse().

Access: public

Type:

int

[ Top ]

$items = array()

[line 88]

Holds a list of all items that are part of the library

This variable is an associative array where the key is a unique, alphanumeric identifier and the value is an instance of a subclass of File_DeliciousLibrary_Item containing information about the item.

Access: public

Type:

array

[ Top ]

$shelves = array()

[line 101]

Holds a list of all custom shelves and their items

This variable is an associative array where the key is the name of the, shelf and the value is an instance of File_DeliciousLibrary_Shelf containing information about the custom shelf and the items that are part of it.

Access: public

Type:

array

[ Top ]

Method Detail

__construct (Constructor) [line 110]

File_DeliciousLibrary __construct(
string
$library)

Constructor

Access: public

Parameters:

string $library — Location of the library file. This file is usually called Library Media Data.xml and resides in the directory ~/Library/Application Support/Delicious Library.

[ Top ]

getBooks [line 185]

array getBooks(
)

Returns all books from the library

Return: Returns an associative array where the key is a unique, alphanumeric identifier and the value is an instance of File_DeliciousLibrary_Book containing information about each book.
Access: public

[ Top ]

getGames [line 221]

array getGames(
)

Returns all games from the library

Return: Returns an associative array where the key is a unique, alphanumeric identifier and the value is an instance of File_DeliciousLibrary_Game containing information about each game.
Access: public

[ Top ]

getItemInstance [line 124]

File_DeliciousLibrary_Item getItemInstance(
string
$ident)

Returns an instance of a subclass of File_DeliciousLibrary_Item for an item from the library

You are not expected to call this method directly.

Throws: File_DeliciousLibrary_Exception
Access: public

Parameters:

string $ident — Name of the item ("book", "movie", "music", "game")

[ Top ]

getMovies [line 197]

array getMovies(
)

Returns all movies from the library

Return: Returns an associative array where the key is a unique, alphanumeric identifier and the value is an instance of File_DeliciousLibrary_Movie containing information about each movie.
Access: public

[ Top ]

getMusic [line 209]

array getMusic(
)

Returns all music from the library

Return: Returns an associative array where the key is a unique, alphanumeric identifier and the value is an instance of File_DeliciousLibrary_Music containing information about each album.
Access: public

[ Top ]

parse [line 140]

void parse(
)

Parses the Delicous Library library database

Throws: File_DeliciousLibrary_Exception
Access: public

[ Top ]