/**
* Handle the final step of the queue
+ *
+ * @param \CRM_Queue_TaskContext $ctx
*/
public static function onEnd(CRM_Queue_TaskContext $ctx) {
CRM_Core_Error::debug_log_message('CRM_Admin_Page_ExtensionsUpgrade: Finish upgrades');
* build form elements
* params object $form object of the form
*
+ * @param $form
*/
public static function buildQuickForm(&$form) {
$form->applyFilter('__ALL__', 'trim');
/**
* The constructor gets the submitted form values
+ *
+ * @param $formValues
*/
public function __construct(&$formValues);
/**
* Class constructor
+ *
+ * @param null $title
+ * @param bool|int $action
+ * @param bool $modal
*/
public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
parent::__construct($title, $modal);
/**
* Class constructor
+ *
+ * @param null $title
+ * @param bool|int $action
+ * @param bool $modal
*/
public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
parent::__construct($title, $modal);
/**
* Create UF Match, Note that thsi function is here in it's simplest form @ the moment
*
- * @return CRM_Core_DAO_UFMatch
+ * @param $params
+ *
+ * @return \CRM_Core_DAO_UFMatch
*/
public static function create($params) {
$hook = empty($params['id']) ? 'create' : 'edit';
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
* Our base DAO class. All DAO classes should inherit from this class.
* load a context. If name is asked for only name data is returned.
* And if name is not provided whole context is returned.
*
+ * @param $params
+ * @param $smarty
*/
function smarty_function_crmDBTpl($params, &$smarty) {
// $vars = array('context', 'name', 'assign' ); out of which name is optional
*/
/**
- * Retrieve CiviCRM settings from the api for use in templates
+ * Retrieve CiviCRM settings from the api for use in templates.
+ *
+ * @param $params
+ * @param $smarty
+ *
+ * @return int|string|void
*/
function smarty_function_crmSetting($params, &$smarty) {
);
}
+ /**
+ * EXPERIMENTAL: Get a list of AngularJS modules
+ *
+ * @return array
+ * list of modules; same format as CRM_Utils_Hook::angularModules(&$angularModules)
+ * @see CRM_Utils_Hook::angularModules
+ */
public function getAngularModules() {
$result = array();
$result['crmMailing'] = array(
protected $_type = NULL;
/**
+ * Run page.
+ *
+ * This includes assigning smarty variables and other page processing.
+ *
* @return string
* @throws Exception
*/
*
*/
class CRM_Mailing_Page_Optout extends CRM_Mailing_Page_Common {
+ /**
+ * Run page.
+ *
+ * This includes assigning smarty variables and other page processing.
+ *
+ * @return string
+ * @throws Exception
+ */
public function run() {
$this->_type = 'optout';
return parent::run();
*/
class CRM_Mailing_Page_Unsubscribe extends CRM_Mailing_Page_Common {
+ /**
+ * Run page.
+ *
+ * This includes assigning smarty variables and other page processing.
+ *
+ * @return string
+ * @throws Exception
+ */
public function run() {
$this->_type = 'unsubscribe';
return parent::run();
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
foreach ($rows as $rowNum => $row) {
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$checkList = array();
$entryFound = FALSE;
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
+
$entryFound = FALSE;
foreach ($rows as $rowNum => $row) {
// convert display name to links
}
/**
- * Alter Report Display.
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
*
* @param array $rows
- * Rows from report query.
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
// cache for id → is_deleted mapping
);
public $_drilldownReport = array('contact/detail' => 'Link to Detail Report');
+ /**
+ * Class constructor.
+ */
public function __construct() {
$contact_type = CRM_Contact_BAO_ContactType::getSelectElements(FALSE, TRUE, '_');
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
foreach ($rows as $rowNum => $row) {
$entryFound = TRUE;
}
+ /**
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
+ */
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
$genders = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id', array('localize' => TRUE));
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
$contributionTypes = CRM_Contribute_PseudoConstant::financialType();
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$checkList = array();
$entryFound = FALSE;
$display_flag = $prev_cid = $cid = 0;
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
if (empty($rows)) {
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$type = substr($this->_params['relationship_type_id_value'], -3);
$entryFound = FALSE;
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
// cache for id → is_deleted mapping
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
foreach ($rows as $rowNum => $row) {
}
/**
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
* @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$type = substr($this->_params['relationship_type_id_value'], -3);
$entryFound = FALSE;
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
$checkList = array();
foreach ($rows as $rowNum => $row) {
*/
class CRM_Report_Form_Contribute_Recur extends CRM_Report_Form {
+ /**
+ * Class constructor.
+ */
public function __construct() {
$this->_columns = array(
'civicrm_contact' => array(
parent::__construct();
}
+ /**
+ * Get template file name.
+ *
+ * @return string
+ */
public function getTemplateName() {
return 'CRM/Report/Form.tpl';
}
+ /**
+ * Generate FROM SQL clause.
+ */
public function from() {
$this->_from = "
FROM civicrm_contact {$this->_aliases['civicrm_contact']}
}
+ /**
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
+ */
public function alterDisplay(&$rows) {
$contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus();
foreach ($rows as $rowNum => $row) {
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
list($from1, $to1) = $this->getFromTo(CRM_Utils_Array::value("receive_date1_relative", $this->_params),
CRM_Utils_Array::value("receive_date1_from", $this->_params),
CRM_Utils_Array::value("receive_date1_to", $this->_params)
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
-
$entryFound = FALSE;
$dispname_flag = $phone_flag = $email_flag = 0;
$prev_email = $prev_dispname = $prev_phone = NULL;
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
foreach ($rows as $rowNum => $row) {
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
foreach ($rows as $rowNum => $row) {
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
-
$entryFound = FALSE;
$rank = 1;
if (!empty($rows)) {
$this->assign_by_ref('pager', $pager);
}
+ /**
+ * Form post process function.
+ *
+ * @return bool
+ */
public function postProcess() {
$this->beginPostProcess();
$this->_setVariable = TRUE;
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
-
$entryFound = FALSE;
$eventType = CRM_Core_OptionGroup::values('event_type');
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
-
$entryFound = FALSE;
$eventType = CRM_Core_OptionGroup::values('event_type');
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
}
/**
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
* @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
parent::alterDisplay($rows);
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
foreach ($rows as $rowNum => $row) {
// convert display name to links
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
$totalStatistics = $grantStatistics = array();
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
foreach ($rows as $rowNum => $row) {
// make count columns point to detail report
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
foreach ($rows as $rowNum => $row) {
// make count columns point to detail report
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
foreach ($rows as $rowNum => $row) {
// make count columns point to detail report
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
foreach ($rows as $rowNum => $row) {
// make count columns point to detail report
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
foreach ($rows as $rowNum => $row) {
// make count columns point to detail report
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
$checkList = array();
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
$checkList = array();
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
foreach ($rows as $rowNum => $row) {
// make count columns point to detail report
}
/**
- * Make changes to how data is displayed.
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
*
* @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
$checkList = array();
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
$checkList = array();
$display_flag = $prev_cid = $cid = 0;
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
$checkList = array();
$display_flag = $prev_cid = $cid = 0;
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
$checkList = array();
$display_flag = $prev_cid = $cid = 0;
}
/**
- * @param $rows
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
*/
public function alterDisplay(&$rows) {
- // custom code to alter rows
$entryFound = FALSE;
foreach ($rows as $rowNum => $row) {
// handle state province
return static::entities(static::toBeSkipped_getlimit());
}
+ /**
+ * Generate list of entities that can be retrieved using SQL operator syntax.
+ *
+ * @return array
+ */
public static function entities_getSqlOperators() {
return static::entities(static::toBeSkipped_getSqlOperators());
}
projects / civicrm-core.git / commitdiff