api/v3/PrintLabel.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * This api exposes CiviCRM PrintLabel.
  14  *
  15  * @package CiviCRM_APIv3
  16  */
  17
  18 /**
  19  * Save a PrintLabel.
  20  *
  21  * @param array $params
  22  *
  23  * @return array
  24  */
  25 function civicrm_api3_print_label_create($params) {
  26   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'PrintLabel');
  27 }
  28
  29 /**
  30  * Adjust metadata for navigation create action.
  31  *
  32  * @param array $params
  33  */
  34 function _civicrm_api3_print_label_create_spec(&$params) {
  35   $params['name']['api.required'] = 1;
  36 }
  37
  38 /**
  39  * Get a PrintLabel.
  40  *
  41  * @param array $params
  42  *
  43  * @return array
  44  *   Array of retrieved PrintLabel property values.
  45  */
  46 function civicrm_api3_print_label_get($params) {
  47   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  48 }
  49
  50 /**
  51  * Delete a PrintLabel.
  52  *
  53  * @param array $params
  54  *
  55  * @return array
  56  *   Array of deleted values.
  57  */
  58 function civicrm_api3_print_label_delete($params) {
  59   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  60 }