| 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 | * |
| 30 | * APIv3 functions for registering/processing mailing jobs. |
| 31 | * |
| 32 | * @package CiviCRM_APIv3 |
| 33 | */ |
| 34 | |
| 35 | /** |
| 36 | * Handle creation of a MailingJob for a Mailing. |
| 37 | * |
| 38 | * @param array $params |
| 39 | * |
| 40 | * @return array |
| 41 | * @throws \API_Exception |
| 42 | */ |
| 43 | function civicrm_api3_mailing_job_create($params) { |
| 44 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 45 | } |
| 46 | |
| 47 | /** |
| 48 | * Adjust Metadata for Create action. |
| 49 | * |
| 50 | * The metadata is used for setting defaults, documentation & validation. |
| 51 | * |
| 52 | * @param array $params |
| 53 | * Array of parameters determined by getfields. |
| 54 | */ |
| 55 | function _civicrm_api3_mailing_job_create_spec(&$params) { |
| 56 | $params['status']['api.default'] = 'Scheduled'; |
| 57 | $params['scheduled_date']['api.default'] = 'now'; |
| 58 | $params['is_test']['api.default'] = 0; |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Returns array of Mailing Jobs matching a set of one or more group properties. |
| 63 | * |
| 64 | * @param array $params |
| 65 | * |
| 66 | * @return array |
| 67 | * API return Array of matching mailing jobs. |
| 68 | */ |
| 69 | function civicrm_api3_mailing_job_get($params) { |
| 70 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Handle deletion of a Mailing Job for a Mailing. |
| 75 | * |
| 76 | * @param array $params |
| 77 | * |
| 78 | * @return array |
| 79 | * @throws \API_Exception |
| 80 | */ |
| 81 | function civicrm_api3_mailing_job_delete($params) { |
| 82 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 83 | } |