<?php

/*
 +--------------------------------------------------------------------+
 | CiviCRM version 3.0                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2009                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007.                                       |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License along with this program; if not, contact CiviCRM LLC       |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
*/

/**
 * The Contact Wrapper is a wrapper class which is called by
 * contact.module after it parses the menu path.
 *
 * The key elements of the wrapper are the controller and the 
 * run method as explained below.
 *
 * @package CRM
 * @copyright CiviCRM LLC (c) 2004-2009
 * $Id$
 *
 */

require_once 'CRM/Core/Base.php';
require_once 'CRM/Core/Controller/Simple.php';

class CRM_Utils_Wrapper 
{
    /**
     * Simple Controller
     *
     * The controller which will handle the display and processing of this page.
     *
     * @access protected
     */
    protected $_controller;

    /**
     * Run.
     *
     * The heart of the callback processing is done by this method.
     * forms are of different type and have different operations.
     *
     * @param string  formName    name of the form processing this action
     * @param string  formLabel   label for the above form
     * @param int     mode        mode of operation.
     * @param boolean addSequence should we add a unique sequence number to the end of the key
     * @param boolean ignoreKey   should we not set a qfKey for this controller (for standalone forms)
     *
     * @return none.
     * @access public
     */
    function run( $formName, $formLabel, $arguments = null ) {
        if ( is_array($arguments) ) {
            $mode         = CRM_Utils_Array::value( 'mode',        $arguments );
            $imageUpload  = (bool) CRM_Utils_Array::value( 'imageUpload' , $arguments, false );
            $addSequence  = (bool) CRM_Utils_Array::value( 'addSequence' , $arguments, false );
            $attachUpload = (bool) CRM_Utils_Array::value( 'attachUpload',   $arguments, false );
            $ignoreKey    = (bool) CRM_Utils_Array::value( 'ignoreKey'   ,   $arguments, false );
        } else {
            $arguments   = array( );
            $mode        = null;
            $addSequence = $ignoreKey = $imageUpload = $attachUpload = false;
        }

        $this->_controller =& new CRM_Core_Controller_Simple( $formName    ,
                                                              $formLabel   ,
                                                              $mode        ,
                                                              $imageUpload ,
                                                              $addSequence ,
                                                              $ignoreKey   ,
                                                              $attachUpload );

        if ( array_key_exists('urlToSession', $arguments) ) {
            if ( is_array($arguments['urlToSession']) ) {
                foreach ( $arguments['urlToSession'] as $params ) {
                    $urlVar     = CRM_Utils_Array::value( 'urlVar',     $params );
                    $sessionVar = CRM_Utils_Array::value( 'sessionVar', $params );
                    $type       = CRM_Utils_Array::value( 'type',       $params );
                    $default    = CRM_Utils_Array::value( 'default',    $params );
                    
                    $value = null; 
                    $value = CRM_Utils_Request::retrieve( $urlVar, 
                                                          $type,
                                                          $this->_controller,
                                                          $default );
                    $this->_controller->set( $sessionVar, $value );
                }
            }
        }
        
        if ( array_key_exists('setEmbedded', $arguments) ) {
            $this->_controller->setEmbedded( true );
        }

        $this->_controller->process();
        $this->_controller->run();
    }
}
