3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This api is a simple wrapper of the CiviCRM file DAO.
31 * Creating and updating files is a complex process and this api is usually insufficient.
32 * Use the "Attachment" api instead for more robust file handling.
34 * @fixme no unit tests
35 * @package CiviCRM_APIv3
39 * Create a file record.
40 * @note This is only one of several steps needed to create a file in CiviCRM.
41 * Use the "Attachment" api to better handle all steps.
43 * @param array $params
44 * Array per getfields metadata.
48 function civicrm_api3_file_create($params) {
50 civicrm_api3_verify_mandatory($params, 'CRM_Core_DAO_File', array('uri'));
52 if (!isset($params['upload_date'])) {
53 $params['upload_date'] = date("Ymd");
56 $fileDAO = new CRM_Core_DAO_File();
67 foreach ($properties as $name) {
68 if (array_key_exists($name, $params)) {
69 $fileDAO->$name = $params[$name];
76 _civicrm_api3_object_to_array($fileDAO, $file);
78 return civicrm_api3_create_success($file, $params, 'File', 'create', $fileDAO);
84 * @param array $params
85 * Array per getfields metadata.
88 * Array of all found file object property values.
90 function civicrm_api3_file_get($params) {
91 civicrm_api3_verify_one_mandatory($params);
92 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
96 * Update an existing File.
98 * @param array $params
99 * Array per getfields metadata.
103 function civicrm_api3_file_update($params) {
105 if (!isset($params['id'])) {
106 return civicrm_api3_create_error('Required parameter missing');
109 $fileDAO = new CRM_Core_DAO_File();
110 $fileDAO->id
= $params['id'];
111 if ($fileDAO->find(TRUE)) {
112 $fileDAO->copyValues($params);
113 if (!$params['upload_date'] && !$fileDAO->upload_date
) {
114 $fileDAO->upload_date
= date("Ymd");
119 $cloneDAO = clone($fileDAO);
120 _civicrm_api3_object_to_array($cloneDAO, $file);
125 * Delete an existing File.
127 * @param array $params
128 * Array per getfields metadata.
129 * @return array API Result Array
130 * @throws API_Exception
132 function civicrm_api3_file_delete($params) {
134 civicrm_api3_verify_mandatory($params, NULL, array('id'));
135 if (CRM_Core_BAO_File
::deleteEntityFile('*', $params['id'])) {
136 return civicrm_api3_create_success();
139 throw new API_Exception('Error while deleting a file.');