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 ()
Boutique findBoutiqueWithChannel (mixed $pChannelID)
array getAthentication ()
string getBoutiqueUrl ()
boolean getDreamboxIP ()
password getDreamboxPassWord ()
void getRecordings ()
string getRecordingUrl ()
boolean isOnline ()
boolean loadBoutiques (int $pReNew)
void loadChannels (int $pReNew)
void loadProgramGuide ([string $pChannelID = ""])
string sanityCheck ()
void saveObjectCache ()
Boutique searchBoutique (string $pBoutiqueID)
boolean setDreamboxIP (string $pIp)
boolean setDreamboxType (string $pType)
void zap (string $pBoutiqueID, string $pChannelID)
Variables
array $lAuthentication (line 62)
  • 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 $lRecordings (line 50)
  • access: private
int $lRecordingsQueueCounter (line 56)
  • access: private
string $lType (line 20)
  • access: private
Methods
Constructor __construct (line 72)

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 500)

Dump the complete object to screen.

Dump the complete object to screen.

  • access: public
void dump ()
findBoutiqueWithChannel (line 442)

Find the boutique that holds the channel.

Find the boutique that holds the channel. So you can search for the boutique that contains a specifeid channel. Return null when not found

Boutique findBoutiqueWithChannel (mixed $pChannelID)
getAthentication (line 321)

Get the authentication array.

Get the authentication array. This will containt the username and password in an array.

  • access: public
array getAthentication ()
getBoutiquesCount (line 405)

Get the total boutiques.

Get the total boutiques.

int getBoutiquesCount ()
getBoutiqueUrl (line 117)

Get the Boutique url.

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

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

Get the current IP of the Dreambox object.

Get the current IP of the Dreambox object.

  • access: public
boolean getDreamboxIP ()
getDreamboxPassWord (line 312)

Get the dreambox password for authorization in plain text

Get the dreambox password for authorization in plain text

  • access: public
password getDreamboxPassWord ()
getDreamboxUserName (line 303)

Get the dreambox username for authorization

Get the dreambox username for authorization

  • access: public
string getDreamboxUserName ()
getNextBoutique (line 414)

Get the next boutique.

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

Boutique getNextBoutique ()
getNextRecording (line 211)

Iterate trough the recordings.

Iterate trough the recordings.

Recording getNextRecording ()
getRecordings (line 162)

Get all recordings from the dreambox.

Get all recordings from the dreambox. The recordings will be save in a recording object array. It can self see with enigma version is used, and what the code will be that will be returned from the dreambox

  • access: public
void getRecordings ()
getRecordingUrl (line 140)

Get the Recording url.

Get the Recording url. This is used for getting recoring information from your dreambox.

  • access: public
string getRecordingUrl ()
isOnline (line 255)

Check if the Dreambox is online.

Check if the Dreambox is online.

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

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 384)

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 476)

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 467)

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 395)

Reset the boutiquecounter.

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

void resetBoutiqueCounter ()
sanityCheck (line 487)

Sanity check.

Sanity check. This checks all settings that are needed. You can easy append the checks. When everything is ok, a empty string is returned. Else the error message is returned

  • access: public
string sanityCheck ()
saveObjectCache (line 108)

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 429)

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 224)

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 282)

Set the Dreambox type.

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

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

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 Tue, 24 Jun 2008 18:59:32 +0200 by phpDocumentor 1.3.0RC3