CRM/Core/QuickForm/NestedAdvMultiSelect.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright U.S. PIRG Education Fund (c) 2007                        |
   7  | Licensed to CiviCRM under the Academic Free License version 3.0.   |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright U.S. PIRG Education Fund 2007
  33  * $Id$
  34  *
  35  */
  36
  37 require_once 'HTML/QuickForm/advmultiselect.php';
  38
  39 /**
  40  * Class CRM_Core_QuickForm_NestedAdvMultiSelect
  41  */
  42 class CRM_Core_QuickForm_NestedAdvMultiSelect extends HTML_QuickForm_advmultiselect {
  43
  44   /**
  45    * Loads options from different types of data sources.
  46    *
  47    * This method overloaded parent method of select element, to allow
  48    * loading options with fancy attributes.
  49    *
  50    * @param mixed &$options Options source currently supports assoc array or DB_result
  51    * @param mixed $param1
  52    *   (optional) See function detail.
  53    * @param mixed $param2
  54    *   (optional) See function detail.
  55    * @param mixed $param3
  56    *   (optional) See function detail.
  57    * @param mixed $param4
  58    *   (optional) See function detail.
  59    *
  60    * @since      version 1.5.0 (2009-02-15)
  61    * @return PEAR_Error|NULL on error and TRUE on success
  62    * @throws     PEAR_Error
  63    * @see        loadArray()
  64    */
  65   public function load(
  66     &$options, $param1 = NULL, $param2 = NULL,
  67     $param3 = NULL, $param4 = NULL
  68   ) {
  69     switch (TRUE) {
  70       case ($options instanceof Iterator):
  71         $arr = [];
  72         foreach ($options as $key => $val) {
  73           $arr[$key] = $val;
  74         }
  75         return $this->loadArray($arr, $param1);
  76
  77       default:
  78         return parent::load($options, $param1, $param2, $param3, $param4);
  79     }
  80   }
  81
  82 }