winbooksexport.php

<?php
/*
  be.chiro.civi.winbooksexport - export contribution batches to Winbooks.
  Copyright (C) 2016  Chirojeugd-Vlaanderen vzw

  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU Affero General Public License as
  published by the Free Software Foundation, either version 3 of the
  License, or (at your option) any later version.

  This program 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
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

require_once 'winbooksexport.civix.php';

/**
 * Implements hook_civicrm_config().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config
 */
function winbooksexport_civicrm_config(&$config) {
  _winbooksexport_civix_civicrm_config($config);
}

/**
 * Implements hook_civicrm_xmlMenu().
 *
 * @param array $files
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu
 */
function winbooksexport_civicrm_xmlMenu(&$files) {
  _winbooksexport_civix_civicrm_xmlMenu($files);
}

/**
 * Implements hook_civicrm_install().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install
 */
function winbooksexport_civicrm_install() {
  _winbooksexport_civix_civicrm_install();
}

/**
 * Implements hook_civicrm_uninstall().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall
 */
function winbooksexport_civicrm_uninstall() {
  _winbooksexport_civix_civicrm_uninstall();
}

/**
 * Implements hook_civicrm_enable().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable
 */
function winbooksexport_civicrm_enable() {
  _winbooksexport_civix_civicrm_enable();
}

/**
 * Implements hook_civicrm_disable().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable
 */
function winbooksexport_civicrm_disable() {
  _winbooksexport_civix_civicrm_disable();
}

/**
 * Implements hook_civicrm_upgrade().
 *
 * @param $op string, the type of operation being performed; 'check' or 'enqueue'
 * @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks
 *
 * @return mixed
 *   Based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
 *                for 'enqueue', returns void
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade
 */
function winbooksexport_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
  return _winbooksexport_civix_civicrm_upgrade($op, $queue);
}

/**
 * Implements hook_civicrm_managed().
 *
 * Generate a list of entities to create/deactivate/delete when this module
 * is installed, disabled, uninstalled.
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed
 */
function winbooksexport_civicrm_managed(&$entities) {
  _winbooksexport_civix_civicrm_managed($entities);
}

/**
 * Implements hook_civicrm_caseTypes().
 *
 * Generate a list of case-types.
 *
 * @param array $caseTypes
 *
 * Note: This hook only runs in CiviCRM 4.4+.
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes
 */
function winbooksexport_civicrm_caseTypes(&$caseTypes) {
  _winbooksexport_civix_civicrm_caseTypes($caseTypes);
}

/**
 * Implements hook_civicrm_angularModules().
 *
 * Generate a list of Angular modules.
 *
 * Note: This hook only runs in CiviCRM 4.5+. It may
 * use features only available in v4.6+.
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes
 */
function winbooksexport_civicrm_angularModules(&$angularModules) {
_winbooksexport_civix_civicrm_angularModules($angularModules);
}

/**
 * Implements hook_civicrm_alterSettingsFolders().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders
 */
function winbooksexport_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
  _winbooksexport_civix_civicrm_alterSettingsFolders($metaDataFolders);
}

/**
 * Implements hook_civicrm_preProcess().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_preProcess
 */
function winbooksexport_civicrm_preProcess($formName, &$form) {
  if ($formName == "CRM_Financial_Form_Export") {
    $form->export_format = "Winbooks";
  }
}

/**
 * Implements hook_civicrm_buildForm
 *
 * @param string $formName
 * @param object $form
 */
function winbooksexport_civicrm_buildForm($formName, &$form) {
  if ($formName == "CRM_Financial_Form_Export") {
    // TODO: can't we just add Winbooks to the existing element?
    $form->removeElement('export_format');
    
    $optionTypes = array(
      'Winbooks' => ts('Export to Winbooks'),
    );

    $form->addRadio('export_format', NULL, $optionTypes, NULL, '<br/>', TRUE);
  }
}

/**
 * Implements hook_civicrm_alterAPIPermissions.
 *
 * @param string $entity
 * @param string $action
 * @param array $params
 * @param array $permissions
 */
function winbooksexport_civicrm_alterAPIPermissions($entity, $action, &$params, &$permissions) {
  $permissions['batched_contribution']['get'] = array(
    'access CiviCRM',
    'view all manual batches',
    'access CiviContribute');
}

/**
 * Implements hook_civicrm_navigationMenu().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_navigationMenu
 */
function winbooksexport_civicrm_navigationMenu(&$menu) {
  _winbooksexport_civix_insert_navigation_menu($menu, 'Contributions/Accounting Batches', array(
    'label' => ts('Clear transaction IDs', array('domain' => 'be.chiro.civi.winbooksexport')),
    'name' => 'clearbatchtrxnids',
    'url' => 'civicrm/financial/clearbatchtrxnids',
    'permission' => 'edit contributions',
    'operator' => 'OR',
    'separator' => 0,
  ));
  _winbooksexport_civix_navigationMenu($menu);
} // */