<?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        |
+--------------------------------------------------------------------+
*/
/**
 *
 * @package CRM
 * @copyright CiviCRM LLC (c) 2004-2009
 * $Id$
 *
 */
require_once 'CRM/Core/DAO.php';
require_once 'CRM/Utils/Type.php';
class CRM_Core_DAO_Menu extends CRM_Core_DAO
{
    /**
     * static instance to hold the table name
     *
     * @var string
     * @static
     */
    static $_tableName = 'civicrm_menu';
    /**
     * static instance to hold the field values
     *
     * @var array
     * @static
     */
    static $_fields = null;
    /**
     * static instance to hold the FK relationships
     *
     * @var string
     * @static
     */
    static $_links = null;
    /**
     * static instance to hold the values that can
     * be imported / apu
     *
     * @var array
     * @static
     */
    static $_import = null;
    /**
     * static instance to hold the values that can
     * be exported / apu
     *
     * @var array
     * @static
     */
    static $_export = null;
    /**
     * static value to see if we should log any modifications to
     * this table in the civicrm_log table
     *
     * @var boolean
     * @static
     */
    static $_log = false;
    /**
     *
     * @var int unsigned
     */
    public $id;
    /**
     * Which Domain is this menu item for
     *
     * @var int unsigned
     */
    public $domain_id;
    /**
     * Path Name
     *
     * @var string
     */
    public $path;
    /**
     * Arguments to pass to the url
     *
     * @var text
     */
    public $path_arguments;
    /**
     * Menu Title
     *
     * @var string
     */
    public $title;
    /**
     * Function to call to check access permissions
     *
     * @var string
     */
    public $access_callback;
    /**
     * Arguments to pass to access callback
     *
     * @var text
     */
    public $access_arguments;
    /**
     * function to call for this url
     *
     * @var string
     */
    public $page_callback;
    /**
     * Arguments to pass to page callback
     *
     * @var text
     */
    public $page_arguments;
    /**
     * Breadcrumb for the path.
     *
     * @var text
     */
    public $breadcrumb;
    /**
     * Url where a page should redirected to, if next url not known.
     *
     * @var string
     */
    public $return_url;
    /**
     * Arguments to pass to return_url
     *
     * @var string
     */
    public $return_url_args;
    /**
     * Component that this menu item belongs to
     *
     * @var int unsigned
     */
    public $component_id;
    /**
     * Is this menu item active?
     *
     * @var boolean
     */
    public $is_active;
    /**
     * Is this menu accessible to the public?
     *
     * @var boolean
     */
    public $is_public;
    /**
     * Is this menu exposed to the navigation system?
     *
     * @var boolean
     */
    public $is_exposed;
    /**
     * Should this menu be exposed via SSL if enabled?
     *
     * @var boolean
     */
    public $is_ssl;
    /**
     * Ordering of the menu items in various blocks.
     *
     * @var int
     */
    public $weight;
    /**
     * Drupal menu type.
     *
     * @var int
     */
    public $type;
    /**
     * CiviCRM menu type.
     *
     * @var int
     */
    public $page_type;
    /**
     * skip this url being exposed to breadcrumb
     *
     * @var boolean
     */
    public $skipBreadcrumb;
    /**
     * class constructor
     *
     * @access public
     * @return civicrm_menu
     */
    function __construct() 
    {
        parent::__construct();
    }
    /**
     * return foreign links
     *
     * @access public
     * @return array
     */
    function &links() 
    {
        if (!(self::$_links)) {
            self::$_links = array(
                'domain_id' => 'civicrm_domain:id',
                'component_id' => 'civicrm_component:id',
            );
        }
        return self::$_links;
    }
    /**
     * returns all the column names of this table
     *
     * @access public
     * @return array
     */
    function &fields() 
    {
        if (!(self::$_fields)) {
            self::$_fields = array(
                'id' => array(
                    'name' => 'id',
                    'type' => CRM_Utils_Type::T_INT,
                    'required' => true,
                ) ,
                'domain_id' => array(
                    'name' => 'domain_id',
                    'type' => CRM_Utils_Type::T_INT,
                    'required' => true,
                ) ,
                'path' => array(
                    'name' => 'path',
                    'type' => CRM_Utils_Type::T_STRING,
                    'title' => ts('Path') ,
                    'maxlength' => 255,
                    'size' => CRM_Utils_Type::HUGE,
                ) ,
                'path_arguments' => array(
                    'name' => 'path_arguments',
                    'type' => CRM_Utils_Type::T_TEXT,
                    'title' => ts('Path Arguments') ,
                ) ,
                'title' => array(
                    'name' => 'title',
                    'type' => CRM_Utils_Type::T_STRING,
                    'title' => ts('Title') ,
                    'maxlength' => 255,
                    'size' => CRM_Utils_Type::HUGE,
                ) ,
                'access_callback' => array(
                    'name' => 'access_callback',
                    'type' => CRM_Utils_Type::T_STRING,
                    'title' => ts('Access Callback') ,
                    'maxlength' => 255,
                    'size' => CRM_Utils_Type::HUGE,
                ) ,
                'access_arguments' => array(
                    'name' => 'access_arguments',
                    'type' => CRM_Utils_Type::T_TEXT,
                    'title' => ts('Access Arguments') ,
                ) ,
                'page_callback' => array(
                    'name' => 'page_callback',
                    'type' => CRM_Utils_Type::T_STRING,
                    'title' => ts('Page Callback') ,
                    'maxlength' => 255,
                    'size' => CRM_Utils_Type::HUGE,
                ) ,
                'page_arguments' => array(
                    'name' => 'page_arguments',
                    'type' => CRM_Utils_Type::T_TEXT,
                    'title' => ts('Page Arguments') ,
                ) ,
                'breadcrumb' => array(
                    'name' => 'breadcrumb',
                    'type' => CRM_Utils_Type::T_TEXT,
                    'title' => ts('Breadcrumb') ,
                ) ,
                'return_url' => array(
                    'name' => 'return_url',
                    'type' => CRM_Utils_Type::T_STRING,
                    'title' => ts('Return Url') ,
                    'maxlength' => 255,
                    'size' => CRM_Utils_Type::HUGE,
                ) ,
                'return_url_args' => array(
                    'name' => 'return_url_args',
                    'type' => CRM_Utils_Type::T_STRING,
                    'title' => ts('Return Url Args') ,
                    'maxlength' => 255,
                    'size' => CRM_Utils_Type::HUGE,
                ) ,
                'component_id' => array(
                    'name' => 'component_id',
                    'type' => CRM_Utils_Type::T_INT,
                ) ,
                'is_active' => array(
                    'name' => 'is_active',
                    'type' => CRM_Utils_Type::T_BOOLEAN,
                ) ,
                'is_public' => array(
                    'name' => 'is_public',
                    'type' => CRM_Utils_Type::T_BOOLEAN,
                ) ,
                'is_exposed' => array(
                    'name' => 'is_exposed',
                    'type' => CRM_Utils_Type::T_BOOLEAN,
                ) ,
                'is_ssl' => array(
                    'name' => 'is_ssl',
                    'type' => CRM_Utils_Type::T_BOOLEAN,
                ) ,
                'weight' => array(
                    'name' => 'weight',
                    'type' => CRM_Utils_Type::T_INT,
                    'title' => ts('Weight') ,
                    'required' => true,
                ) ,
                'type' => array(
                    'name' => 'type',
                    'type' => CRM_Utils_Type::T_INT,
                    'title' => ts('Type') ,
                    'required' => true,
                ) ,
                'page_type' => array(
                    'name' => 'page_type',
                    'type' => CRM_Utils_Type::T_INT,
                    'title' => ts('Page Type') ,
                    'required' => true,
                ) ,
                'skipBreadcrumb' => array(
                    'name' => 'skipBreadcrumb',
                    'type' => CRM_Utils_Type::T_BOOLEAN,
                    'title' => ts('Skipbreadcrumb') ,
                ) ,
            );
        }
        return self::$_fields;
    }
    /**
     * returns the names of this table
     *
     * @access public
     * @return string
     */
    function getTableName() 
    {
        return self::$_tableName;
    }
    /**
     * returns if this table needs to be logged
     *
     * @access public
     * @return boolean
     */
    function getLog() 
    {
        return self::$_log;
    }
    /**
     * returns the list of fields that can be imported
     *
     * @access public
     * return array
     */
    function &import($prefix = false) 
    {
        if (!(self::$_import)) {
            self::$_import = array();
            $fields = &self::fields();
            foreach($fields as $name => $field) {
                if (CRM_Utils_Array::value('import', $field)) {
                    if ($prefix) {
                        self::$_import['menu'] = &$fields[$name];
                    } else {
                        self::$_import[$name] = &$fields[$name];
                    }
                }
            }
        }
        return self::$_import;
    }
    /**
     * returns the list of fields that can be exported
     *
     * @access public
     * return array
     */
    function &export($prefix = false) 
    {
        if (!(self::$_export)) {
            self::$_export = array();
            $fields = &self::fields();
            foreach($fields as $name => $field) {
                if (CRM_Utils_Array::value('export', $field)) {
                    if ($prefix) {
                        self::$_export['menu'] = &$fields[$name];
                    } else {
                        self::$_export[$name] = &$fields[$name];
                    }
                }
            }
        }
        return self::$_export;
    }
}
