PHPJQueryToggler
[ class tree: PHPJQueryToggler ] [ index: PHPJQueryToggler ] [ all elements ]

Class: phpToggler

Source Location: /PHPJQueryToggler.php

Class Overview




Variables

Methods



Class Details

[line 44]


[ Top ]


Class Variables

$button_type =

[line 61]



Tags:

var:  set button type [I|T] Image|Text
access:  public

Type:   char


[ Top ]

$closeFunctions =  NULL

[line 90]



Tags:

var:  array of functions to call at close action
access:  public

Type:   mixed


[ Top ]

$close_image =

[line 69]



Tags:

var:  contains image path of closed button
access:  public

Type:   string


[ Top ]

$close_txt =

[line 77]



Tags:

var:  contains text of close string
access:  public

Type:   string


[ Top ]

$div_button =

[line 49]



Tags:

var:  contains button's div id
access:  public

Type:   string


[ Top ]

$div_content =

[line 53]



Tags:

var:  contains content's div id
access:  public

Type:   string


[ Top ]

$motion_duration =

[line 57]



Tags:

var:  set motion duration in milliseconds
access:  public

Type:   integer


[ Top ]

$openFunctions =  NULL

[line 86]



Tags:

var:  array of functions to call at open action
access:  public

Type:   mixed


[ Top ]

$open_image =

[line 65]



Tags:

var:  contains image path of open button
access:  public

Type:   string


[ Top ]

$open_txt =

[line 73]



Tags:

var:  contains text of open string
access:  public

Type:   string


[ Top ]

$start_status =

[line 81]



Tags:

var:  set the init status [1|0] open|close
access:  public

Type:   integer


[ Top ]



Class Methods


constructor phpToggler [line 101]

phpToggler phpToggler( string $button, string $content, [char $button_type = BUTTON_TYPE_TEXT], [integer $start_status = STATUS_CLOSE], [integer $motion_duration = DEFAULT_DURATION])



Tags:

method:  void phpToggler(): phpToggler($button,$content,$button_type=BUTTON_TYPE_TEXT,$start_status=STATUS_CLOSE,$motion_duration=DEFAULT_DURATION) is class costructor


Parameters:

string   $button   contains button's div id
string   $content   contains content's div id
char   $button_type   [I|T] set button type Image|Text
integer   $start_status   [1|0] set init status Open|Close
integer   $motion_duration   motion_duration set motion duration in milliseconds

[ Top ]

method addCloseFunction [line 205]

void addCloseFunction( string $function)



Tags:

method:  void addCloseFunction(): addCloseFunction($function) add function at closeFunction array


Parameters:

string   $function   call string of javascript function at close action

[ Top ]

method addOpenFunction [line 188]

void addOpenFunction( string $function)



Tags:

method:  void addOpenFunction(): addOpenFunction($function) add function at openFunction array


Parameters:

string   $function   call string of javascript function at open action

[ Top ]

method checkAll [line 295]

void checkAll( )



Tags:

method:  void checkAll(): checkAll() check configuration


[ Top ]

method checkButton [line 304]

void checkButton( )



Tags:

method:  void checkButton(): checkButton() check if image or text are set


[ Top ]

method includeJQuery [line 123]

void includeJQuery( string $path, [bool $return = false])



Tags:

method:  void|string includeJQuery(): includeJQuery($path,$return=false) print or return the include string of JQuery


Parameters:

string   $path   contains JQuery path
bool   $return   set print|return type

[ Top ]

method printJs [line 222]

void printJs( [bool $return = false])



Tags:

method:  void|string printJs(): addOpenFunction($return=false) print or return javascript code


Parameters:

bool   $return   set print or return mode

[ Top ]

method printVars [line 326]

void printVars( )



Tags:

method:  void printVars(): printVars() debug function to print all configuration vars


[ Top ]

method setCloseFunction [line 178]

void setCloseFunction( mixed $array)



Tags:

method:  void setCloseFunction(): setCloseFunction($array) set the close funcions


Parameters:

mixed   $array   array of javascript functions to call at close action

[ Top ]

method setOpenCloseImg [line 137]

void setOpenCloseImg( string $open_image, string $close_image)



Tags:

method:  void setOpenCloseImg(): setOpenCloseImg($open_image,$close_image) set images used as open|close button


Parameters:

string   $open_image   contains open image path
string   $close_image   contains close image path

[ Top ]

method setOpenCloseTxt [line 154]

void setOpenCloseTxt( string $open_txt, string $close_txt)



Tags:

method:  void setOpenCloseTxt(): setOpenCloseTxt($open_txt,$close_txt) set text used as open|close text


Parameters:

string   $open_txt   contains open text
string   $close_txt   contains close text

[ Top ]

method setOpenFunction [line 168]

void setOpenFunction( mixed $array)



Tags:

method:  void setOpenFunction(): setOpenFunction($array) set the open funcions


Parameters:

mixed   $array   array of javascript functions to call at open action

[ Top ]


Documentation generated on Sun, 03 Oct 2010 11:32:36 +0200 by phpDocumentor 1.4.3