X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FFile.php;h=b3f347611494636317d1d85b77a9b90b494d9620;hb=c28e17683c9a697a035d17c26f337c2229275673;hp=682775b1e7e9d156feae2558a53583ee88826543;hpb=cf3a4f07f917a3da1b47d74ff0da121f7e2ba41e;p=civicrm-core.git diff --git a/api/v3/File.php b/api/v3/File.php index 682775b1e7..b3f3476114 100644 --- a/api/v3/File.php +++ b/api/v3/File.php @@ -26,20 +26,19 @@ */ /** + * This api allows minimal handling with the CiviCRM file DAO. + * Creating and updating files is a complex process and this api is usually insufficient. + * Use the "Attachment" api instead for more robust file handling. * - * Definition of the Tag of the CRM API. - * More detailed documentation can be found - * {@link http://objectledge.org/confluence/display/CRM/CRM+v1.0+Public+APIs - * here} - * + * @fixme no unit tests * @package CiviCRM_APIv3 * @subpackage API_File - * @copyright CiviCRM LLC (c) 2004-2014 - * $Id: $ */ /** - * Create a file. + * Create a file record. + * Note: This is only one of several steps needed to create a file in CiviCRM. + * Use the "Attachment" api to better handle all steps. * * @param array $params * Array per getfields metadata.