Source for file OCSP_FRMVIEW_LIST_FLEXGRID.phpclass

Documentation is available at OCSP_FRMVIEW_LIST_FLEXGRID.phpclass

  1. <?php
  2. /**
  3.   * openCSP class file
  4.   *
  5.   * @project Open CSP-Management
  6.   * @package default
  7.   *
  8.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  9.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10.   *
  11.   * @since pk-29.05.2008
  12.   * @version $Id: OCSP_FRMVIEW_LIST_FLEXGRID.phpclass,v 1.6 2008/12/03 21:32:42 pitlinz Exp $
  13.   */
  14.  
  15. // ---------------------------------------------------------
  16. // requirements
  17. // ---------------------------------------------------------
  18.  
  19.     pcf_require_class('OCSP_FRMVIEW_LIST',dirname(__FILE__) . _OCSP_DIRSEP_ . "OCSP_FRMVIEW_LIST.phpclass");
  20.  
  21. /**
  22.   * openCSP class file
  23.   *
  24.   * @project Open CSP-Management
  25.   * @package default
  26.   *
  27.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  28.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  29.   *
  30.   * @since pk-29.05.2008
  31.   * @version $Id: OCSP_FRMVIEW_LIST_FLEXGRID.phpclass,v 1.6 2008/12/03 21:32:42 pitlinz Exp $
  32.   */
  33. class OCSP_FRMVIEW_LIST_FLEXGRID
  34.     extends OCSP_FRMVIEW_LIST 
  35. {
  36.     /*** class constants  --------------------------------------------- */
  37.  
  38.     /**
  39.      * @constant string CLASS_SRC_FILE
  40.      *
  41.      * @abstract
  42.      */
  43.     const CLASS_SRC_FILE = __FILE__;
  44.     
  45.     /*** compostion --------------------------------------------------- */
  46.     
  47.     /*** attributes  -------------------------------------------------- */
  48.     
  49.     /**
  50.      * @var string $gridDOMId 
  51.      */
  52.     protected $gridDOMId = "";
  53.     
  54.     // flexgrid layout attributes
  55.     
  56.     /**
  57.      * @var boolean $grid_showTableToggleBtn 
  58.      */
  59.     protected $grid_showTableToggleBtn = True;
  60.     
  61.     
  62.     protected $grid_attributes = array();
  63.         
  64.     
  65.     /*** factory / construct  ----------------------------------------- */
  66.     
  67.     /*** getter / setter ---------------------------------------------- */
  68.     
  69.     /**
  70.      * @param string $aDOMId 
  71.      */
  72.     public function setGridDOMId($aDOMId)
  73.     {
  74.         $this->gridDOMId = $aDOMId;
  75.     }
  76.     
  77.     /**
  78.      * @return string 
  79.      */
  80.     public function getGridDOMId()
  81.     {
  82.         if (empty($this->gridDOMId))
  83.         {
  84.             $this->gridDOMId = trim($this->getControl()->getTableId()); 
  85.         }
  86.         return $this->gridDOMId;
  87.     }
  88.  
  89.     /**
  90.      * sets a jQuery.flexgrid attribute
  91.      *
  92.      *         height: 200, //default height
  93.      *         width: 'auto', //auto width
  94.      *         striped: true, //apply odd even stripes
  95.      *         novstripe: false,
  96.      *         minwidth: 30, //min width of columns
  97.      *         minheight: 100, //min height of columns
  98.      *         resizable: true, //resizable table
  99.      *         url: false, //ajax url
  100.      *         method: 'POST', // data sending method
  101.      *         dataType: 'xml', // type of data loaded
  102.      *         errormsg: 'Connection Error',
  103.      *         usepager: false, //
  104.      *         nowrap: true, //
  105.      *         page: 1, //current page
  106.      *         total: 1, //total pages
  107.      *         useRp: true, //use the results per page select box
  108.      *         rp: 15, // results per page
  109.      *         rpOptions: [10,15,20,25,40],
  110.      *         title: false,
  111.      *         pagestat: 'Displaying {from} to {to} of {total} items',
  112.      *         procmsg: 'Processing, please wait ...',
  113.      *         query: '',
  114.      *         qtype: '',
  115.      *         nomsg: 'No items',
  116.      *         minColToggle: 1, //minimum allowed column to be hidden
  117.      *          showToggleBtn: true, //show or hide column toggle popup
  118.      *         hideOnSubmit: true,
  119.      *         autoload: true,
  120.      *         blockOpacity: 0.5,
  121.      *         onToggleCol: false,
  122.      *         onChangeSort: false,
  123.      *         onSuccess: false,
  124.      *         onSubmit: false // using a custom populate function
  125.      *  
  126.      * @param string $settingName 
  127.      * @param string $value (js escaped
  128.      */
  129.     public function setGridAttribute($settingName,$value)
  130.     {
  131.         $this->grid_attributes[$settingName] = $value;
  132.     }
  133.     
  134.     /*** jQuery Flexgrid definitions ----------------------------------- */
  135.     
  136.     
  137.     /**
  138.      * returns the jQuery js to init the flexgrid
  139.      *
  140.      * @param int $buttonColPos  0 not show -1 left 1 right
  141.      * @param boolean $debug 
  142.      * 
  143.      * @return string 
  144.      */
  145.     public function getJQueryDefinition($debug=False)
  146.     {
  147.         $str_ret = "
  148.             jQuery('#" . $this->getGridDOMId(). "').flexigrid
  149.             (
  150.             {
  151.             url: '" . $this->myControl->getJsonUrl() . "',
  152.             dataType: 'json'
  153.             ";
  154.         
  155.         $arr_colModel         = array();
  156.         $arr_searchItems    = array();
  157.         
  158.         $arr_LeftButtons     = $this->getPosButtons(-1);
  159.         $arr_RightButtons     = $this->getPosButtons(1);
  160.                 
  161.         if (sizeof($arr_LeftButtons))
  162.         {
  163.             $arr_colModel['lst_buttons_left'] = array(
  164.                     'display'     => "'Aktionen'",
  165.                     'name'          => "'lst_buttons_left'",
  166.                     'sortable'     => "false",
  167.                     'width'        => (sizeof($arr_LeftButtons) * 22),
  168.                     'hide'        => "false"
  169.                 );
  170.         }
  171.         
  172.         if ($arr_fields = $this->myForm->getFields(Null,$debug))
  173.         {
  174.             foreach($arr_fields as &$obj_fld)
  175.             {
  176.                 if (!$obj_fld->isHidden('flexgrid'))
  177.                 {
  178.                     $arr_colModel[$obj_fld->getName()] = array(
  179.                         'display'     => "'" . str_replace("'","\\'",$obj_fld->getLstLabel()) . "'", 
  180.                         'name'          => "'" . $obj_fld->getName() . "'",
  181.                         'sortable'     => ($obj_fld->isSearchable() ? 'true' : 'false'), 
  182.                         'width'        => (intval($obj_fld->getLstWidth()) ? $obj_fld->getLstWidth() : ($obj_fld->getSize() * 5)),
  183.                         'hide'         => ($obj_fld->isHidden('list') ? 'true' : 'false')
  184.                     );
  185.                     
  186.                     if ($obj_fld->isSearchable())
  187.                     {
  188.                         $arr_searchItems[$obj_fld->getName()] = array(
  189.                             'display'     => "'" . $obj_fld->getLstLabel() . "'", 
  190.                             'name'          => "'" . $obj_fld->getName() . "'"                        
  191.                         );
  192.                     }
  193.                 } 
  194.             }
  195.         }        
  196.  
  197.         if (sizeof($arr_RightButtons))
  198.         {
  199.             $arr_colModel['lst_buttons_right'] = array(
  200.                     'display'     => "' Aktionen '",
  201.                     'name'          => "'lst_buttons_right'",
  202.                     'sortable'     => "false",
  203.                     'width'        => (sizeof($arr_RightButtons) * 22),
  204.                     'hide'        => "false"
  205.                 );
  206.         }
  207.         
  208.         
  209.         $str_ret .= ",\ncolModel : [";
  210.         $cha_sep = "";
  211.         foreach($arr_colModel as $arr_colDesc)
  212.         {
  213.             $str_ret .= "$cha_sep{";
  214.             $cha_sepInner = "";
  215.             foreach($arr_colDesc as $str_key => $mix_val)
  216.             {
  217.                 $str_ret .= $cha_sepInner .  $str_key . " : " . $mix_val;
  218.                 $cha_sepInner = ","; 
  219.             }
  220.             $str_ret .= "}";
  221.             $cha_sep = ",";
  222.         }
  223.         $str_ret .= "]";
  224.         
  225.         if (sizeof($arr_searchItems))
  226.         {
  227.             $cha_SISep = '';
  228.             $str_ret .= ",\nsearchitems:[";
  229.             foreach($arr_searchItems as $arr_itemDesc)
  230.             {
  231.                 $str_ret .= $cha_SISep . "{";
  232.                 $cha_sep = '';
  233.                 foreach($arr_itemDesc as $str_key => $mix_val)
  234.                 {
  235.                     $str_ret .= $cha_sep .  $str_key . " : " . $mix_val;
  236.                     $cha_sep = ","; 
  237.                 }
  238.                 $str_ret .= "}";        
  239.                 $cha_SISep = ",";
  240.             }            
  241.             $str_ret .= "]";
  242.         }
  243.         
  244.         /*
  245.             buttons : [
  246.                 {name: 'Add', bclass: 'add', onpress : test},
  247.                 {name: 'Delete', bclass: 'delete', onpress : test},
  248.                 {separator: true}
  249.                 ],
  250.             sortname: "iso",
  251.             sortorder: "asc",
  252.         */
  253.         
  254.         
  255.         foreach($this->grid_attributes as $str_attName => $str_value)
  256.         {
  257.             $str_ret .= "," . $str_attName . ": " . $str_value;
  258.         }        
  259.     
  260.         $str_ret .= "});";
  261.  
  262.         return $str_ret;
  263.     }
  264.     
  265.     /**
  266.      * returns the list HTML code
  267.      * 
  268.      * @param boolean $debug 
  269.      * 
  270.      * @return string 
  271.      */
  272.     function getList($debug=False)
  273.     {  
  274.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FRMVIEW_LIST::getList()");
  275.         $str_ret = "<table id=\"".$this->getGridDOMId() ."\"></table>";
  276.         return $str_ret;
  277.     }    
  278.     
  279. }
  280.  
  281. ?>

Documentation generated on Thu, 08 Jan 2009 17:46:39 +0100 by phpDocumentor 1.4.0a2