Class: File_DeliciousLibrary_Shelf

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

Class Overview

Class representing custom shelves containing a mix of books, movies, video games, and music

Author(s):

Martin Jansen <mj at php.net>

Inherited Variables

Inherited Methods

Class Details

[line 47]
Class representing custom shelves containing a mix of books, movies, video games, and music

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

[ Top ]

Class Variables

$items = array()

[line 67]

The items on the shelf

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 ]

$name = ""

[line 55]

The name of the shelf

Access: public

Type:

string

[ Top ]

Method Detail

contains [line 82]

boolean contains(
File_DeliciousLibrary_Item
$item)

Checks if an item is part of the shelf

This method takes an item as its input and determines if the shelf contains this item.

It is basically is a convenience helper so that one does not need to work with the unique identifiers provided by Delicious Library but directly with instances of the item classes.

Return: TRUE if the item is part of the shelf, FALSE otherwise.
Access: public

Parameters:

File_DeliciousLibrary_Item $item — The item

[ Top ]