<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
* This class introduces component to the system and provides all the
* abstract class.
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
* $Id$
*
*/
class CRM_Contribute_Info extends CRM_Core_Component_Info {
- // docs inherited from interface
+ /**
+ * @inheritDoc
+ */
protected $keyword = 'contribute';
- // docs inherited from interface
/**
+ * @inheritDoc
* 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
+ * collection of required component settings
*/
/**
* @return array
);
}
- // docs inherited from interface
/**
+ * @inheritDoc
* Provides permissions that are used by component.
* Needs to be implemented in component's information
* class.
* implementation of $getAllUnconditionally is required.
*
* @param bool $getAllUnconditionally
+ * @param bool $descriptions
+ * Whether to return permission descriptions
*
- * @return array|null collection of permissions, null if none
- * @access public
+ * @return array|null
+ * collection of permissions, null if none
*/
/**
* @param bool $getAllUnconditionally
*
* @return array|null
*/
- public function getPermissions($getAllUnconditionally = FALSE) {
- return array(
- 'access CiviContribute',
- 'edit contributions',
- 'make online contributions',
- 'delete in CiviContribute',
+ public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) {
+ $permissions = array(
+ 'access CiviContribute' => array(
+ ts('access CiviContribute'),
+ ts('Record backend contributions (with edit contributions) and view all contributions (for visible contacts)'),
+ ),
+ 'edit contributions' => array(
+ ts('edit contributions'),
+ ts('Record and update contributions'),
+ ),
+ 'make online contributions' => array(
+ ts('make online contributions'),
+ ),
+ 'delete in CiviContribute' => array(
+ ts('delete in CiviContribute'),
+ ts('Delete contributions'),
+ ),
);
+
+ if (!$descriptions) {
+ foreach ($permissions as $name => $attr) {
+ $permissions[$name] = array_shift($attr);
+ }
+ }
+
+ return $permissions;
}
/**
- * Provides permissions that are unwise for Anonymous Roles to have
+ * Provides permissions that are unwise for Anonymous Roles to have.
*
- * @return array list of permissions
+ * @return array
+ * list of permissions
* @see CRM_Component_Info::getPermissions
*/
/**
);
}
- // docs inherited from interface
/**
+ * @inheritDoc
* Provides information about user dashboard element
* offered by this component.
*
- * @return array|null collection of required dashboard settings,
+ * @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'),
+ return array(
+ 'name' => ts('Contributions'),
'title' => ts('Your Contribution(s)'),
'perm' => array('make online contributions'),
'weight' => 10,
);
}
- // docs inherited from interface
/**
+ * @inheritDoc
* Provides information about user dashboard element
* offered by this component.
*
- * @return array|null collection of required dashboard settings,
+ * @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'),
+ return array(
+ 'title' => ts('Contributions'),
'url' => 'contribution',
'weight' => 20,
);
}
- // docs inherited from interface
/**
+ * @inheritDoc
* Provides information about advanced search pane
* offered by this component.
*
- * @return array|null collection of required pane settings,
+ * @return array|null
+ * collection of required pane settings,
* null if no element offered
- * @access public
- *
*/
/**
* @return array|null
);
}
- // docs inherited from interface
/**
+ * @inheritDoc
* 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
+ * collection of activity types
*/
/**
* @return array|null
return NULL;
}
- // add shortcut to Create New
/**
+ * add shortcut to Create New.
* @param $shortCuts
* @param $newCredit
*/
$shortCuts = array_merge($shortCuts, $shortCut);
}
}
-}
+}