*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Import_DataSource_CSV extends CRM_Import_DataSource {
const
}
/**
- * This is function is called by the form object to get the DataSource's
- * form snippet. It should add all fields necesarry to get the data
+ * This is function is called by the form object to get the DataSource's form snippet.
+ *
+ * It should add all fields necessary to get the data
* uploaded to the temporary table in the DB.
*
* @param CRM_Core_Form $form
- *
- * @return void
- * (operates directly on form argument)
*/
public function buildQuickForm(&$form) {
$form->add('hidden', 'hidden_dataSource', 'CRM_Import_DataSource_CSV');
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates task actions for CiviEvent
- *
+ * This class generates task actions for CiviEvent.
*/
class CRM_Pledge_Form_Task extends CRM_Core_Form {
/**
* Build all the data structures needed to build the form.
- *
- * @param
- *
- * @return void
*/
public function preProcess() {
self::preProcessCommon($this);
* @param string $nextType
* @param string $backType
* @param bool $submitOnce
- *
- *
- * @return void
*/
public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
$this->addButtons(array(
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This file is used to build the form configuring mass sms details
+ * This file is used to build the form configuring mass sms details.
*/
class CRM_SMS_Form_Upload extends CRM_Core_Form {
public $_mailingID;
/**
* Set default values for the form.
- * the default values are retrieved from the database
- *
- *
- * @return void
*/
public function setDefaultValues() {
$mailingID = CRM_Utils_Request::retrieve('mid', 'Integer', $this, FALSE, NULL);
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$session = CRM_Core_Session::singleton();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
interface CRM_Utils_Cache_Interface {
*
* @param string $key
* @param mixed $value
- * @return void
*/
public function set($key, &$value);
* Delete a value from the cache.
*
* @param string $key
- * @return void
*/
public function delete($key);
/**
* Delete all values from the cache.
- *
- * @return void
*/
public function flush();
*
* @package CiviCRM_Hook
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id: $
- *
*/
abstract class CRM_Utils_Hook {
* fieldHeaders - field headers
* fields - import fields
*
- * @return void
+ * @return mixed
*/
public static function import($object, $usage, &$objectRef, &$params) {
return self::singleton()->invoke(4, $object, $usage, $objectRef, $params,
* @param array $selector
* the selector object. Allows you access to the context of the search
*
- * @return void
+ * @return mixed
* modify the header and values object to pass the data u need
*/
public static function searchColumns($objectName, &$headers, &$rows, &$selector) {
* @param int $otherCaseId
* @param bool $changeClient
*
- * @return void
+ * @return mixed
*/
public static function pre_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
return self::singleton()
* @param int $otherCaseId
* @param bool $changeClient
*
- * @return void
+ * @return mixed
*/
public static function post_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) {
return self::singleton()
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* API for event export in iCalendar format
* as outlined in Internet Calendaring and
* Scheduling Core Object Specification
- *
*/
class CRM_Utils_ICalendar {
* The file name (for downloads).
* @param string $disposition
* How the file should be sent ('attachment' for downloads).
- *
- * @return void
*/
public static function send($calendar, $content_type = 'text/calendar', $charset = 'us-ascii', $fileName = NULL, $disposition = NULL) {
$config = CRM_Core_Config::singleton();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
// we should consider moving these to the settings table
define('MAIL_BATCH_SIZE', 50);
/**
- * Class CRM_Utils_Mail_EmailProcessor
+ * Class CRM_Utils_Mail_EmailProcessor.
*/
class CRM_Utils_Mail_EmailProcessor {
}
/**
- * Delete old files from a given directory (recursively)
+ * Delete old files from a given directory (recursively).
*
* @param string $dir
* Directory to cleanup.
* @param int $age
* Files older than this many seconds will be deleted (default: 60 days).
- *
- * @return void
*/
public static function cleanupDir($dir, $age = 5184000) {
// return early if we can’t read/write the dir
}
/**
- * Process the mailboxes that aren't default (ie. that aren't used by civiMail for the bounce)
- *
- * @return void
+ * Process the mailboxes that aren't default (ie. that aren't used by civiMail for the bounce).
*/
public static function processActivities() {
$dao = new CRM_Core_DAO_MailSettings();
* Process the mailbox for all the settings from civicrm_mail_settings.
*
* @param bool|string $civiMail if true, processing is done in CiviMail context, or Activities otherwise.
- *
- * @return void
*/
public static function process($civiMail = TRUE) {
$dao = new CRM_Core_DAO_MailSettings();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Utils_Migrate_Export {
}
/**
- * Scan local customizations and build an in-memory representation
- *
- * @return void
+ * Scan local customizations and build an in-memory representation.
*/
public function build() {
// fetch the option group / values for
}
/**
+ * Build custom groups.
+ *
* @param array $customGroupIds
* List of custom groups to export.
- * @return void
*/
public function buildCustomGroups($customGroupIds) {
$customGroupIdsSql = implode(',', array_filter($customGroupIds, 'is_numeric'));
/**
* @param array $ufGroupIds
* List of custom groups to export.
- * @return void
*/
public function buildUFGroups($ufGroupIds) {
$ufGroupIdsSql = implode(',', array_filter($ufGroupIds, 'is_numeric'));
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Utils_Migrate_Import {
/**
+ * Class constructor.
*/
public function __construct() {
}
/**
- * Import custom-data from an XML file
+ * Import custom-data from an XML file.
*
* @param string $file
* Path to an XML file.
+ *
* @throws CRM_Core_Exception
- * @return void;
*/
public function run($file) {
// read xml file
}
/**
- * Import custom-data from an XML element
+ * Import custom-data from an XML element.
*
* @param SimpleXMLElement $xml
- * @return void
*/
public function runXmlElement($xml) {
$idMap = array(
<?php
/**
- * Class CRM_Utils_OptionBag
+ * Class CRM_Utils_OptionBag.
*/
class CRM_Utils_OptionBag implements ArrayAccess, IteratorAggregate, Countable {
protected $data;
* <p>.
* The value to set.
* </p>
- * @return void
*/
public function offsetSet($offset, $value) {
$this->data[$offset] = $value;
* <p>.
* The offset to unset.
* </p>
- * @return void
*/
public function offsetUnset($offset) {
unset($this->data[$offset]);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* use a POST to jump to a specific page). At some point we should evaluate if we want
* to use Pager_Jumping instead. We've changed the format to allow navigation by jumping
* to a page and also First, Prev CURRENT Next Last
- *
*/
require_once 'Pager/Sliding.php';
* values.
*
* @param array $params
- * The set of options needed to initialize the parent.
- * constructor
+ * The set of options needed to initialize the parent constructor.
*
- *
- * @return void
+ * @return array
*/
public function initialize(&$params) {
/* set the mode for the pager to Sliding */
*/
/**
- * Utilities for manipulating/inspecting CRM_*_PseudoConstant classes
+ * Utilities for manipulating/inspecting CRM_*_PseudoConstant classes.
*/
class CRM_Utils_PseudoConstant {
/**
*
* Wrapper for Pseudoconstant methods. We use this so the calling function
* doesn't need to know which class the Pseudoconstant is on
- * (some are on the Contribute_Pseudoconsant Class etc
+ * (some are on the Contribute_Pseudoconstant Class etc
*
*
- * @param $constant
+ * @param string $constant
*
* @return array
* array reference of all relevant constant
}
/**
- * Flush all caches related to pseudo-constants. This may be inefficient
- * and should generally be avoided.
+ * Flush all caches related to pseudo-constants.
*
- * @return void
+ * This may be inefficient and should generally be avoided.
*/
public static function flushAll() {
foreach (self::findConstants() as $constant) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- *
+ * Recent items utility class.
*/
class CRM_Utils_Recent {
/**
* Initialize this class and set the static variables.
- *
- * @return void
*/
public static function initialize() {
if (!self::$_recent) {
* @param int $contactId
* @param string $contactName
* @param array $others
- *
- * @return void
*/
public static function add(
$title,
*
* @param array $recentItem
* Array of the recent Item to be removed.
- *
- * @return void
*/
public static function del($recentItem) {
self::initialize();
*
* @param string $id
* Contact id that had to be removed.
- *
- * @return void
*/
public static function delContact($id) {
self::initialize();
+--------------------------------------------------------------------+
*/
-/**
- *
- * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
- */
-
/**
* This class handles all SOAP client requests.
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Utils_SoapServer {
* The soap key generated by authenticate().
*
* @throws SoapFault
- * @return void
*/
public function verify($key) {
$session = CRM_Core_Session::singleton();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
*
- * Base class to provide generic sort functionality. Note that some ideas
- * have been borrowed from the drupal tablesort.inc code. Also note that
- * since the Pager and Sort class are similar, do match the function names
+ * Base class to provide generic sort functionality.
+ *
+ * Note that some ideas have been borrowed from the drupal tablesort.inc code.
+ *
+ * Also note that since the Pager and Sort class are similar, do match the function names
* if introducing additional functionality
*
* @package CRM
*
* @param string $defaultSortOrder
* The sort order to use by default.
- *
- * @return void
*/
public function initSortID($defaultSortOrder) {
$url = CRM_Utils_Array::value(self::SORT_ID, $_GET, $defaultSortOrder);
*
* @param string $defaultSortOrder
* The sort order to use by default.
- *
- * @return void
*/
public function initialize($defaultSortOrder) {
$this->initSortID($defaultSortOrder);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* System wide utilities.
- *
*/
class CRM_Utils_System {
* @param array $params
* An array of parameters (see CRM_Utils_System::docURL2 method for names)
*
- * @return void|string
+ * @return null|string
* URL or link to documentation page, based on provided parameters.
*/
public static function docURL($params) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* Array of errors.
* @param string $emailName
* Field label for the 'email'.
- *
- * @return void
*/
public static function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') {
$config = CRM_Core_Config::singleton();
* @param string $oldPerm
* @param array $newPerms
* Array, strings.
- *
- * @return void
*/
public function replacePermission($oldPerm, $newPerms) {
$roles = user_roles(FALSE, $oldPerm);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Drupal specific stuff goes here
+ * Drupal specific stuff goes here.
*/
class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase {
/**
- * If we are using a theming system, invoke theme, else just print the
- * content
+ * Theme output.
+ *
+ * If we are using a theming system, invoke theme, else just print the content.
*
* @param string $content
* The content that will be themed.
* @param bool $maintenance
* For maintenance mode.
*
- * @return void
+ * @return null|string
* prints content on stdout
*/
public function theme(&$content, $print = FALSE, $maintenance = FALSE) {
}
print $out;
+ return NULL;
}
/**
+ * Create user.
+ *
* @inheritDoc
*/
public function createUser(&$params, $mail) {
* Array of errors.
* @param string $emailName
* Field label for the 'email'.
- *
- * @return void
*/
public function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') {
$config = CRM_Core_Config::singleton();
*
* @param string $head
* The new string to be appended.
- *
- * @return void
*/
public function addHTMLHead($head) {
drupal_set_html_head($head);
* @param string $oldPerm
* @param array $newPerms
* Array, strings.
- *
- * @return void
*/
public function replacePermission($oldPerm, $newPerms) {
$roles = user_roles(FALSE, $oldPerm);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Joomla specific stuff goes here
+ * Joomla specific stuff goes here.
*/
class CRM_Utils_System_Joomla extends CRM_Utils_System_Base {
/**
+ * Class constructor.
*/
public function __construct() {
/**
* Array of errors.
* @param string $emailName
* Field label for the 'email'.
- *
- * @return void
*/
public function checkUserNameEmailExists(&$params, &$errors, $emailName = 'email') {
$config = CRM_Core_Config::singleton();
*
* @param object $user
* Handle to the user object.
- *
- * @return void
*/
public function setEmail(&$user) {
global $database;
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Soap specific stuff goes here
+ * Soap specific stuff goes here.
*/
class CRM_Utils_System_Soap extends CRM_Utils_System_Base {
*
* @param object $user
* Handle to the user object.
- *
- * @return void
*/
public function setEmail(&$user) {
}
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id: $
- *
*/
/**
- * Class to abstract token replacement
+ * Class to abstract token replacement.
*/
class CRM_Utils_Token {
static $_requiredTokens = NULL;
* this routine will remove the extra backslashes and braces
*
* @param $str ref to the string that will be scanned and modified
- * @return void
- * this function works directly on the string that is passed
*/
public static function unescapeTokens(&$str) {
$str = preg_replace('/\\\\|\{(\{\w+\.\w+\})\}/', '\\1', $str);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Manage simple Tree data structure
- * example of Tree is
+ * Manage simple Tree data structure.
+ *
+ * Example of Tree is
*
* 'a'
* |
/**
* Check if node is a leaf node.
+ *
* Currently leaf nodes are strings and non-leaf nodes are arrays
*
* @param array $node node which needs to checked
* @param string $parentName
* Name of the parent ?.
* @param array (ref) $node - node to be added
- *
- * @return void
*/
public function addNode($parentName, &$node) {
$temp = '';
* @param string $parentName Name of the parent ?.
* @param string $childName - key to be used (optional)
* @param mixed $data - data to be added
- *
- * @return void
*/
public function addData($parentName, $childName, $data) {
$temp = '';
/**
* Print the tree.
- *
- * @return void
*/
public function display() {
print_r($this->tree);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id: $
- *
*/
class CRM_Utils_Wrapper {
* - bool addSequence: should we add a unique sequence number to the end of the key
* - bool ignoreKey: should we not set a qfKey for this controller (for standalone forms)
*
- * @return void
+ * @return mixed
*/
public function run($formName, $formLabel = NULL, $arguments = NULL) {
if (is_array($arguments)) {
/**
* Flush any cached information.
- *
- * @return void
*/
public function flush() {
$this->case = NULL;
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class NullLock implements LockInterface {
private $hasLock = FALSE;
/**
+ * Create lock.
+ *
* @param string $name
+ *
* @return static
*/
public static function create($name) {
}
/**
+ * Acquire lock.
+ *
* @param int|NULL $timeout
* The number of seconds to wait to get the lock.
* For a default value, use NULL.
+ *
* @return bool
*/
public function acquire($timeout = NULL) {
}
/**
+ * Release lock.
+ *
* @return bool|null|string
* Trueish/falsish.
*/
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CiviContributeProcessor {
static $_paypalParamsMapper = array(
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
define('CRM_ENCRYPT', 1);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
function run() {
session_start();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
function run() {
session_start();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
function run() {
session_start();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
function run() {
session_start();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
function run() {
session_start();
projects / civicrm-core.git / commitdiff