From f9e31d7f8d75ec9704de907bf0ab5599dc70c642 Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Wed, 4 Feb 2015 14:02:15 +1300 Subject: [PATCH] INFRA-132 add full stops --- CRM/Core/Resources.php | 2 +- CRM/Core/SelectValues.php | 96 +++++++++++++-------------- CRM/Core/Session.php | 30 ++++----- CRM/Core/ShowHideBlocks.php | 20 +++--- CRM/Core/Smarty.php | 2 +- CRM/Core/State.php | 16 ++--- CRM/Core/StateMachine.php | 24 +++---- CRM/Event/Form/ManageEvent/Repeat.php | 6 +- 8 files changed, 98 insertions(+), 98 deletions(-) diff --git a/CRM/Core/Resources.php b/CRM/Core/Resources.php index 744e5be721..7586d25f24 100644 --- a/CRM/Core/Resources.php +++ b/CRM/Core/Resources.php @@ -744,7 +744,7 @@ class CRM_Core_Resources { } /** - * Provide a list of available entityRef filters + * Provide a list of available entityRef filters. * FIXME: This function doesn't really belong in this class * @TODO: Provide a sane way to extend this list for other entities - a hook or?? * @return array diff --git a/CRM/Core/SelectValues.php b/CRM/Core/SelectValues.php index 40d983c454..2e30aafd67 100644 --- a/CRM/Core/SelectValues.php +++ b/CRM/Core/SelectValues.php @@ -38,7 +38,7 @@ class CRM_Core_SelectValues { /** - * Preferred mail format + * Preferred mail format. * * @return array */ @@ -51,7 +51,7 @@ class CRM_Core_SelectValues { } /** - * Privacy options + * Privacy options. * * @return array */ @@ -67,7 +67,7 @@ class CRM_Core_SelectValues { } /** - * Various pre defined contact super types + * Various pre defined contact super types. * * @return array */ @@ -80,7 +80,7 @@ class CRM_Core_SelectValues { } /** - * Various pre defined unit list + * Various pre defined unit list. * * @param string $unitType * @return array @@ -98,7 +98,7 @@ class CRM_Core_SelectValues { } /** - * Membership type unit + * Membership type unit. * * @return array */ @@ -107,7 +107,7 @@ class CRM_Core_SelectValues { } /** - * Various pre defined period types + * Various pre defined period types. * * @return array */ @@ -119,7 +119,7 @@ class CRM_Core_SelectValues { } /** - * Various pre defined email selection methods + * Various pre defined email selection methods. * * @return array */ @@ -133,7 +133,7 @@ class CRM_Core_SelectValues { } /** - * Various pre defined member visibility options + * Various pre defined member visibility options. * * @return array */ @@ -158,7 +158,7 @@ class CRM_Core_SelectValues { } /** - * Various pre defined event dates + * Various pre defined event dates. * * @return array */ @@ -171,7 +171,7 @@ class CRM_Core_SelectValues { } /** - * Custom form field types + * Custom form field types. * * @return array */ @@ -198,7 +198,7 @@ class CRM_Core_SelectValues { } /** - * Various pre defined extensions for dynamic properties and groups + * Various pre defined extensions for dynamic properties and groups. * * @return array * @@ -228,7 +228,7 @@ class CRM_Core_SelectValues { } /** - * Styles for displaying the custom data group + * Styles for displaying the custom data group. * * @return array * @@ -242,7 +242,7 @@ class CRM_Core_SelectValues { } /** - * For displaying the uf group types + * For displaying the uf group types. * * @return array */ @@ -262,7 +262,7 @@ class CRM_Core_SelectValues { } /** - * The status of a contact within a group + * The status of a contact within a group. * * @return array * @@ -276,7 +276,7 @@ class CRM_Core_SelectValues { } /** - * List of Group Types + * List of Group Types. * * @return array */ @@ -288,7 +288,7 @@ class CRM_Core_SelectValues { } /** - * Compose the parameters for a date select object + * Compose the parameters for a date select object. * * @param string|NULL $type * the type of date @@ -340,7 +340,7 @@ class CRM_Core_SelectValues { } /** - * Values for UF form visibility options + * Values for UF form visibility options. * * @return array */ @@ -353,7 +353,7 @@ class CRM_Core_SelectValues { } /** - * Values for group form visibility options + * Values for group form visibility options. * * @return array */ @@ -365,7 +365,7 @@ class CRM_Core_SelectValues { } /** - * Different type of Mailing Components + * Different type of Mailing Components. * * @return array */ @@ -383,7 +383,7 @@ class CRM_Core_SelectValues { } /** - * Get hours + * Get hours. * * @return array */ @@ -396,7 +396,7 @@ class CRM_Core_SelectValues { } /** - * Get minutes + * Get minutes. * * @return array */ @@ -409,7 +409,7 @@ class CRM_Core_SelectValues { } /** - * Get the Map Provider + * Get the Map Provider. * * @return array * array of map providers @@ -423,7 +423,7 @@ class CRM_Core_SelectValues { } /** - * Get the Geocoding Providers from available plugins + * Get the Geocoding Providers from available plugins. * * @return array * array of geocoder providers @@ -437,7 +437,7 @@ class CRM_Core_SelectValues { } /** - * Get the Address Standardization Providers from available plugins + * Get the Address Standardization Providers from available plugins. * * @return array * array of address standardization providers @@ -451,7 +451,7 @@ class CRM_Core_SelectValues { } /** - * Different type of Mailing Tokens + * Different type of Mailing Tokens. * * @return array */ @@ -477,7 +477,7 @@ class CRM_Core_SelectValues { } /** - * Different type of Activity Tokens + * Different type of Activity Tokens. * * @return array */ @@ -491,7 +491,7 @@ class CRM_Core_SelectValues { } /** - * Different type of Membership Tokens + * Different type of Membership Tokens. * * @return array */ @@ -508,7 +508,7 @@ class CRM_Core_SelectValues { } /** - * Different type of Event Tokens + * Different type of Event Tokens. * * @return array */ @@ -532,7 +532,7 @@ class CRM_Core_SelectValues { } /** - * Different type of Event Tokens + * Different type of Event Tokens. * * @return array */ @@ -565,7 +565,7 @@ class CRM_Core_SelectValues { } /** - * Different type of Contact Tokens + * Different type of Contact Tokens. * * @return array */ @@ -640,7 +640,7 @@ class CRM_Core_SelectValues { } /** - * Different type of Participant Tokens + * Different type of Participant Tokens. * * @return array */ @@ -683,7 +683,7 @@ class CRM_Core_SelectValues { } /** - * CiviCRM supported date input formats + * CiviCRM supported date input formats. * * @return array */ @@ -723,7 +723,7 @@ class CRM_Core_SelectValues { } /** - * Map date plugin and actual format that is used by PHP + * Map date plugin and actual format that is used by PHP. * * @return array */ @@ -749,7 +749,7 @@ class CRM_Core_SelectValues { } /** - * Time formats + * Time formats. * * @return array */ @@ -761,7 +761,7 @@ class CRM_Core_SelectValues { } /** - * Get numeric options + * Get numeric options. * * @param int $start * @param int $end @@ -777,7 +777,7 @@ class CRM_Core_SelectValues { } /** - * Barcode types + * Barcode types. * * @return array */ @@ -789,7 +789,7 @@ class CRM_Core_SelectValues { } /** - * Dedupe rule types + * Dedupe rule types. * * @return array */ @@ -802,7 +802,7 @@ class CRM_Core_SelectValues { } /** - * Campaign group types + * Campaign group types. * * @return array */ @@ -814,7 +814,7 @@ class CRM_Core_SelectValues { } /** - * Subscription history method + * Subscription history method. * * @return array */ @@ -828,7 +828,7 @@ class CRM_Core_SelectValues { } /** - * Premium units + * Premium units. * * @return array */ @@ -842,7 +842,7 @@ class CRM_Core_SelectValues { } /** - * Extension types + * Extension types. * * @return array */ @@ -857,7 +857,7 @@ class CRM_Core_SelectValues { } /** - * Job frequency + * Job frequency. * * @return array */ @@ -870,7 +870,7 @@ class CRM_Core_SelectValues { } /** - * Search builder operators + * Search builder operators. * * @return array */ @@ -895,7 +895,7 @@ class CRM_Core_SelectValues { } /** - * Profile group types + * Profile group types. * * @return array */ @@ -915,7 +915,7 @@ class CRM_Core_SelectValues { /** - * Word replacement match type + * Word replacement match type. * * @return array */ @@ -927,7 +927,7 @@ class CRM_Core_SelectValues { } /** - * Mailing group types + * Mailing group types. * * @return array */ @@ -940,7 +940,7 @@ class CRM_Core_SelectValues { } /** - * Mailing Job Status + * Mailing Job Status. * * @return array */ @@ -966,7 +966,7 @@ class CRM_Core_SelectValues { } /** - * Frequency unit for schedule reminders + * Frequency unit for schedule reminders. * * @return array */ diff --git a/CRM/Core/Session.php b/CRM/Core/Session.php index ba1fe1b2a8..438701ef67 100644 --- a/CRM/Core/Session.php +++ b/CRM/Core/Session.php @@ -34,7 +34,7 @@ require_once "PEAR.php"; class CRM_Core_Session { /** - * Cache of all the session names that we manage + * Cache of all the session names that we manage. */ static $_managedNames = NULL; @@ -68,7 +68,7 @@ class CRM_Core_Session { static private $_singleton = NULL; /** - * Constructor + * Constructor. * * The CMS takes care of initiating the php session handler session_start(). * @@ -89,7 +89,7 @@ class CRM_Core_Session { } /** - * Singleton function used to manage this object + * Singleton function used to manage this object. * * @return CRM_Core_Session */ @@ -148,7 +148,7 @@ class CRM_Core_Session { } /** - * Resets the session store + * Resets the session store. * * * @param int $all @@ -171,7 +171,7 @@ class CRM_Core_Session { } /** - * Creates a session local scope + * Creates a session local scope. * * @param string $prefix * Local scope name. @@ -194,7 +194,7 @@ class CRM_Core_Session { } /** - * Resets the session local scope + * Resets the session local scope. * * @param string $prefix * Local scope name. @@ -214,7 +214,7 @@ class CRM_Core_Session { } /** - * Store the variable with the value in the session scope + * Store the variable with the value in the session scope. * * This function takes a name, value pair and stores this * in the session scope. Not sure what happens if we try @@ -253,7 +253,7 @@ class CRM_Core_Session { } /** - * Gets the value of the named variable in the session scope + * Gets the value of the named variable in the session scope. * * This function takes a name and retrieves the value of this * variable from the session scope. @@ -341,7 +341,7 @@ class CRM_Core_Session { } /** - * Adds a userContext to the stack + * Adds a userContext to the stack. * * @param string $userContext * The url to return to when done. @@ -380,7 +380,7 @@ class CRM_Core_Session { } /** - * Replace the userContext of the stack with the passed one + * Replace the userContext of the stack with the passed one. * * @param string $userContext * The url to return to when done. @@ -399,7 +399,7 @@ class CRM_Core_Session { } /** - * Pops the top userContext stack + * Pops the top userContext stack. * * @return string * the top of the userContext stack (also pops the top element) @@ -411,7 +411,7 @@ class CRM_Core_Session { } /** - * Reads the top userContext stack + * Reads the top userContext stack. * * @return string * the top of the userContext stack @@ -425,7 +425,7 @@ class CRM_Core_Session { } /** - * Dumps the session to the log + * Dumps the session to the log. * @param int $all */ public function debug($all = 1) { @@ -439,7 +439,7 @@ class CRM_Core_Session { } /** - * Fetches status messages + * Fetches status messages. * * @param bool $reset * Should we reset the status variable?. @@ -553,7 +553,7 @@ class CRM_Core_Session { } /** - * Retrieve contact id of the logged in user + * Retrieve contact id of the logged in user. * @return int|NULL * contact ID of logged in user */ diff --git a/CRM/Core/ShowHideBlocks.php b/CRM/Core/ShowHideBlocks.php index 96707ae28e..3680230bc6 100644 --- a/CRM/Core/ShowHideBlocks.php +++ b/CRM/Core/ShowHideBlocks.php @@ -42,21 +42,21 @@ class CRM_Core_ShowHideBlocks { static $_showIcon, $_hideIcon; /** - * The array of ids of blocks that will be shown + * The array of ids of blocks that will be shown. * * @var array */ protected $_show; /** - * The array of ids of blocks that will be hidden + * The array of ids of blocks that will be hidden. * * @var array */ protected $_hide; /** - * Class constructor + * Class constructor. * * @param array $show * Initial value of show array. @@ -82,7 +82,7 @@ class CRM_Core_ShowHideBlocks { } /** - * Load icon vars used in hide and show links + * Load icon vars used in hide and show links. * * @return void */ @@ -95,7 +95,7 @@ class CRM_Core_ShowHideBlocks { } /** - * Add the values from this class to the template + * Add the values from this class to the template. * * @return void */ @@ -126,7 +126,7 @@ class CRM_Core_ShowHideBlocks { } /** - * Add a value to the show array + * Add a value to the show array. * * @param string $name * Id to be added. @@ -141,7 +141,7 @@ class CRM_Core_ShowHideBlocks { } /** - * Add a value to the hide array + * Add a value to the hide array. * * @param string $name * Id to be added. @@ -156,7 +156,7 @@ class CRM_Core_ShowHideBlocks { } /** - * Create a well formatted html link from the smaller pieces + * Create a well formatted html link from the smaller pieces. * * @param string $name * Name of the link. @@ -172,7 +172,7 @@ class CRM_Core_ShowHideBlocks { } /** - * Create links that we can use in the form + * Create links that we can use in the form. * * @param CRM_Core_Form $form * The form object. @@ -206,7 +206,7 @@ class CRM_Core_ShowHideBlocks { } /** - * Create html link elements that we can use in the form + * Create html link elements that we can use in the form. * * @param CRM_Core_Form $form * The form object. diff --git a/CRM/Core/Smarty.php b/CRM/Core/Smarty.php index 6e2ce6406d..b378bbcdc5 100644 --- a/CRM/Core/Smarty.php +++ b/CRM/Core/Smarty.php @@ -78,7 +78,7 @@ class CRM_Core_Smarty extends Smarty { private $backupFrames = array(); /** - * Class constructor + * Class constructor. * * @return CRM_Core_Smarty */ diff --git a/CRM/Core/State.php b/CRM/Core/State.php index b2c2c3c4b4..323dc3df39 100644 --- a/CRM/Core/State.php +++ b/CRM/Core/State.php @@ -39,7 +39,7 @@ class CRM_Core_State { /** - * State name + * State name. * @var string */ protected $_name; @@ -51,19 +51,19 @@ class CRM_Core_State { protected $_type; /** - * The state that precedes this state + * The state that precedes this state. * @var CRM_Core_State */ protected $_back; /** - * The state that succeeds this state + * The state that succeeds this state. * @var CRM_Core_State */ protected $_next; /** - * The state machine that this state is part of + * The state machine that this state is part of. * @var CRM_Core_StateMachine */ protected $_stateMachine; @@ -77,7 +77,7 @@ class CRM_Core_State { const START = 1, FINISH = 2, SIMPLE = 4; /** - * Constructor + * Constructor. * * @param string $name * Internal name of the state. @@ -174,7 +174,7 @@ class CRM_Core_State { } /** - * Getter for name + * Getter for name. * * @return string */ @@ -183,7 +183,7 @@ class CRM_Core_State { } /** - * Setter for name + * Setter for name. * * @return void */ @@ -192,7 +192,7 @@ class CRM_Core_State { } /** - * Getter for type + * Getter for type. * * @return int */ diff --git a/CRM/Core/StateMachine.php b/CRM/Core/StateMachine.php index d41330b956..91c92a3ad8 100644 --- a/CRM/Core/StateMachine.php +++ b/CRM/Core/StateMachine.php @@ -44,13 +44,13 @@ class CRM_Core_StateMachine { /** - * The controller of this state machine + * The controller of this state machine. * @var object */ protected $_controller; /** - * The list of states that belong to this state machine + * The list of states that belong to this state machine. * @var array */ protected $_states; @@ -64,26 +64,26 @@ class CRM_Core_StateMachine { protected $_pages; /** - * The names of the pages + * The names of the pages. * * @var array */ protected $_pageNames; /** - * The mode that the state machine is operating in + * The mode that the state machine is operating in. * @var int */ protected $_action = NULL; /** - * The display name for this machine + * The display name for this machine. * @var string */ protected $_name = NULL; /** - * Class constructor + * Class constructor. * * @param object $controller * The controller for this state machine. @@ -219,7 +219,7 @@ class CRM_Core_StateMachine { } /** - * Return the state object corresponding to the name + * Return the state object corresponding to the name. * * @param string $name * Name of page. @@ -247,7 +247,7 @@ class CRM_Core_StateMachine { } /** - * Return the list of form objects + * Return the list of form objects. * * @return array * array of pages in the state machine @@ -317,7 +317,7 @@ class CRM_Core_StateMachine { } /** - * Reset the state machine + * Reset the state machine. * * @return void */ @@ -326,7 +326,7 @@ class CRM_Core_StateMachine { } /** - * Getter for action + * Getter for action. * * @return int */ @@ -335,7 +335,7 @@ class CRM_Core_StateMachine { } /** - * Setter for content + * Setter for content. * * @param string $content * The content generated by this state machine. @@ -347,7 +347,7 @@ class CRM_Core_StateMachine { } /** - * Getter for content + * Getter for content. * * @return string */ diff --git a/CRM/Event/Form/ManageEvent/Repeat.php b/CRM/Event/Form/ManageEvent/Repeat.php index 3e1103f37f..c5da44b37c 100644 --- a/CRM/Event/Form/ManageEvent/Repeat.php +++ b/CRM/Event/Form/ManageEvent/Repeat.php @@ -13,12 +13,12 @@ class CRM_Event_Form_ManageEvent_Repeat extends CRM_Event_Form_ManageEvent { /** - * Parent Event Start Date + * Parent Event Start Date. */ protected $_parentEventStartDate = NULL; /** - * Parent Event End Date + * Parent Event End Date. */ protected $_parentEventEndDate = NULL; @@ -159,7 +159,7 @@ class CRM_Event_Form_ManageEvent_Repeat extends CRM_Event_Form_ManageEvent { } /** - * This function gets the number of participant count for the list of related event ids + * This function gets the number of participant count for the list of related event ids. * * @param array $listOfRelatedEntities * List of related event ids . -- 2.25.1