protected $keyword = 'report';
// 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' => 'CiviReport',
// 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 CiviReport', 'access Report Criteria', 'administer reserved reports', 'administer Reports');
}
// 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() {
// no dashboard element for this component
return NULL;
}
+ /**
+ * Provides component's user dashboard page object.
+ *
+ * @return mixed component's User Dashboard applet object
+ * @access public
+ *
+ */
+ /**
+ * @return mixed
+ */
public function getUserDashboardObject() {
// no dashboard element for this component
return NULL;
}
// 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() {
// this component doesn't use contact record tabs
return NULL;
}
// 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() {
// this component doesn't use advanced search
return NULL;
}
// 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
+ */
public function creatNewShortcut(&$shortCuts) {}
}