__table = 'civicrm_contribution_page'; parent::__construct(); } /** * Returns foreign keys and entity references * * @return array * [CRM_Core_Reference_Interface] */ static function getReferenceColumns() { if (!self::$_links) { self::$_links = static ::createReferenceColumns(__CLASS__); self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'financial_type_id', 'civicrm_financial_type', 'id'); self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'created_id', 'civicrm_contact', 'id'); self::$_links[] = new CRM_Core_Reference_Basic(self::getTableName() , 'campaign_id', 'civicrm_campaign', 'id'); } return self::$_links; } /** * Returns all the column names of this table * * @return array */ static function &fields() { if (!(self::$_fields)) { self::$_fields = array( 'id' => array( 'name' => 'id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Contribution Page ID') , 'description' => 'Contribution Id', 'required' => true, ) , 'title' => array( 'name' => 'title', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Contribution Page Title') , 'description' => 'Contribution Page title. For top of page display', 'maxlength' => 255, 'size' => CRM_Utils_Type::HUGE, ) , 'intro_text' => array( 'name' => 'intro_text', 'type' => CRM_Utils_Type::T_TEXT, 'title' => ts('Contribution Page Introduction Text') , 'description' => 'Text and html allowed. Displayed below title.', 'rows' => 6, 'cols' => 50, 'html' => array( 'type' => 'TextArea', ) , ) , 'financial_type_id' => array( 'name' => 'financial_type_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Financial Type') , 'description' => 'default financial type assigned to contributions submitted via this page, e.g. Contribution, Campaign Contribution', 'FKClassName' => 'CRM_Financial_DAO_FinancialType', 'html' => array( 'type' => 'Select', ) , 'pseudoconstant' => array( 'table' => 'civicrm_financial_type', 'keyColumn' => 'id', 'labelColumn' => 'name', ) ) , 'payment_processor' => array( 'name' => 'payment_processor', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Payment Processor') , 'description' => 'Payment Processors configured for this contribution Page', 'maxlength' => 128, 'size' => CRM_Utils_Type::HUGE, 'html' => array( 'type' => 'Select', ) , 'pseudoconstant' => array( 'table' => 'civicrm_payment_processor', 'keyColumn' => 'id', 'labelColumn' => 'name', ) ) , 'is_credit_card_only' => array( 'name' => 'is_credit_card_only', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Is Credit Card Only?') , 'description' => 'if true - processing logic must reject transaction at confirmation stage if pay method != credit card', ) , 'is_monetary' => array( 'name' => 'is_monetary', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Is Monetary') , 'description' => 'if true - allows real-time monetary transactions otherwise non-monetary transactions', 'default' => '1', ) , 'is_recur' => array( 'name' => 'is_recur', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Is Recurring') , 'description' => 'if true - allows recurring contributions, valid only for PayPal_Standard', ) , 'is_confirm_enabled' => array( 'name' => 'is_confirm_enabled', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Confirmation Page?') , 'description' => 'if false, the confirm page in contribution pages gets skipped', 'default' => '1', ) , 'recur_frequency_unit' => array( 'name' => 'recur_frequency_unit', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Recurring Frequency') , 'description' => 'Supported recurring frequency units.', 'maxlength' => 128, 'size' => CRM_Utils_Type::HUGE, ) , 'is_recur_interval' => array( 'name' => 'is_recur_interval', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Support Recurring Intervals') , 'description' => 'if true - supports recurring intervals', ) , 'is_recur_installments' => array( 'name' => 'is_recur_installments', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Recurring Installments?') , 'description' => 'if true - asks user for recurring installments', ) , 'is_pay_later' => array( 'name' => 'is_pay_later', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Pay Later') , 'description' => 'if true - allows the user to send payment directly to the org later', ) , 'pay_later_text' => array( 'name' => 'pay_later_text', 'type' => CRM_Utils_Type::T_TEXT, 'title' => ts('Pay Later Text') , 'description' => 'The text displayed to the user in the main form', ) , 'pay_later_receipt' => array( 'name' => 'pay_later_receipt', 'type' => CRM_Utils_Type::T_TEXT, 'title' => ts('Pay Later Receipt') , 'description' => 'The receipt sent to the user instead of the normal receipt text', ) , 'is_partial_payment' => array( 'name' => 'is_partial_payment', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Allow Partial Payment') , 'description' => 'is partial payment enabled for this online contribution page', ) , 'initial_amount_label' => array( 'name' => 'initial_amount_label', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Initial Amount Label') , 'description' => 'Initial amount label for partial payment', 'maxlength' => 255, 'size' => CRM_Utils_Type::HUGE, ) , 'initial_amount_help_text' => array( 'name' => 'initial_amount_help_text', 'type' => CRM_Utils_Type::T_TEXT, 'title' => ts('Initial Amount Help Text') , 'description' => 'Initial amount help text for partial payment', ) , 'min_initial_amount' => array( 'name' => 'min_initial_amount', 'type' => CRM_Utils_Type::T_MONEY, 'title' => ts('Min Initial Amount') , 'description' => 'Minimum initial amount for partial payment', 'precision' => array( 20, 2 ) , ) , 'is_allow_other_amount' => array( 'name' => 'is_allow_other_amount', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Allow Other Amounts') , 'description' => 'if true, page will include an input text field where user can enter their own amount', ) , 'default_amount_id' => array( 'name' => 'default_amount_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Default Amount') , 'description' => 'FK to civicrm_option_value.', ) , 'min_amount' => array( 'name' => 'min_amount', 'type' => CRM_Utils_Type::T_MONEY, 'title' => ts('Minimum Amount') , 'description' => 'if other amounts allowed, user can configure minimum allowed.', 'precision' => array( 20, 2 ) , ) , 'max_amount' => array( 'name' => 'max_amount', 'type' => CRM_Utils_Type::T_MONEY, 'title' => ts('Maximum Amount') , 'description' => 'if other amounts allowed, user can configure maximum allowed.', 'precision' => array( 20, 2 ) , ) , 'goal_amount' => array( 'name' => 'goal_amount', 'type' => CRM_Utils_Type::T_MONEY, 'title' => ts('Goal Amount') , 'description' => 'The target goal for this page, allows people to build a goal meter', 'precision' => array( 20, 2 ) , ) , 'thankyou_title' => array( 'name' => 'thankyou_title', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Thank-you Title') , 'description' => 'Title for Thank-you page (header title tag, and display at the top of the page).', 'maxlength' => 255, 'size' => CRM_Utils_Type::HUGE, ) , 'thankyou_text' => array( 'name' => 'thankyou_text', 'type' => CRM_Utils_Type::T_TEXT, 'title' => ts('Thank-you Text') , 'description' => 'text and html allowed. displayed above result on success page', 'rows' => 8, 'cols' => 60, 'html' => array( 'type' => 'TextArea', ) , ) , 'thankyou_footer' => array( 'name' => 'thankyou_footer', 'type' => CRM_Utils_Type::T_TEXT, 'title' => ts('Thank-you Footer') , 'description' => 'Text and html allowed. displayed at the bottom of the success page. Common usage is to include link(s) to other pages such as tell-a-friend, etc.', 'rows' => 8, 'cols' => 60, 'html' => array( 'type' => 'TextArea', ) , ) , 'is_for_organization' => array( 'name' => 'is_for_organization', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Allow For Organization') , 'description' => 'if true, signup is done on behalf of an organization', ) , 'for_organization' => array( 'name' => 'for_organization', 'type' => CRM_Utils_Type::T_TEXT, 'title' => ts('On Behalf Of Organization') , 'description' => 'This text field is shown when is_for_organization is checked. For example - I am contributing on behalf on an organization.', 'rows' => 2, 'cols' => 50, 'html' => array( 'type' => 'TextArea', ) , ) , 'is_email_receipt' => array( 'name' => 'is_email_receipt', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Send email Receipt') , 'description' => 'if true, receipt is automatically emailed to contact on success', ) , 'receipt_from_name' => array( 'name' => 'receipt_from_name', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Receipt From') , 'description' => 'FROM email name used for receipts generated by contributions to this contribution page.', 'maxlength' => 255, 'size' => CRM_Utils_Type::HUGE, ) , 'receipt_from_email' => array( 'name' => 'receipt_from_email', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Receipt From email') , 'description' => 'FROM email address used for receipts generated by contributions to this contribution page.', 'maxlength' => 255, 'size' => CRM_Utils_Type::HUGE, ) , 'cc_receipt' => array( 'name' => 'cc_receipt', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Receipt cc') , 'description' => 'comma-separated list of email addresses to cc each time a receipt is sent', 'maxlength' => 255, 'size' => CRM_Utils_Type::HUGE, ) , 'bcc_receipt' => array( 'name' => 'bcc_receipt', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Receipt bcc') , 'description' => 'comma-separated list of email addresses to bcc each time a receipt is sent', 'maxlength' => 255, 'size' => CRM_Utils_Type::HUGE, ) , 'receipt_text' => array( 'name' => 'receipt_text', 'type' => CRM_Utils_Type::T_TEXT, 'title' => ts('Receipt Text') , 'description' => 'text to include above standard receipt info on receipt email. emails are text-only, so do not allow html for now', 'rows' => 6, 'cols' => 50, 'html' => array( 'type' => 'TextArea', ) , ) , 'is_active' => array( 'name' => 'is_active', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Is Page Active?') , 'description' => 'Is this property active?', ) , 'footer_text' => array( 'name' => 'footer_text', 'type' => CRM_Utils_Type::T_TEXT, 'title' => ts('Footer Text') , 'description' => 'Text and html allowed. Displayed at the bottom of the first page of the contribution wizard.', 'rows' => 6, 'cols' => 50, 'html' => array( 'type' => 'TextArea', ) , ) , 'amount_block_is_active' => array( 'name' => 'amount_block_is_active', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Is Amount Block Active?') , 'description' => 'Is this property active?', 'default' => '1', ) , 'start_date' => array( 'name' => 'start_date', 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, 'title' => ts('Contribution Page Start Date') , 'description' => 'Date and time that this page starts.', ) , 'end_date' => array( 'name' => 'end_date', 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, 'title' => ts('Contribution Page End Date') , 'description' => 'Date and time that this page ends. May be NULL if no defined end date/time', ) , 'created_id' => array( 'name' => 'created_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Contribution Page Created By') , 'description' => 'FK to civicrm_contact, who created this contribution page', 'FKClassName' => 'CRM_Contact_DAO_Contact', ) , 'created_date' => array( 'name' => 'created_date', 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME, 'title' => ts('Contribution Page Created Date') , 'description' => 'Date and time that contribution page was created.', ) , 'currency' => array( 'name' => 'currency', 'type' => CRM_Utils_Type::T_STRING, 'title' => ts('Contribution Page Currency') , 'description' => '3 character string, value from config setting or input via user.', 'maxlength' => 3, 'size' => CRM_Utils_Type::FOUR, 'default' => 'NULL', 'html' => array( 'type' => 'Select', ) , 'pseudoconstant' => array( 'table' => 'civicrm_currency', 'keyColumn' => 'name', 'labelColumn' => 'full_name', 'nameColumn' => 'numeric_code', ) ) , 'campaign_id' => array( 'name' => 'campaign_id', 'type' => CRM_Utils_Type::T_INT, 'title' => ts('Contribution Page Campaign ID') , 'description' => 'The campaign for which we are collecting contributions with this page.', 'FKClassName' => 'CRM_Campaign_DAO_Campaign', 'pseudoconstant' => array( 'table' => 'civicrm_campaign', 'keyColumn' => 'id', 'labelColumn' => 'title', ) ) , 'is_share' => array( 'name' => 'is_share', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Is Contribution Page Shared?') , 'description' => 'Can people share the contribution page through social media?', 'default' => '1', ) , 'is_billing_required' => array( 'name' => 'is_billing_required', 'type' => CRM_Utils_Type::T_BOOLEAN, 'title' => ts('Is billing block required') , 'description' => 'if true - billing block is required for online contribution page', ) , ); } return self::$_fields; } /** * Returns an array containing, for each field, the arary key used for that * field in self::$_fields. * * @return array */ static function &fieldKeys() { if (!(self::$_fieldKeys)) { self::$_fieldKeys = array( 'id' => 'id', 'title' => 'title', 'intro_text' => 'intro_text', 'financial_type_id' => 'financial_type_id', 'payment_processor' => 'payment_processor', 'is_credit_card_only' => 'is_credit_card_only', 'is_monetary' => 'is_monetary', 'is_recur' => 'is_recur', 'is_confirm_enabled' => 'is_confirm_enabled', 'recur_frequency_unit' => 'recur_frequency_unit', 'is_recur_interval' => 'is_recur_interval', 'is_recur_installments' => 'is_recur_installments', 'is_pay_later' => 'is_pay_later', 'pay_later_text' => 'pay_later_text', 'pay_later_receipt' => 'pay_later_receipt', 'is_partial_payment' => 'is_partial_payment', 'initial_amount_label' => 'initial_amount_label', 'initial_amount_help_text' => 'initial_amount_help_text', 'min_initial_amount' => 'min_initial_amount', 'is_allow_other_amount' => 'is_allow_other_amount', 'default_amount_id' => 'default_amount_id', 'min_amount' => 'min_amount', 'max_amount' => 'max_amount', 'goal_amount' => 'goal_amount', 'thankyou_title' => 'thankyou_title', 'thankyou_text' => 'thankyou_text', 'thankyou_footer' => 'thankyou_footer', 'is_for_organization' => 'is_for_organization', 'for_organization' => 'for_organization', 'is_email_receipt' => 'is_email_receipt', 'receipt_from_name' => 'receipt_from_name', 'receipt_from_email' => 'receipt_from_email', 'cc_receipt' => 'cc_receipt', 'bcc_receipt' => 'bcc_receipt', 'receipt_text' => 'receipt_text', 'is_active' => 'is_active', 'footer_text' => 'footer_text', 'amount_block_is_active' => 'amount_block_is_active', 'start_date' => 'start_date', 'end_date' => 'end_date', 'created_id' => 'created_id', 'created_date' => 'created_date', 'currency' => 'currency', 'campaign_id' => 'campaign_id', 'is_share' => 'is_share', 'is_billing_required' => 'is_billing_required', ); } return self::$_fieldKeys; } /** * Returns the names of this table * * @return string */ static function getTableName() { return CRM_Core_DAO::getLocaleTableName(self::$_tableName); } /** * Returns if this table needs to be logged * * @return boolean */ function getLog() { return self::$_log; } /** * Returns the list of fields that can be imported * * @param bool $prefix * * @return array */ static function &import($prefix = false) { if (!(self::$_import)) { self::$_import = array(); $fields = self::fields(); foreach($fields as $name => $field) { if (CRM_Utils_Array::value('import', $field)) { if ($prefix) { self::$_import['contribution_page'] = & $fields[$name]; } else { self::$_import[$name] = & $fields[$name]; } } } } return self::$_import; } /** * Returns the list of fields that can be exported * * @param bool $prefix * * @return array */ static function &export($prefix = false) { if (!(self::$_export)) { self::$_export = array(); $fields = self::fields(); foreach($fields as $name => $field) { if (CRM_Utils_Array::value('export', $field)) { if ($prefix) { self::$_export['contribution_page'] = & $fields[$name]; } else { self::$_export[$name] = & $fields[$name]; } } } } return self::$_export; } }