api/v3/File.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  *
  31  * Definition of the Tag of the CRM API.
  32  * More detailed documentation can be found
  33  * {@link http://objectledge.org/confluence/display/CRM/CRM+v1.0+Public+APIs
  34  * here}
  35  *
  36  * @package CiviCRM_APIv3
  37  * @subpackage API_File
  38  * @copyright CiviCRM LLC (c) 2004-2014
  39  * $Id: $
  40  *
  41  */
  42
  43 /**
  44  * Create a file
  45  *
  46  * This API is used for creating a file
  47  *
  48  * @param array $params
  49  *   An associative array of name/value property values of civicrm_file.
  50  *
  51  * @return array of newly created file property values.
  52  * @access public
  53  */
  54 function civicrm_api3_file_create($params) {
  55
  56   civicrm_api3_verify_mandatory($params, 'CRM_Core_DAO_File', array('uri'));
  57
  58   if (!isset($params['upload_date'])) {
  59     $params['upload_date'] = date("Ymd");
  60   }
  61
  62   $fileDAO = new CRM_Core_DAO_File();
  63   $properties = array('id', 'file_type_id', 'mime_type', 'uri', 'document', 'description', 'upload_date');
  64
  65   foreach ($properties as $name) {
  66     if (array_key_exists($name, $params)) {
  67       $fileDAO->$name = $params[$name];
  68     }
  69   }
  70
  71   $fileDAO->save();
  72
  73   $file = array();
  74   _civicrm_api3_object_to_array($fileDAO, $file);
  75
  76   return civicrm_api3_create_success($file, $params, 'file', 'create', $fileDAO);
  77 }
  78
  79 /**
  80  * Get a file.
  81  *
  82  * This api is used for finding an existing file.
  83  * Required parameters : id OR file_type_id of a file
  84  *
  85  * @param array $params
  86  *   An associative array of name/value property values of civicrm_file.
  87  *
  88  * @return  Array of all found file object property values.
  89  * @access public
  90  */
  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);
  94 }
  95
  96 /**
  97  * Update an existing file
  98  *
  99  * This api is used for updating an existing file.
 100  * Required parameters : id of a file
 101  *
 102  * @param array $paramsAn array of name/value property values of civicrm_file.
 103  *   An array of name/value property values of civicrm_file.
 104  *
 105  * @return array of updated file object property values
 106  * @access public
 107  */
 108 function civicrm_api3_file_update($params) {
 109
 110   if (!isset($params['id'])) {
 111     return civicrm_api3_create_error('Required parameter missing');
 112   }
 113
 114   $fileDAO = new CRM_Core_DAO_File();
 115   $fileDAO->id = $params['id'];
 116   if ($fileDAO->find(TRUE)) {
 117     $fileDAO->copyValues($params);
 118     if (!$params['upload_date'] && !$fileDAO->upload_date) {
 119       $fileDAO->upload_date = date("Ymd");
 120     }
 121     $fileDAO->save();
 122   }
 123   $file = array();
 124   _civicrm_api3_object_to_array(clone($fileDAO), $file);
 125   return $file;
 126 }
 127
 128 /**
 129  * Deletes an existing file
 130  *
 131  * This API is used for deleting a file
 132  * Required parameters : id of a file
 133  *
 134  * @param array $params
 135  *
 136  * @return array API result array
 137  * @access public
 138  */
 139 function civicrm_api3_file_delete($params) {
 140
 141   civicrm_api3_verify_mandatory($params, NULL, array('id'));
 142
 143   $check = FALSE;
 144
 145   $entityFileDAO = new CRM_Core_DAO_EntityFile();
 146   $entityFileDAO->file_id = $params['id'];
 147   if ($entityFileDAO->find()) {
 148     $check = $entityFileDAO->delete();
 149   }
 150
 151   $fileDAO = new CRM_Core_DAO_File();
 152   $fileDAO->id = $params['id'];
 153   if ($fileDAO->find(TRUE)) {
 154     $check = $fileDAO->delete();
 155   }
 156
 157   return $check ? NULL : civicrm_api3_create_error('Error while deleting a file.');
 158 }