<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
/**
* Create various elements of location block
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param boolean $fixAddress true if you need to fix (format) address values
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param bool $fixAddress
+ * True if you need to fix (format) address values.
* before inserting in db
*
* @param null $entity
*
- * @return array $location
- * @access public
- * @static
+ * @return array
*/
- static function create(&$params, $fixAddress = TRUE, $entity = NULL) {
+ public static function create(&$params, $fixAddress = TRUE, $entity = NULL) {
$location = array();
if (!self::dataExists($params)) {
return $location;
// create location blocks.
foreach (self::$blocks as $block) {
if ($block != 'address') {
- $location[$block] = CRM_Core_BAO_Block::create( $block, $params, $entity );
+ $location[$block] = CRM_Core_BAO_Block::create($block, $params, $entity);
}
else {
$location[$block] = CRM_Core_BAO_Address::create($params, $fixAddress, $entity);
/**
* Creates the entry in the civicrm_loc_block
- *
*/
- static function createLocBlock(&$location, &$entityElements) {
+ public static function createLocBlock(&$location, &$entityElements) {
$locId = self::findExisting($entityElements);
$locBlock = array();
}
foreach (array(
- 'phone', 'email', 'im', 'address') as $loc) {
+ 'phone',
+ 'email',
+ 'im',
+ 'address',
+ ) as $loc) {
$locBlock["{$loc}_id"] = !empty($location["$loc"][0]) ? $location["$loc"][0]->id : NULL;
$locBlock["{$loc}_2_id"] = !empty($location["$loc"][1]) ? $location["$loc"][1]->id : NULL;
}
/**
* Takes an entity array and finds the existing location block
- * @access public
- * @static
*/
- static function findExisting($entityElements) {
- $eid = $entityElements['entity_id'];
+ public static function findExisting($entityElements) {
+ $eid = $entityElements['entity_id'];
$etable = $entityElements['entity_table'];
- $query = "
+ $query = "
SELECT e.loc_block_id as locId
FROM {$etable} e
WHERE e.id = %1";
/**
* Takes an associative array and adds location block
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
- * @return object CRM_Core_BAO_locBlock object on success, null otherwise
- * @access public
- * @static
+ * @return object
+ * CRM_Core_BAO_locBlock object on success, null otherwise
*/
- static function addLocBlock(&$params) {
+ public static function addLocBlock(&$params) {
$locBlock = new CRM_Core_DAO_LocBlock();
$locBlock->copyValues($params);
/**
* Delete the Location Block
*
- * @param int $locBlockId id of the Location Block
+ * @param int $locBlockId
+ * Id of the Location Block.
*
* @return void
- * @access public
- * @static
*/
public static function deleteLocBlock($locBlockId) {
if (!$locBlockId) {
/**
* Check if there is data to create the object
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
- * @return boolean
- * @access public
- * @static
+ * @return bool
*/
- static function dataExists(&$params) {
+ public static function dataExists(&$params) {
// return if no data present
$dataExists = FALSE;
foreach (self::$blocks as $block) {
* @param $entityBlock
* @param bool $microformat
*
- * @return array array of objects(CRM_Core_BAO_Location)
- * @access public
- * @static
+ * @return array
+ * array of objects(CRM_Core_BAO_Location)
*/
- static function &getValues($entityBlock, $microformat = FALSE) {
+ public static function &getValues($entityBlock, $microformat = FALSE) {
if (empty($entityBlock)) {
return NULL;
}
/**
* Delete all the block associated with the location
*
- * @param int $contactId contact id
- * @param int $locationTypeId id of the location to delete
+ * @param int $contactId
+ * Contact id.
+ * @param int $locationTypeId
+ * Id of the location to delete.
*
* @return void
- * @access public
- * @static
*/
- static function deleteLocationBlocks($contactId, $locationTypeId) {
+ public static function deleteLocationBlocks($contactId, $locationTypeId) {
// ensure that contactId has a value
if (empty($contactId) ||
!CRM_Utils_Rule::positiveInteger($contactId)
/**
* Copy or update location block.
*
- * @param int $locBlockId location block id.
- * @param int $updateLocBlockId update location block id
+ * @param int $locBlockId
+ * Location block id.
+ * @param int $updateLocBlockId
+ * Update location block id.
*
- * @return int newly created/updated location block id.
+ * @return int
+ * newly created/updated location block id.
*/
- static function copyLocBlock($locBlockId, $updateLocBlockId = NULL) {
+ public static function copyLocBlock($locBlockId, $updateLocBlockId = NULL) {
//get the location info.
$defaults = $updateValues = array();
$locBlock = array('id' => $locBlockId);
//copy all location blocks (email, phone, address, etc)
foreach ($defaults as $key => $value) {
if ($key != 'id') {
- $tbl = explode("_", $key);
- $name = ucfirst($tbl[0]);
+ $tbl = explode("_", $key);
+ $name = ucfirst($tbl[0]);
$updateParams = NULL;
if ($updateId = CRM_Utils_Array::value($key, $updateValues)) {
$updateParams = array('id' => $updateId);
* If contact has data for any location block, make sure
* contact should have only one primary block, CRM-5051
*
- * @param int $contactId - contact id
+ * @param int $contactId
+ * Contact id.
*
- * @access public
- * @static
*/
- static function checkPrimaryBlocks($contactId) {
+ public static function checkPrimaryBlocks($contactId) {
if (!$contactId) {
return;
}
$nonPrimaryBlockIds = CRM_Contact_BAO_Contact::getLocBlockIds($contactId, array('is_primary' => 0));
foreach (array(
- 'Email', 'IM', 'Phone', 'Address', 'OpenID') as $block) {
+ 'Email',
+ 'IM',
+ 'Phone',
+ 'Address',
+ 'OpenID',
+ ) as $block) {
$name = strtolower($block);
if (array_key_exists($name, $primaryLocBlockIds) &&
!CRM_Utils_System::isNull($primaryLocBlockIds[$name])
*
* @return array
*/
- static function getChainSelectValues($values, $valueType, $flatten = FALSE) {
+ public static function getChainSelectValues($values, $valueType, $flatten = FALSE) {
if (!$values) {
return array();
}
// Format for js
else {
- // Option-groups for multiple categories
+ // Option-groups for multiple categories
if ($result && count($values) > 1) {
$elements[] = array(
'value' => CRM_Core_PseudoConstant::$valueType($val, FALSE),
'children' => array(),
);
- $list = & $elements[count($elements) - 1]['children'];
+ $list = &$elements[count($elements) - 1]['children'];
}
foreach ($result as $id => $name) {
$list[] = array(
}
return $elements;
}
-}
+}
projects / civicrm-core.git / blobdiff