--- /dev/null
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.7 |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2017 |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM. |
+ | |
+ | CiviCRM is free software; you can copy, modify, and distribute it |
+ | under the terms of the GNU Affero General Public License |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
+ | |
+ | CiviCRM is distributed in the hope that it will be useful, but |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
+ | See the GNU Affero General Public License for more details. |
+ | |
+ | You should have received a copy of the GNU Affero General Public |
+ | License and the CiviCRM Licensing Exception along |
+ | with this program; if not, contact CiviCRM LLC |
+ | at info[AT]civicrm[DOT]org. If you have questions about the |
+ | GNU Affero General Public License or the licensing of CiviCRM, |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ * Test class for API functions.
+ *
+ * @package CiviCRM_APIv3
+ * @group headless
+ */
+class api_v3_CustomApiTest extends CiviUnitTestCase {
+
+ protected $_apiversion = 3;
+
+ public function setUp() {
+ parent::setUp();
+ $this->installApi();
+ }
+
+ public function tearDown() {
+ parent::tearDown();
+ CRM_Core_DAO::executeQuery('DROP TABLE civicrm_mailing_provider_data');
+ }
+
+ /**
+ * Test that a custom api, as one would add in an extension works.
+ *
+ * This api is a bit 'special' in that it has a composite primary key rather
+ * than using 'id', make sure that works too....
+ */
+ public function testCustomApi() {
+ $this->installApi();
+ $this->callAPISuccess('MailingProviderData', 'create', array(
+ 'contact_identifier' => 'xyz',
+ 'mailing_identifier' => 'abx',
+ ));
+ $this->callAPISuccess('Mailing', 'create', array('name' => 'CiviMail', 'hash' => 'abx'));
+ $result = $this->callAPISuccess('MailingProviderData', 'get', array('return' => array('mailing_identifier.name', 'contact_identifier', 'mailing_identifier')));
+ $this->assertEquals(1, $result['count']);
+ $this->assertEquals('xyzabx0000-00-00 00:00:00', $result['id']);
+ $this->assertEquals('xyzabx0000-00-00 00:00:00', $result['id']);
+ $this->assertEquals(array(
+ 'contact_identifier' => 'xyz',
+ 'mailing_identifier' => 'abx',
+ 'mailing_identifier.name' => 'CiviMail',
+ ),
+ reset($result['values'])
+ );
+ }
+
+ /**
+ * * Implements hook_civicrm_EntityTypes().
+ *
+ * @param array $entityTypes
+ */
+ public function hookEntityTypes(&$entityTypes) {
+ $entityTypes['CRM_Omnimail_DAO_MailingProviderData'] = array(
+ 'name' => 'MailingProviderData',
+ 'class' => 'CRM_Omnimail_DAO_MailingProviderData',
+ 'table' => 'civicrm_maiing_provider_data',
+ );
+ }
+
+ /**
+ * Install the custom api.
+ */
+ public function installApi() {
+ require_once __DIR__ . '/custom_api/MailingProviderData.php';
+ $this->hookClass->setHook('civicrm_entityTypes', array($this, 'hookEntityTypes'));
+ CRM_Core_DAO_AllCoreTables::init(TRUE);
+ CRM_Core_DAO::executeQuery(
+ "CREATE TABLE IF NOT EXISTS `civicrm_mailing_provider_data` (
+ `contact_identifier` varchar(255) COLLATE utf8_unicode_ci NOT NULL DEFAULT '',
+ `mailing_identifier` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
+ `email` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
+ `event_type` varchar(255) COLLATE utf8_unicode_ci NOT NULL DEFAULT '',
+ `recipient_action_datetime` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
+ `contact_id` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
+ `is_civicrm_updated` TINYINT(4) DEFAULT '0',
+ PRIMARY KEY (`contact_identifier`,`recipient_action_datetime`,`event_type`),
+ KEY `contact_identifier` (`contact_identifier`),
+ KEY `mailing_identifier` (`mailing_identifier`),
+ KEY `contact_id` (`contact_id`),
+ KEY `email` (`email`),
+ KEY `event_type` (`event_type`),
+ KEY `recipient_action_datetime` (`recipient_action_datetime`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci"
+ );
+ }
+
+}
--- /dev/null
+<?php
+/*
++--------------------------------------------------------------------+
+| CiviCRM version 4.7 |
++--------------------------------------------------------------------+
+| Copyright CiviCRM LLC (c) 2004-2017 |
++--------------------------------------------------------------------+
+| This file is a part of CiviCRM. |
+| |
+| CiviCRM is free software; you can copy, modify, and distribute it |
+| under the terms of the GNU Affero General Public License |
+| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
+| |
+| CiviCRM is distributed in the hope that it will be useful, but |
+| WITHOUT ANY WARRANTY; without even the implied warranty of |
+| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
+| See the GNU Affero General Public License for more details. |
+| |
+| You should have received a copy of the GNU Affero General Public |
+| License and the CiviCRM Licensing Exception along |
+| with this program; if not, contact CiviCRM LLC |
+| at info[AT]civicrm[DOT]org. If you have questions about the |
+| GNU Affero General Public License or the licensing of CiviCRM, |
+| see the CiviCRM license FAQ at http://civicrm.org/licensing |
++--------------------------------------------------------------------+
+ */
+
+/**
+ * @package CRM
+ * @copyright CiviCRM LLC (c) 2004-2017
+ *
+ * Generated from xml/schema/CRM/Omnimail/MailingProviderData.xml
+ * DO NOT EDIT. Generated by CRM_Core_CodeGen
+ * (GenCodeChecksum:a204d62995809fae79a76799b88a69f8)
+ */
+
+/**
+ * CRM_Omnimail_DAO_MailingProviderData constructor.
+ */
+class CRM_Omnimail_DAO_MailingProviderData extends CRM_Core_DAO {
+ /**
+ * Static instance to hold the table name.
+ *
+ * @var string
+ */
+ static $_tableName = 'civicrm_mailing_provider_data';
+ /**
+ * Should CiviCRM log any modifications to this table in the civicrm_log table.
+ *
+ * @var boolean
+ */
+ static $_log = FALSE;
+ /**
+ * External reference for the contact
+ *
+ * @var string
+ */
+ public $contact_identifier;
+ /**
+ * External Reference for the mailing
+ *
+ * @var string
+ */
+ public $mailing_identifier;
+ /**
+ * Email Address
+ *
+ * @var string
+ */
+ public $email;
+ /**
+ * Type of action
+ *
+ * @var string
+ */
+ public $event_type;
+ /**
+ * When the action happened
+ *
+ * @var timestamp
+ */
+ public $recipient_action_datetime;
+ /**
+ * Contact in CiviCRM
+ *
+ * @var int
+ */
+ public $contact_id;
+ /**
+ * Has the action been synchronised through to CiviCRM
+ *
+ * @var bool
+ */
+ public $is_civicrm_updated;
+
+ /**
+ * Class constructor.
+ */
+ public function __construct() {
+ $this->__table = 'civicrm_mailing_provider_data';
+ parent::__construct();
+ }
+ /**
+ * Returns all the column names of this table
+ *
+ * @return array
+ */
+ public static function &fields() {
+ if (!isset(Civi::$statics[__CLASS__]['fields'])) {
+ Civi::$statics[__CLASS__]['fields'] = array(
+ 'contact_identifier' => array(
+ 'name' => 'contact_identifier',
+ 'type' => CRM_Utils_Type::T_STRING,
+ 'title' => ts('Contact Identifier') ,
+ 'description' => 'External reference for the contact',
+ 'maxlength' => 255,
+ 'size' => CRM_Utils_Type::HUGE,
+ 'table_name' => 'civicrm_mailing_provider_data',
+ 'entity' => 'MailingProviderData',
+ 'bao' => 'CRM_Omnimail_DAO_MailingProviderData',
+ 'localizable' => 0,
+ ) ,
+ 'mailing_identifier' => array(
+ 'name' => 'mailing_identifier',
+ 'type' => CRM_Utils_Type::T_STRING,
+ 'title' => ts('Mailing Identifier') ,
+ 'description' => 'External Referencefor the mailing',
+ 'maxlength' => 255,
+ 'size' => CRM_Utils_Type::HUGE,
+ 'table_name' => 'civicrm_mailing_provider_data',
+ 'entity' => 'MailingProviderData',
+ 'bao' => 'CRM_Omnimail_DAO_MailingProviderData',
+ 'localizable' => 0,
+ ) ,
+ 'email' => array(
+ 'name' => 'email',
+ 'type' => CRM_Utils_Type::T_STRING,
+ 'title' => ts('Email') ,
+ 'description' => 'Email Address',
+ 'maxlength' => 255,
+ 'size' => CRM_Utils_Type::HUGE,
+ 'table_name' => 'civicrm_mailing_provider_data',
+ 'entity' => 'MailingProviderData',
+ 'bao' => 'CRM_Omnimail_DAO_MailingProviderData',
+ 'localizable' => 0,
+ ) ,
+ 'event_type' => array(
+ 'name' => 'event_type',
+ 'type' => CRM_Utils_Type::T_STRING,
+ 'title' => ts('Recipient Action Type') ,
+ 'description' => 'Type of action',
+ 'maxlength' => 255,
+ 'size' => CRM_Utils_Type::HUGE,
+ 'table_name' => 'civicrm_mailing_provider_data',
+ 'entity' => 'MailingProviderData',
+ 'bao' => 'CRM_Omnimail_DAO_MailingProviderData',
+ 'localizable' => 0,
+ ) ,
+ 'recipient_action_datetime' => array(
+ 'name' => 'recipient_action_datetime',
+ 'type' => CRM_Utils_Type::T_TIMESTAMP,
+ 'title' => ts('Recipient Action Datetime') ,
+ 'description' => 'When the action happened',
+ 'table_name' => 'civicrm_mailing_provider_data',
+ 'entity' => 'MailingProviderData',
+ 'bao' => 'CRM_Omnimail_DAO_MailingProviderData',
+ 'localizable' => 0,
+ ) ,
+ 'contact_id' => array(
+ 'name' => 'contact_id',
+ 'type' => CRM_Utils_Type::T_INT,
+ 'description' => 'Contact in CiviCRM',
+ 'table_name' => 'civicrm_mailing_provider_data',
+ 'entity' => 'MailingProviderData',
+ 'bao' => 'CRM_Omnimail_DAO_MailingProviderData',
+ 'localizable' => 0,
+ ) ,
+ 'is_civicrm_updated' => array(
+ 'name' => 'is_civicrm_updated',
+ 'type' => CRM_Utils_Type::T_BOOLEAN,
+ 'description' => 'Has the action been synchronised through to CiviCRM',
+ 'table_name' => 'civicrm_mailing_provider_data',
+ 'entity' => 'MailingProviderData',
+ 'bao' => 'CRM_Omnimail_DAO_MailingProviderData',
+ 'localizable' => 0,
+ ) ,
+ );
+ CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
+ }
+ return Civi::$statics[__CLASS__]['fields'];
+ }
+ /**
+ * Return a mapping from field-name to the corresponding key (as used in fields()).
+ *
+ * @return array
+ * Array(string $name => string $uniqueName).
+ */
+ public static function &fieldKeys() {
+ if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
+ Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
+ }
+ return Civi::$statics[__CLASS__]['fieldKeys'];
+ }
+ /**
+ * Returns the names of this table
+ *
+ * @return string
+ */
+ public static function getTableName() {
+ return self::$_tableName;
+ }
+ /**
+ * Returns if this table needs to be logged
+ *
+ * @return bool
+ */
+ public function getLog() {
+ return self::$_log;
+ }
+ /**
+ * Returns the list of fields that can be imported
+ *
+ * @param bool $prefix
+ *
+ * @return array
+ */
+ public static function &import($prefix = FALSE) {
+ $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'mailing_provider_data', $prefix, array());
+ return $r;
+ }
+ /**
+ * Returns the list of fields that can be exported
+ *
+ * @param bool $prefix
+ *
+ * @return array
+ */
+ public static function &export($prefix = FALSE) {
+ $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'mailing_provider_data', $prefix, array());
+ return $r;
+ }
+ /**
+ * Returns the list of indices
+ */
+ public static function indices($localize = TRUE) {
+ $indices = array();
+ return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
+ }
+
+}
+
+/**
+ * CRM_Omnimail_BAO_MailingProviderData constructor.
+ */
+class CRM_Omnimail_BAO_MailingProviderData extends CRM_Omnimail_DAO_MailingProviderData {
+
+}
+
+/**
+ * MailingProviderData.get API
+ *
+ * @param array $params
+ * @return array API result descriptor
+ * @throws API_Exception
+ */
+function civicrm_api3_mailing_provider_data_get($params) {
+ $sql = CRM_Utils_SQL_Select::fragment();
+ $sql->select('CONCAT(contact_identifier, mailing_identifier, recipient_action_datetime) as id');
+ return civicrm_api3_create_success(_civicrm_api3_basic_get('CRM_Omnimail_BAO_MailingProviderData', $params, FALSE, 'MailingProviderData', $sql, FALSE));
+}
+
+/**
+ * Metadata for MailingProviderData.get API
+ *
+ * @param array $params
+ *
+ * @throws API_Exception
+ */
+function _civicrm_api3_mailing_provider_data_get_spec(&$params) {
+ $params['mailing_identifier']['FKClassName'] = 'CRM_Mailing_BAO_Mailing';
+ $params['mailing_identifier']['FKApiName'] = 'Mailing';
+ $params['mailing_identifier']['FKKeyColumn'] = 'hash';
+}
+
+/**
+ * MailingProviderData.create API
+ *
+ * @param array $params
+ * @return array API result descriptor
+ * @throws API_Exception
+ */
+function civicrm_api3_mailing_provider_data_create($params) {
+ return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+}
projects / civicrm-core.git / commitdiff