[civicrm-core.git] / api / v3 / Navigation.php

<?php
/*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.6                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2015                                |
 +--------------------------------------------------------------------+
 | 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 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | 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 and the CiviCRM Licensing Exception 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        |
 +--------------------------------------------------------------------+
 */

/**
 * This api exposes CiviCRM Navigation BAO.
 *
 * @package CiviCRM_APIv3
 */

/**
 * Adjust metadata for navigation reset action.
 *
 * @param array $params
 */
function _civicrm_api3_navigation_get_spec(&$params) {
}

/**
 * Reset navigation.
 *
 * @param array $params
 *   Array of name/value pairs.
 *
 * @return array
 *   API result array.
 */
function civicrm_api3_navigation_get($params) {
  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}

/**
 * Adjust metadata for navigation create action.
 *
 * @param array $params
 */
function _civicrm_api3_navigation_create_spec(&$params) {
}

/**
 * Create navigation item.
 *
 * @param array $params
 *   Array of name/value pairs.
 *
 * @return array
 *   API result array.
 */
function civicrm_api3_navigation_create($params) {
  return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}

/**
 * Adjust metadata for navigation create action.
 *
 * @param array $params
 */
function _civicrm_api3_navigation_delete_spec(&$params) {
}

/**
 * Create navigation item.
 *
 * @param array $params
 *   Array of name/value pairs.
 *
 * @return array
 *   API result array.
 */
function civicrm_api3_navigation_delete($params) {
  return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
Commit	Line	Data
3523b615	1	<?php
	2	/*
	3	+--------------------------------------------------------------------+
	4	\| CiviCRM version 4.6 \|
	5	+--------------------------------------------------------------------+
	6	\| Copyright CiviCRM LLC (c) 2004-2015 \|
	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	* This api exposes CiviCRM Navigation BAO.
	30	*
	31	* @package CiviCRM_APIv3
	32	*/
	33
	34	/**
	35	* Adjust metadata for navigation reset action.
	36	*
	37	* @param array $params
	38	*/
	39	function _civicrm_api3_navigation_get_spec(&$params) {
	40	}
	41
	42	/**
	43	* Reset navigation.
	44	*
	45	* @param array $params
	46	* Array of name/value pairs.
	47	*
	48	* @return array
	49	* API result array.
	50	*/
	51	function civicrm_api3_navigation_get($params) {
	52	return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
	53	}
	54
	55	/**
	56	* Adjust metadata for navigation create action.
	57	*
	58	* @param array $params
	59	*/
	60	function _civicrm_api3_navigation_create_spec(&$params) {
	61	}
	62
	63	/**
	64	* Create navigation item.
65	*
66	* @param array $params
67	* Array of name/value pairs.
68	*
69	* @return array
70	* API result array.
71	*/
72	function civicrm_api3_navigation_create($params) {
73	return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
74	}
75
76	/**
77	* Adjust metadata for navigation create action.
78	*
79	* @param array $params
80	*/
81	function _civicrm_api3_navigation_delete_spec(&$params) {
82	}
83
84	/**
85	* Create navigation item.
86	*
87	* @param array $params
88	* Array of name/value pairs.
89	*
90	* @return array
91	* API result array.
92	*/
93	function civicrm_api3_navigation_delete($params) {
94	return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
95	}