<?php
-
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
* "Attachment" is a pseudo-entity which represents a record in civicrm_file
* combined with a record in civicrm_entity_file as well as the underlying
* file content.
+ * For core fields use "entity_table", for custom fields use "field_name"
*
* @code
+ * // Create an attachment for a core field
* $result = civicrm_api3('Attachment', 'create', array(
* 'entity_table' => 'civicrm_activity',
* 'entity_id' => 123,
* @endcode
*
* @code
+ * // Create an attachment for a custom file field
+ * $result = civicrm_api3('Attachment', 'create', array(
+ * 'field_name' => 'custom_6',
+ * 'entity_id' => 123,
+ * 'name' => 'README.txt',
+ * 'mime_type' => 'text/plain',
+ * 'content' => 'Please to read the README',
+ * ));
+ * $attachment = $result['values'][$result['id']];
+ * echo sprintf("<a href='%s'>View %s</a>", $attachment['url'], $attachment['name']);
+ * @endcode
+ *
+ * @code
+ * // Move an existing file and save as an attachment
* $result = civicrm_api3('Attachment', 'create', array(
* 'entity_table' => 'civicrm_activity',
* 'entity_id' => 123,
*
* @package CiviCRM_APIv3
* @subpackage API_Attachment
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id: $
- *
*/
/**
- * Adjust metadata for "create" action
+ * Adjust metadata for "create" action.
*
- * @param array $spec list of fields
+ * @param array $spec
+ * List of fields.
*/
function _civicrm_api3_attachment_create_spec(&$spec) {
$spec = array_merge($spec, _civicrm_api3_attachment_getfields());
$spec['name']['api.required'] = 1;
$spec['mime_type']['api.required'] = 1;
- $spec['entity_table']['api.required'] = 1;
$spec['entity_id']['api.required'] = 1;
$spec['upload_date']['api.default'] = 'now';
}
/**
- * Create an attachment
+ * Create an attachment.
+ *
+ * @param array $params
*
- * @param array $params
- * @return array of newly created file property values.
- * @access public
+ * @return array
+ * Array of newly created file property values.
* @throws API_Exception validation errors
*/
function civicrm_api3_attachment_create($params) {
+
+ if (empty($params['id'])) {
+ // When creating we need either entity_table or field_name
+ civicrm_api3_verify_one_mandatory($params, NULL, array('entity_table', 'field_name'));
+ }
+
$config = CRM_Core_Config::singleton();
list($id, $file, $entityFile, $name, $content, $moveFile, $isTrusted, $returnContent) = _civicrm_api3_attachment_parse_params($params);
rename($moveFile, $path);
}
+ // Save custom field to entity
+ if (!$id && empty($params['entity_table']) && isset($params['field_name'])) {
+ civicrm_api3('custom_value', 'create', array(
+ 'entity_id' => $params['entity_id'],
+ $params['field_name'] => $fileDao->id,
+ ));
+ }
+
$result = array(
- $fileDao->id => _civicrm_api3_attachment_format_result($fileDao, $entityFileDao, $returnContent, $isTrusted)
+ $fileDao->id => _civicrm_api3_attachment_format_result($fileDao, $entityFileDao, $returnContent, $isTrusted),
);
return civicrm_api3_create_success($result, $params, 'Attachment', 'create');
}
/**
- * Adjust metadata for "create" action
+ * Adjust metadata for get action.
*
- * @param array $spec list of fields
+ * @param array $spec
+ * List of fields.
*/
function _civicrm_api3_attachment_get_spec(&$spec) {
$spec = array_merge($spec, _civicrm_api3_attachment_getfields());
}
/**
+ * Get attachment.
+ *
* @param array $params
- * @return array per APIv3
+ *
+ * @return array
+ * per APIv3
* @throws API_Exception validation errors
*/
function civicrm_api3_attachment_get($params) {
return civicrm_api3_create_success($result, $params, 'Attachment', 'create');
}
+/**
+ * Adjust metadata for attachment delete action.
+ *
+ * @param $spec
+ */
function _civicrm_api3_attachment_delete_spec(&$spec) {
unset($spec['id']['api.required']);
$entityFileFields = CRM_Core_DAO_EntityFile::fields();
}
/**
- * @param $params
+ * Delete attachment.
+ *
+ * @param array $params
+ *
* @return array
* @throws API_Exception
*/
$filePaths = array();
$fileIds = array();
while ($dao->fetch()) {
- $filePaths [] = $config->customFileUploadDir . DIRECTORY_SEPARATOR . $dao->uri;
+ $filePaths[] = $config->customFileUploadDir . DIRECTORY_SEPARATOR . $dao->uri;
$fileIds[] = $dao->id;
}
}
/**
+ * Attachment find helper.
+ *
* @param array $params
* @param int|null $id the user-supplied ID of the attachment record
- * @param array $file the user-supplied vales for the file (mime_type, description, upload_date)
- * @param array $entityFile the user-supllied values of the entity-file (entity_table, entity_id)
+ * @param array $file
+ * The user-supplied vales for the file (mime_type, description, upload_date).
+ * @param array $entityFile
+ * The user-supplied values of the entity-file (entity_table, entity_id).
* @param bool $isTrusted
+ *
* @return CRM_Core_DAO
* @throws API_Exception
*/
if ($id) {
$select->where('cf.id = #id', array('#id' => $id));
}
- // recall: $file is filtered by parse_params
+ // Recall: $file is filtered by parse_params.
foreach ($file as $key => $value) {
$select->where('cf.!field = @value', array(
'!field' => $key,
'@value' => $value,
));
}
- // recall: $entityFile is filtered by parse_params
+ // Recall: $entityFile is filtered by parse_params.
foreach ($entityFile as $key => $value) {
$select->where('cef.!field = @value', array(
'!field' => $key,
}
/**
+ * Attachment parsing helper.
+ *
* @param array $params
- * @return array (0 => int $id, 1 => array $file, 2 => array $entityFile, 3 => string $name, 4 => string $content, 5 => string $moveFile, 6 => $isTrusted, 7 => bool $returnContent)
- * - array $file: whitelisted fields that can pass through directly to civicrm_file
- * - array $entityFile: whitelisted fields that can pass through directly to civicrm_entity_file
- * - string $name: the printable name
- * - string $moveFile: the full path to a local file whose content should be loaded
- * - bool $isTrusted: whether we trust the requester to do sketchy things (like moving files or reassigning entities)
- * - bool $returnContent: whether we are expected to return the full content of the file
+ *
+ * @return array
+ * (0 => int $id, 1 => array $file, 2 => array $entityFile, 3 => string $name, 4 => string $content,
+ * 5 => string $moveFile, 6 => $isTrusted, 7 => bool $returnContent)
+ * - array $file: whitelisted fields that can pass through directly to civicrm_file
+ * - array $entityFile: whitelisted fields that can pass through directly to civicrm_entity_file
+ * - string $name: the printable name
+ * - string $moveFile: the full path to a local file whose content should be loaded
+ * - bool $isTrusted: whether we trust the requester to do sketchy things (like moving files or reassigning entities)
+ * - bool $returnContent: whether we are expected to return the full content of the file
* @throws API_Exception validation errors
*/
function _civicrm_api3_attachment_parse_params($params) {
}
}
+ if (empty($params['entity_table']) && isset($params['field_name'])) {
+ $tableInfo = CRM_Core_BAO_CustomField::getTableColumnGroup(intval(str_replace('custom_', '', $params['field_name'])));
+ $entityFile['entity_table'] = $tableInfo[0];
+ }
+
$name = NULL;
if (array_key_exists('name', $params)) {
if ($params['name'] != basename($params['name']) || preg_match(':[/\\\\]:', $params['name'])) {
}
/**
- * @param CRM_Core_DAO_File $fileDao maybe "File" or "File JOIN EntityFile"
- * @param CRM_Core_DAO_EntityFile $entityFileDao maybe "EntityFile" or "File JOIN EntityFile"
- * @param bool $returnContent whether to return the full content of the file
- * @param bool $isTrusted whether the current request is trusted to perform file-specific operations
+ * Attachment result formatting helper.
+ *
+ * @param CRM_Core_DAO_File $fileDao
+ * Maybe "File" or "File JOIN EntityFile".
+ * @param CRM_Core_DAO_EntityFile $entityFileDao
+ * Maybe "EntityFile" or "File JOIN EntityFile".
+ * @param bool $returnContent
+ * Whether to return the full content of the file.
+ * @param bool $isTrusted
+ * Whether the current request is trusted to perform file-specific operations.
+ *
* @return array
*/
function _civicrm_api3_attachment_format_result($fileDao, $entityFileDao, $returnContent, $isTrusted) {
}
/**
- * @return array list of fields (indexed by name)
+ * Attachment getfields helper.
+ *
+ * @return array
+ * list of fields (indexed by name)
*/
function _civicrm_api3_attachment_getfields() {
$fileFields = CRM_Core_DAO_File::fields();
'description' => 'The logical file name (not searchable)',
'type' => CRM_Utils_Type::T_STRING,
);
+ $spec['field_name'] = array(
+ 'title' => 'Field Name (write-once)',
+ 'description' => 'Alternative to "entity_table" param - sets custom field value.',
+ 'type' => CRM_Utils_Type::T_STRING,
+ );
$spec['mime_type'] = $fileFields['mime_type'];
$spec['description'] = $fileFields['description'];
$spec['upload_date'] = $fileFields['upload_date'];
$spec['entity_table'] = $entityFileFields['entity_table'];
- $spec['entity_table']['title'] = CRM_Utils_Array::value('title', $spec['entity_table'], 'Entity Table') . ' (write-once)'; // would be hard to securely handle changes
+ // Would be hard to securely handle changes.
+ $spec['entity_table']['title'] = CRM_Utils_Array::value('title', $spec['entity_table'], 'Entity Table') . ' (write-once)';
$spec['entity_id'] = $entityFileFields['entity_id'];
$spec['entity_id']['title'] = CRM_Utils_Array::value('title', $spec['entity_id'], 'Entity ID') . ' (write-once)'; // would be hard to securely handle changes
$spec['url'] = array(
projects / civicrm-core.git / blobdiff