*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class provides the functionality to email a group of
- * contacts.
+ * This class provides the functionality to email a group of contacts.
*/
class CRM_Contact_Form_Task_Email extends CRM_Contact_Form_Task {
/**
- * Are we operating in "single mode", i.e. sending email to one
- * specific contact?
+ * Are we operating in "single mode".
+ *
+ * Single mode means sending email to one specific contact.
*
* @var boolean
*/
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
// store case id if present
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
//enable form element
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
CRM_Contact_Form_Task_EmailCommon::postProcess($this);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* Build the form object.
*
- *
* @param CRM_Core_Form $form
- *
- * @return void
*/
public static function buildQuickForm(&$form) {
$toArray = $ccArray = $bccArray = array();
/**
* Process the form after the input has been submitted and validated.
*
- *
* @param CRM_Core_Form $form
- *
- * @return void
*/
public static function postProcess(&$form) {
if (count($form->_contactIds) > self::MAX_EMAILS_KILL_SWITCH) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class provides the functionality to save a search
+ * This class provides the functionality to save a search.
+ *
* Saved Searches are used for saving frequently used queries
*/
class CRM_Contact_Form_Task_HookSample extends CRM_Contact_Form_Task {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
parent::preProcess();
}
/**
- * Build the form object - it consists of
- *
- *
- * @return void
+ * Build the form object.
*/
public function buildQuickForm() {
$this->addDefaultButtons(ts('Back to Search'), 'done');
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
}
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class helps to print the labels for contacts
- *
+ * This class helps to print the labels for contacts.
*/
class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
$this->set('contactIds', $this->_contactIds);
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
CRM_Utils_System::setTitle(ts('Make Mailing Labels'));
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
$fv = $this->controller->exportValues($this->_name);
}
/**
- * Create labels (pdf)
+ * Create labels (pdf).
*
* @param array $contactRows
- * Assciated array of contact data.
+ * Associated array of contact data.
* @param string $format
* Format in which labels needs to be printed.
* @param string $fileName
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class provides the common functionality for sending email to
- * one or a group of contact ids. This class is reused by all the search
- * components in CiviCRM (since they all have send email as a task)
+ * This class provides the common functionality for sending email to one or a group of contact ids.
*/
class CRM_Contact_Form_Task_LabelCommon {
/**
- * Create labels (pdf)
+ * Create labels (pdf).
*
* @param array $contactRows
- * Assciated array of contact data.
+ * Associated array of contact data.
* @param string $format
* Format in which labels needs to be printed.
* @param string $fileName
* The name of the file to save the label in.
- *
*/
public static function createLabel(&$contactRows, &$format, $fileName = 'MailingLabels_CiviCRM.pdf') {
$pdf = new CRM_Utils_PDF_Label($format, 'mm');
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
$cid = CRM_Utils_Request::retrieve('cid', 'Positive',
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
$this->addButtons(array(
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
}
/**
* Assign smarty variables to the template that will be used by google api to plot the contacts.
*
- * @param $ids
+ * @param array $ids
* @param int $locationId
* Location_id.
- * @param $page
- * @param $addBreadCrumb
+ * @param CRM_Core_Page $page
+ * @param bool $addBreadCrumb
* @param string $type
- *
- * @return void
- * the location of the file we have created
*/
public static function createMapXML($ids, $locationId, &$page, $addBreadCrumb, $type = 'Contact') {
$config = CRM_Core_Config::singleton();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id: Event.php 45499 2013-02-08 12:31:05Z kurund $
- *
*/
/**
- * This class provides the functionality to map
- * the address for group of
- * contacts.
+ * This class provides the functionality to map the address for group of contacts.
*/
class CRM_Contact_Form_Task_Map_Event extends CRM_Contact_Form_Task_Map {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
$ids = CRM_Utils_Request::retrieve('eid', 'Positive',
*
* @return string
*/
- /**
- * @return string
- */
public function getTemplateFileName() {
return 'CRM/Contact/Form/Task/Map.tpl';
}
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* This class provides the functionality to Merge Contacts.
- *
*/
class CRM_Contact_Form_Task_Merge extends CRM_Contact_Form_Task {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
parent::preProcess();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class provides the functionality to create PDF letter for a group of
- * contacts or a single contact.
+ * This class provides the functionality to create PDF letter for a group of contacts or a single contact.
*/
class CRM_Contact_Form_Task_PDF extends CRM_Contact_Form_Task {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
}
/**
- * Set default values for the form. Relationship that in edit/view action
- * the default values are retrieved from the database
- *
- *
- * @return void
- */
- /**
+ * Set default values for the form.
*/
public function setDefaultValues() {
$defaults = array();
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
//enable form element
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
CRM_Contact_Form_Task_PDFLetterCommon::postProcess($this);
projects / civicrm-core.git / commitdiff