api/v3/File.php

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