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

Class: sc_ajax_select_boxes

Source Location: /PhpDoc/lsb/sc_classes.php

Class Overview


Linked Select Boxes main class


Author(s):

  • Panos Kyriakakis (http://www.salix.gr)

Copyright:

  • Copyright (c) 2006,7 Panos Kyriakakis

Variables

Methods



Class Details

[line 363]
Linked Select Boxes main class



Tags:

author:  Panos Kyriakakis (http://www.salix.gr)
copyright:  Copyright (c) 2006,7 Panos Kyriakakis
license:  GNU Public License


[ Top ]


Class Variables

$group_post_group =  ''

[line 425]

html tag placed at the end of elements group


Type:   string


[ Top ]

$group_post_input =  '<br />'

[line 435]

html tag placed after input element


Type:   string


[ Top ]

$group_post_wrap =  '<br />'

[line 450]

html tag placed after input element warp in group.


Type:   string


[ Top ]

$group_pre_group =  ''

[line 420]

html tag placed at the begining of elements group


Type:   string


[ Top ]

$group_pre_input =  ''

[line 430]

html tag placed before input element


Type:   string


[ Top ]

$group_pre_wrap =  ''

[line 445]

html tag placed before input element warp in group. Defaul is ''.


Type:   string


[ Top ]

$group_wrap_every =  0

[line 440]

Wrap elements in group every N elements. 0 means no wrap (default).


Type:   int


[ Top ]

$php_ajax_handler =  'sc_select_ajax_handler.php'

[line 368]

ajax call back file. If not in same folder with page using it path should be added.


Type:   string


[ Top ]

$select_add_prompt_row =  TRUE

[line 383]

show pease "Please select" option in select box or not


Type:   bool


[ Top ]

$select_boxes = array()

[line 404]

Hold element definitions



Tags:

access:  private

Type:   array


[ Top ]

$select_box_links = array()

[line 410]

Holds element linking information



Tags:

access:  private

Type:   array


[ Top ]

$select_empty_text =  '(None)'

[line 393]

the text diplayed when there are no option to show


Type:   string


[ Top ]

$select_not_found_text =  '(Not found)'

[line 398]

the text diplayed when ?????


Type:   string


[ Top ]

$select_prompt_key =  0

[line 373]

the value of "Please select" option in select boxes


Type:   int


[ Top ]

$select_prompt_text =  'Please Select'

[line 378]

the text of "Please select" option in select boxes


Type:   string


[ Top ]

$select_wait_text =  'Please wait'

[line 388]

the text of "Please wait" while waiting for ajax response


Type:   string


[ Top ]

$xml_encoding =  'ISO-8859-1'

[line 415]

encoding of the xml document passed by ajax calls. Useful for non latin languages.


Type:   string


[ Top ]



Class Methods


method add_radio_box [line 574]

void add_radio_box( $table_name, $key_field, $text_field, $order_field, $selected, $name, $id, [ $extra = ""], [ $extra_where = ""], [ $select_prompt_text = 'Please Select'])

adds radio group (wrapper for _add_box)



Tags:

access:  public


Parameters:

   $table_name  
   $key_field  
   $text_field  
   $order_field  
   $selected  
   $name  
   $id  
   $extra  
   $extra_where  
   $select_prompt_text  

[ Top ]

method add_select_box [line 554]

void add_select_box( $table_name, $key_field, $text_field, $order_field, $selected, $name, $id, [ $extra = ""], [ $extra_where = ""], [ $select_prompt_text = 'Please Select'])

adds a select box (wrapper for _add_box)



Tags:

access:  public


Parameters:

   $table_name  
   $key_field  
   $text_field  
   $order_field  
   $selected  
   $name  
   $id  
   $extra  
   $extra_where  
   $select_prompt_text  

[ Top ]

method ajax_get_records [line 1144]

void ajax_get_records( $table, $key_fld, $text_fld, [ $order_fld = ''], [ $link_field = ""], [ $link_field_value = ""], [ $extra_where = ""])

(Insert method's description here)



Parameters:

   $table  
   $key_fld  
   $text_fld  
   $order_fld  
   $link_field  
   $link_field_value  
   $extra_where  

[ Top ]

method ajax_output_xml [line 1164]

void ajax_output_xml( $rows, $select_prompt_text, [ $encoding = 'ISO-8859-1'])

(Insert method's description here)



Parameters:

   $rows  
   $select_prompt_text  
   $encoding  

[ Top ]

method ajax_output_xml_for_none [line 1193]

void ajax_output_xml_for_none( [ $encoding = 'ISO-8859-1'])

(Insert method's description here)



Parameters:

   $encoding  

[ Top ]

method get_list_from_db [line 513]

void get_list_from_db( $table, $key_fld, $text_fld, [ $order_fld = ''], [ $link_field = ""], [ $link_field_value = ""], [ $extra_where = ""])

(Insert method's description here)



Tags:

access:  private


Parameters:

   $table  
   $key_fld  
   $text_fld  
   $order_fld  
   $link_field  
   $link_field_value  
   $extra_where  

[ Top ]

method link_select_boxes [line 628]

void link_select_boxes( $parent_box, $child_box, [ $link_field = ""], [ $link_field_selected = ""])

adds box link definition



Tags:

access:  public


Parameters:

   $parent_box  
   $child_box  
   $link_field  
   $link_field_selected  

[ Top ]

method openDB [line 482]

void openDB( $dbserver_name, $database_name, $dbserver_username, $dbserver_password)

(Insert method's description here)



Tags:

access:  private


Parameters:

   $dbserver_name  
   $database_name  
   $dbserver_username  
   $dbserver_password  

[ Top ]

method place_jscripts [line 1119]

void place_jscripts( )

(Insert method's description here)



[ Top ]

method place_onchange_control_func [line 832]

void place_onchange_control_func( )

(Insert method's description here)



Tags:

access:  private


[ Top ]

method place_onchange_event [line 795]

void place_onchange_event( $box_name, [ $only_set_radio_value = TRUE])

(Insert method's description here)



Tags:

access:  private


Parameters:

   $box_name  
   $only_set_radio_value  

[ Top ]

method place_show_items_response [line 1009]

void place_show_items_response( )

(Insert method's description here)



[ Top ]

method show_select_box [line 723]

void show_select_box( $box_name)

(Insert method's description here)



Tags:

access:  public


Parameters:

   $box_name  

[ Top ]

method _add_box [line 594]

void _add_box( $box_type, $table_name, $key_field, $text_field, $order_field, $selected, $name, $id, [ $extra = ""], [ $extra_where = ""], [ $select_prompt_text = 'Please Select'])

(Insert method's description here)



Tags:

access:  private


Parameters:

   $box_type  
   $table_name  
   $key_field  
   $text_field  
   $order_field  
   $selected  
   $name  
   $id  
   $extra  
   $extra_where  
   $select_prompt_text  

[ Top ]

method _getRecords [line 462]

void _getRecords( $query)

(Insert method's description here)



Tags:

access:  private


Parameters:

   $query  

[ Top ]

method _get_select_childs [line 671]

void _get_select_childs( $box_name)

(Insert method's description here)



Tags:

access:  private


Parameters:

   $box_name  

[ Top ]

method _get_select_js_clean_relations [line 988]

void _get_select_js_clean_relations( )

(Insert method's description here)



Tags:

access:  private


[ Top ]

method _get_select_parent [line 706]

void _get_select_parent( $box_name)

(Insert method's description here)



Tags:

access:  private


Parameters:

   $box_name  

[ Top ]

method _get_select_relatives [line 971]

void _get_select_relatives( $box_name, &$rels, &$sel_texts)

returns childs and child childs



Tags:

access:  private


Parameters:

   $box_name  
   &$rels  
   &$sel_texts  

[ Top ]

method _is_select_child [line 688]

void _is_select_child( $box_name)

(Insert method's description here)



Tags:

access:  private


Parameters:

   $box_name  

[ Top ]

method _is_select_parent [line 653]

void _is_select_parent( $box_name)

(Insert method's description here)



Tags:

access:  private


Parameters:

   $box_name  

[ Top ]


Documentation generated on Sun, 04 Nov 2007 22:12:31 +0200 by phpDocumentor 1.4.0a2