CRM/Case/XMLProcessor/Settings.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35 class CRM_Case_XMLProcessor_Settings extends CRM_Case_XMLProcessor {
  36
  37   private $_settings = array();
  38
  39   // Input: The base filename without the .xml extension
  40   // Output: An array of settings.
  41   function run($filename = 'settings') {
  42     $xml = $this->retrieve($filename);
  43
  44     // For now it's not an error. In the future it might be a required file.
  45     if ($xml !== FALSE) {
  46       // There's only one setting right now, and only one value.
  47       if ($xml->group[0]) {
  48         if ($xml->group[0]->attributes()) {
  49           $groupName = (string) $xml->group[0]->attributes()->name;
  50           if ($groupName) {
  51             $this->_settings['groupname'] = $groupName;
  52           }
  53         }
  54       }
  55     }
  56     return $this->_settings;
  57   }
  58 }
  59