protected $_relationshipValuesAdded = FALSE;
/**
- * Set to the name of the temp table if one has been created
- * @var String
+ * Set to the name of the temp table if one has been created.
+ *
+ * @var string
*/
public static $_relationshipTempTable = NULL;
/**
* The profile group id used for display.
*
- * @var integer
+ * @var int
*/
protected $_ufGroupID;
public static $csv = ['contact_type', 'group', 'tag'];
/**
- * @var string how to display the results. Should we display as
- * contributons, members, cases etc
+ * How to display the results. Should we display as contributons, members, cases etc.
+ *
+ * @var string
*/
protected $_componentMode;
/**
- * @var string what operator should we use, AND or OR
+ * What operator should we use, AND or OR.
+ *
+ * @var string
*/
protected $_operator;
const LIMIT = 10;
/**
- * @var array CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery
+ * @var CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery[]
*/
protected $_partialQueries = NULL;
protected $_tableFields = NULL;
/**
- * @var array|null NULL if no limit; or array(0 => $limit, 1 => $offset)
+ * Limit clause.
+ *
+ * NULL if no limit; or array(0 => $limit, 1 => $offset).
+ *
+ * @var array|null
*/
protected $_limitClause = NULL;
/**
- * @var array|null NULL if no limit; or array(0 => $limit, 1 => $offset)
+ * Limit row clause.
+ *
+ * NULL if no limit; or array(0 => $limit, 1 => $offset)
+ *
+ * @var array|null
*/
protected $_limitRowClause = NULL;
/**
- * @var array|null NULL if no limit; or array(0 => $limit, 1 => $offset)
+ * Limit detail clause.
+ *
+ * NULL if no limit; or array(0 => $limit, 1 => $offset).
+ *
+ * @var array|null
*/
protected $_limitDetailClause = NULL;
protected $_limitNumber = 10;
+
/**
- * this should be one more than self::LIMIT
+ * This should be one more than self::LIMIT.
+ *
* @var int
*/
protected $_limitNumberPlus1 = 11;
/**
* @param int $offset
* @param int $rowcount
- * @param NULL $sort
+ * @param string $sort
* @param bool $includeContactIDs
* @param bool $justIDs
*
* @return string
+ * @throws \Exception
*/
public function all(
$offset = 0, $rowcount = 0, $sort = NULL,
/**
* @param int $offset
* @param int $rowcount
- * @param NULL $sort
+ * @param string $sort
* @param bool $returnSQL
*
* @return string
+ * @throws \Exception
*/
public function contactIDs($offset = 0, $rowcount = 0, $sort = NULL, $returnSQL = FALSE) {
return $this->all($offset, $rowcount, $sort, FALSE, TRUE);
/**
* Total number of lines in file
*
- * @var integer
+ * @var int
*/
protected $_rowCount;
/**
* Running total number of un-matched Contacts.
+ *
* @var int
*/
protected $_unMatchCount;
/**
- * Array of unmatched lines
+ * Array of unmatched lines.
+ *
* @var array
*/
protected $_unMatch;
'return' => 'location_type_id',
'contact_id' => $contactID,
'is_primary' => 1,
- 'sequential' => 1
+ 'sequential' => 1,
]);
}
$defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
*/
class CRM_Contact_Page_ImageFile extends CRM_Core_Page {
/**
- * @var int Time to live (seconds).
+ * Time to live (seconds).
+ *
+ * @var int
*
* 12 hours: 12 * 60 * 60 = 43200
*/
class CRM_Contact_Page_View_ContactSmartGroup extends CRM_Core_Page {
/**
- * @var int contact id
+ * Contact id.
+ *
+ * @var int
*/
public $_contactId;
/**
- * called when action is browse.
- *
+ * Called when action is browse.
*/
public function browse() {
$in = CRM_Contact_BAO_GroupContact::getContactGroup($this->_contactId, 'Added');
public $_fromEmails;
/**
- * ID of from email
- * @var integer
+ * ID of from email.
+ *
+ * @var int
*/
public $fromEmailId;
public $userEmail;
/**
- * Price set ID
- * @var integer
+ * Price set ID.
+ *
+ * @var int
*/
public $_priceSetId;
/**
* Pcp id
*
- * @var integer
+ * @var int
*/
public $_pcpId;
* Different possible actions are defined here. Keep in sync with the
* constant from CRM_Core_Form for various modes.
*
- * @var integer const
+ * @var int
*/
const
NONE = 0,
protected $_fileName;
/**
- * #@+
- * @var integer
- */
-
- /**
- * Imported file size
+ * Imported file size.
+ *
* @var int
*/
protected $_fileSize;
protected $_isTemplate = FALSE;
/**
- * Pre-populate fields based on this template event_id
- * @var integer
+ * Pre-populate fields based on this template event_id.
+ *
+ * @var int
*/
protected $_templateId;
/**
* Show fee block or not.
*
- * @var bool determines if fee block should be shown or hidden
+ * @var bool
*/
public $_noFees;
/**
- * @var array Fee Block
+ * Fee Block.
+ *
+ * @var array
*/
public $_feeBlock;
protected $_fileName;
/**
- * #@+
- * @var integer
- */
-
- /**
- * Imported file size
+ * Imported file size.
+ *
* @var int
*/
protected $_fileSize;
/**
- * Seperator being used
+ * Separator being used.
+ *
* @var string
*/
protected $_seperator;
/**
- * Total number of lines in file
+ * Total number of lines in file.
+ *
* @var int
*/
protected $_lineCount;
public $isBackOffice = FALSE;
/**
- * @var String
+ * @var string
*/
public $_formName = '';
class CRM_Mailing_Page_View extends CRM_Core_Page {
/**
- * @var Signal to Flexmailer that this version of the class is usable.
+ * Signal to Flexmailer that this version of the class is usable.
+ *
+ * @var bool
*/
const USES_MAILING_PREVIEW_API = 1;
protected $_fileName;
- /**
- * #@+
- * @var integer
- */
-
/**
* Imported file size
* @var int
/**
* The id of the report instance
*
- * @var integer
+ * @var int
*/
protected $_id;
/**
* The id of the report template
*
- * @var integer;
+ * @var int
*/
protected $_templateID;
* when $_output mode is not 'html' or 'group' so as not to have to interpret / mess with that part
* of the code (see limit() fn.
*
- * @var integer
+ * @var int
*/
protected $_limitValue = NULL;
/**
* This can be set to specify row offset
* See notes on _limitValue
- * @var integer
+ *
+ * @var int
*/
protected $_offsetValue = NULL;
/**
public $_section;
/**
- * @var string Report description.
+ * Report description.
+ *
+ * @var string
*/
public $_description;
/**
- * @var bool Is an address field selected.
+ * Is an address field selected.
+ *
+ * @var bool
* This was intended to determine if the address table should be joined in
* The isTableSelected function is now preferred for this purpose
*/
protected $_addressField;
/**
- * @var bool Is an email field selected.
+ * Is an email field selected.
+ *
+ * @var bool
* This was intended to determine if the email table should be joined in
* The isTableSelected function is now preferred for this purpose
*/
protected $_emailField;
/**
- * @var bool Is a phone field selected.
+ * Is a phone field selected.
+ *
+ * @var bool
* This was intended to determine if the phone table should be joined in
* The isTableSelected function is now preferred for this purpose
*/
protected $_phoneField;
/**
- * @var bool Create new report instance? (or update existing) on save.
+ * Create new report instance? (or update existing) on save.
+ *
+ * @var bool
*/
protected $_createNew;
* When a grand total row has calculated the status we pop it off to here.
*
* This allows us to access it from the stats function and avoid recalculating.
+ *
* @var array
*/
protected $rollupRow = [];
/**
- * @var string Database attributes - character set and collation
+ * Database attributes - character set and collation.
+ *
+ * @var string
*/
protected $_databaseAttributes = ' DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci';
class CRM_SMS_Message {
/**
- * @var String
* What address is this SMS message coming from.
+ *
+ * @var string
*/
public $from = '';
/**
- * @var String
* What address is this SMS message going to.
+ *
+ * @var string
*/
public $to = '';
/**
- * @var Integer
- * Contact ID that is matched to the From address
+ * Contact ID that is matched to the From address.
+ *
+ * @var int
*/
public $fromContactID = NULL;
/**
- * @var Integer
- * Contact ID that is matched to the To address
+ * Contact ID that is matched to the To address.
+ *
+ * @var int
*/
public $toContactID = NULL;
/**
- * @var String
- * Body content of the message
+ * Body content of the message.
+ *
+ * @var string
*/
public $body = '';
/**
- * @var Integer
- * Trackable ID in the system to match to
+ * Trackable ID in the system to match to.
+ *
+ * @var int
*/
public $trackID = NULL;
* Is this profile has searchable field.
* or is any field having in selector true.
*
- * @var bool.
+ * @var bool
*/
protected $_hasSearchableORInSelector;
* @param string $column
* @param string $properties
* @param bool $localizable is this a field that should be localized
- * @param string|NULL $version CiviCRM version to use if rebuilding multilingual schema
+ * @param string|null $version CiviCRM version to use if rebuilding multilingual schema
+ *
* @return bool
*/
public static function addColumn($ctx, $table, $column, $properties, $localizable = FALSE, $version = NULL) {
/**
* Rebuild Multilingual Schema.
* @param CRM_Queue_TaskContext $ctx
- * @param string|NULL $version CiviCRM version to use if rebuilding multilingual schema
+ * @param string|null $version CiviCRM version to use if rebuilding multilingual schema
+ *
* @return bool
*/
public static function rebuildMultilingalSchema($ctx, $version = NULL) {
/**
* The region of the page into which JavaScript will be loaded.
*
- * @var String
+ * @var string
* @deprecated
*/
public $region;
/**
* Membership type name used in test function.
- * @var String
+ *
+ * @var string
*/
protected $_membershipTypeName = NULL;
/**
* Membership type id used in test function.
- * @var String
+ *
+ * @var string
*/
protected $_membershipTypeID = NULL;
/**
* Contact id used in test function.
- * @var String
+ *
+ * @var string
*/
protected $_contactID = NULL;
/**
* Contact id used in test function.
- * @var String
+ *
+ * @var string
*/
protected $_contactID2 = NULL;
/**
* Contact id used in test function.
- * @var String
+ *
+ * @var string
*/
protected $_contactID3 = NULL;
/**
* Contact id used in test function.
- * @var String
+ *
+ * @var string
*/
protected $_contactID4 = NULL;
class CRM_Contact_BAO_QueryTestDataProvider implements Iterator {
/**
- * @var integer
+ * Current count.
+ *
+ * @var int
*/
private $i = 0;
class CRM_Contact_Form_Search_Custom_GroupTestDataProvider implements Iterator {
/**
- * @var integer
+ * Current count.
+ *
+ * @var int
*/
private $i = 0;
class CRM_Contact_Form_Search_Custom_SampleTestDataProvider implements Iterator {
/**
- * @var integer
+ * Current count.
+ *
+ * @var int
*/
private $i = 0;
class CRM_Group_Page_AjaxTest extends CiviUnitTestCase {
/**
* Permissioned group is used both as an active group the contact can see and as a group that allows
- * logged in user to see contacts
- * @var integer
+ * logged in user to see contacts.
+ *
+ * @var int
*/
protected $_permissionedGroup;
/**
class CRM_Mailing_BAO_QueryTestDataProvider implements Iterator {
/**
- * @var integer
+ * @var int
*/
private $i = 0;
class CRM_Member_Import_Parser_MembershipTest extends CiviUnitTestCase {
/**
* Membership type name used in test function.
- * @var String
+ *
+ * @var string
*/
protected $_membershipTypeName = NULL;
/**
* Membership type id used in test function.
- * @var String
+ *
+ * @var string
*/
protected $_membershipTypeID = NULL;
protected $_cId_a;
/**
* Second individual.
- * @var integer
+ *
+ * @var int
*/
protected $_cId_a_2;
protected $_cId_b;
protected $ids = array();
/**
* Tag id.
- * @var integer
+ *
+ * @var int
*/
protected $tag = array();
projects / civicrm-core.git / commitdiff