* @package CRM
* @copyright CiviCRM LLC https://civicrm.org/licensing
*/
-class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP {
+class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP implements \Civi\Core\HookInterface {
/**
* The action links that we need to display for the browse screen.
public static $_pcpLinks = NULL;
/**
- * Add or update either a Personal Campaign Page OR a PCP Block.
- *
- * @param array $params
- * Values to create the pcp.
- *
- * @return object
+ * @deprecated
+ * @return CRM_PCP_DAO_PCP
*/
public static function create($params) {
+ CRM_Core_Error::deprecatedFunctionWarning('writeRecord');
+ return self::writeRecord($params);
+ }
- $dao = new CRM_PCP_DAO_PCP();
- $dao->copyValues($params);
-
- // ensure we set status_id since it is a not null field
- // we should change the schema and allow this to be null
- if (!$dao->id && !isset($dao->status_id)) {
- $dao->status_id = 0;
- }
-
- // set currency for CRM-1496
- if (!isset($dao->currency)) {
- $dao->currency = CRM_Core_Config::singleton()->defaultCurrency;
+ /**
+ * Callback for hook_civicrm_pre().
+ *
+ * @param \Civi\Core\Event\PreEvent $event
+ *
+ * @throws \CRM_Core_Exception
+ */
+ public static function self_hook_civicrm_pre(\Civi\Core\Event\PreEvent $event): void {
+ if ($event->action === 'create') {
+ // For some reason `status_id` is allowed to be empty
+ // FIXME: Why?
+ $event->params['status_id'] = $event->params['status_id'] ?? 0;
+ // Supply default for `currency`
+ $event->params['currency'] = $event->params['currency'] ?? Civi::settings()->get('defaultCurrency');
}
-
- $dao->save();
- return $dao;
}
/**
}
/**
- * Delete the campaign page.
- *
+ * @deprecated
* @param int $id
- * Campaign page id.
*/
public static function deleteById($id) {
- CRM_Utils_Hook::pre('delete', 'Campaign', $id);
-
- $transaction = new CRM_Core_Transaction();
-
- // delete from pcp table
- $pcp = new CRM_PCP_DAO_PCP();
- $pcp->id = $id;
- $pcp->delete();
-
- $transaction->commit();
-
- CRM_Utils_Hook::post('delete', 'Campaign', $id, $pcp);
+ CRM_Core_Error::deprecatedFunctionWarning('deleteRecord');
+ return self::deleteRecord(['id' => $id]);
}
/**
class CRM_PCP_BAO_PCPBlock extends CRM_PCP_DAO_PCPBlock {
/**
- * Create or update either a Personal Campaign Page OR a PCP Block.
- *
- * @param array $params
- *
+ * @deprecated
* @return CRM_PCP_DAO_PCPBlock
*/
public static function create($params) {
- $dao = new CRM_PCP_DAO_PCPBlock();
- $dao->copyValues($params);
- $dao->save();
- return $dao;
+ CRM_Core_Error::deprecatedFunctionWarning('writeRecord');
+ return self::writeRecord($params);
}
}
$params['id'] = $this->_pageId;
- $pcp = CRM_PCP_BAO_PCP::create($params);
+ $pcp = CRM_PCP_BAO_PCP::writeRecord($params);
// add attachments as needed
CRM_Core_BAO_File::formatAttachment($params,
$params['is_approval_needed'] = CRM_Utils_Array::value('is_approval_needed', $params, FALSE);
$params['is_tellfriend_enabled'] = CRM_Utils_Array::value('is_tellfriend_enabled', $params, FALSE);
- CRM_PCP_BAO_PCPBlock::create($params);
+ CRM_PCP_BAO_PCPBlock::writeRecord($params);
parent::endPostProcess();
}
$params['is_approval_needed'] = CRM_Utils_Array::value('is_approval_needed', $params, FALSE);
$params['is_tellfriend_enabled'] = CRM_Utils_Array::value('is_tellfriend_enabled', $params, FALSE);
- CRM_PCP_BAO_PCPBlock::create($params);
+ CRM_PCP_BAO_PCPBlock::writeRecord($params);
// Update tab "disabled" css class
$this->ajaxResponse['tabValid'] = !empty($params['is_active']);
switch ($this->_action) {
case CRM_Core_Action::DELETE:
case 'delete':
- CRM_PCP_BAO_PCP::deleteById($this->_id);
+ CRM_PCP_BAO_PCP::deleteRecord(['id' => $this->_id]);
CRM_Core_Session::setStatus(ts("The Campaign Page '%1' has been deleted.", [1 => $this->_title]), ts('Page Deleted'), 'success');
break;
*/
public function postProcess() {
if ($this->_action & CRM_Core_Action::DELETE) {
- CRM_PCP_BAO_PCP::deleteById($this->_id);
+ CRM_PCP_BAO_PCP::deleteRecord(['id' => $this->_id]);
CRM_Core_Session::setStatus(ts("The Campaign Page '%1' has been deleted.", [1 => $this->_title]), ts('Page Deleted'), 'success');
}
else {
public function testAddPCPBlock() {
$params = $this->pcpBlockParams();
- $pcpBlock = CRM_PCP_BAO_PCPBlock::create($params);
+ $pcpBlock = CRM_PCP_BAO_PCPBlock::writeRecord($params);
$this->assertInstanceOf('CRM_PCP_DAO_PCPBlock', $pcpBlock, 'Check for created object');
$this->assertEquals($params['entity_table'], $pcpBlock->entity_table, 'Check for entity table.');
public function testAddPCPNoStatus() {
$blockParams = $this->pcpBlockParams();
- $pcpBlock = CRM_PCP_BAO_PCPBlock::create($blockParams);
+ $pcpBlock = CRM_PCP_BAO_PCPBlock::writeRecord($blockParams);
$params = $this->pcpParams();
$params['pcp_block_id'] = $pcpBlock->id;
unset($params['status_id']);
- $pcp = CRM_PCP_BAO_PCP::create($params);
+ $pcp = CRM_PCP_BAO_PCP::writeRecord($params);
$this->assertInstanceOf('CRM_PCP_DAO_PCP', $pcp, 'Check for created object');
$this->assertEquals($params['contact_id'], $pcp->contact_id, 'Check for entity table.');
$pcp = CRM_Core_DAO::createTestObject('CRM_PCP_DAO_PCP');
$pcpId = $pcp->id;
- CRM_PCP_BAO_PCP::deleteById($pcpId);
+ CRM_PCP_BAO_PCP::deleteRecord(['id' => $pcpId]);
$this->assertDBRowNotExist('CRM_PCP_DAO_PCP', $pcpId, 'Database check PCP deleted successfully.');
}
* @throws \CRM_Core_Exception
*/
public function testGetPcpDashboardInfo() {
- $block = CRM_PCP_BAO_PCPBlock::create($this->pcpBlockParams());
+ $block = CRM_PCP_BAO_PCPBlock::writeRecord($this->pcpBlockParams());
$contactID = $this->individualCreate();
$submitParams = [
'id' => 1,
// Reset the cache otherwise our hook will not be called
CRM_PCP_BAO_PCP::$_pcpLinks = NULL;
- $block = CRM_PCP_BAO_PCPBlock::create($this->pcpBlockParams());
+ $block = CRM_PCP_BAO_PCPBlock::writeRecord($this->pcpBlockParams());
$contactID = $this->individualCreate();
$contributionPage = $this->callAPISuccessGetSingle('ContributionPage', []);
$pcp = $this->callAPISuccess('Pcp', 'create', ['contact_id' => $contactID, 'title' => 'pcp', 'page_id' => $contributionPage['id'], 'pcp_block_id' => $block->id, 'is_active' => TRUE, 'status_id' => 'Approved']);
*/
public function testGatherMessageValuesForPCP() {
// set up a pcp page
- $block = CRM_PCP_BAO_PCPBlock::create($this->pcpBlockParams());
+ $block = CRM_PCP_BAO_PCPBlock::writeRecord($this->pcpBlockParams());
// The owner of the pcp, who gets the soft credit
$contact_owner = $this->individualCreate([], 0, TRUE);
$contributionPage = $this->callAPISuccessGetSingle('ContributionPage', []);
$params = array_merge($this->pcpParams(), $params);
$params['pcp_block_id'] = PCPBlock::create()->setValues($blockParams)->execute()->first()['id'];
- $pcp = CRM_PCP_BAO_PCP::create($params);
+ $pcp = CRM_PCP_BAO_PCP::writeRecord($params);
return (int) $pcp->id;
}
// pcpBLockParams creates a contribution page and returns the parameters
// necessary to create a PBP Block.
$blockParams = $this->pcpBlockParams();
- $pcpBlock = CRM_PCP_BAO_PCPBlock::create($blockParams);
+ $pcpBlock = CRM_PCP_BAO_PCPBlock::writeRecord($blockParams);
// Keep track of the contribution page id created. We will use this
// contribution page id for all the PCP pages.
$pcpParams['pcp_block_id'] = $pcpBlock->id;
$pcpParams['page_id'] = $contribution_page_id;
$pcpParams['page_type'] = 'contribute';
- $pcp1 = CRM_PCP_BAO_PCP::create($pcpParams);
+ $pcp1 = CRM_PCP_BAO_PCP::writeRecord($pcpParams);
// Nice work. Now, let's create a second PCP page.
$pcpParams = $this->pcpParams();
$pcpParams['pcp_block_id'] = $pcpBlock->id;
$pcpParams['page_id'] = $contribution_page_id;
$pcpParams['page_type'] = 'contribute';
- $pcp2 = CRM_PCP_BAO_PCP::create($pcpParams);
+ $pcp2 = CRM_PCP_BAO_PCP::writeRecord($pcpParams);
// Get soft credit types, with the name column as the key.
$soft_credit_types = CRM_Core_PseudoConstant::get('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', ['flip' => TRUE, 'labelColumn' => 'name']);
projects / civicrm-core.git / commitdiff