API/DAO Metadata - Retain versioning metadata for possible usage in runtime+tooling

[civicrm-core.git] / CRM / Core / DAO / ActionLog.php

<?php

/**
 * @package CRM
 * @copyright CiviCRM LLC https://civicrm.org/licensing
 *
 * Generated from xml/schema/CRM/Core/ActionLog.xml
 * DO NOT EDIT.  Generated by CRM_Core_CodeGen
 * (GenCodeChecksum:1cc48318ce597a6cac7ff0e2a4518ff5)
 */

/**
 * Database access object for the ActionLog entity.
 */
class CRM_Core_DAO_ActionLog extends CRM_Core_DAO {

  /**
   * Static instance to hold the table name.
   *
   * @var string
   */
  public static $_tableName = 'civicrm_action_log';

  /**
   * Should CiviCRM log any modifications to this table in the civicrm_log table.
   *
   * @var bool
   */
  public static $_log = FALSE;

  /**
   * @var int
   */
  public $id;

  /**
   * FK to Contact ID
   *
   * @var int
   */
  public $contact_id;

  /**
   * FK to id of the entity that the action was performed on. Pseudo - FK.
   *
   * @var int
   */
  public $entity_id;

  /**
   * name of the entity table for the above id, e.g. civicrm_activity, civicrm_participant
   *
   * @var string
   */
  public $entity_table;

  /**
   * FK to the action schedule that this action originated from.
   *
   * @var int
   */
  public $action_schedule_id;

  /**
   * date time that the action was performed on.
   *
   * @var datetime
   */
  public $action_date_time;

  /**
   * Was there any error sending the reminder?
   *
   * @var bool
   */
  public $is_error;

  /**
   * Description / text in case there was an error encountered.
   *
   * @var text
   */
  public $message;

  /**
   * Keeps track of the sequence number of this repetition.
   *
   * @var int
   */
  public $repetition_number;

  /**
   * Stores the date from the entity which triggered this reminder action (e.g. membership.end_date for most membership renewal reminders)
   *
   * @var datetime
   */
  public $reference_date;

  /**
   * Class constructor.
   */
  public function __construct() {
    $this->__table = 'civicrm_action_log';
    parent::__construct();
  }

  /**
   * Returns localized title of this entity.
   */
  public static function getEntityTitle() {
    return ts('Action Logs');
  }

  /**
   * Returns foreign keys and entity references.
   *
   * @return array
   *   [CRM_Core_Reference_Interface]
   */
  public static function getReferenceColumns() {
    if (!isset(Civi::$statics[__CLASS__]['links'])) {
      Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id', 'civicrm_contact', 'id');
      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'action_schedule_id', 'civicrm_action_schedule', 'id');
      Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
      CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
    }
    return Civi::$statics[__CLASS__]['links'];
  }

  /**
   * Returns all the column names of this table
   *
   * @return array
   */
  public static function &fields() {
    if (!isset(Civi::$statics[__CLASS__]['fields'])) {
      Civi::$statics[__CLASS__]['fields'] = [
        'id' => [
          'name' => 'id',
          'type' => CRM_Utils_Type::T_INT,
          'title' => ts('Action Schedule ID'),
          'required' => TRUE,
          'where' => 'civicrm_action_log.id',
          'table_name' => 'civicrm_action_log',
          'entity' => 'ActionLog',
          'bao' => 'CRM_Core_BAO_ActionLog',
          'localizable' => 0,
          'add' => '3.4',
        ],
        'contact_id' => [
          'name' => 'contact_id',
          'type' => CRM_Utils_Type::T_INT,
          'title' => ts('Action Schedule Contact ID'),
          'description' => ts('FK to Contact ID'),
          'where' => 'civicrm_action_log.contact_id',
          'table_name' => 'civicrm_action_log',
          'entity' => 'ActionLog',
          'bao' => 'CRM_Core_BAO_ActionLog',
          'localizable' => 0,
          'FKClassName' => 'CRM_Contact_DAO_Contact',
          'add' => '3.4',
        ],
        'entity_id' => [
          'name' => 'entity_id',
          'type' => CRM_Utils_Type::T_INT,
          'title' => ts('Entity ID'),
          'description' => ts('FK to id of the entity that the action was performed on. Pseudo - FK.'),
          'required' => TRUE,
          'where' => 'civicrm_action_log.entity_id',
          'table_name' => 'civicrm_action_log',
          'entity' => 'ActionLog',
          'bao' => 'CRM_Core_BAO_ActionLog',
          'localizable' => 0,
          'add' => '3.4',
        ],
        'entity_table' => [
          'name' => 'entity_table',
          'type' => CRM_Utils_Type::T_STRING,
          'title' => ts('Entity Table'),
          'description' => ts('name of the entity table for the above id, e.g. civicrm_activity, civicrm_participant'),
          'maxlength' => 255,
          'size' => CRM_Utils_Type::HUGE,
          'where' => 'civicrm_action_log.entity_table',
          'table_name' => 'civicrm_action_log',
          'entity' => 'ActionLog',
          'bao' => 'CRM_Core_BAO_ActionLog',
          'localizable' => 0,
          'add' => '3.4',
        ],
        'action_schedule_id' => [
          'name' => 'action_schedule_id',
          'type' => CRM_Utils_Type::T_INT,
          'title' => ts('Schedule'),
          'description' => ts('FK to the action schedule that this action originated from.'),
          'required' => TRUE,
          'where' => 'civicrm_action_log.action_schedule_id',
          'table_name' => 'civicrm_action_log',
          'entity' => 'ActionLog',
          'bao' => 'CRM_Core_BAO_ActionLog',
          'localizable' => 0,
          'FKClassName' => 'CRM_Core_DAO_ActionSchedule',
          'add' => '3.4',
        ],
        'action_date_time' => [
          'name' => 'action_date_time',
          'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
          'title' => ts('Action Date And Time'),
          'description' => ts('date time that the action was performed on.'),
          'where' => 'civicrm_action_log.action_date_time',
          'table_name' => 'civicrm_action_log',
          'entity' => 'ActionLog',
          'bao' => 'CRM_Core_BAO_ActionLog',
          'localizable' => 0,
          'add' => '3.4',
        ],
        'is_error' => [
          'name' => 'is_error',
          'type' => CRM_Utils_Type::T_BOOLEAN,
          'title' => ts('Error?'),
          'description' => ts('Was there any error sending the reminder?'),
          'where' => 'civicrm_action_log.is_error',
          'default' => '0',
          'table_name' => 'civicrm_action_log',
          'entity' => 'ActionLog',
          'bao' => 'CRM_Core_BAO_ActionLog',
          'localizable' => 0,
          'add' => '3.4',
        ],
        'message' => [
          'name' => 'message',
          'type' => CRM_Utils_Type::T_TEXT,
          'title' => ts('Message'),
          'description' => ts('Description / text in case there was an error encountered.'),
          'where' => 'civicrm_action_log.message',
          'table_name' => 'civicrm_action_log',
          'entity' => 'ActionLog',
          'bao' => 'CRM_Core_BAO_ActionLog',
          'localizable' => 0,
          'add' => '3.4',
        ],
        'repetition_number' => [
          'name' => 'repetition_number',
          'type' => CRM_Utils_Type::T_INT,
          'title' => ts('Repetition Number'),
          'description' => ts('Keeps track of the sequence number of this repetition.'),
          'where' => 'civicrm_action_log.repetition_number',
          'table_name' => 'civicrm_action_log',
          'entity' => 'ActionLog',
          'bao' => 'CRM_Core_BAO_ActionLog',
          'localizable' => 0,
          'add' => '3.4',
        ],
        'reference_date' => [
          'name' => 'reference_date',
          'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
          'title' => ts('Reference Date'),
          'description' => ts('Stores the date from the entity which triggered this reminder action (e.g. membership.end_date for most membership renewal reminders)'),
          'where' => 'civicrm_action_log.reference_date',
          'default' => 'NULL',
          'table_name' => 'civicrm_action_log',
          'entity' => 'ActionLog',
          'bao' => 'CRM_Core_BAO_ActionLog',
          'localizable' => 0,
          'add' => '4.6',
        ],
      ];
      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__, 'action_log', $prefix, []);
    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__, 'action_log', $prefix, []);
    return $r;
  }

  /**
   * Returns the list of indices
   *
   * @param bool $localize
   *
   * @return array
   */
  public static function indices($localize = TRUE) {
    $indices = [];
    return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
  }

}