b3f347611494636317d1d85b77a9b90b494d9620
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 allows minimal handling with the CiviCRM file DAO.
30 * Creating and updating files is a complex process and this api is usually insufficient.
31 * Use the "Attachment" api instead for more robust file handling.
33 * @fixme no unit tests
34 * @package CiviCRM_APIv3
35 * @subpackage API_File
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.
47 * Array of newly created file property values.
49 function civicrm_api3_file_create($params) {
51 civicrm_api3_verify_mandatory($params, 'CRM_Core_DAO_File', array('uri'));
53 if (!isset($params['upload_date'])) {
54 $params['upload_date'] = date("Ymd");
57 $fileDAO = new CRM_Core_DAO_File();
68 foreach ($properties as $name) {
69 if (array_key_exists($name, $params)) {
70 $fileDAO->$name = $params[$name];
77 _civicrm_api3_object_to_array($fileDAO, $file);
79 return civicrm_api3_create_success($file, $params, 'file', 'create', $fileDAO);
85 * @param array $params
86 * Array per getfields metadata.
89 * Array of all found file object property values.
91 function civicrm_api3_file_get($params) {
92 civicrm_api3_verify_one_mandatory($params);
93 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
97 * Update an existing file.
99 * @param array $params
100 * Array per getfields metadata.
104 function civicrm_api3_file_update($params) {
106 if (!isset($params['id'])) {
107 return civicrm_api3_create_error('Required parameter missing');
110 $fileDAO = new CRM_Core_DAO_File();
111 $fileDAO->id
= $params['id'];
112 if ($fileDAO->find(TRUE)) {
113 $fileDAO->copyValues($params);
114 if (!$params['upload_date'] && !$fileDAO->upload_date
) {
115 $fileDAO->upload_date
= date("Ymd");
120 _civicrm_api3_object_to_array(clone($fileDAO), $file);
125 * Delete an existing file.
127 * @param array $params
128 * Array per getfields metadata.
133 function civicrm_api3_file_delete($params) {
135 civicrm_api3_verify_mandatory($params, NULL, array('id'));
139 $entityFileDAO = new CRM_Core_DAO_EntityFile();
140 $entityFileDAO->file_id
= $params['id'];
141 if ($entityFileDAO->find()) {
142 $check = $entityFileDAO->delete();
145 $fileDAO = new CRM_Core_DAO_File();
146 $fileDAO->id
= $params['id'];
147 if ($fileDAO->find(TRUE)) {
148 $check = $fileDAO->delete();
151 return $check ?
NULL : civicrm_api3_create_error('Error while deleting a file.');