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 +--------------------------------------------------------------------+
30 * Definition of the Tag of the CRM API.
31 * More detailed documentation can be found
32 * {@link http://objectledge.org/confluence/display/CRM/CRM+v1.0+Public+APIs
35 * @package CiviCRM_APIv3
36 * @subpackage API_File
37 * @copyright CiviCRM LLC (c) 2004-2014
45 * This API is used for creating a file
47 * @param array $params
48 * An associative array of name/value property values of civicrm_file.
51 * Array of newly created file property values.
53 function civicrm_api3_file_create($params) {
55 civicrm_api3_verify_mandatory($params, 'CRM_Core_DAO_File', array('uri'));
57 if (!isset($params['upload_date'])) {
58 $params['upload_date'] = date("Ymd");
61 $fileDAO = new CRM_Core_DAO_File();
62 $properties = array('id', 'file_type_id', 'mime_type', 'uri', 'document', 'description', 'upload_date');
64 foreach ($properties as $name) {
65 if (array_key_exists($name, $params)) {
66 $fileDAO->$name = $params[$name];
73 _civicrm_api3_object_to_array($fileDAO, $file);
75 return civicrm_api3_create_success($file, $params, 'file', 'create', $fileDAO);
81 * This api is used for finding an existing file.
82 * Required parameters : id OR file_type_id of a file
84 * @param array $params
85 * An associative array of name/value property values of civicrm_file.
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 * This api is used for updating an existing file.
99 * Required parameters : id of a file
101 * @param array $params
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 * Deletes an existing file
127 * This API is used for deleting a file
128 * Required parameters : id of a file
130 * @param array $params
135 function civicrm_api3_file_delete($params) {
137 civicrm_api3_verify_mandatory($params, NULL, array('id'));
141 $entityFileDAO = new CRM_Core_DAO_EntityFile();
142 $entityFileDAO->file_id
= $params['id'];
143 if ($entityFileDAO->find()) {
144 $check = $entityFileDAO->delete();
147 $fileDAO = new CRM_Core_DAO_File();
148 $fileDAO->id
= $params['id'];
149 if ($fileDAO->find(TRUE)) {
150 $check = $fileDAO->delete();
153 return $check ?
NULL : civicrm_api3_create_error('Error while deleting a file.');