SqueezePHPAPI
[ class tree: SqueezePHPAPI ] [ index: SqueezePHPAPI ] [ all elements ] [ doc index ]

Class: SqueezeCenter

Source Location: /lib/class.SqueezeCenter.php

Class Overview

SqueezeCenter


Author(s):

Copyright:

Variables

Methods


 

Class Details

[line 28]
SqueezeCenter

Squeezecenter Command Line Inteface API


Tags:

author:  David Broz <db-dev__AT__0r9.org>
copyright:  (c) 2009 by David Broz - Disorganization Zurich, Switzerland
license:  GNU General Public License v2


[ Top ]


Class Variables

$CurrentPlayer =  

[line 60]

CurrentPlayer

A currently selected SqueezePlayer Object


Tags:

access:  protected

Type:   SqueezePlayer


[ Top ]

$Database =  

[line 44]

Database

Connection to SqueezeDatabase Object of server.


Tags:

access:  protected

Type:   SqueezeDatabase


[ Top ]

$Players =  

[line 52]

Players

Connection to SqueezePlayers Object of server.


Tags:

access:  protected

Type:   SqueezePlayers


[ Top ]



Class Methods


constructor __construct [line 70]

SqueezeCenter __construct( SqueezeConnection $CLI)

SqueezeCenter (constructor)



Parameters:

SqueezeConnection   $CLI  

[ Top ]

destructor __destruct [line 313]

void __destruct( )

SqueezeCenter (destructor)



[ Top ]

method can [line 115]

boolean can( [string $request_terms = ""])

can

The "can" query allows the caller to determine if the command or query indicated by <request terms> is available.


Tags:

access:  public


Parameters:

string   $request_terms  

[ Top ]

method connect [line 82]

boolean connect( )

connect

Connects to SqueezeCenter CLI socket


Tags:

access:  public


[ Top ]

method debug [line 229]

string debug( [string $debug_category = ""], [string $state = ""])

debug

The "debug" command allows the caller to query or set the server's internal debugging categories. Use 'OFF' to silence, 'FATAL' for only seeing fatal errors, 'ERROR' for non-fatal errors, etc. Finally, using ? will query the current level for the category.


Tags:

access:  public


Parameters:

string   $debug_category  
string   $state  

[ Top ]

method disconnect [line 98]

boolean disconnect( )

disconnect

Disconnects from SqueezeCenter CLI socket


Tags:

access:  public


[ Top ]

method getstring [line 214]

string getstring( [string $stringtoken = ""])

getstring

The "getstring" command allows the caller to query one or several localized strings. String tokens can be passed as a single, concatenated value.


Tags:

access:  public


Parameters:

string   $stringtoken  

[ Top ]

method listen [line 145]

boolean listen( )

listen

!CURRENTLY NOT SUPPORTED


Tags:

access:  public


[ Top ]

method pref [line 171]

mixed pref( [string $prefname = ""], [$prefvalue $prefvalue = ""])

pref

The "pref" command allows the caller to set and query the SqueezeCenter's internal preference values.


Tags:

return:  (boolean success) OR (string from query)
access:  public


Parameters:

string   $prefname   <prefname|namespace:prefname>
$prefvalue   $prefvalue   <prefvalue|?>

[ Top ]

method pref_validate [line 195]

string pref_validate( [string $prefname = ""], [$prefvalue $prefvalue = ""])

pref_validate

The "pref validate" command allows the caller to validate a SqueezeCenter's internal preference value without setting it.


Tags:

access:  public


Parameters:

string   $prefname   <prefname|namespace:prefname>
$prefvalue   $prefvalue   <prefvalue>

[ Top ]

method setCurrentPlayer [line 304]

void setCurrentPlayer( [integer $playerindex = 0])

setCurrentPlayer

Sets the current player at playerindex. Query Players for a list of players.


Tags:

access:  public


Parameters:

integer   $playerindex  

[ Top ]

method shutdown [line 253]

boolean shutdown( )

shutdown

Shuts down the SqueezeCenter server. (WARNING!) There is no way to come back up without restarting the server manually.


Tags:

access:  public


[ Top ]

method subscribe [line 157]

boolean subscribe( )

subscribe

!CURRENTLY NOT SUPPORTED


Tags:

access:  public


[ Top ]

method version [line 133]

string version( )

version

Returns SqueezeCenter version


Tags:

access:  public


[ Top ]

method __get [line 265]

mixed __get( string $property_name)

__get (getter)



Parameters:

string   $property_name  

[ Top ]


Documentation generated on Wed, 16 Sep 2009 18:08:26 +0200 by phpDocumentor 1.4.2