<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.3 |
+ | CiviCRM version 4.5 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013 |
+ | Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
* abstract class.
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
* $Id$
*
*/
protected $keyword = 'contribute';
// docs inherited from interface
+ /**
+ * Provides base information about the component.
+ * Needs to be implemented in component's information
+ * class.
+ *
+ * @return array collection of required component settings
+ * @access public
+ *
+ */
+ /**
+ * @return array
+ */
public function getInfo() {
return array(
'name' => 'CiviContribute',
}
// docs inherited from interface
+ /**
+ * Provides permissions that are used by component.
+ * Needs to be implemented in component's information
+ * class.
+ *
+ * NOTE: if using conditionally permission return,
+ * implementation of $getAllUnconditionally is required.
+ *
+ * @param bool $getAllUnconditionally
+ *
+ * @return array|null collection of permissions, null if none
+ * @access public
+ */
+ /**
+ * @param bool $getAllUnconditionally
+ *
+ * @return array|null
+ */
public function getPermissions($getAllUnconditionally = FALSE) {
return array(
'access CiviContribute',
);
}
+ /**
+ * Provides permissions that are unwise for Anonymous Roles to have
+ *
+ * @return array list of permissions
+ * @see CRM_Component_Info::getPermissions
+ */
+ /**
+ * @return array
+ */
+ public function getAnonymousPermissionWarnings() {
+ return array(
+ 'access CiviContribute',
+ );
+ }
// docs inherited from interface
+ /**
+ * Provides information about user dashboard element
+ * offered by this component.
+ *
+ * @return array|null collection of required dashboard settings,
+ * null if no element offered
+ * @access public
+ *
+ */
+ /**
+ * @return array|null
+ */
public function getUserDashboardElement() {
return array('name' => ts('Contributions'),
'title' => ts('Your Contribution(s)'),
}
// docs inherited from interface
+ /**
+ * Provides information about user dashboard element
+ * offered by this component.
+ *
+ * @return array|null collection of required dashboard settings,
+ * null if no element offered
+ * @access public
+ *
+ */
+ /**
+ * @return array|null
+ */
public function registerTab() {
return array('title' => ts('Contributions'),
'url' => 'contribution',
}
// docs inherited from interface
+ /**
+ * Provides information about advanced search pane
+ * offered by this component.
+ *
+ * @return array|null collection of required pane settings,
+ * null if no element offered
+ * @access public
+ *
+ */
+ /**
+ * @return array|null
+ */
public function registerAdvancedSearchPane() {
- return array('title' => ts('Contributions'),
+ return array(
+ 'title' => ts('Contributions'),
'weight' => 20,
);
}
// docs inherited from interface
+ /**
+ * Provides potential activity types that this
+ * component might want to register in activity history.
+ * Needs to be implemented in component's information
+ * class.
+ *
+ * @return array|null collection of activity types
+ * @access public
+ *
+ */
+ /**
+ * @return array|null
+ */
public function getActivityTypes() {
return NULL;
}
// add shortcut to Create New
+ /**
+ * @param $shortCuts
+ * @param $newCredit
+ */
public function creatNewShortcut(&$shortCuts, $newCredit) {
if (CRM_Core_Permission::check('access CiviContribute') &&
CRM_Core_Permission::check('edit contributions')
) {
- $shortCuts = array_merge($shortCuts, array(
- array('path' => 'civicrm/contribute/add',
- 'query' => "reset=1&action=add&context=standalone",
- 'ref' => 'new-contribution',
- 'title' => ts('Contribution'),
- )));
+ $shortCut[] = array(
+ 'path' => 'civicrm/contribute/add',
+ 'query' => "reset=1&action=add&context=standalone",
+ 'ref' => 'new-contribution',
+ 'title' => ts('Contribution'),
+ );
if ($newCredit) {
$title = ts('Contribution') . '<br /> (' . ts('credit card') . ')';
- $shortCuts = array_merge($shortCuts, array(
- array('path' => 'civicrm/contribute/add',
- 'query' => "reset=1&action=add&context=standalone&mode=live",
- 'ref' => 'new-contribution-cc',
- 'title' => $title,
- )));
+ $shortCut[0]['shortCuts'][] = array(
+ 'path' => 'civicrm/contribute/add',
+ 'query' => "reset=1&action=add&context=standalone&mode=live",
+ 'ref' => 'new-contribution-cc',
+ 'title' => $title,
+ );
}
+ $shortCuts = array_merge($shortCuts, $shortCut);
}
}
}