Docs For Class Basket

Description

A Basket is a session-persistant ordered collection of Asset Ids. Items can be added and removed from it, as well as its contents viewed.

author: Adam Franco
version: $Id: Basket.class.php,v 1.17 2007/09/19 14:04:43 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 8/5/05

Located in /polyphony/main/library/Basket/Basket.class.php (line 24)

SObject
   |
   --OrderedSet
      |
      --Basket

Method Summary

void Basket ()

void clean ()

string getAddLink (object Id $assetId)

object Component getSmallBasketBlock ([integer $level = ALERT_BLOCK])

<##> getSmallBasketHtml (<##> 0)

object Basket instance ()

Variables

Inherited Variables

Inherited from OrderedSet

OrderedSet::$_i
OrderedSet::$_items
OrderedSet::$_setId

Methods

Constructor Basket (line 60)

The constructor.

access: public

void Basket ()

clean (line 95)

removes unauthorized assets from the basket

since: 12/14/05
access: public

void clean ()

getAddLink (line 393)

Answer the link to add a particular id to the basket

return: XHTML
since: 5/2/06
access: public

string getAddLink (object Id $assetId)

object Id $assetId

getSmallBasketBlock (line 121)

Return an XHTML string of a small version of the basket for use in a header.

Includes a link and the number of items in it.

since: 8/5/05
access: public

object Component getSmallBasketBlock ([integer $level = ALERT_BLOCK])

integer $level: The level of component to return

getSmallBasketHtml (line 315)

Answer the XHTML string of the small version of the basket contents

since: 5/2/06
access: public

<##> getSmallBasketHtml (<##> 0)

<##> 0

instance (line 43)

Get the instance of the Basket.

The Basket class implements the Singleton pattern. There is only ever on instance of the Basket object and it is accessed only via the Basket::instance() method.

static:
since: 5/26/05
access: public

object Basket instance ()

Inherited Methods

Inherited From OrderedSet

OrderedSet::OrderedSet()
OrderedSet::addItem()
OrderedSet::atPosition()
OrderedSet::count()
OrderedSet::getId()
OrderedSet::getPosition()
OrderedSet::hasNext()
OrderedSet::initializeWithData()
OrderedSet::isInSet()
OrderedSet::moveDown()
OrderedSet::moveToBeginning()
OrderedSet::moveToEnd()
OrderedSet::moveToPosition()
OrderedSet::moveUp()
OrderedSet::next()
OrderedSet::removeAllItems()
OrderedSet::removeItem()
OrderedSet::reset()
OrderedSet::toDataString()

Inherited From SObject

SObject::asA()
SObject::asString()
SObject::copy()
SObject::copySameFrom()
SObject::copyTwoLevel()
SObject::deepCopy()
SObject::isEqual()
SObject::isEqualTo()
SObject::isNotEqualTo()
SObject::isNotReferenceTo()
SObject::isReferenceTo()
SObject::newFrom()
SObject::postCopy()
SObject::printableString()
SObject::shallowCopy()
SObject::_deepCopyArray()