return FALSE;
}
+ /**
+ * @param $id
+ * @return bool
+ */
+ public static function del($id) {
+ return self::deleteCase($id);
+ }
+
/**
* Enable disable case related relationships.
*
--- /dev/null
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved. |
+ | |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+
+
+namespace Civi\Api4\Action\CiviCase;
+
+/**
+ * @inheritDoc
+ */
+trait CiviCaseSaveTrait {
+
+ /**
+ * @param array $cases
+ * @return array
+ */
+ protected function writeObjects($cases) {
+ $cases = array_values($cases);
+ $result = parent::writeObjects($cases);
+
+ // If the case doesn't have an id, it's new & needs to be opened.
+ foreach ($cases as $idx => $case) {
+ if (empty($case['id'])) {
+ $this->openCase($case, $result[$idx]['id']);
+ }
+ }
+ return $result;
+ }
+
+ /**
+ * @param $case
+ * @param $id
+ * @throws \CRM_Core_Exception
+ */
+ private function openCase($case, $id) {
+ // Add case contacts (clients)
+ foreach ((array) $case['contact_id'] as $cid) {
+ $contactParams = ['case_id' => $id, 'contact_id' => $cid];
+ \CRM_Case_BAO_CaseContact::create($contactParams);
+ }
+
+ $caseType = \CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseType', $case['case_type_id'], 'name');
+
+ // Pass "Open Case" params to XML processor
+ $xmlProcessor = new \CRM_Case_XMLProcessor_Process();
+ $params = [
+ 'clientID' => $case['contact_id'] ?? NULL,
+ 'creatorID' => $case['creator_id'] ?? NULL,
+ 'standardTimeline' => 1,
+ 'activityTypeName' => 'Open Case',
+ 'caseID' => $id,
+ 'subject' => $case['subject'] ?? NULL,
+ 'location' => $case['location'] ?? NULL,
+ 'activity_date_time' => $case['start_date'] ?? NULL,
+ 'duration' => $case['duration'] ?? NULL,
+ 'medium_id' => $case['medium_id'] ?? NULL,
+ 'details' => $case['details'] ?? NULL,
+ 'custom' => [],
+ 'relationship_end_date' => $case['end_date'] ?? NULL,
+ ];
+
+ // Do it! :-D
+ $xmlProcessor->run($caseType, $params);
+ }
+
+}
--- /dev/null
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved. |
+ | |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+
+
+namespace Civi\Api4\Action\CiviCase;
+
+/**
+ * @inheritDoc
+ */
+class Create extends \Civi\Api4\Generic\DAOCreateAction {
+ use CiviCaseSaveTrait;
+
+}
--- /dev/null
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved. |
+ | |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+ */
+
+namespace Civi\Api4\Action\CiviCase;
+
+/**
+ * @inheritDoc
+ */
+class Save extends \Civi\Api4\Generic\DAOSaveAction {
+ use CiviCaseSaveTrait;
+
+}
--- /dev/null
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved. |
+ | |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+
+
+namespace Civi\Api4\Action\CiviCase;
+
+/**
+ * @inheritDoc
+ */
+class Update extends \Civi\Api4\Generic\DAOUpdateAction {
+ use CiviCaseSaveTrait;
+
+}
foreach (glob("$dir/*.php") as $file) {
$actionName = basename($file, '.php');
$actionClass = new \ReflectionClass($nameSpace . '\\' . $actionName);
- if ($actionClass->isInstantiable() && $actionClass->isSubclassOf('\Civi\\Api4\Generic\AbstractAction')) {
+ if ($actionClass->isInstantiable() && $actionClass->isSubclassOf('\Civi\Api4\Generic\AbstractAction')) {
$this->loadAction(lcfirst($actionName));
}
}
--- /dev/null
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved. |
+ | |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+
+
+namespace Civi\Api4;
+
+/**
+ * CaseContact BridgeEntity.
+ *
+ * This connects a client to a case.
+ *
+ * @see \Civi\Api4\Case
+ * @package Civi\Api4
+ */
+class CaseContact extends Generic\DAOEntity {
+ use Generic\Traits\EntityBridge;
+
+ protected static function getEntityTitle($plural = FALSE) {
+ return $plural ? ts('Case Clients') : ts('Case Client');
+ }
+
+}
--- /dev/null
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved. |
+ | |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+
+
+namespace Civi\Api4;
+
+/**
+ * Case entity.
+ *
+ * Note that the class for this entity is named "CiviCase" because "Case" is a keyword reserved by php.
+ *
+ * @see https://docs.civicrm.org/user/en/latest/case-management/what-is-civicase/
+ * @package Civi\Api4
+ */
+class CiviCase extends Generic\DAOEntity {
+
+ /**
+ * Explicitly declare entity name because it doesn't match the name of this class
+ * (due to the php reserved keyword issue)
+ *
+ * @return string
+ */
+ protected static function getEntityName() {
+ return 'Case';
+ }
+
+ /**
+ * @param bool $checkPermissions
+ * @return Action\CiviCase\Create
+ */
+ public static function create($checkPermissions = TRUE) {
+ return (new Action\CiviCase\Create('Case', __FUNCTION__))
+ ->setCheckPermissions($checkPermissions);
+ }
+
+ /**
+ * @param bool $checkPermissions
+ * @return Action\CiviCase\Save
+ */
+ public static function save($checkPermissions = TRUE) {
+ return (new Action\CiviCase\Save('Case', __FUNCTION__))
+ ->setCheckPermissions($checkPermissions);
+ }
+
+ /**
+ * @param bool $checkPermissions
+ * @return Action\CiviCase\Update
+ */
+ public static function update($checkPermissions = TRUE) {
+ return (new Action\CiviCase\Update('Case', __FUNCTION__))
+ ->setCheckPermissions($checkPermissions);
+ }
+
+}
use Civi\Api4\CustomField;
use Civi\Api4\Service\Schema\Joinable\CustomGroupJoinable;
use Civi\Api4\Utils\FormattingUtil;
+use Civi\Api4\Utils\CoreUtil;
/**
* @method string getLanguage()
* @return \CRM_Core_DAO|string
*/
protected function getBaoName() {
- require_once 'api/v3/utils.php';
- return \_civicrm_api3_get_BAO($this->getEntityName());
+ return CoreUtil::getBAOFromApiName($this->getEntityName());
}
/**
* @param array $params
* @param int $entityId
*
- * @return mixed
- *
* @throws \API_Exception
* @throws \CRM_Core_Exception
*/
--- /dev/null
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved. |
+ | |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+
+
+namespace Civi\Api4\Service\Spec\Provider;
+
+use Civi\Api4\Service\Spec\FieldSpec;
+use Civi\Api4\Service\Spec\RequestSpec;
+
+class CaseCreationSpecProvider implements Generic\SpecProviderInterface {
+
+ /**
+ * @inheritDoc
+ */
+ public function modifySpec(RequestSpec $spec) {
+ $creator = new FieldSpec('creator_id', $spec->getEntity(), 'Integer');
+ $creator->setTitle(ts('Case Creator'));
+ $creator->setDescription('Contact who created the case.');
+ $creator->setFkEntity('Contact');
+ $creator->setInputType('EntityRef');
+ $spec->addFieldSpec($creator);
+
+ $contact = new FieldSpec('contact_id', $spec->getEntity(), 'Array');
+ $contact->setTitle(ts('Case Contact(s)'));
+ $contact->setLabel(ts('Case Client(s)'));
+ $contact->setDescription('Contact(s) who are case clients.');
+ $contact->setFkEntity('Contact');
+ $contact->setInputType('EntityRef');
+ $contact->setRequired(TRUE);
+ $spec->addFieldSpec($contact);
+
+ $location = new FieldSpec('location', $spec->getEntity(), 'String');
+ $location->setTitle(ts('Activity Location'));
+ $location->setDescription('Open Case activity location.');
+ $spec->addFieldSpec($location);
+
+ $medium_id = new FieldSpec('medium_id', $spec->getEntity(), 'Integer');
+ $medium_id->setTitle(ts('Activity Medium'));
+ $medium_id->setDescription('Open Case activity medium.');
+ $spec->addFieldSpec($medium_id);
+
+ $duration = new FieldSpec('duration', $spec->getEntity(), 'Integer');
+ $duration->setTitle(ts('Activity Duration'));
+ $duration->setInputType('Number');
+ $duration->setDescription('Open Case activity duration (minutes).');
+ $spec->addFieldSpec($duration);
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function applies($entity, $action) {
+ return $entity === 'Case' && $action === 'create';
+ }
+
+}
"@ref": "test_contact_1"
}
],
+ "Case": [
+ {
+ "case_type_id": 1,
+ "status_id": 1,
+ "contact_id": "@ref test_contact_1.id",
+ "creator_id": "@ref test_contact_1.id"
+ }
+ ],
"CustomGroup": [
{
"name": "MyFavoriteThings",
*/
public function getEntitiesHitech() {
// Ensure all components are enabled so their entities show up
- \CRM_Core_BAO_ConfigSetting::enableComponent('CiviEvent');
- \CRM_Core_BAO_ConfigSetting::enableComponent('CiviGrant');
- \CRM_Core_BAO_ConfigSetting::enableComponent('CiviCase');
- \CRM_Core_BAO_ConfigSetting::enableComponent('CiviContribute');
- \CRM_Core_BAO_ConfigSetting::enableComponent('CiviCampaign');
- \CRM_Core_BAO_ConfigSetting::enableComponent('CiviPledge');
- \CRM_Core_BAO_ConfigSetting::enableComponent('CiviReport');
+ foreach (array_keys(\CRM_Core_Component::getComponents()) as $component) {
+ \CRM_Core_BAO_ConfigSetting::enableComponent($component);
+ }
return $this->toDataProviderArray(Entity::get(FALSE)->execute()->column('name'));
}
public function getEntitiesLotech() {
$manual['add'] = [];
$manual['remove'] = ['CustomValue'];
+ $manual['transform'] = ['CiviCase' => 'Case'];
$scanned = [];
$srcDir = dirname(__DIR__, 5);
foreach ((array) glob("$srcDir/Civi/Api4/*.php") as $name) {
- $scanned[] = preg_replace('/\.php/', '', basename($name));
+ $fileName = basename($name, '.php');
+ $scanned[] = $manual['transform'][$fileName] ?? $fileName;
}
$names = array_diff(
projects / civicrm-core.git / commitdiff