Class Dreambox

Description

Located in /Dreambox.class.php (line 2)


	
			
Variable Summary
Method Summary
Dreambox __construct ([string $pIP = ""], [string $pType = ""], [array $pAuthentication = array()], int $pReNew)
void dump ()
string getBoutiqueUrl ()
boolean getDreamboxIP ()
boolean isOnline ()
boolean loadBoutiques (int $pReNew)
void loadChannels (int $pReNew)
void loadProgramGuide ([string $pChannelID = ""])
void saveObjectCache ()
Boutique searchBoutique (string $pBoutiqueID)
boolean setDreamboxIP (string $pIp)
boolean setDreamboxType (string $pType)
void zap (string $pBoutiqueID, string $pChannelID)
Variables
array $lAuthentication (line 51)
  • access: private
int $lBoutiqueQueueCounter (line 26)
  • access: private
string $lBoutiques (line 14)
  • access: private
string $lCurrentBoutique (line 32)
  • access: private
string $lCurrentChannel (line 38)
  • access: private
string $lIPNummer (line 8)
  • access: private
ProgramGuide $lProgramGuide (line 44)
  • access: private
string $lType (line 20)
  • access: private
Methods
Constructor __construct (line 61)

Constructor.

Constructor. This creates the Dreambox object. If it exists in the session cache, it will be recreated from the cahce instead a new object.

Dreambox __construct ([string $pIP = ""], [string $pType = ""], [array $pAuthentication = array()], int $pReNew)
  • string $pIP
  • string $pType
  • array $pAuthentication
  • int $pReNew
dump (line 339)

Dump the complete object to screen.

Dump the complete object to screen.

  • access: public
void dump ()
getAthentication (line 195)
  • access: public
void getAthentication ()
getBoutiquesCount (line 274)

Get the total boutiques.

Get the total boutiques.

int getBoutiquesCount ()
getBoutiqueUrl (line 102)

Get the Boutique url.

Get the Boutique url. This is used for getting boutique information from your dreambox.

  • access: private
string getBoutiqueUrl ()
getDreamboxIP (line 148)

Get the current IP of the Dreambox object.

Get the current IP of the Dreambox object.

  • access: public
boolean getDreamboxIP ()
getDreamboxPassWord (line 191)
  • access: public
void getDreamboxPassWord ()
getDreamboxUserName (line 187)
  • access: public
void getDreamboxUserName ()
getNextBoutique (line 282)

Get the next boutique.

Get the next boutique. This function gives the next boutique and updates it internal counter.

Boutique getNextBoutique ()
isOnline (line 156)

Check if the Dreambox is online.

Check if the Dreambox is online.

  • access: public
boolean isOnline ()
loadBoutiques (line 206)

Load the data from the Dreambox.

Load the data from the Dreambox. Here all youre boutiques will be collected and saved in the dreambox object. Set $pReNew to 1 to force a reload of the boutique data.

  • access: public
boolean loadBoutiques (int $pReNew)
  • int $pReNew
loadChannels (line 254)

Load the channel data.

Load the channel data. This is done after the boutiques are loaded. The actual loading of the data happens in the Boutique class. Set $pReNew to 1 to force a reload of the channel data

void loadChannels (int $pReNew)
  • int $pReNew
loadProgramGuide (line 330)

Load the program guide of a channel.

Load the program guide of a channel. The function uses the ProgramGuide object to load the data.

  • access: public
void loadProgramGuide ([string $pChannelID = ""])
  • string $pChannelID
programGuide (line 322)

Return the programguide object.

Return the programguide object. You can use the programguide to find programs and show a soort of tv guide.

  • access: public
ProgramGuide programGuide ()
resetBoutiqueCounter (line 265)

Reset the boutiquecounter.

Reset the boutiquecounter. This is an internal counter to keep track of the possituin in the boutique list.

void resetBoutiqueCounter ()
saveObjectCache (line 94)

Save the current Dreambox object state to a session.

Save the current Dreambox object state to a session. This is used for caching.

  • access: private
void saveObjectCache ()
searchBoutique (line 296)

Search for a boutique base on boutiqueID.

Search for a boutique base on boutiqueID. This function returns a boutique when ID is valid and found. Else it returns false.

Boutique searchBoutique (string $pBoutiqueID)
  • string $pBoutiqueID
setDreamboxIP (line 125)

Set the Dreambox IP nummer.

Set the Dreambox IP nummer. If the IP nummer is not valid, it will be ignored.

  • access: public
boolean setDreamboxIP (string $pIp)
  • string $pIp
setDreamboxType (line 168)

Set the Dreambox type.

Set the Dreambox type. Valid values are 'enigma1' and 'enigma2'.

  • access: public
boolean setDreamboxType (string $pType)
  • string $pType
zap (line 312)

Zap the dreambox to the new channel.

Zap the dreambox to the new channel. This function saves the boutique and channel in the dreambox object so that you can ask the dreambox what you are wachting.

void zap (string $pBoutiqueID, string $pChannelID)
  • string $pBoutiqueID
  • string $pChannelID

Documentation generated on Sat, 19 Jan 2008 12:56:15 +0100 by phpDocumentor 1.3.0RC3