From 77b97be727fa1e9882ed62953d17afbc36431730 Mon Sep 17 00:00:00 2001 From: Eileen McNaughton Date: Fri, 9 May 2014 12:37:40 +1200 Subject: [PATCH] mass update of comment blocks --- CRM/ACL/BAO/ACL.php | 15 ++-- CRM/ACL/Page/ACL.php | 2 + CRM/ACL/Page/ACLBasic.php | 2 + CRM/ACL/Page/EntityRole.php | 2 + CRM/Activity/BAO/Activity.php | 50 +++++++++--- CRM/Activity/BAO/ActivityContact.php | 6 +- CRM/Activity/BAO/Query.php | 16 ++-- CRM/Activity/Form/Activity.php | 4 +- CRM/Activity/Import/Parser.php | 3 +- CRM/Activity/Selector/Activity.php | 10 ++- CRM/Admin/Form/CaseType.php | 5 +- CRM/Admin/Form/ContactType.php | 5 +- CRM/Admin/Form/Job.php | 2 + CRM/Admin/Form/PaymentProcessor.php | 4 + CRM/Admin/Page/APIDoc.php | 2 + CRM/Admin/Page/Job.php | 2 + CRM/Admin/Page/MessageTemplates.php | 4 +- CRM/Admin/Page/PaymentProcessor.php | 2 + CRM/Admin/Page/ScheduleReminders.php | 2 + CRM/Badge/BAO/Layout.php | 3 +- CRM/Batch/Page/Batch.php | 4 +- CRM/Campaign/BAO/Campaign.php | 8 +- CRM/Campaign/BAO/Petition.php | 24 ++++-- CRM/Campaign/BAO/Survey.php | 12 ++- CRM/Campaign/StateMachine/Search.php | 2 + CRM/Case/BAO/Case.php | 76 ++++++++++++----- CRM/Case/BAO/CaseType.php | 9 ++- CRM/Case/BAO/Query.php | 7 ++ CRM/Case/Form/Activity.php | 12 ++- .../Form/Activity/ChangeCaseStartDate.php | 6 ++ CRM/Case/Form/Activity/ChangeCaseStatus.php | 5 ++ CRM/Case/Form/Activity/ChangeCaseType.php | 5 ++ CRM/Case/Form/Activity/LinkCases.php | 5 ++ CRM/Case/Form/Activity/OpenCase.php | 3 + CRM/Case/StateMachine/Search.php | 2 + CRM/Contact/BAO/Contact.php | 26 ++++-- CRM/Contact/BAO/Contact/Location.php | 5 +- CRM/Contact/BAO/Contact/Permission.php | 8 +- CRM/Contact/BAO/GroupContactCache.php | 4 +- CRM/Contact/BAO/GroupNesting.php | 4 +- CRM/Contact/BAO/Query.php | 81 ++++++++++++++++--- CRM/Contact/BAO/Relationship.php | 27 +++++-- CRM/Contact/BAO/RelationshipType.php | 3 + CRM/Contact/BAO/SavedSearch.php | 2 + CRM/Contact/Form/Contact.php | 33 ++++---- .../Form/Edit/CommunicationPreferences.php | 13 ++- CRM/Contact/Form/Edit/CustomData.php | 5 ++ CRM/Contact/Form/Edit/Demographics.php | 3 + CRM/Contact/Form/Edit/Household.php | 7 +- CRM/Contact/Form/Edit/Individual.php | 8 +- CRM/Contact/Form/Edit/TagsAndGroups.php | 30 ++++--- CRM/Contact/Form/Inline/Lock.php | 2 + CRM/Contact/Form/Location.php | 2 + CRM/Contact/Form/ProfileContact.php | 7 +- CRM/Contact/Form/Task.php | 6 +- CRM/Contact/Form/Task/Label.php | 3 + CRM/Contact/Form/Task/LabelCommon.php | 3 + CRM/Contact/Form/Task/Map.php | 9 ++- CRM/Contact/Import/Form/DataSource.php | 3 + CRM/Contact/Import/Parser/Contact.php | 16 +++- CRM/Contact/Page/DedupeFind.php | 2 + CRM/Contact/Page/View/GroupContact.php | 7 +- .../Page/View/UserDashBoard/GroupContact.php | 4 +- CRM/Contact/Selector.php | 19 ++++- CRM/Contact/StateMachine/Search.php | 2 + CRM/Contribute/BAO/Contribution.php | 24 +++++- CRM/Contribute/BAO/Query.php | 29 ++++--- CRM/Core/BAO/ActionLog.php | 2 + CRM/Core/BAO/Address.php | 6 +- CRM/Core/BAO/Block.php | 23 +++--- CRM/Core/BAO/ConfigSetting.php | 2 + CRM/Core/BAO/CustomField.php | 23 ++++-- CRM/Core/BAO/CustomGroup.php | 15 +++- CRM/Core/BAO/CustomOption.php | 5 +- CRM/Core/BAO/CustomValueTable.php | 12 +-- CRM/Core/BAO/Dashboard.php | 5 ++ CRM/Core/BAO/Discount.php | 6 +- CRM/Core/BAO/Domain.php | 4 +- CRM/Core/BAO/Email.php | 2 + CRM/Core/BAO/FinancialTrxn.php | 12 ++- CRM/Core/BAO/IM.php | 2 + CRM/Core/BAO/Job.php | 10 ++- CRM/Core/BAO/LabelFormat.php | 16 ++-- CRM/Core/BAO/Location.php | 6 +- CRM/Core/BAO/MailSettings.php | 1 + CRM/Core/BAO/Mapping.php | 28 +++++-- CRM/Core/BAO/MessageTemplate.php | 2 + CRM/Core/BAO/Note.php | 4 +- CRM/Core/BAO/OpenID.php | 2 + CRM/Core/BAO/OptionValue.php | 15 +++- CRM/Core/BAO/PrevNextCache.php | 6 +- CRM/Core/BAO/SchemaHandler.php | 6 +- CRM/Core/BAO/Setting.php | 13 ++- CRM/Core/BAO/UFGroup.php | 44 ++++++++-- CRM/Core/BAO/UFMatch.php | 16 ++-- CRM/Core/BAO/Website.php | 4 +- CRM/Core/BAO/WordReplacement.php | 5 ++ CRM/Core/CodeGen/Specification.php | 1 + CRM/Core/CodeGen/Util/File.php | 3 +- CRM/Core/CommunityMessages.php | 1 + CRM/Core/Component/Config.php | 4 +- CRM/Core/Component/Info.php | 3 +- CRM/Core/Controller.php | 6 +- CRM/Core/Controller/Simple.php | 17 ++-- CRM/Core/DAO.php | 23 +++--- CRM/Core/Error.php | 13 ++- CRM/Core/Form.php | 28 +++++-- CRM/Core/Form/Date.php | 3 +- CRM/Core/Form/Tag.php | 12 +-- CRM/Core/I18n.php | 2 +- CRM/Core/IDS.php | 5 +- CRM/Core/Invoke.php | 3 + CRM/Core/Key.php | 10 ++- CRM/Core/Lock.php | 7 +- CRM/Core/ManagedEntities.php | 7 +- CRM/Core/Page/AJAX.php | 2 + CRM/Core/Page/Basic.php | 3 + CRM/Core/Payment/AuthorizeNet.php | 4 +- CRM/Core/Payment/BaseIPN.php | 4 +- CRM/Core/Payment/Dummy.php | 4 +- CRM/Core/Payment/Elavon.php | 13 ++- CRM/Core/Payment/FirstData.php | 16 ++-- CRM/Core/Payment/Form.php | 7 ++ CRM/Core/Payment/Google.php | 7 +- CRM/Core/Payment/GoogleIPN.php | 4 +- CRM/Core/Payment/IATS.php | 4 +- CRM/Core/Payment/Moneris.php | 7 +- CRM/Core/Payment/PayJunction.php | 4 +- CRM/Core/Payment/PayPalImpl.php | 9 ++- CRM/Core/Payment/PayPalProIPN.php | 5 ++ CRM/Core/Payment/PayflowPro.php | 3 +- CRM/Core/Payment/PaymentExpress.php | 4 +- CRM/Core/Payment/PaymentExpressIPN.php | 4 +- CRM/Core/Payment/Realex.php | 7 +- CRM/Core/Payment/eWAY.php | 6 +- CRM/Core/Permission.php | 6 +- CRM/Core/Permission/Base.php | 14 +++- CRM/Core/Permission/Drupal.php | 2 + CRM/Core/Permission/Drupal6.php | 2 + CRM/Core/Permission/DrupalBase.php | 5 +- CRM/Core/Permission/Joomla.php | 4 +- CRM/Core/PseudoConstant.php | 28 ++++--- CRM/Core/QuickForm/Action.php | 9 ++- CRM/Core/QuickForm/Action/Back.php | 4 +- CRM/Core/QuickForm/Action/Cancel.php | 4 +- CRM/Core/QuickForm/Action/Display.php | 4 +- CRM/Core/QuickForm/Action/Done.php | 4 +- CRM/Core/QuickForm/Action/Jump.php | 4 +- CRM/Core/QuickForm/Action/Next.php | 4 +- CRM/Core/QuickForm/Action/Process.php | 4 +- CRM/Core/QuickForm/Action/Refresh.php | 4 +- CRM/Core/QuickForm/Action/Reload.php | 4 +- CRM/Core/QuickForm/Action/Submit.php | 4 +- CRM/Core/QuickForm/Action/Upload.php | 11 +-- CRM/Core/Region.php | 2 + CRM/Core/Report/Excel.php | 9 ++- CRM/Core/Session.php | 2 +- CRM/Core/ShowHideBlocks.php | 3 +- CRM/Core/Smarty.php | 2 + CRM/Core/Smarty/plugins/block.crmRegion.php | 8 +- CRM/Core/Smarty/plugins/block.crmScope.php | 10 ++- .../Smarty/plugins/function.crmResURL.php | 3 + .../Smarty/plugins/function.crmScript.php | 3 + CRM/Core/Smarty/plugins/function.crmStyle.php | 3 + .../function.simpleActivityContacts.php | 4 +- .../Smarty/plugins/modifier.crmBtnType.php | 4 +- CRM/Core/Smarty/plugins/modifier.crmDate.php | 3 + .../Smarty/plugins/modifier.crmFirstWord.php | 7 +- .../Smarty/plugins/modifier.crmICalDate.php | 2 + CRM/Core/Smarty/plugins/modifier.crmMoney.php | 7 +- CRM/Core/State.php | 20 +++-- CRM/Core/TemporaryErrorScope.php | 2 + CRM/Custom/Form/CustomData.php | 2 + CRM/Custom/Form/Field.php | 5 +- CRM/Dashlet/Page/Blog.php | 2 + CRM/Dedupe/BAO/RuleGroup.php | 7 +- CRM/Dedupe/Merger.php | 50 +++++++----- CRM/Event/BAO/Event.php | 43 ++++++---- CRM/Event/BAO/Query.php | 2 + CRM/Event/Form/EventFees.php | 8 +- CRM/Event/Form/ManageEvent/Registration.php | 5 +- CRM/Event/Form/Registration.php | 4 + .../Registration/AdditionalParticipant.php | 8 +- CRM/Event/PseudoConstant.php | 8 ++ CRM/Event/Selector/Search.php | 5 +- CRM/Event/StateMachine/Registration.php | 9 ++- CRM/Event/StateMachine/Search.php | 2 + CRM/Extension/Info.php | 2 + CRM/Extension/Manager.php | 6 +- CRM/Extension/Mapper.php | 4 + CRM/Financial/BAO/FinancialType.php | 5 +- CRM/Financial/BAO/FinancialTypeAccount.php | 8 +- CRM/Financial/BAO/PaymentProcessor.php | 5 +- CRM/Financial/BAO/PaymentProcessorType.php | 14 ++-- CRM/Financial/Page/Batch.php | 2 +- CRM/Friend/BAO/Friend.php | 3 + CRM/Grant/BAO/Grant.php | 14 +++- CRM/Grant/BAO/Query.php | 4 + CRM/Grant/Form/Task.php | 5 +- CRM/Grant/Selector/Search.php | 22 +++-- CRM/Grant/StateMachine/Search.php | 2 + CRM/Group/Form/Edit.php | 3 + CRM/Group/Page/Group.php | 4 + CRM/Import/Parser.php | 6 +- CRM/Mailing/BAO/Mailing.php | 66 +++++++++------ CRM/Mailing/BAO/Query.php | 4 + CRM/Mailing/BAO/Spool.php | 15 ++-- CRM/Mailing/Event/BAO/Subscribe.php | 6 ++ CRM/Mailing/MailStore.php | 6 +- CRM/Mailing/MailStore/Localdir.php | 6 +- CRM/Mailing/MailStore/Maildir.php | 6 +- CRM/Mailing/Page/View.php | 5 ++ CRM/Member/BAO/MembershipBlock.php | 2 + CRM/Member/BAO/MembershipLog.php | 5 +- CRM/Member/BAO/MembershipPayment.php | 2 + CRM/Member/BAO/MembershipStatus.php | 8 +- CRM/Member/BAO/MembershipType.php | 20 ++++- CRM/Member/Form/Task/PDFLetterCommon.php | 6 ++ CRM/Member/Import/Parser.php | 3 +- CRM/Member/Import/Parser/Membership.php | 8 +- CRM/Member/StateMachine/Search.php | 2 + CRM/PCP/BAO/PCP.php | 5 +- CRM/PCP/Page/PCP.php | 2 + CRM/PCP/StateMachine/PCP.php | 7 +- CRM/Pledge/BAO/Pledge.php | 3 +- CRM/Pledge/BAO/PledgeBlock.php | 8 +- CRM/Pledge/BAO/PledgePayment.php | 19 +++-- CRM/Pledge/StateMachine/Search.php | 2 + CRM/Price/BAO/LineItem.php | 1 + CRM/Price/BAO/PriceField.php | 20 +++-- CRM/Price/BAO/PriceFieldValue.php | 19 +++-- CRM/Price/BAO/PriceSet.php | 22 +++-- CRM/Price/Form/Field.php | 5 +- CRM/Price/Form/Option.php | 5 +- CRM/Price/Page/Field.php | 4 +- CRM/Price/Page/Set.php | 9 ++- CRM/Profile/Form/Dynamic.php | 6 +- CRM/Profile/Page/Dynamic.php | 10 ++- CRM/Profile/Page/Listings.php | 5 +- .../Page/MultipleRecordFieldsListing.php | 2 + CRM/Profile/Page/Router.php | 3 +- CRM/Profile/Selector/Listings.php | 22 ++++- CRM/Queue/Queue.php | 6 +- CRM/Queue/Queue/Memory.php | 2 +- CRM/Queue/Queue/Sql.php | 4 +- CRM/Queue/Runner.php | 3 + CRM/Queue/Service.php | 2 + CRM/Queue/Task.php | 5 +- CRM/Report/Form.php | 12 ++- CRM/SMS/Form/Upload.php | 3 + CRM/SMS/Provider.php | 4 +- CRM/SMS/StateMachine/Send.php | 7 +- CRM/UF/Form/AdvanceSetting.php | 2 + CRM/UF/Form/Field.php | 5 +- CRM/UF/Page/Field.php | 5 +- CRM/UF/Page/Group.php | 2 + CRM/UF/Page/ProfileEditor.php | 2 + CRM/Upgrade/Form.php | 23 +++++- CRM/Upgrade/Headless.php | 5 +- CRM/Upgrade/Incremental/Legacy.php | 2 + CRM/Upgrade/Incremental/php/FourFour.php | 8 +- CRM/Upgrade/Incremental/php/FourThree.php | 65 ++++++++------- CRM/Upgrade/Incremental/php/FourTwo.php | 11 ++- CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php | 15 ++-- .../Snapshot/V4p2/Price/BAO/FieldValue.php | 2 +- .../Snapshot/V4p2/Price/BAO/LineItem.php | 3 + CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php | 76 ++++++++++------- CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php | 13 +-- .../Snapshot/V4p2/Price/DAO/FieldValue.php | 13 +-- .../Snapshot/V4p2/Price/DAO/LineItem.php | 13 +-- CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php | 13 +-- .../Snapshot/V4p2/Price/DAO/SetEntity.php | 13 +-- CRM/Upgrade/StateMachine.php | 8 +- CRM/Utils/API/AbstractFieldCoder.php | 2 + CRM/Utils/API/MatchOption.php | 4 +- CRM/Utils/API/NullOutputCoder.php | 3 +- CRM/Utils/Cache.php | 2 + CRM/Utils/Cache/APCcache.php | 4 +- CRM/Utils/Cache/ArrayCache.php | 4 +- CRM/Utils/Cache/Memcache.php | 4 +- CRM/Utils/Cache/NoCache.php | 4 +- CRM/Utils/Cache/SerializeCache.php | 4 +- CRM/Utils/Cache/SqlGroup.php | 5 +- CRM/Utils/Geocode/Google.php | 5 +- CRM/Utils/Hook.php | 3 +- CRM/Utils/Hook/DrupalBase.php | 22 ++--- CRM/Utils/Migrate/Export.php | 2 + CRM/Utils/PDF/Label.php | 2 +- CRM/Utils/SQL/Select.php | 1 + CRM/Utils/System.php | 2 + CRM/Utils/System/Base.php | 3 + CRM/Utils/Type.php | 4 +- Civi/Core/Container.php | 1 + api/Wrapper.php | 5 ++ api/v3/Acl.php | 6 ++ api/v3/AclRole.php | 6 ++ api/v3/Activity.php | 4 +- api/v3/ActivityContact.php | 4 +- api/v3/ActivityType.php | 2 + api/v3/Address.php | 2 + api/v3/Batch.php | 6 ++ api/v3/Case.php | 6 +- api/v3/CaseType.php | 3 +- api/v3/Contact.php | 4 +- api/v3/CustomField.php | 12 ++- api/v3/CustomGroup.php | 1 + api/v3/CustomSearch.php | 6 +- api/v3/CustomValue.php | 20 ++--- api/v3/Email.php | 2 + api/v3/EntityTag.php | 4 +- api/v3/Extension.php | 7 +- api/v3/File.php | 5 +- api/v3/FinancialAccount.php | 6 ++ api/v3/FinancialType.php | 6 ++ api/v3/Generic.php | 3 + api/v3/Generic/Update.php | 2 + api/v3/GroupContact.php | 6 +- api/v3/Im.php | 2 + api/v3/Job.php | 3 +- api/v3/LocationType.php | 2 + api/v3/Mailing.php | 5 ++ api/v3/MailingEventConfirm.php | 3 +- api/v3/MailingEventSubscribe.php | 3 +- api/v3/MailingRecipients.php | 4 +- api/v3/MembershipStatus.php | 7 +- api/v3/Note.php | 2 + api/v3/Participant.php | 4 +- api/v3/ParticipantPayment.php | 4 +- api/v3/PaymentProcessor.php | 2 + api/v3/Phone.php | 2 + api/v3/Pledge.php | 8 +- api/v3/PledgePayment.php | 2 + api/v3/PrintLabel.php | 6 ++ api/v3/Relationship.php | 9 ++- api/v3/ReportInstance.php | 4 +- api/v3/ReportTemplate.php | 6 +- api/v3/SmsProvider.php | 6 ++ api/v3/Tag.php | 2 + api/v3/Website.php | 2 + api/v3/utils.php | 9 ++- bin/givi | 12 ++- sql/GenerateData.php | 13 +++ tests/phpunit/CiviTest/CiviMailUtils.php | 3 + tests/phpunit/CiviTest/CiviUnitTestCase.php | 21 +++-- 344 files changed, 2027 insertions(+), 788 deletions(-) diff --git a/CRM/ACL/BAO/ACL.php b/CRM/ACL/BAO/ACL.php index 8600d3d217..6cc025e85d 100644 --- a/CRM/ACL/BAO/ACL.php +++ b/CRM/ACL/BAO/ACL.php @@ -83,13 +83,14 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { /** * Construct a WHERE clause to handle permissions to $object_* * - * @param array ref $tables - Any tables that may be needed in the FROM + * @param $tables * @param string $operation - The operation being attempted * @param string $object_table - The table of the object in question - * @param int $object_id - The ID of the object in question - * @param int $acl_id - If it's a grant/revoke operation, the ACL ID + * @param int $object_id - The ID of the object in question + * @param int $acl_id - If it's a grant/revoke operation, the ACL ID * @param boolean $acl_role - For grant operations, this flag determines if we're granting a single acl (false) or an entire group. * + * @internal param \ref $array $tables - Any tables that may be needed in the FROM * @return string - The WHERE clause, or 0 on failure * @access public * @static @@ -319,11 +320,13 @@ class CRM_ACL_BAO_ACL extends CRM_ACL_DAO_ACL { * Given a table and id pair, return the filter clause * * @param string $table - The table owning the object - * @param int $id - The ID of the object - * @param array ref $tables - Tables that will be needed in the FROM + * @param int $id - The ID of the object + * @param $tables + * + * @internal param \ref $array $tables - Tables that will be needed in the FROM * * @return string|null - WHERE-style clause to filter results, - or null if $table or $id is null + * or null if $table or $id is null * @access public * @static */ diff --git a/CRM/ACL/Page/ACL.php b/CRM/ACL/Page/ACL.php index a78976cd91..e784a08d97 100644 --- a/CRM/ACL/Page/ACL.php +++ b/CRM/ACL/Page/ACL.php @@ -271,6 +271,8 @@ ORDER BY entity_id /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/ACL/Page/ACLBasic.php b/CRM/ACL/Page/ACLBasic.php index 69a9df3764..0f24b3face 100644 --- a/CRM/ACL/Page/ACLBasic.php +++ b/CRM/ACL/Page/ACLBasic.php @@ -208,6 +208,8 @@ ORDER BY entity_id /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/ACL/Page/EntityRole.php b/CRM/ACL/Page/EntityRole.php index a21092dad2..b5ab2a37c8 100644 --- a/CRM/ACL/Page/EntityRole.php +++ b/CRM/ACL/Page/EntityRole.php @@ -215,6 +215,8 @@ class CRM_ACL_Page_EntityRole extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Activity/BAO/Activity.php b/CRM/Activity/BAO/Activity.php index a3b9d06427..d1a8cccb51 100644 --- a/CRM/Activity/BAO/Activity.php +++ b/CRM/Activity/BAO/Activity.php @@ -1483,9 +1483,13 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND /** * send the sms message to a specific contact * - * @param int $toID the contact id of the recipient - * @param int $activityID the activity ID that tracks the message - * @param array $smsParams the params used for sending sms + * @param int $toID the contact id of the recipient + * @param $tokenText + * @param $tokenHtml + * @param array $smsParams the params used for sending sms + * + * @param int $activityID the activity ID that tracks the message + * @param null $userID * * @return mixed true on success or PEAR_Error object * @access public @@ -1555,13 +1559,20 @@ LEFT JOIN civicrm_activity_contact src ON (src.activity_id = ac.activity_id AND /** * send the message to a specific contact * - * @param string $from the name and email of the sender - * @param int $toID the contact id of the recipient - * @param string $subject the subject of the message - * @param string $message the message contents + * @param string $from the name and email of the sender + * @param $fromID + * @param int $toID the contact id of the recipient + * @param string $subject the subject of the message + * @param $text_message + * @param $html_message * @param string $emailAddress use this 'to' email address instead of the default Primary address - * @param int $activityID the activity ID that tracks the message + * @param int $activityID the activity ID that tracks the message + * + * @param null $attachments + * @param null $cc + * @param null $bcc * + * @internal param string $message the message contents * @return boolean true if successfull else false. * @access public * @static @@ -1903,7 +1914,9 @@ SELECT display_name /** * Function to get total count of prior revision of currently viewd activity * - * @param int $activityId current activity id + * @param $activityID + * + * @internal param int $activityId current activity id * * @return int $params count of prior activities otherwise false. * @access public @@ -1941,7 +1954,10 @@ AND id < {$activityID} * Function to get all prior activities of currently viewe * d activity * - * @param int $activityId current activity id + * @param $activityID + * @param bool $onlyPriorRevisions + * + * @internal param int $activityId current activity id * * @return array $result prior activities info. * @access public @@ -1990,7 +2006,9 @@ AND cl.modified_id = c.id /** * Function to find the latest revision of a given activity * - * @param int $activityId prior activity id + * @param $activityID + * + * @internal param int $activityId prior activity id * * @return int $params current activity id. * @access public @@ -2024,7 +2042,11 @@ AND cl.modified_id = c.id * * @activityId int activity id of parent activity * - * @param array $activity details + * @param $activityId + * @param $params + * + * @return $this|null|object + * @internal param array $activity details * * @access public */ @@ -2061,7 +2083,9 @@ AND cl.modified_id = c.id /** * Function to get Activity specific File according activity type Id. * - * @param int $activityTypeId activity id + * @param int $activityTypeId activity id + * + * @param string $crmDir * * @return if file exists returns $activityTypeFile activity filename otherwise false. * diff --git a/CRM/Activity/BAO/ActivityContact.php b/CRM/Activity/BAO/ActivityContact.php index b3ae3e2951..32612b0288 100644 --- a/CRM/Activity/BAO/ActivityContact.php +++ b/CRM/Activity/BAO/ActivityContact.php @@ -109,12 +109,14 @@ AND contact_a.is_deleted = 0 /** * function to retrieve id of target contact by activity_id * - * @param int $id ID of the activity + * @param $activityID + * @param $recordTypeID + * + * @internal param int $id ID of the activity * * @return mixed * * @access public - * */ static function retrieveContactIdsByActivityId($activityID, $recordTypeID) { $activityContact = array(); diff --git a/CRM/Activity/BAO/Query.php b/CRM/Activity/BAO/Query.php index b89cf2b5c2..6706e72ce8 100644 --- a/CRM/Activity/BAO/Query.php +++ b/CRM/Activity/BAO/Query.php @@ -38,6 +38,8 @@ class CRM_Activity_BAO_Query { /** * build select for Case * + * @param $query + * * @return void * @access public */ @@ -194,7 +196,7 @@ class CRM_Activity_BAO_Query { //get the component activity types. $compActTypes = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE, TRUE); $activityTypeIds = self::buildWhereAndQill($query, $value, $types, $op, $grouping, array('Activity Type', 'civicrm_activity.activity_type_id')); - + foreach ($activityTypeIds as $activityTypeId) { if (array_key_exists($activityTypeId, $compActTypes)) { CRM_Contact_BAO_Query::$_considerCompActivities = TRUE; @@ -248,7 +250,7 @@ class CRM_Activity_BAO_Query { case 'activity_status': $status = CRM_Core_PseudoConstant::activityStatus(); - + $activityTypeIds = self::buildWhereAndQill($query, $value, $status, $op, $grouping, array('Activity Status', 'civicrm_activity.status_id')); break; @@ -523,7 +525,7 @@ class CRM_Activity_BAO_Query { ); } } - + $form->assign('buildEngagementLevel', $buildEngagementLevel); $form->assign('buildSurveyResult', $buildSurveyResult); $form->setDefaults(array('activity_test' => 0)); @@ -567,17 +569,17 @@ class CRM_Activity_BAO_Query { return $properties; } - + static function buildWhereAndQill(&$query, $value, $pseudoconstantType, $op, $grouping, $params) { $matches = $val = $clause = array(); - + if (is_array($value)) { foreach ($value as $k => $v) { if ($k) { $val[] = $k; } } - + if (count($val) > 0) { // Overwrite $op so it works with an IN where statement. $op = 'IN'; @@ -594,7 +596,7 @@ class CRM_Activity_BAO_Query { foreach ($matches[0] as $qill) { $clause[] = CRM_Utils_Array::value($qill, $pseudoconstantType); } - + $query->_qill[$grouping][] = ts($params[0] . ' %1 ', array(1 => $op)) . implode(' ' . ts('or') . ' ', $clause); $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($params[1], $op, $value, "Integer" diff --git a/CRM/Activity/Form/Activity.php b/CRM/Activity/Form/Activity.php index b9340a21e2..2dc5d2ffdf 100644 --- a/CRM/Activity/Form/Activity.php +++ b/CRM/Activity/Form/Activity.php @@ -955,6 +955,8 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { * Process activity creation * * @param array $params associated array of submitted values + * + * @return $this|null|object * @access protected */ protected function processActivity(&$params) { @@ -1050,7 +1052,7 @@ class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task { $mailStatus .= ts("A copy of the activity has also been sent to assignee contacts(s)."); } } - + // Also send email to follow-up activity assignees if set if ($followupActivity) { $mailToFollowupContacts = array(); diff --git a/CRM/Activity/Import/Parser.php b/CRM/Activity/Import/Parser.php index 06263f0797..555c9beeed 100644 --- a/CRM/Activity/Import/Parser.php +++ b/CRM/Activity/Import/Parser.php @@ -366,10 +366,11 @@ abstract class CRM_Activity_Import_Parser extends CRM_Import_Parser { /** * Export data to a CSV file * - * @param string $filename + * @param $fileName * @param array $header * @param data $data * + * @internal param string $filename * @return void * @access public */ diff --git a/CRM/Activity/Selector/Activity.php b/CRM/Activity/Selector/Activity.php index f3a319291b..06f895a181 100644 --- a/CRM/Activity/Selector/Activity.php +++ b/CRM/Activity/Selector/Activity.php @@ -95,11 +95,17 @@ class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements C * * - View * - * @param string $activityType type of activity + * @param $activityTypeId + * @param null $sourceRecordId + * @param bool $accessMailingReport + * @param null $activityId + * @param null $key + * @param null $compContext + * + * @internal param string $activityType type of activity * * @return array * @access public - * */ public static function actionLinks($activityTypeId, $sourceRecordId = NULL, diff --git a/CRM/Admin/Form/CaseType.php b/CRM/Admin/Form/CaseType.php index 201fe24dc9..32b4bcc28d 100644 --- a/CRM/Admin/Form/CaseType.php +++ b/CRM/Admin/Form/CaseType.php @@ -67,7 +67,10 @@ class CRM_Admin_Form_CaseType extends CRM_Admin_Form { /** * global form rule * - * @param array $fields the input form values + * @param array $fields the input form values + * + * @param $files + * @param $self * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Admin/Form/ContactType.php b/CRM/Admin/Form/ContactType.php index 78a60d0879..0f900b9296 100644 --- a/CRM/Admin/Form/ContactType.php +++ b/CRM/Admin/Form/ContactType.php @@ -83,7 +83,10 @@ class CRM_Admin_Form_ContactType extends CRM_Admin_Form { /** * global form rule * - * @param array $fields the input form values + * @param array $fields the input form values + * + * @param $files + * @param $self * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Admin/Form/Job.php b/CRM/Admin/Form/Job.php index c9ec3be713..69432ed836 100644 --- a/CRM/Admin/Form/Job.php +++ b/CRM/Admin/Form/Job.php @@ -64,6 +64,8 @@ class CRM_Admin_Form_Job extends CRM_Admin_Form { /** * Function to build the form * + * @param bool $check + * * @return void * @access public */ diff --git a/CRM/Admin/Form/PaymentProcessor.php b/CRM/Admin/Form/PaymentProcessor.php index 706c8e8423..a3f6670dde 100644 --- a/CRM/Admin/Form/PaymentProcessor.php +++ b/CRM/Admin/Form/PaymentProcessor.php @@ -349,6 +349,10 @@ class CRM_Admin_Form_PaymentProcessor extends CRM_Admin_Form { /** * Save a payment processor * + * @param $values + * @param $domainID + * @param $test + * * @return Void */ function updatePaymentProcessor(&$values, $domainID, $test) { diff --git a/CRM/Admin/Page/APIDoc.php b/CRM/Admin/Page/APIDoc.php index 7b847a18c5..51a5440cc2 100644 --- a/CRM/Admin/Page/APIDoc.php +++ b/CRM/Admin/Page/APIDoc.php @@ -50,6 +50,8 @@ class CRM_Admin_Page_APIDoc extends CRM_Core_Page { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Admin/Page/Job.php b/CRM/Admin/Page/Job.php index 95328d8fbd..7b2d97ef45 100644 --- a/CRM/Admin/Page/Job.php +++ b/CRM/Admin/Page/Job.php @@ -208,6 +208,8 @@ class CRM_Admin_Page_Job extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Admin/Page/MessageTemplates.php b/CRM/Admin/Page/MessageTemplates.php index 5622e7a079..8974e7c4ce 100644 --- a/CRM/Admin/Page/MessageTemplates.php +++ b/CRM/Admin/Page/MessageTemplates.php @@ -208,6 +208,8 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { @@ -217,7 +219,7 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic { /** * browse all entities. * - * @param int $action + * @internal param int $action * * @return void * @access public diff --git a/CRM/Admin/Page/PaymentProcessor.php b/CRM/Admin/Page/PaymentProcessor.php index 7c6207a9e1..adcb704963 100644 --- a/CRM/Admin/Page/PaymentProcessor.php +++ b/CRM/Admin/Page/PaymentProcessor.php @@ -116,6 +116,8 @@ class CRM_Admin_Page_PaymentProcessor extends CRM_Core_Page_Basic { /** * Browse all payment processors. * + * @param null $action + * * @return void * @access public * @static diff --git a/CRM/Admin/Page/ScheduleReminders.php b/CRM/Admin/Page/ScheduleReminders.php index c1a1fb0277..70f77583bb 100644 --- a/CRM/Admin/Page/ScheduleReminders.php +++ b/CRM/Admin/Page/ScheduleReminders.php @@ -116,6 +116,8 @@ class CRM_Admin_Page_ScheduleReminders extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/Badge/BAO/Layout.php b/CRM/Badge/BAO/Layout.php index 8ceb633f68..e7a698396c 100644 --- a/CRM/Badge/BAO/Layout.php +++ b/CRM/Badge/BAO/Layout.php @@ -82,7 +82,8 @@ class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel { * Function to add a name label * * @param array $params reference array contains the values submitted by the form - * @param array $ids reference array contains the id + * + * @internal param array $ids reference array contains the id * * @access public * @static diff --git a/CRM/Batch/Page/Batch.php b/CRM/Batch/Page/Batch.php index 7fec6d0a49..8f6a66bb03 100644 --- a/CRM/Batch/Page/Batch.php +++ b/CRM/Batch/Page/Batch.php @@ -83,6 +83,8 @@ class CRM_Batch_Page_Batch extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { @@ -92,7 +94,7 @@ class CRM_Batch_Page_Batch extends CRM_Core_Page_Basic { /** * browse all entities. * - * @param int $action + * @internal param int $action * * @return void * @access public diff --git a/CRM/Campaign/BAO/Campaign.php b/CRM/Campaign/BAO/Campaign.php index 19cec46a3d..17ff36333e 100644 --- a/CRM/Campaign/BAO/Campaign.php +++ b/CRM/Campaign/BAO/Campaign.php @@ -102,6 +102,8 @@ Class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { * function to delete the campaign * * @param int $id id of the campaign + * + * @return bool|mixed */ public static function del($id) { if (!$id) { @@ -117,9 +119,10 @@ Class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign { * retrieves the relevant objects. Typically the valid params are only * campaign_id. * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $defaults (reference ) an assoc array to hold the flattened values + * @param array $params (reference ) an assoc array of name/value pairs + * @param array $defaults (reference ) an assoc array to hold the flattened values * + * @return \CRM_Campaign_DAO_Campaign|null * @access public */ public function retrieve(&$params, &$defaults) { @@ -464,6 +467,7 @@ SELECT campaign.id as id, * * @param int $campaignId campaign id * + * @return array * @static */ static function getCampaignGroups($campaignId) { diff --git a/CRM/Campaign/BAO/Petition.php b/CRM/Campaign/BAO/Petition.php index a30b2ccde0..481e31c84c 100644 --- a/CRM/Campaign/BAO/Petition.php +++ b/CRM/Campaign/BAO/Petition.php @@ -271,8 +271,11 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; /** * Function to get Petition Signature Total * - * @param boolean $all - * @param int $id + * @param $surveyId + * + * @return array + * @internal param bool $all + * @internal param int $id * @static */ static function getPetitionSignatureTotalbyCountry($surveyId) { @@ -313,8 +316,11 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; /** * Function to get Petition Signature Total * - * @param boolean $all - * @param int $id + * @param $surveyId + * + * @return array + * @internal param bool $all + * @internal param int $id * @static */ static function getPetitionSignatureTotal($surveyId) { @@ -368,8 +374,12 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; /** * Function to get Petition Signature Details * - * @param boolean $all - * @param int $id + * @param $surveyId + * @param null $status_id + * + * @return array + * @internal param bool $all + * @internal param int $id * @static */ static function getPetitionSignature($surveyId, $status_id = NULL) { @@ -466,6 +476,8 @@ AND tag_id = ( SELECT id FROM civicrm_tag WHERE name = %2 )"; * * @param int $surveyId * @param int $contactId + * + * @return array * @static */ static function checkSignature($surveyId, $contactId) { diff --git a/CRM/Campaign/BAO/Survey.php b/CRM/Campaign/BAO/Survey.php index e41482bda2..c90b0dd14c 100644 --- a/CRM/Campaign/BAO/Survey.php +++ b/CRM/Campaign/BAO/Survey.php @@ -49,7 +49,11 @@ class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey { /** * The action links that we need to display for the browse screen * - * @var array + * @param $params + * @param $defaults + * + * @return \CRM_Campaign_DAO_Survey|null + * @internal param array $ */ static function retrieve(&$params, &$defaults) { $dao = new CRM_Campaign_DAO_Survey(); @@ -70,6 +74,8 @@ class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey { * survey object. * * + * @param $params + * * @return object CRM_Survey_DAO_Survey object * @access public * @static @@ -326,6 +332,7 @@ SELECT survey.id as id, * * @param $surveyTypes array an array of survey type id. * + * @return array * @static */ static function getSurveyCustomGroups($surveyTypes = array( @@ -379,6 +386,7 @@ SELECT survey.id as id, * * @param int $id survey id * + * @return mixed|null * @access public * @static * @@ -533,7 +541,7 @@ INNER JOIN civicrm_activity_contact activityAssignment } $query .= "AND activityTarget.contact_id IN {$targetContactIds} $whereClause"; - $activity = CRM_Core_DAO::executeQuery($query, $params); + $activity = CRM_Core_DAO::executeQuery($query, $params); while ($activity->fetch()) { $activityDetails[$activity->voter_id] = array( 'voter_id' => $activity->voter_id, diff --git a/CRM/Campaign/StateMachine/Search.php b/CRM/Campaign/StateMachine/Search.php index d1945568ea..180f984151 100755 --- a/CRM/Campaign/StateMachine/Search.php +++ b/CRM/Campaign/StateMachine/Search.php @@ -74,6 +74,8 @@ class CRM_Campaign_StateMachine_Search extends CRM_Core_StateMachine { * * @param CRM_Core_Controller $controller the controller object * + * @param string $formName + * * @return string the name of the form that will handle the task * @access protected */ diff --git a/CRM/Case/BAO/Case.php b/CRM/Case/BAO/Case.php index dc33d0cafd..7002f030e8 100644 --- a/CRM/Case/BAO/Case.php +++ b/CRM/Case/BAO/Case.php @@ -59,7 +59,8 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * pairs * * @param array $params (reference ) an assoc array of name/value pairs - * @param array $ids the array that holds all the db ids + * + * @internal param array $ids the array that holds all the db ids * * @return object CRM_Case_BAO_Case object * @access public @@ -100,7 +101,8 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * takes an associative array and creates a case object * * @param array $params (reference ) an assoc array of name/value pairs - * @param array $ids the array that holds all the db ids + * + * @internal param array $ids the array that holds all the db ids * * @return object CRM_Case_BAO_Case object * @access public @@ -296,6 +298,8 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case { * * @param int $caseId * + * @param string $colName + * * @return case type * @access public * @static @@ -318,6 +322,8 @@ WHERE civicrm_case.id = %1"; * * @param int $caseId id of the case to delete * + * @param bool $moveToTrash + * * @return void * @access public * @static @@ -409,11 +415,12 @@ WHERE civicrm_case.id = %1"; /** * Retrieve contact_id by case_id * - * @param int $caseId ID of the case + * @param int $caseId ID of the case + * + * @param null $contactID * * @return array * @access public - * */ static function retrieveContactIdsByCaseId($caseId, $contactID = NULL) { $caseContact = new CRM_Case_DAO_CaseContact(); @@ -434,7 +441,9 @@ WHERE civicrm_case.id = %1"; /** * Look up a case using an activity ID * - * @param $activity_id + * @param $activityId + * + * @internal param $activity_id * * @return int, case ID */ @@ -501,13 +510,15 @@ WHERE civicrm_case.id = %1"; /** * Retrieve case_id by contact_id * - * @param int $contactId ID of the contact + * @param $contactID * @param boolean $includeDeleted include the deleted cases in result * + * @param null $caseType + * + * @internal param int $contactId ID of the contact * @return array * * @access public - * */ static function retrieveCaseIdsByContactId($contactID, $includeDeleted = FALSE, $caseType = NULL) { $query = " @@ -698,10 +709,11 @@ LEFT JOIN civicrm_option_group aog ON aog.name='activity_type' * * @param String $type /upcoming,recent,all/ * + * @param string $context + * * @return array Array of Cases * * @access public - * */ static function getCases($allCases = TRUE, $userID = NULL, $type = 'upcoming', $context = 'dashboard') { $condition = NULL; @@ -943,6 +955,8 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * * @param int $contactID contact id * @param int $caseID case id + * @param null $relationshipID + * * @return returns case role / relationships * * @static @@ -1000,6 +1014,10 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c * @param array $params posted params * @param int $contactID contact id * + * @param null $context + * @param null $userID + * @param null $type + * * @return returns case activities * * @static @@ -1379,9 +1397,13 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c /** * Function that sends e-mail copy of activity * + * @param $clientId * @param int $activityId activity Id * @param array $contacts array of related contact * + * @param null $attachments + * @param $caseId + * * @return void * @access public */ @@ -1549,12 +1571,9 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c /** * Create an activity for a case via email * - * @param int $file email sent - * - * @return $activity object of newly creted activity via email - * - * @access public + * @param int $file email sent * + * @return array|void $activity object of newly creted activity via email@access public */ static function recordActivityViaEmail($file) { if (!file_exists($file) || @@ -1640,7 +1659,9 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c /** * Function to retrieve the scheduled activity type and date * - * @param array $cases Array of contact and case id + * @param array $cases Array of contact and case id + * + * @param string $type * * @return array $activityInfo Array of scheduled activity type and date * @@ -1845,10 +1866,13 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c /** * Function to create activities when Case or Other roles assigned/modified/deleted. * - * @param int $caseID case id + * @param $caseId * @param int $relationshipId relationship id * @param int $relContactId case role assignee contactId. * + * @param null $contactId + * + * @internal param int $caseID case id * @return void on success creates activity and case activity * * @static @@ -1982,6 +2006,10 @@ SELECT civicrm_contact.id as casemanager_id, /** * Get all cases with no end dates * + * @param array $params + * @param array $excludeCaseIds + * @param bool $excludeDeleted + * * @return array of case and related data keyed on case id */ static function getUnclosedCases($params = array(), $excludeCaseIds = array(), $excludeDeleted = TRUE) { @@ -2254,10 +2282,12 @@ INNER JOIN civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.cas * 1. Merge two duplicate contacts cases - follow CRM-5758 rules. * 2. Merge two cases of same contact - follow CRM-5598 rules. * - * @param int $mainContactId contact id of main contact record. - * @param int $mainCaseId case id of main case record. - * @param int $otherContactId contact id of record which is going to merge. - * @param int $otherCaseId case id of record which is going to merge. + * @param int $mainContactId contact id of main contact record. + * @param int $mainCaseId case id of main case record. + * @param int $otherContactId contact id of record which is going to merge. + * @param int $otherCaseId case id of record which is going to merge. + * + * @param bool $changeClient * * @return void. * @static @@ -3079,6 +3109,8 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; /** * Function to check case configuration. * + * @param null $contactId + * * @return array $configured */ static function isCaseConfigured($contactId = NULL) { @@ -3253,8 +3285,10 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')'; * @see CRM_Core_DAO::buildOptions * * @param String $fieldName - * @param String $context: @see CRM_Core_DAO::buildOptionsContext - * @param Array $props: whatever is known about this dao object + * @param String $context : @see CRM_Core_DAO::buildOptionsContext + * @param Array $props : whatever is known about this dao object + * + * @return Array|bool */ public static function buildOptions($fieldName, $context = NULL, $props = array()) { $className = __CLASS__; diff --git a/CRM/Case/BAO/CaseType.php b/CRM/Case/BAO/CaseType.php index 3a9f02ca1d..16fd0e93f5 100644 --- a/CRM/Case/BAO/CaseType.php +++ b/CRM/Case/BAO/CaseType.php @@ -55,7 +55,8 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * pairs * * @param array $params (reference ) an assoc array of name/value pairs - * @param array $ids the array that holds all the db ids + * + * @internal param array $ids the array that holds all the db ids * * @return object CRM_Case_BAO_CaseType object * @access public @@ -73,7 +74,8 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * * @param array $params input parameters to find object * @param array $values output values of the object - * @param array $ids the array that holds all the db ids + * + * @internal param array $ids the array that holds all the db ids * * @return CRM_Case_BAO_CaseType|null the found object or null * @access public @@ -95,7 +97,8 @@ class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType { * takes an associative array and creates a case type object * * @param array $params (reference ) an assoc array of name/value pairs - * @param array $ids the array that holds all the db ids + * + * @internal param array $ids the array that holds all the db ids * * @return object CRM_Case_BAO_CaseType object * @access public diff --git a/CRM/Case/BAO/Query.php b/CRM/Case/BAO/Query.php index 2872186cfa..c92963b4ab 100644 --- a/CRM/Case/BAO/Query.php +++ b/CRM/Case/BAO/Query.php @@ -49,6 +49,8 @@ class CRM_Case_BAO_Query { /** * build select for Case * + * @param $query + * * @return void * @access public */ @@ -215,6 +217,8 @@ class CRM_Case_BAO_Query { * Given a list of conditions in query generate the required * where clause * + * @param $query + * * @return void * @access public */ @@ -237,6 +241,9 @@ class CRM_Case_BAO_Query { /** * where clause for a single field * + * @param $values + * @param $query + * * @return void * @access public */ diff --git a/CRM/Case/Form/Activity.php b/CRM/Case/Form/Activity.php index b16bf12cec..0f93fb404a 100644 --- a/CRM/Case/Form/Activity.php +++ b/CRM/Case/Form/Activity.php @@ -38,7 +38,7 @@ * */ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { - + /** * The default variable defined * @@ -354,9 +354,11 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { /** * global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any - * @param array $options additional user data + * @param array $fields the input form values + * @param array $files the uploaded files if any + * @param $self + * + * @internal param array $options additional user data * * @return true if no errors, else array of errors * @access public @@ -376,6 +378,8 @@ class CRM_Case_Form_Activity extends CRM_Activity_Form_Activity { * * @access public * + * @param null $params + * * @return void */ public function postProcess($params = NULL) { diff --git a/CRM/Case/Form/Activity/ChangeCaseStartDate.php b/CRM/Case/Form/Activity/ChangeCaseStartDate.php index 1e2cfede90..2f2f9ef875 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStartDate.php +++ b/CRM/Case/Form/Activity/ChangeCaseStartDate.php @@ -51,6 +51,8 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { * * @access public * + * @param $form + * * @return void */ static function setDefaultValues(&$form) { @@ -117,6 +119,10 @@ class CRM_Case_Form_Activity_ChangeCaseStartDate { * * @access public * + * @param $form + * @param $params + * @param $activity + * * @return void */ static function endPostProcess(&$form, &$params, $activity) { diff --git a/CRM/Case/Form/Activity/ChangeCaseStatus.php b/CRM/Case/Form/Activity/ChangeCaseStatus.php index 5439004700..0e7a68fb02 100644 --- a/CRM/Case/Form/Activity/ChangeCaseStatus.php +++ b/CRM/Case/Form/Activity/ChangeCaseStatus.php @@ -51,6 +51,8 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { * * @access public * + * @param $form + * * @return void */ static function setDefaultValues(&$form) { @@ -96,6 +98,9 @@ class CRM_Case_Form_Activity_ChangeCaseStatus { * * @param array $values posted values of the form * + * @param $files + * @param $form + * * @return array list of errors to be posted back to the form * @static * @access public diff --git a/CRM/Case/Form/Activity/ChangeCaseType.php b/CRM/Case/Form/Activity/ChangeCaseType.php index 9c7aaf4db4..9cb5864c67 100644 --- a/CRM/Case/Form/Activity/ChangeCaseType.php +++ b/CRM/Case/Form/Activity/ChangeCaseType.php @@ -51,6 +51,8 @@ class CRM_Case_Form_Activity_ChangeCaseType { * * @access public * + * @param $form + * * @return void */ static function setDefaultValues(&$form) { @@ -92,6 +94,9 @@ class CRM_Case_Form_Activity_ChangeCaseType { * * @param array $values posted values of the form * + * @param $files + * @param $form + * * @return array list of errors to be posted back to the form * @static * @access public diff --git a/CRM/Case/Form/Activity/LinkCases.php b/CRM/Case/Form/Activity/LinkCases.php index 5449605cf7..636036fd7b 100644 --- a/CRM/Case/Form/Activity/LinkCases.php +++ b/CRM/Case/Form/Activity/LinkCases.php @@ -65,6 +65,8 @@ class CRM_Case_Form_Activity_LinkCases { * * @access public * + * @param $form + * * @return void */ static function setDefaultValues(&$form) { @@ -80,6 +82,9 @@ class CRM_Case_Form_Activity_LinkCases { * * @param array $values posted values of the form * + * @param $files + * @param $form + * * @return array list of errors to be posted back to the form * @static * @access public diff --git a/CRM/Case/Form/Activity/OpenCase.php b/CRM/Case/Form/Activity/OpenCase.php index 101cf7c8ea..03f4ea68fd 100644 --- a/CRM/Case/Form/Activity/OpenCase.php +++ b/CRM/Case/Form/Activity/OpenCase.php @@ -206,6 +206,9 @@ class CRM_Case_Form_Activity_OpenCase { * * @access public * + * @param $form + * @param $params + * * @return void */ static function beginPostProcess(&$form, &$params) { diff --git a/CRM/Case/StateMachine/Search.php b/CRM/Case/StateMachine/Search.php index 3ee7d6191e..f8a7bc10a5 100644 --- a/CRM/Case/StateMachine/Search.php +++ b/CRM/Case/StateMachine/Search.php @@ -76,6 +76,8 @@ class CRM_Case_StateMachine_Search extends CRM_Core_StateMachine { * * @param CRM_Core_Controller $controller the controller object * + * @param string $formName + * * @return string the name of the form that will handle the task * @access protected */ diff --git a/CRM/Contact/BAO/Contact.php b/CRM/Contact/BAO/Contact.php index 5b5d0985cf..c0cada5018 100644 --- a/CRM/Contact/BAO/Contact.php +++ b/CRM/Contact/BAO/Contact.php @@ -1733,8 +1733,13 @@ ORDER BY civicrm_email.is_primary DESC"; * @params array $fields array of fields from UFGroup * @params int $addToGroupID specifies the default group to which contact is added. * @params int $ufGroupId uf group id (profile id) - * @param string $ctype contact type - * @param boolean $visibility basically lets us know where this request is coming from + * @param $params + * @param $fields + * @param null $contactID + * @param null $addToGroupID + * @param null $ufGroupId + * @param string $ctype contact type + * @param boolean $visibility basically lets us know where this request is coming from * if via a profile from web, we restrict what groups are changed * * @return int contact id created/edited @@ -2704,6 +2709,8 @@ AND civicrm_openid.is_primary = 1"; /** * Function to build context menu items. * + * @param null $contactId + * * @return array of context menu for logged in user. * @static */ @@ -3000,8 +3007,10 @@ LEFT JOIN civicrm_address add2 ON ( add1.master_id = add2.id ) /** * Get the creation/modification times for a contact * + * @param $contactId + * * @return array('created_date' => $, 'modified_date' => $) - */ + */ static function getTimestamps($contactId) { $timestamps = CRM_Core_DAO::executeQuery( 'SELECT created_date, modified_date @@ -3137,8 +3146,10 @@ LEFT JOIN civicrm_address add2 ON ( add1.master_id = add2.id ) * TODO: In context of chainselect, what to return if e.g. a country has no states? * * @param String $fieldName - * @param String $context: @see CRM_Core_DAO::buildOptionsContext - * @param Array $props: whatever is known about this dao object + * @param String $context : @see CRM_Core_DAO::buildOptionsContext + * @param Array $props : whatever is known about this dao object + * + * @return Array|bool */ public static function buildOptions($fieldName, $context = NULL, $props = array()) { $params = array(); @@ -3158,8 +3169,9 @@ LEFT JOIN civicrm_address add2 ON ( add1.master_id = add2.id ) * Ensures that is_primary gets assigned to another object if available * Also calls pre/post hooks * - * @var $type: object type - * @var $id: object id + * @var $type : object type + * @var $id : object id + * @return bool */ public static function deleteObjectWithPrimary($type, $id) { if (!$id || !is_numeric($id)) { diff --git a/CRM/Contact/BAO/Contact/Location.php b/CRM/Contact/BAO/Contact/Location.php index 2a4a28214a..a9e2903996 100644 --- a/CRM/Contact/BAO/Contact/Location.php +++ b/CRM/Contact/BAO/Contact/Location.php @@ -37,7 +37,10 @@ class CRM_Contact_BAO_Contact_Location { /** * function to get the display name, primary email, location type and location id of a contact * - * @param int $id id of the contact + * @param int $id id of the contact + * + * @param bool $isPrimary + * @param null $locationTypeID * * @return array of display_name, email, location type and location id if found, or (null,null,null, null) * @static diff --git a/CRM/Contact/BAO/Contact/Permission.php b/CRM/Contact/BAO/Contact/Permission.php index 28d286f318..8243b9989f 100644 --- a/CRM/Contact/BAO/Contact/Permission.php +++ b/CRM/Contact/BAO/Contact/Permission.php @@ -37,8 +37,8 @@ class CRM_Contact_BAO_Contact_Permission { /** * check if the logged in user has permissions for the operation type * - * @param int $id contact id - * @param string $type the type of operation (view|edit) + * @param int $id contact id + * @param int|string $type the type of operation (view|edit) * * @return boolean true if the user has permission, false otherwise * @access public @@ -351,7 +351,7 @@ WHERE (( contact_id_a = %1 AND contact_id_b = %2 AND is_permission_a_b = 1 ) OR CRM_Core_DAO::executeQuery('SET @civicrm_user_id = %1', array(1 => array($contactID, 'Integer')) ); - + return TRUE; } @@ -361,7 +361,7 @@ WHERE (( contact_id_a = %1 AND contact_id_b = %2 AND is_permission_a_b = 1 ) OR // if result is already validated, and url has cs, set the flag. $session->set('authSrc', CRM_Core_Permission::AUTH_SRC_CHECKSUM); } else if (($session->get('authSrc') & CRM_Core_Permission::AUTH_SRC_CHECKSUM) == CRM_Core_Permission::AUTH_SRC_CHECKSUM) { - // if checksum wasn't present in REQUEST OR checksum result validated as FALSE, + // if checksum wasn't present in REQUEST OR checksum result validated as FALSE, // and flag was already set exactly as AUTH_SRC_CHECKSUM, unset it. $session->set('authSrc', CRM_Core_Permission::AUTH_SRC_UNKNOWN); } diff --git a/CRM/Contact/BAO/GroupContactCache.php b/CRM/Contact/BAO/GroupContactCache.php index 9e13d05bd8..9a82607c45 100644 --- a/CRM/Contact/BAO/GroupContactCache.php +++ b/CRM/Contact/BAO/GroupContactCache.php @@ -40,7 +40,9 @@ class CRM_Contact_BAO_GroupContactCache extends CRM_Contact_DAO_GroupContactCach * Check to see if we have cache entries for this group * if not, regenerate, else return * - * @param int $groupID groupID of group that we are checking against + * @param $groupIDs + * + * @internal param int $groupID groupID of group that we are checking against * * @return boolean true if we did not regenerate, false if we did */ diff --git a/CRM/Contact/BAO/GroupNesting.php b/CRM/Contact/BAO/GroupNesting.php index 2727e68b64..73ea6d8e94 100644 --- a/CRM/Contact/BAO/GroupNesting.php +++ b/CRM/Contact/BAO/GroupNesting.php @@ -578,9 +578,7 @@ class CRM_Contact_BAO_GroupNesting extends CRM_Contact_DAO_GroupNesting implemen * * @param $groupIds An array of valid group ids (passed by reference) * - * @return $groupIdArray List of groupIds that represent the requested group and its parents - * - * @access public + * @return array $groupIdArray List of groupIds that represent the requested group and its parents@access public */ static function getParentGroupIds($groupIds) { if (!is_array($groupIds)) { diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php index 42589ddbc5..c0ea1bdc1e 100644 --- a/CRM/Contact/BAO/Query.php +++ b/CRM/Contact/BAO/Query.php @@ -2231,6 +2231,7 @@ class CRM_Contact_BAO_Query { * @param array $params * @param array $fields * @param array $tables + * @param $whereTables * @param boolean $strict * * @return string @@ -2253,8 +2254,11 @@ class CRM_Contact_BAO_Query { * * @param array $tables tables that need to be included in this from clause * if null, return mimimal from clause (i.e. civicrm_contact) - * @param array $inner tables that should be inner-joined - * @param array $right tables that should be right-joined + * @param array $inner tables that should be inner-joined + * @param array $right tables that should be right-joined + * + * @param bool $primaryLocation + * @param int $mode * * @return string the from clause * @access public @@ -2482,6 +2486,8 @@ class CRM_Contact_BAO_Query { /** * WHERE / QILL clause for deleted_contacts * + * @param $values + * * @return void */ function deletedContacts($values) { @@ -2495,6 +2501,8 @@ class CRM_Contact_BAO_Query { /** * where / qill clause for contact_type * + * @param $values + * * @return void * @access public */ @@ -2561,6 +2569,8 @@ class CRM_Contact_BAO_Query { /** * where / qill clause for contact_sub_type * + * @param $values + * * @return void * @access public */ @@ -2594,6 +2604,8 @@ class CRM_Contact_BAO_Query { /** * where / qill clause for groups * + * @param $values + * * @return void * @access public */ @@ -2701,6 +2713,8 @@ class CRM_Contact_BAO_Query { /** * where / qill clause for smart groups * + * @param $values + * * @return void * @access public */ @@ -2765,6 +2779,8 @@ WHERE id IN ( $groupIDs ) /** * where / qill clause for cms users * + * @param $values + * * @return void * @access public */ @@ -2787,6 +2803,8 @@ WHERE id IN ( $groupIDs ) /** * all tag search specific * + * @param $values + * * @return void * @access public */ @@ -2853,6 +2871,8 @@ WHERE id IN ( $groupIDs ) /** * where / qill clause for tag * + * @param $values + * * @return void * @access public */ @@ -2938,6 +2958,8 @@ WHERE id IN ( $groupIDs ) /** * where/qill clause for notes * + * @param $values + * * @return void * @access public */ @@ -3007,6 +3029,8 @@ WHERE id IN ( $groupIDs ) /** * where / qill clause for sort_name * + * @param $values + * * @return void * @access public */ @@ -3164,6 +3188,8 @@ WHERE id IN ( $groupIDs ) /** * where / qill clause for email * + * @param $values + * * @return void * @access public */ @@ -3205,6 +3231,8 @@ WHERE id IN ( $groupIDs ) /** * where / qill clause for phone number * + * @param $values + * * @return void * @access public */ @@ -3226,6 +3254,8 @@ WHERE id IN ( $groupIDs ) /** * where / qill clause for phone type/location * + * @param $values + * * @return void * @access public */ @@ -3242,6 +3272,8 @@ WHERE id IN ( $groupIDs ) /** * where / qill clause for street_address * + * @param $values + * * @return void * @access public */ @@ -3275,6 +3307,8 @@ WHERE id IN ( $groupIDs ) /** * where / qill clause for street_unit * + * @param $values + * * @return void * @access public */ @@ -3308,6 +3342,8 @@ WHERE id IN ( $groupIDs ) /** * where / qill clause for sorting by character * + * @param $values + * * @return void * @access public */ @@ -3345,6 +3381,8 @@ WHERE id IN ( $groupIDs ) /** * where / qill clause for postal code * + * @param $values + * * @return void * @access public */ @@ -3385,6 +3423,9 @@ WHERE id IN ( $groupIDs ) /** * where / qill clause for location type * + * @param $values + * @param null $status + * * @return void * @access public */ @@ -3496,6 +3537,9 @@ WHERE id IN ( $groupIDs ) /** * where / qill clause for county (if present) * + * @param $values + * @param null $status + * * @return void * @access public */ @@ -3562,6 +3606,9 @@ WHERE id IN ( $groupIDs ) /** * where / qill clause for state/province AND country (if present) * + * @param $values + * @param null $status + * * @return void * @access public */ @@ -3655,6 +3702,8 @@ WHERE id IN ( $groupIDs ) /** * where / qill clause for change log * + * @param $values + * * @return void * @access public */ @@ -3819,6 +3868,8 @@ WHERE id IN ( $groupIDs ) /** * where / qill clause for relationship * + * @param $values + * * @return void * @access public */ @@ -4014,9 +4065,12 @@ civicrm_relationship.is_permission_a_b = 0 } } } + /** * default set of return properties * + * @param int $mode + * * @return void * @access public */ @@ -4231,16 +4285,19 @@ civicrm_relationship.is_permission_a_b = 0 /** * create and query the db for an contact search * - * @param int $offset the offset for the query - * @param int $rowCount the number of rows to return - * @param string $sort the order by string - * @param boolean $count is this a count only query ? - * @param boolean $includeContactIds should we include contact ids? - * @param boolean $sortByChar if true returns the distinct array of first characters for search results - * @param boolean $groupContacts if true, return only the contact ids - * @param boolean $returnQuery should we return the query as a string - * @param string $additionalWhereClause if the caller wants to further restrict the search (used for components) - * @param string $additionalFromClause should be clause with proper joins, effective to reduce where clause load. + * @param int $offset the offset for the query + * @param int $rowCount the number of rows to return + * @param string $sort the order by string + * @param boolean $count is this a count only query ? + * @param boolean $includeContactIds should we include contact ids? + * @param boolean $sortByChar if true returns the distinct array of first characters for search results + * @param boolean $groupContacts if true, return only the contact ids + * @param boolean $returnQuery should we return the query as a string + * @param string $additionalWhereClause if the caller wants to further restrict the search (used for components) + * @param null $sortOrder + * @param string $additionalFromClause should be clause with proper joins, effective to reduce where clause load. + * + * @param bool $skipOrderAndLimit * * @return CRM_Contact_DAO_Contact * @access public diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php index e2d30b4cfe..1a3750ea34 100644 --- a/CRM/Contact/BAO/Relationship.php +++ b/CRM/Contact/BAO/Relationship.php @@ -562,6 +562,8 @@ class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship { * @param int $id relationship id * * $returns returns the contact ids in the realtionship + * + * @return \CRM_Contact_DAO_Relationship * @access public * @static */ @@ -724,9 +726,10 @@ WHERE relationship_type_id = " . CRM_Utils_Type::escape($type, 'Integer'); /** * update the is_active flag in the db * - * @param int $id id of the database record - * @param boolean $is_active value we want to set the is_active field + * @param int $id id of the database record + * @param boolean $is_active value we want to set the is_active field * + * @throws CiviCRM_API3_Exception * @return Object DAO object on success, null otherwise * @static */ @@ -796,10 +799,13 @@ WHERE relationship_type_id = " . CRM_Utils_Type::escape($type, 'Integer'); * @param int $numRelationship no of relationships to display (limit) * @param int $count get the no of relationships * $param int $relationshipId relationship id - * @param string $direction the direction we are interested in a_b or b_a + * @param $relationshipId + * @param string $direction the direction we are interested in a_b or b_a * @param array $params array of extra values including relationship_type_id per api spec * * return string the query for this diretion + * + * @return array * @static * @access public */ @@ -940,6 +946,13 @@ LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id) * $param boolean $permissionedContact to return only permissioned Contact * $param array $params array of variables consistent with filters supported by the api * return array $values relationship records + * @param int $relationshipId + * @param null $links + * @param null $permissionMask + * @param bool $permissionedContact + * @param array $params + * + * @return array|int * @static * @access public */ @@ -1416,10 +1429,7 @@ SELECT count(*) * * @param $contactIds Contact Ids * - * @return $currentEmployer array of the current employer - * - * @static - * + * @return array $currentEmployer array of the current employer@static */ static function getCurrentEmployer($contactIds) { $contacts = implode(',', $contactIds); @@ -1574,6 +1584,9 @@ AND cc.sort_name LIKE '%$name%'"; * (as opposed to those who inherit a particular membership * * @param array $params api input array + * @param null $direction + * + * @return array */ static function membershipTypeToRelationshipTypes(&$params, $direction = NULL) { $membershipType = civicrm_api3('membership_type', 'getsingle', array('id' => $params['membership_type_id'], 'return' => 'relationship_type_id, relationship_direction')); diff --git a/CRM/Contact/BAO/RelationshipType.php b/CRM/Contact/BAO/RelationshipType.php index 0f410357a5..58ec7cefd5 100644 --- a/CRM/Contact/BAO/RelationshipType.php +++ b/CRM/Contact/BAO/RelationshipType.php @@ -133,6 +133,9 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType * Function to delete Relationship Types * * @param int $relationshipTypeId + * + * @throws CRM_Core_Exception + * @return mixed * @static */ static function del($relationshipTypeId) { diff --git a/CRM/Contact/BAO/SavedSearch.php b/CRM/Contact/BAO/SavedSearch.php index 02a3fe5974..051ad3c5d0 100644 --- a/CRM/Contact/BAO/SavedSearch.php +++ b/CRM/Contact/BAO/SavedSearch.php @@ -253,6 +253,8 @@ LEFT JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_ * * @param int $id the id of the saved search * + * @param string $value + * * @return string the name of the saved search * @access public * @static diff --git a/CRM/Contact/Form/Contact.php b/CRM/Contact/Form/Contact.php index 2445ba7299..4ca9547786 100644 --- a/CRM/Contact/Form/Contact.php +++ b/CRM/Contact/Form/Contact.php @@ -602,12 +602,11 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { /** * global validation rules for the form * - * @param array $fields posted values of the form - * @param array $errors list of errors to be posted back to the form - * @param int $contactId contact id if doing update. + * @param array $fields posted values of the form + * @param array $errors list of errors to be posted back to the form + * @param int $contactId contact id if doing update. * - * @return $primaryID email/openId - * @static + * @return bool $primaryID email/openId@static * @access public */ static function formRule($fields, &$errors, $contactId = NULL) { @@ -1199,15 +1198,16 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { /** * Parse all address blocks present in given params - * and return parse result for all address blocks, - * This function either parse street address in to child - * elements or build street address from child elements. - * - * @params $params an array of key value consist of address blocks. - * - * @return $parseSuccess as array of sucess/fails for each address block - * @static - */ + * and return parse result for all address blocks, + * This function either parse street address in to child + * elements or build street address from child elements. + * + * @params $params an array of key value consist of address blocks. + * + * @param $params + * + * @return array $parseSuccess as array of sucess/fails for each address block@static + */ function parseAddress(&$params) { $parseSuccess = $parsedFields = array(); if (!is_array($params['address']) || @@ -1291,8 +1291,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * * @param $parseResult an array of address blk instance and its status. * - * @return $statusMsg string status message for all address blocks. - * @static + * @return null|string $statusMsg string status message for all address blocks.@static */ static function parseAddressStatusMsg($parseResult) { $statusMsg = NULL; @@ -1358,7 +1357,7 @@ class CRM_Contact_Form_Contact extends CRM_Core_Form { * * @param $deceasedParams array having contact id and deceased value. * - * @return $updateMembershipMsg string status message for updated membership. + * @return null|string $updateMembershipMsg string status message for updated membership. */ function updateMembershipStatus($deceasedParams) { $updateMembershipMsg = NULL; diff --git a/CRM/Contact/Form/Edit/CommunicationPreferences.php b/CRM/Contact/Form/Edit/CommunicationPreferences.php index b0951f6f3f..1c0fa4b091 100644 --- a/CRM/Contact/Form/Edit/CommunicationPreferences.php +++ b/CRM/Contact/Form/Edit/CommunicationPreferences.php @@ -133,9 +133,11 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { /** * global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any - * @param array $options additional user data + * @param array $fields the input form values + * @param array $files the uploaded files if any + * @param $self + * + * @internal param array $options additional user data * * @return true if no errors, else array of errors * @access public @@ -162,6 +164,9 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { * * @access public * + * @param $form + * @param $defaults + * * @return void */ static function setDefaultValues(&$form, &$defaults) { @@ -204,6 +209,8 @@ class CRM_Contact_Form_Edit_CommunicationPreferences { /** * set array of greeting fields * + * @param $contactType + * * @return void * @access public */ diff --git a/CRM/Contact/Form/Edit/CustomData.php b/CRM/Contact/Form/Edit/CustomData.php index 3ee652ba6a..b1c3ceb801 100644 --- a/CRM/Contact/Form/Edit/CustomData.php +++ b/CRM/Contact/Form/Edit/CustomData.php @@ -41,6 +41,8 @@ class CRM_Contact_Form_Edit_CustomData { /** * build all the data structures needed to build the form * + * @param $form + * * @return void * @access public */ @@ -105,6 +107,9 @@ class CRM_Contact_Form_Edit_CustomData { * * @access public * + * @param $form + * @param $defaults + * * @return void */ static function setDefaultValues(&$form, &$defaults) { diff --git a/CRM/Contact/Form/Edit/Demographics.php b/CRM/Contact/Form/Edit/Demographics.php index 2f9dc8fed7..a54bb4864e 100644 --- a/CRM/Contact/Form/Edit/Demographics.php +++ b/CRM/Contact/Form/Edit/Demographics.php @@ -71,6 +71,9 @@ class CRM_Contact_Form_Edit_Demographics { * * @access public * + * @param $form + * @param $defaults + * * @return void */ static function setDefaultValues(&$form, &$defaults) {} diff --git a/CRM/Contact/Form/Edit/Household.php b/CRM/Contact/Form/Edit/Household.php index 95b1ebed68..e38294250a 100644 --- a/CRM/Contact/Form/Edit/Household.php +++ b/CRM/Contact/Form/Edit/Household.php @@ -82,8 +82,11 @@ class CRM_Contact_Form_Edit_Household { * * @params array $fields array of form values * - * @return $error - * @static + * @param $fields + * @param $files + * @param null $contactID + * + * @return array|bool $error@static * @public */ static function formRule($fields, $files, $contactID = NULL) { diff --git a/CRM/Contact/Form/Edit/Individual.php b/CRM/Contact/Form/Edit/Individual.php index c5b872e3c2..8df832970c 100644 --- a/CRM/Contact/Form/Edit/Individual.php +++ b/CRM/Contact/Form/Edit/Individual.php @@ -145,9 +145,11 @@ class CRM_Contact_Form_Edit_Individual { /** * global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any - * @param array $options additional user data + * @param array $fields the input form values + * @param array $files the uploaded files if any + * @param null $contactID + * + * @internal param array $options additional user data * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Contact/Form/Edit/TagsAndGroups.php b/CRM/Contact/Form/Edit/TagsAndGroups.php index 2b2366a42f..21a4f2f74e 100644 --- a/CRM/Contact/Form/Edit/TagsAndGroups.php +++ b/CRM/Contact/Form/Edit/TagsAndGroups.php @@ -45,13 +45,16 @@ class CRM_Contact_Form_Edit_TagsAndGroups { * This function is to build form elements * params object $form object of the form * - * @param Object $form the form object that we are operating on - * @param int $contactId contact id - * @param int $type what components are we interested in - * @param boolean $visibility visibility of the field - * @param string $groupName if used for building group block - * @param string $tagName if used for building tag block - * @param string $fieldName this is used in batch profile(i.e to build multiple blocks) + * @param Object $form the form object that we are operating on + * @param int $contactId contact id + * @param int $type what components are we interested in + * @param boolean $visibility visibility of the field + * @param null $isRequired + * @param string $groupName if used for building group block + * @param string $tagName if used for building tag block + * @param string $fieldName this is used in batch profile(i.e to build multiple blocks) + * + * @param string $groupElementType * * @static * @access public @@ -110,7 +113,7 @@ class CRM_Contact_Form_Edit_TagsAndGroups { ) { continue; } - + if ($groupElementType == 'select') { $groupsOptions[$id] = $group['title']; } @@ -170,11 +173,13 @@ class CRM_Contact_Form_Edit_TagsAndGroups { /** * set defaults for relevant form elements * - * @param int $id the contact id - * @param array $defaults the defaults array to store the values in - * @param int $type what components are we interested in + * @param int $id the contact id + * @param array $defaults the defaults array to store the values in + * @param int $type what components are we interested in * @param string $fieldName this is used in batch profile(i.e to build multiple blocks) * + * @param string $groupElementType + * * @return void * @access public * @static @@ -221,6 +226,9 @@ class CRM_Contact_Form_Edit_TagsAndGroups { * * @access public * + * @param $form + * @param $defaults + * * @return void */ public static function setDefaultValues(&$form, &$defaults) { diff --git a/CRM/Contact/Form/Inline/Lock.php b/CRM/Contact/Form/Inline/Lock.php index 837eaa3f87..72423c5c9f 100644 --- a/CRM/Contact/Form/Inline/Lock.php +++ b/CRM/Contact/Form/Inline/Lock.php @@ -91,6 +91,8 @@ class CRM_Contact_Form_Inline_Lock { /** * Return any post-save data * + * @param $contactID + * * @return array extra options to return in JSON */ static function getResponse($contactID) { diff --git a/CRM/Contact/Form/Location.php b/CRM/Contact/Form/Location.php index 980209d4ff..a77a9bba22 100644 --- a/CRM/Contact/Form/Location.php +++ b/CRM/Contact/Form/Location.php @@ -37,6 +37,8 @@ class CRM_Contact_Form_Location { /** * Function to set variables up before form is built * + * @param $form + * * @return void */ static function preProcess(&$form) { diff --git a/CRM/Contact/Form/ProfileContact.php b/CRM/Contact/Form/ProfileContact.php index 8c865da177..49a6a5ee1d 100644 --- a/CRM/Contact/Form/ProfileContact.php +++ b/CRM/Contact/Form/ProfileContact.php @@ -39,6 +39,8 @@ class CRM_Contact_Form_ProfileContact { /** * Function to set variables up before form is built * + * @param $form + * * @return void * @access public */ @@ -76,8 +78,9 @@ class CRM_Contact_Form_ProfileContact { * Function to build form for honoree contact / on behalf of organization. * * @param $form object invoking Object - * @param $contactType string contact type - * @param $title string fieldset title + * + * @internal param string $contactType contact type + * @internal param string $title fieldset title * * @static */ diff --git a/CRM/Contact/Form/Task.php b/CRM/Contact/Form/Task.php index a569029b62..64a0104d7f 100644 --- a/CRM/Contact/Form/Task.php +++ b/CRM/Contact/Form/Task.php @@ -371,7 +371,11 @@ class CRM_Contact_Form_Task extends CRM_Core_Form { * the form with a customized title for the main Submit * * @param string $title title of the main button - * @param string $type button type for the form after processing + * @param string $nextType + * @param string $backType + * @param bool $submitOnce + * + * @internal param string $type button type for the form after processing * * @return void * @access public diff --git a/CRM/Contact/Form/Task/Label.php b/CRM/Contact/Form/Task/Label.php index 13442b752b..e036741723 100644 --- a/CRM/Contact/Form/Task/Label.php +++ b/CRM/Contact/Form/Task/Label.php @@ -358,9 +358,12 @@ class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task { /** * Check for presence of tokens to be swapped out + * * @param array $contact * @param array $mailingFormatProperties * @param array $tokenFields + * + * @return bool */ function tokenIsFound($contact, $mailingFormatProperties, $tokenFields) { foreach (array_merge($mailingFormatProperties, array_fill_keys($tokenFields, 1)) as $key => $dontCare) { diff --git a/CRM/Contact/Form/Task/LabelCommon.php b/CRM/Contact/Form/Task/LabelCommon.php index 2085272009..cfeba4f747 100644 --- a/CRM/Contact/Form/Task/LabelCommon.php +++ b/CRM/Contact/Form/Task/LabelCommon.php @@ -41,9 +41,12 @@ class CRM_Contact_Form_Task_LabelCommon { /** * Check for presence of tokens to be swapped out + * * @param array $contact * @param array $mailingFormatProperties * @param array $tokenFields + * + * @return bool */ function tokenIsFound($contact, $mailingFormatProperties, $tokenFields) { foreach (array_merge($mailingFormatProperties, array_fill_keys($tokenFields, 1)) as $key => $dontCare) { diff --git a/CRM/Contact/Form/Task/Map.php b/CRM/Contact/Form/Task/Map.php index 375b28b7ce..270074618e 100644 --- a/CRM/Contact/Form/Task/Map.php +++ b/CRM/Contact/Form/Task/Map.php @@ -145,9 +145,14 @@ class CRM_Contact_Form_Task_Map extends CRM_Contact_Form_Task { /** * assign smarty variables to the template that will be used by google api to plot the contacts * - * @param array $contactIds list of contact ids that we need to plot - * @param int $locationId location_id + * @param $ids + * @param int $locationId location_id * + * @param $page + * @param $addBreadCrumb + * @param string $type + * + * @internal param array $contactIds list of contact ids that we need to plot * @return string the location of the file we have created * @access protected */ diff --git a/CRM/Contact/Import/Form/DataSource.php b/CRM/Contact/Import/Form/DataSource.php index 23c61afba0..a31e5086ed 100644 --- a/CRM/Contact/Import/Form/DataSource.php +++ b/CRM/Contact/Import/Form/DataSource.php @@ -351,6 +351,9 @@ class CRM_Contact_Import_Form_DataSource extends CRM_Core_Form { * Add a PK and status column to the import table so we can track our progress * Returns the name of the primary key and status columns * + * @param $db + * @param $importTableName + * * @return array * @access private */ diff --git a/CRM/Contact/Import/Parser/Contact.php b/CRM/Contact/Import/Parser/Contact.php index f2d4f81eb7..d4e915e517 100644 --- a/CRM/Contact/Import/Parser/Contact.php +++ b/CRM/Contact/Import/Parser/Contact.php @@ -1303,6 +1303,8 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { * @param string $gender check this value across gender values. * * retunr gender value / false + * + * @return bool * @access public */ public function checkGender($gender) { @@ -1330,7 +1332,8 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * function to check if an error in Core( non-custom fields ) field * - * @param String $errorMessage A string containing all the error-fields. + * @param $params + * @param String $errorMessage A string containing all the error-fields. * * @access public */ @@ -1600,6 +1603,9 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * function to ckeck a value present or not in a array * + * @param $value + * @param $valueArray + * * @return ture if value present in array or retun false * * @access public @@ -2039,9 +2045,11 @@ class CRM_Contact_Import_Parser_Contact extends CRM_Contact_Import_Parser { /** * Function to generate status and error message for unparsed street address records. * - * @param array $values the array of values belonging to each row - * @param array $statusFieldName store formatted date in this array - + * @param array $values the array of values belonging to each row + * @param array $statusFieldName store formatted date in this array + * @param $returnCode + * + * @return int * @access public */ function processMessage(&$values, $statusFieldName, $returnCode) { diff --git a/CRM/Contact/Page/DedupeFind.php b/CRM/Contact/Page/DedupeFind.php index 1d21e9c062..99e52addb9 100644 --- a/CRM/Contact/Page/DedupeFind.php +++ b/CRM/Contact/Page/DedupeFind.php @@ -350,6 +350,8 @@ class CRM_Contact_Page_DedupeFind extends CRM_Core_Page_Basic { /** * Get user context * + * @param null $mode + * * @return string user context */ function userContext($mode = NULL) { diff --git a/CRM/Contact/Page/View/GroupContact.php b/CRM/Contact/Page/View/GroupContact.php index 569e37ea8a..32ae9d45e5 100644 --- a/CRM/Contact/Page/View/GroupContact.php +++ b/CRM/Contact/Page/View/GroupContact.php @@ -73,7 +73,9 @@ class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page { /** * This function is called when action is update * - * @param int $groupID group id + * @param null $groupId + * + * @internal param int $groupID group id * * return null * @access public @@ -152,6 +154,9 @@ class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page { * @param string $status this is the status that should be updated. * * $access public + * @param $contactID + * + * @return bool */ static function del($groupContactId, $status, $contactID) { $groupId = CRM_Contact_BAO_GroupContact::getGroupId($groupContactId); diff --git a/CRM/Contact/Page/View/UserDashBoard/GroupContact.php b/CRM/Contact/Page/View/UserDashBoard/GroupContact.php index cd06bd0afe..cfedeb4d9e 100644 --- a/CRM/Contact/Page/View/UserDashBoard/GroupContact.php +++ b/CRM/Contact/Page/View/UserDashBoard/GroupContact.php @@ -78,7 +78,9 @@ class CRM_Contact_Page_View_UserDashBoard_GroupContact extends CRM_Contact_Page_ /** * This function is called when action is update * - * @param int $groupID group id + * @param null $groupId + * + * @internal param int $groupID group id * * return null * @access public diff --git a/CRM/Contact/Selector.php b/CRM/Contact/Selector.php index 344820c82a..a7e38b0b15 100644 --- a/CRM/Contact/Selector.php +++ b/CRM/Contact/Selector.php @@ -134,9 +134,16 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se /** * Class constructor * + * @param $customSearchClass * @param array $formValues array of form values imported - * @param array $params array of parameters for query - * @param int $action - action of search basic or advanced. + * @param array $params array of parameters for query + * @param null $returnProperties + * @param \const|int $action - action of search basic or advanced. + * + * @param bool $includeContactIds + * @param bool $searchDescendentGroups + * @param string $searchContext + * @param null $contextMenu * * @return CRM_Contact_Selector * @access public @@ -297,7 +304,10 @@ class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Se /** * getter for array of the parameters required for creating pager. * - * @param + * @param $action + * @param $params + * + * @internal param $ * @access public */ function getPagerParams($action, &$params) { @@ -1001,9 +1011,10 @@ SELECT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', contact_a.dis * * @param int $start start for limit clause * @param int $end end for limit clause - * @param $object $sort sort object + * @param $sort * @param string $cacheKey cache key * + * @internal param $object $sort sort object * @return void */ function rebuildPreNextCache($start, $end, $sort, $cacheKey) { diff --git a/CRM/Contact/StateMachine/Search.php b/CRM/Contact/StateMachine/Search.php index f8593b7043..835d4a8553 100644 --- a/CRM/Contact/StateMachine/Search.php +++ b/CRM/Contact/StateMachine/Search.php @@ -88,6 +88,8 @@ class CRM_Contact_StateMachine_Search extends CRM_Core_StateMachine { * * @param CRM_Core_Controller $controller the controller object * + * @param string $formName + * * @return string the name of the form that will handle the task * @access protected */ diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php index 04e461e146..181adf5f38 100644 --- a/CRM/Contribute/BAO/Contribution.php +++ b/CRM/Contribute/BAO/Contribution.php @@ -1191,8 +1191,11 @@ LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.cont /** * Delete billing address record related contribution * - * @param int $contact_id contact id - * @param int $contribution_id contributionId + * @param null $contributionId + * @param null $contactId + * + * @internal param int $contact_id contact id + * @internal param int $contribution_id contributionId * @access public * @static */ @@ -2416,6 +2419,8 @@ WHERE contribution_id = %1 "; * * @param int $contributionId contribution id * + * @param bool $isNotCancelled + * * @return boolean * @access public * @static @@ -2472,6 +2477,9 @@ WHERE contribution_id = %1 "; * @param array $params contribution object, line item array and params for trxn * * + * @param null $financialTrxnVals + * + * @return null|object * @access public * @static */ @@ -2742,6 +2750,8 @@ WHERE contribution_id = %1 "; * * @param string $context update scenarios * + * @param null $skipTrxn + * * @access public * @static */ @@ -2891,6 +2901,7 @@ WHERE contribution_id = %1 "; * * @param array $errors list of errors * + * @return bool * @access public * @static */ @@ -2939,8 +2950,10 @@ WHERE contribution_id = %1 "; * @see CRM_Core_DAO::buildOptions * * @param String $fieldName - * @param String $context: @see CRM_Core_DAO::buildOptionsContext - * @param Array $props: whatever is known about this dao object + * @param String $context : @see CRM_Core_DAO::buildOptionsContext + * @param Array $props : whatever is known about this dao object + * + * @return Array|bool */ public static function buildOptions($fieldName, $context = NULL, $props = array()) { $className = __CLASS__; @@ -2969,6 +2982,9 @@ WHERE contribution_id = %1 "; * * @param integer $financialTypeId Financial Type id * + * @param string $relationName + * + * @return array|bool * @access public * @static */ diff --git a/CRM/Contribute/BAO/Query.php b/CRM/Contribute/BAO/Query.php index aae282abae..1170b22c2e 100644 --- a/CRM/Contribute/BAO/Query.php +++ b/CRM/Contribute/BAO/Query.php @@ -407,7 +407,7 @@ class CRM_Contribute_BAO_Query { $names[] = $softCreditTypes[$value]; } $query->_qill[$grouping][] = ts('Soft Credit Type %1', array(1 => $op)) . " '" . implode("' " . ts('or') . " '", $names) . "'"; - $query->_where[$grouping][] = + $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause( "civicrm_contribution_soft.soft_credit_type_id", $op, @@ -718,9 +718,9 @@ class CRM_Contribute_BAO_Query { break; case 'contribution_softcredit_type': - $from = " $side JOIN civicrm_option_group option_group_contribution_softcredit_type ON + $from = " $side JOIN civicrm_option_group option_group_contribution_softcredit_type ON (option_group_contribution_softcredit_type.name = 'soft_credit_type')"; - $from .= " $side JOIN civicrm_option_value contribution_softcredit_type ON + $from .= " $side JOIN civicrm_option_value contribution_softcredit_type ON ( civicrm_contribution_soft.soft_credit_type_id = contribution_softcredit_type.value AND option_group_contribution_softcredit_type.id = contribution_softcredit_type.option_group_id )"; break; @@ -748,7 +748,7 @@ class CRM_Contribute_BAO_Query { case 'civicrm_contribution_soft_contact': if (in_array(self::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) { - $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution.contact_id = civicrm_contact_d.id ) + $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution.contact_id = civicrm_contact_d.id ) AND contribution_search_scredit_combined.scredit_id IS NOT NULL"; } else { $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution_soft.contact_id = civicrm_contact_d.id )"; @@ -802,19 +802,19 @@ class CRM_Contribute_BAO_Query { } } } - if (in_array(self::$_contribOrSoftCredit, + if (in_array(self::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) { if (!$tempTableFilled) { // build a temp table which is union of contributions and soft credits // note: group-by in first part ensures uniqueness in counts $tempQuery = " - CREATE TEMPORARY TABLE IF NOT EXISTS contribution_search_scredit_combined AS - SELECT con.id as id, con.contact_id, cso.id as filter_id, NULL as scredit_id + CREATE TEMPORARY TABLE IF NOT EXISTS contribution_search_scredit_combined AS + SELECT con.id as id, con.contact_id, cso.id as filter_id, NULL as scredit_id FROM civicrm_contribution con LEFT JOIN civicrm_contribution_soft cso ON con.id = cso.contribution_id GROUP BY id, contact_id, scredit_id UNION ALL - SELECT scredit.contribution_id as id, scredit.contact_id, scredit.id as filter_id, scredit.id as scredit_id + SELECT scredit.contribution_id as id, scredit.contact_id, scredit.id as filter_id, scredit.id as scredit_id FROM civicrm_contribution_soft as scredit"; CRM_Core_DAO::executeQuery($tempQuery); $tempTableFilled = TRUE; @@ -1000,12 +1000,12 @@ class CRM_Contribute_BAO_Query { ); $form->add('select', 'contribution_or_softcredits', ts('Contributions OR Soft Credits?'), $options, FALSE, array('class' => "crm-select2")); $form->addSelect( - 'contribution_soft_credit_type_id', + 'contribution_soft_credit_type_id', array( - 'entity' => 'contribution_soft', - 'field' => 'soft_credit_type_id', - 'multiple' => 'multiple', - 'option_url' => NULL, + 'entity' => 'contribution_soft', + 'field' => 'soft_credit_type_id', + 'multiple' => 'multiple', + 'option_url' => NULL, 'placeholder' => ts('- any -') ) ); @@ -1061,11 +1061,14 @@ class CRM_Contribute_BAO_Query { /** * Add the where for dates + * * @param array $values array of query values * @param object $query the query object * @param string $name query field that is set * @param string $field name of field to be set * @param string $title title of the field + * + * @return bool */ static function buildDateWhere(&$values, $query, $name, $field, $title) { $fieldPart = strpos($name, $field); diff --git a/CRM/Core/BAO/ActionLog.php b/CRM/Core/BAO/ActionLog.php index 486df88a6d..d57a53da1f 100644 --- a/CRM/Core/BAO/ActionLog.php +++ b/CRM/Core/BAO/ActionLog.php @@ -42,6 +42,8 @@ class CRM_Core_BAO_ActionLog extends CRM_Core_DAO_ActionLog { /** * Create or update an action log entry * + * @param $params + * * @return actionLog array * @access public */ diff --git a/CRM/Core/BAO/Address.php b/CRM/Core/BAO/Address.php index 1769269e0a..5a3b03116d 100644 --- a/CRM/Core/BAO/Address.php +++ b/CRM/Core/BAO/Address.php @@ -1160,8 +1160,10 @@ SELECT is_primary, * TODO: In context of chainselect, what to return if e.g. a country has no states? * * @param String $fieldName - * @param String $context: @see CRM_Core_DAO::buildOptionsContext - * @param Array $props: whatever is known about this dao object + * @param String $context : @see CRM_Core_DAO::buildOptionsContext + * @param Array $props : whatever is known about this dao object + * + * @return Array|bool */ public static function buildOptions($fieldName, $context = NULL, $props = array()) { $params = array(); diff --git a/CRM/Core/BAO/Block.php b/CRM/Core/BAO/Block.php index 30310c1a0f..3c714f8978 100644 --- a/CRM/Core/BAO/Block.php +++ b/CRM/Core/BAO/Block.php @@ -51,10 +51,11 @@ class CRM_Core_BAO_Block { * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param Object $block typically a Phone|Email|IM|OpenID object - * @param string $blockName name of the above object - * @param array $params input parameters to find object - * @param array $values output values of the object + * @param string $blockName name of the above object + * @param array $params input parameters to find object + * + * @internal param Object $block typically a Phone|Email|IM|OpenID object + * @internal param array $values output values of the object * * @return array of $block objects. * @access public @@ -98,9 +99,10 @@ class CRM_Core_BAO_Block { * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param Object $block typically a Phone|Email|IM|OpenID object - * @param string $blockName name of the above object - * @param array $values output values of the object + * @param Object $block typically a Phone|Email|IM|OpenID object + * @param string $blockName name of the above object + * + * @internal param array $values output values of the object * * @return array of $block objects. * @access public @@ -422,13 +424,16 @@ class CRM_Core_BAO_Block { * - if no other entry is 1 change to 1 * - if one other entry exists change that to 1 * - if more than one other entry exists change first one to 1 - * @fixme - perhaps should choose by location_type + * @fixme - perhaps should choose by location_type * # empty - same as 0 as once we have checked first step * we know if it should be 1 or 0 * * if $params['id'] is set $params['contact_id'] may need to be retrieved * - * @param array $params + * @param array $params + * @param $class + * + * @throws API_Exception * @static */ public static function handlePrimary(&$params, $class) { diff --git a/CRM/Core/BAO/ConfigSetting.php b/CRM/Core/BAO/ConfigSetting.php index 0e0df8f304..5ce9603c3a 100644 --- a/CRM/Core/BAO/ConfigSetting.php +++ b/CRM/Core/BAO/ConfigSetting.php @@ -46,6 +46,8 @@ class CRM_Core_BAO_ConfigSetting { * * @params array $params associated array of civicrm variables * + * @param $params + * * @return null * @static */ diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php index 9efe8abf62..8c386f2c81 100644 --- a/CRM/Core/BAO/CustomField.php +++ b/CRM/Core/BAO/CustomField.php @@ -1374,9 +1374,14 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * @params string $elementName custom field name * @params array $defaults associated array of fields * @params int $contactId contact id - * @param int $mode profile mode - * @param mixed $value if passed - dont fetch value from db, + * @param $customFieldId + * @param $elementName + * @param $defaults + * @param null $contactId + * @param int $mode profile mode + * @param mixed $value if passed - dont fetch value from db, * just format the given value + * * @static * @access public */ @@ -2059,8 +2064,9 @@ AND cf.id = %1"; * * @access public * - * @return $customOptionGroup - * @static + * @param null $includeFieldIds + * + * @return mixed $customOptionGroup@static */ public static function &customOptionGroup($includeFieldIds = NULL) { static $customOptionGroup = NULL; @@ -2104,6 +2110,9 @@ INNER JOIN civicrm_custom_field f ON ( g.id = f.option_group_id ) * * @access public * + * @param $customFieldId + * @param $optionGroupId + * * @return void * @static */ @@ -2130,8 +2139,10 @@ INNER JOIN civicrm_custom_field f ON ( g.id = f.option_group_id ) * * @params int $optionGroupId option group id * - * @return - * @static + * @param $optionGroupId + * + * @return void + @static */ static function checkOptionGroup($optionGroupId) { $query = " diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php index b36e861a05..ad3b3b76e2 100644 --- a/CRM/Core/BAO/CustomGroup.php +++ b/CRM/Core/BAO/CustomGroup.php @@ -250,6 +250,8 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { * @param string $extends e.g. "Individual", "Activity" * @param int $columnId e.g. custom-group matching mechanism (usu NULL for matching on sub type-id); see extends_entity_column_id * @param string $columnValue e.g. "Student" or "3" or "3\05"; see extends_entity_column_value + * + * @return bool */ public static function hasCustomGroup($extends, $columnId, $columnValue) { $dao = new CRM_Core_DAO_CustomGroup(); @@ -1760,9 +1762,15 @@ SELECT IF( EXISTS(SELECT name FROM civicrm_contact_type WHERE name like %1), 1, /** * Build custom data view - * @param object $form page object - * @param array $groupTree associated array - * @param boolean $returnCount true if customValue count needs to be returned + * + * @param object $form page object + * @param array $groupTree associated array + * @param boolean $returnCount true if customValue count needs to be returned + * @param null $gID + * @param null $prefix + * @param null $customValueId + * + * @return array|int */ static function buildCustomDataView(&$form, &$groupTree, $returnCount = FALSE, $gID = NULL, $prefix = NULL, $customValueId = NULL) { $details = array(); @@ -1845,6 +1853,7 @@ SELECT IF( EXISTS(SELECT name FROM civicrm_contact_type WHERE name like %1), 1, * @param array $field associated array * @param boolean $dncOptionPerLine true if optionPerLine should not be consider * + * @return array|null|string */ static function formatCustomValues(&$values, &$field, $dncOptionPerLine = FALSE) { $value = $values['data']; diff --git a/CRM/Core/BAO/CustomOption.php b/CRM/Core/BAO/CustomOption.php index 2035dc37cb..eca547815a 100644 --- a/CRM/Core/BAO/CustomOption.php +++ b/CRM/Core/BAO/CustomOption.php @@ -66,9 +66,10 @@ class CRM_Core_BAO_CustomOption { /** * Returns all active options ordered by weight for a given field * - * @param int $fieldId field whose options are needed - * @param boolean $inactiveNeeded do we need inactive options ? + * @param $fieldID + * @param boolean $inactiveNeeded do we need inactive options ? * + * @internal param int $fieldId field whose options are needed * @return array $customOption all active options for fieldId * @static */ diff --git a/CRM/Core/BAO/CustomValueTable.php b/CRM/Core/BAO/CustomValueTable.php index 5c004a44fa..cd52496a93 100644 --- a/CRM/Core/BAO/CustomValueTable.php +++ b/CRM/Core/BAO/CustomValueTable.php @@ -354,16 +354,18 @@ class CRM_Core_BAO_CustomValueTable { /** * Return an array of all custom values associated with an entity. * - * @param int $entityID Identification number of the entity - * @param string $entityType Type of entity that the entityID corresponds to, specified + * @param int $entityID Identification number of the entity + * @param string $entityType Type of entity that the entityID corresponds to, specified * as a string with format "''". Comma separated * list may be used to specify OR matches. Allowable values * are enumerated types in civicrm_custom_group.extends field. * Optional. Default value assumes entityID references a * contact entity. - * @param array $fieldIDs optional list of fieldIDs that we want to retrieve. If this + * @param array $fieldIDs optional list of fieldIDs that we want to retrieve. If this * is set the entityType is ignored * + * @param bool $formatMultiRecordField + * * @return array $fields Array of custom values for the entity with key=>value * pairs specified as civicrm_custom_field.id => custom value. * Empty array if no custom values found. @@ -420,7 +422,7 @@ AND $cond $fields[$dao->table_name][] = $dao->fieldID; $select[$dao->table_name][] = "{$dao->column_name} AS custom_{$dao->fieldID}"; $isMultiple[$dao->table_name] = $dao->is_multiple ? TRUE : FALSE; - $file[$dao->table_name][$dao->fieldID] = $dao->fieldDataType; + $file[$dao->table_name][$dao->fieldID] = $dao->fieldDataType; } $result = array(); @@ -453,7 +455,7 @@ AND $cond } } else { - $result[$fieldID] = $dao->$fieldName; + $result[$fieldID] = $dao->$fieldName; } } } diff --git a/CRM/Core/BAO/Dashboard.php b/CRM/Core/BAO/Dashboard.php index 065f5715b0..5d6662f514 100644 --- a/CRM/Core/BAO/Dashboard.php +++ b/CRM/Core/BAO/Dashboard.php @@ -79,6 +79,8 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { * * @param boolean $flatFormat this is true if you want simple associated array of contact dashlets * + * @param null $contactID + * * @return array $dashlets array of dashlets * @access public * @static @@ -299,6 +301,9 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { * * @param array $columns associated array * + * @param null $contactID + * + * @throws RuntimeException * @return void * @access public * @static diff --git a/CRM/Core/BAO/Discount.php b/CRM/Core/BAO/Discount.php index 3d5888867f..8d24c15d5a 100644 --- a/CRM/Core/BAO/Discount.php +++ b/CRM/Core/BAO/Discount.php @@ -44,12 +44,14 @@ class CRM_Core_BAO_Discount extends CRM_Core_DAO_Discount { /** * Function to delete the discount * - * @param int $id discount id + * @param $entityId + * @param $entityTable + * + * @internal param int $id discount id * * @return boolean * @access public * @static - * */ static function del($entityId,$entityTable) { // delete all discount records with the selected discounted id diff --git a/CRM/Core/BAO/Domain.php b/CRM/Core/BAO/Domain.php index 04ac90d4da..46930a91cc 100644 --- a/CRM/Core/BAO/Domain.php +++ b/CRM/Core/BAO/Domain.php @@ -69,6 +69,8 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { /** * Get the domain BAO * + * @param null $reset + * * @return null|object CRM_Core_BAO_Domain * @access public * @static @@ -108,7 +110,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { * Reset domain to default (ie. as loaded from settings). This is the * counterpart to CRM_Core_BAO_Domain::setDomain. * - * @param integer $domainID id for domain you want to set as current + * @internal param int $domainID id for domain you want to set as current * @deprecated * @see CRM_Core_BAO_Domain::setDomain */ diff --git a/CRM/Core/BAO/Email.php b/CRM/Core/BAO/Email.php index ca650ba469..6e0872681a 100644 --- a/CRM/Core/BAO/Email.php +++ b/CRM/Core/BAO/Email.php @@ -43,6 +43,8 @@ class CRM_Core_BAO_Email extends CRM_Core_DAO_Email { * has more business logic * * @param array $params input parameters + * + * @return object */ static function create($params) { // if id is set & is_primary isn't we can assume no change diff --git a/CRM/Core/BAO/FinancialTrxn.php b/CRM/Core/BAO/FinancialTrxn.php index 6bca09ca2f..9169b8e579 100644 --- a/CRM/Core/BAO/FinancialTrxn.php +++ b/CRM/Core/BAO/FinancialTrxn.php @@ -197,10 +197,13 @@ WHERE ft.entity_table = 'civicrm_contribution' AND ft.entity_id = %1 return CRM_Core_DAO::singleValueQuery($query, $sqlParams); } + /** * Given an financial_trxn_id check for previous entity_financial_trxn. * - * @param int $financialTrxn_id id of the latest payment. + * @param $financial_trxn_id + * + * @internal param int $financialTrxn_id id of the latest payment. * * @return array( ) $payment array of previous payments * @@ -251,8 +254,11 @@ WHERE ef2.financial_trxn_id =%1 * Given an entity_id and entity_table, check for corresponding entity_financial_trxn and financial_trxn record. * NOTE: This should be moved to separate BAO for EntityFinancialTrxn when we start adding more code for that object. * - * @param string $entityTable name of the entity table usually 'civicrm_contact' - * @param int $entityID id of the entity usually the contactID. + * @param $entity_id + * @param string $entity_table + * + * @internal param string $entityTable name of the entity table usually 'civicrm_contact' + * @internal param int $entityID id of the entity usually the contactID. * * @return array( ) reference $tag array of catagory id's the contact belongs to. * diff --git a/CRM/Core/BAO/IM.php b/CRM/Core/BAO/IM.php index bc4d2519ca..e37eec8cdd 100644 --- a/CRM/Core/BAO/IM.php +++ b/CRM/Core/BAO/IM.php @@ -78,6 +78,8 @@ class CRM_Core_BAO_IM extends CRM_Core_DAO_IM { * * @param int $id the contact id * + * @param bool $updateBlankLocInfo + * * @return array the array of im details * @access public * @static diff --git a/CRM/Core/BAO/Job.php b/CRM/Core/BAO/Job.php index e3d149fe88..0053f5a548 100644 --- a/CRM/Core/BAO/Job.php +++ b/CRM/Core/BAO/Job.php @@ -44,16 +44,17 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { function __construct() { parent::__construct(); } + /** * Function to add the payment-processor type in the db * * @param array $params (reference ) an assoc array of name/value pairs - * @param array $ids the array that holds all the db ids + * + * @internal param array $ids the array that holds all the db ids * * @return object CRM_Financial_DAO_PaymentProcessorType * @access public * @static - * */ static function create($params) { $job = new CRM_Core_DAO_Job(); @@ -101,8 +102,11 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { /** * Function to delete scheduled job * - * @param int $jobId ID of the job to be deleted. + * @param $jobID + * + * @internal param int $jobId ID of the job to be deleted. * + * @return bool|null * @access public * @static */ diff --git a/CRM/Core/BAO/LabelFormat.php b/CRM/Core/BAO/LabelFormat.php index 8b95e9d34f..5ef6312117 100644 --- a/CRM/Core/BAO/LabelFormat.php +++ b/CRM/Core/BAO/LabelFormat.php @@ -257,7 +257,9 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { /** * Get Option Group ID for Label Formats * - * @param void + * @param string $name + * + * @internal param $void * * @return int Group ID (null if Group ID doesn't exist) * @access private @@ -343,8 +345,10 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { /** * Get Label Format from the DB * - * @param string $field Field name to search by - * @param int $val Field value to search for + * @param string $field Field name to search by + * @param int $val Field value to search for + * + * @param string $groupName * * @return array $values (reference) associative array of name/value pairs * @access public @@ -420,8 +424,10 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * retrieves the relevant objects. Typically the valid params are only * label id. It also stores all the retrieved values in the default array. * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $values (reference ) an assoc array to hold the flattened values + * @param array $params (reference ) an assoc array of name/value pairs + * @param array $values (reference ) an assoc array to hold the flattened values + * + * @param string $groupName * * @return object CRM_Core_DAO_OptionValue object * @access public diff --git a/CRM/Core/BAO/Location.php b/CRM/Core/BAO/Location.php index 792d93497f..9b49d63ad8 100644 --- a/CRM/Core/BAO/Location.php +++ b/CRM/Core/BAO/Location.php @@ -46,10 +46,12 @@ class CRM_Core_BAO_Location extends CRM_Core_DAO { /** * Function to 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 boolean $fixAddress true if you need to fix (format) address values * before inserting in db * + * @param null $entity + * * @return array $location * @access public * @static diff --git a/CRM/Core/BAO/MailSettings.php b/CRM/Core/BAO/MailSettings.php index 619a547027..9d03f289b9 100644 --- a/CRM/Core/BAO/MailSettings.php +++ b/CRM/Core/BAO/MailSettings.php @@ -185,6 +185,7 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { * * @param int $id mail settings id * + * @return mixed|null * @access public * @static * diff --git a/CRM/Core/BAO/Mapping.php b/CRM/Core/BAO/Mapping.php index b992cb8431..a6824490d3 100644 --- a/CRM/Core/BAO/Mapping.php +++ b/CRM/Core/BAO/Mapping.php @@ -119,6 +119,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * * @params string $mappingTypeId mapping type id * + * @param $mappingTypeId + * * @return array $mapping array of mapping name * @access public * @static @@ -141,10 +143,11 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * * @params int $mappingId mapping id * + * @param $mappingId + * * @return array $mappingFields array of mapping fields * @access public * @static - * */ static function getMappingFields($mappingId) { //mapping is to be loaded from database @@ -222,9 +225,9 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * * @params int $smartGroupId smart group id * - * @return $returnFields associated array of elements + * @param $smartGroupId * - * @static + * @return array $returnFields associated array of elements@static * @public */ static function getFormattedFields($smartGroupId) { @@ -258,6 +261,13 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * @params mixed $columnCount column count is int for and array for search builder * @params int $blockCount block count (no of blocks shown) * + * @param $form + * @param string $mappingType + * @param null $mappingId + * @param $columnNo + * @param int $blockCount + * @param null $exportMode + * * @return void * @access public * @static @@ -941,9 +951,10 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** * Function returns all Custom group Names * - * @param customfieldId related custom field id - * @return $customGroupName all custom group names - * @static + * @param related $customfieldId + * + * @internal param \related $customfieldId custom field id + * @return null|string $customGroupName all custom group names@static */ static function getCustomGroupName($customfieldId) { if ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($customfieldId)) { @@ -964,9 +975,10 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * @params array $params associated array of submitted values * @params boolean $row row no of the fields * - * @return $returnFields formatted associated array of elements + * @param $params + * @param bool $row * - * @static + * @return array $returnFields formatted associated array of elements@static * @public */ static function &formattedFields(&$params, $row = FALSE) { diff --git a/CRM/Core/BAO/MessageTemplate.php b/CRM/Core/BAO/MessageTemplate.php index 1e03cdbba5..9ac565358f 100644 --- a/CRM/Core/BAO/MessageTemplate.php +++ b/CRM/Core/BAO/MessageTemplate.php @@ -101,6 +101,8 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { * @access public * @static * + * @param $messageTemplatesID + * * @return object */ static function del($messageTemplatesID) { diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php index 091afa1c0c..55f7d3732e 100644 --- a/CRM/Core/BAO/Note.php +++ b/CRM/Core/BAO/Note.php @@ -356,7 +356,9 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { /** * retrieve all records for this entity-id * - * @param int $id ID of the relationship for which records needs to be retrieved. + * @param int $id ID of the relationship for which records needs to be retrieved. + * + * @param string $entityTable * * @return array $viewNote array of note properties * diff --git a/CRM/Core/BAO/OpenID.php b/CRM/Core/BAO/OpenID.php index 6cfd9bc686..2f43ae48d0 100644 --- a/CRM/Core/BAO/OpenID.php +++ b/CRM/Core/BAO/OpenID.php @@ -96,6 +96,8 @@ class CRM_Core_BAO_OpenID extends CRM_Core_DAO_OpenID { * * @param int $id the contact id * + * @param bool $updateBlankLocInfo + * * @return array the array of openid's * @access public * @static diff --git a/CRM/Core/BAO/OptionValue.php b/CRM/Core/BAO/OptionValue.php index d62fcfba82..33816630e2 100644 --- a/CRM/Core/BAO/OptionValue.php +++ b/CRM/Core/BAO/OptionValue.php @@ -40,12 +40,15 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { function __construct() { parent::__construct(); } + /** * Create option value - note that the create function calls 'add' but - * has more business logic - * - * @param array $params input parameters - */ + * has more business logic + * + * @param array $params input parameters + * + * @return object + */ static function create($params) { if (empty($params['id'])){ self::setDefaults($params); @@ -84,12 +87,16 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { $params['value'] = self::getDefaultValue($params); } } + /** * Get next available value * We will take the highest numeric value (or 0 if no numeric values exist) * and add one. The calling function is responsible for any * more complex decision making + * * @param array $params + * + * @return int */ static function getDefaultWeight($params){ return (int) CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue', diff --git a/CRM/Core/BAO/PrevNextCache.php b/CRM/Core/BAO/PrevNextCache.php index 790d49bda8..3f7c53c17d 100644 --- a/CRM/Core/BAO/PrevNextCache.php +++ b/CRM/Core/BAO/PrevNextCache.php @@ -341,11 +341,13 @@ WHERE cacheKey LIKE %1 AND is_selected = 1 /** * function to get the selections * - * @param string $cacheKey cache key - * @param string $action action + * @param string $cacheKey cache key + * @param string $action action * $action : get - get only selection records * getall - get all the records of the specified cache key * @param string $entity_table entity table + * + * @return array */ static function getSelection($cacheKey, $action = 'get', $entity_table = 'civicrm_contact') { if (!$cacheKey) { diff --git a/CRM/Core/BAO/SchemaHandler.php b/CRM/Core/BAO/SchemaHandler.php index 6f3cdf1cce..f79f9b7dd6 100644 --- a/CRM/Core/BAO/SchemaHandler.php +++ b/CRM/Core/BAO/SchemaHandler.php @@ -64,8 +64,10 @@ class CRM_Core_BAO_SchemaHandler { /** * Function for creating a civiCRM-table * - * @param String $tableName name of the table to be created. - * @param Array $tableAttributes array containing atrributes for the table that needs to be created + * @param $params + * + * @internal param String $tableName name of the table to be created. + * @internal param Array $tableAttributes array containing atrributes for the table that needs to be created * * @return true if successfully created, false otherwise * diff --git a/CRM/Core/BAO/Setting.php b/CRM/Core/BAO/Setting.php index 6854949e0d..858a791370 100644 --- a/CRM/Core/BAO/Setting.php +++ b/CRM/Core/BAO/Setting.php @@ -66,10 +66,13 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * Checks whether an item is present in the in-memory cache table * * @param string $group (required) The group name of the item - * @param string $name (required) The name of the setting - * @param int $componentID The optional component ID (so componenets can share the same name space) - * @param int $contactID If set, this is a contactID specific setting, else its a global setting - * @param int $load if true, load from local cache (typically memcache) + * @param string $name (required) The name of the setting + * @param int $componentID The optional component ID (so componenets can share the same name space) + * @param int $contactID If set, this is a contactID specific setting, else its a global setting + * @param bool|int $load if true, load from local cache (typically memcache) + * + * @param null $domainID + * @param bool $force * * @return boolean true if item is already in cache * @static @@ -475,10 +478,12 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * gets metadata about the settings fields (from getfields) based on the fields being passed in * * This function filters on the fields like 'version' & 'debug' that are not settings + * * @param array $params Parameters as passed into API * @param array $fields empty array to be populated with fields metadata * @param bool $createMode * + * @throws api_Exception * @return array $fieldstoset name => value array of the fields to be set (with extraneous removed) */ static function validateSettingsInput($params, &$fields, $createMode = TRUE) { diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php index 83c7fdbda6..365d4f05d5 100644 --- a/CRM/Core/BAO/UFGroup.php +++ b/CRM/Core/BAO/UFGroup.php @@ -350,9 +350,13 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * * @param array $groupArr (mimic CRM_UF_DAO_UFGroup) * @param array $fieldArrs list of fields (each mimics CRM_UF_DAO_UFField) - * @param bool $visibility visibility of fields we are interested in + * @param bool $visibility visibility of fields we are interested in * @param bool $searchable - * @param bool $showall + * @param bool $showAll + * @param null $ctype + * @param int $permissionType + * + * @internal param bool $showall * @return array * @see getFields */ @@ -1470,6 +1474,10 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @params int $displayName if set return display name in array * @params int $status if set return module other than default modules (User Account/User registration/Profile) * + * @param null $ufGroupId + * @param null $displayName + * @param null $status + * * @return array $ufGroupJoinRecords * * @access public @@ -1576,11 +1584,12 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * Function to get the uf group for a module * * @param string $moduleName module name - * @param int $count no to increment the weight - * @param bool $skipPermision - whether to add permission clause - * @param int $op - which operation (view, edit, create, etc) to check permission for + * @param int $count no to increment the weight + * @param bool $skipPermission + * @param int $op - which operation (view, edit, create, etc) to check permission for * @param array|NULL $returnFields list of UFGroup fields to return; NULL for default * + * @internal param bool $skipPermision - whether to add permission clause * @return array $ufGroups array of ufgroups for a module * @access public * @static @@ -1653,6 +1662,9 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * * @params int $ufGroupId uf group id (profile id) * + * @param $ufGroupId + * @param null $contactID + * * @return boolean true or false * @static * @access public @@ -1698,6 +1710,15 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @params int $contactID contact id * @params string $usedFor for building up prefixed fieldname for special cases (e.g. onBehalf, Honor) * + * @param $form + * @param $field + * @param $mode + * @param null $contactId + * @param bool $online + * @param null $usedFor + * @param null $rowNumber + * @param string $prefix + * * @return null * @static * @access public @@ -2211,6 +2232,13 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * @params boolean $singleProfile true for single profile else false(batch update) * @params int $componentId id for specific components like contribute, event etc * + * @param $contactId + * @param $fields + * @param $defaults + * @param bool $singleProfile + * @param null $componentId + * @param null $component + * * @return null * @static * @access public @@ -2557,8 +2585,10 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Function to get default value for Register. * - * @return $defaults - * @static + * @param $fields + * @param $defaults + * + * @return mixed $defaults@static * @access public */ static function setRegisterDefaults(&$fields, &$defaults) { diff --git a/CRM/Core/BAO/UFMatch.php b/CRM/Core/BAO/UFMatch.php index 7a8e8fa096..fcd4c6f060 100644 --- a/CRM/Core/BAO/UFMatch.php +++ b/CRM/Core/BAO/UFMatch.php @@ -63,9 +63,12 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch { * object for this user. If the user has new values, we need * to update the CRM DB with the new values * - * @param Object $user the drupal user object - * @param boolean $update has the user object been edited - * @param $uf + * @param Object $user the drupal user object + * @param boolean $update has the user object been edited + * @param $uf + * + * @param $ctype + * @param bool $isLogin * * @return void * @access public @@ -599,10 +602,13 @@ AND domain_id = %4 /** * Get uf match values for given uf id or logged in user. * - * @param int $ufID uf id. + * @param int $ufID uf id. * * return array $ufValues uf values. - **/ + ** + * + * @return array + */ static function getUFValues($ufID = NULL) { if (!$ufID) { //get logged in user uf id. diff --git a/CRM/Core/BAO/Website.php b/CRM/Core/BAO/Website.php index d7eaedd92a..bb8e1587d3 100644 --- a/CRM/Core/BAO/Website.php +++ b/CRM/Core/BAO/Website.php @@ -63,7 +63,9 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website { * process website * * @param array $params associated array - * @param int $contactID contact id + * @param int $contactID contact id + * + * @param $skipDelete * * @return void * @access public diff --git a/CRM/Core/BAO/WordReplacement.php b/CRM/Core/BAO/WordReplacement.php index d5ae5a44b0..fff0161f9e 100644 --- a/CRM/Core/BAO/WordReplacement.php +++ b/CRM/Core/BAO/WordReplacement.php @@ -60,6 +60,8 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { /** * Get the domain BAO * + * @param null $reset + * * @return null|object CRM_Core_BAO_WordRepalcement * @access public * @static @@ -80,6 +82,9 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { /** * Save the values of a WordReplacement * + * @param $params + * @param $id + * * @return WordReplacement array * @access public */ diff --git a/CRM/Core/CodeGen/Specification.php b/CRM/Core/CodeGen/Specification.php index c66b91df3e..cd415662f9 100644 --- a/CRM/Core/CodeGen/Specification.php +++ b/CRM/Core/CodeGen/Specification.php @@ -12,6 +12,7 @@ class CRM_Core_CodeGen_Specification { /** * Read and parse. * + * @param $schemaPath * @param string $buildVersion which version of the schema to build */ function parse($schemaPath, $buildVersion) { diff --git a/CRM/Core/CodeGen/Util/File.php b/CRM/Core/CodeGen/Util/File.php index 81ee570ef5..ee18c97f1a 100644 --- a/CRM/Core/CodeGen/Util/File.php +++ b/CRM/Core/CodeGen/Util/File.php @@ -39,7 +39,8 @@ class CRM_Core_CodeGen_Util_File { * Calculate a cumulative digest based on a collection of files * * @param array $files list of file names (strings) - * @param callable $digest a one-way hash function (string => string) + * @param callable|string $digest a one-way hash function (string => string) + * * @return string */ static function digestAll($files, $digest = 'md5') { diff --git a/CRM/Core/CommunityMessages.php b/CRM/Core/CommunityMessages.php index a370bbc8a0..9a6bcf6504 100644 --- a/CRM/Core/CommunityMessages.php +++ b/CRM/Core/CommunityMessages.php @@ -71,6 +71,7 @@ class CRM_Core_CommunityMessages { /** * @param CRM_Utils_Cache_Interface $cache * @param CRM_Utils_HttpClient $client + * @param null $messagesUrl */ public function __construct($cache, $client, $messagesUrl = NULL) { $this->cache = $cache; diff --git a/CRM/Core/Component/Config.php b/CRM/Core/Component/Config.php index 87c0921ec9..2ccd429711 100644 --- a/CRM/Core/Component/Config.php +++ b/CRM/Core/Component/Config.php @@ -42,9 +42,11 @@ abstract class CRM_Core_Component_Config { * configuration file and injects them into system wide * configuration object. * + * @param $config + * @param $oldMode + * * @return array collection of component settings * @access public - * */ public function add($config, $oldMode) { foreach (get_class_vars(get_class($this)) as $key => $value) { diff --git a/CRM/Core/Component/Info.php b/CRM/Core/Component/Info.php index f79cdba620..7490c2af38 100644 --- a/CRM/Core/Component/Info.php +++ b/CRM/Core/Component/Info.php @@ -360,9 +360,10 @@ abstract class CRM_Core_Component_Info { /** * Helper for instantiating component's elements. * + * @param $cl + * * @return mixed component's element as class instance * @access private - * */ private function _instantiate($cl) { $className = $this->namespace . '_' . $cl; diff --git a/CRM/Core/Controller.php b/CRM/Core/Controller.php index 3aa9582bdb..2d0b1b4776 100644 --- a/CRM/Core/Controller.php +++ b/CRM/Core/Controller.php @@ -592,9 +592,10 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * assign value to name in template * - * @param array|string $name name of variable + * @param $var * @param mixed $value value of varaible * + * @internal param array|string $name name of variable * @return void * @access public */ @@ -605,9 +606,10 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * assign value to name in template by reference * - * @param array|string $name name of variable + * @param $var * @param mixed $value (reference) value of varaible * + * @internal param array|string $name name of variable * @return void * @access public */ diff --git a/CRM/Core/Controller/Simple.php b/CRM/Core/Controller/Simple.php index f5858f506d..5fb151bed8 100644 --- a/CRM/Core/Controller/Simple.php +++ b/CRM/Core/Controller/Simple.php @@ -41,14 +41,19 @@ class CRM_Core_Controller_Simple extends CRM_Core_Controller { /** * constructor * + * @param null $path + * @param bool $title * @param string path the class Path of the form being implemented - * @param string title the descriptive name for the page - * @param int mode the mode that the form will operate on - * @param boolean addSequence should we add a unique sequence number to the end of the key - * @param boolean ignoreKey should we not set a qfKey for this controller (for standalone forms) + * @param bool $imageUpload + * @param bool $addSequence + * @param bool $ignoreKey + * @param bool $attachUpload * - * @return object - * @access public + * @internal param \addSequence $boolean should we add a unique sequence number to the end of the key + * @internal param \ignoreKey $boolean should we not set a qfKey for this controller (for standalone forms) + * + * @return \CRM_Core_Controller_Simple + @access public */ function __construct( $path, diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index 0879ab6cc2..0eec8b1632 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -75,8 +75,8 @@ class CRM_Core_DAO extends DB_DataObject { /** * Class constructor * - * @return object - * @access public + * @return \CRM_Core_DAO + @access public */ function __construct() { $this->initialize(); @@ -1545,13 +1545,15 @@ SELECT contact_id } } - /** - * Build a list of triggers via hook and add them to (err, reconcile them - * with) the database. - * - * @param $tableName string the specific table requiring a rebuild; or NULL to rebuild all tables - * @see CRM-9716 - */ + /** + * Build a list of triggers via hook and add them to (err, reconcile them + * with) the database. + * + * @param $tableName string the specific table requiring a rebuild; or NULL to rebuild all tables + * @param bool $force + * + * @see CRM-9716 + */ static function triggerRebuild($tableName = NULL, $force = FALSE) { $info = array(); @@ -1842,6 +1844,9 @@ EOS; * Provides documentation and validation for the buildOptions $context param * * @param String $context + * + * @throws Exception + * @return array */ public static function buildOptionsContext($context = NULL) { $contexts = array( diff --git a/CRM/Core/Error.php b/CRM/Core/Error.php index 1da9a4fbab..f9a49c894c 100644 --- a/CRM/Core/Error.php +++ b/CRM/Core/Error.php @@ -263,9 +263,14 @@ class CRM_Core_Error extends PEAR_ErrorStack { /** * display an error page with an error message describing what happened * - * @param string message the error message - * @param string code the error code if any - * @param string email the email address to notify of this situation + * @param null $message + * @param null $code + * @param null $email + * + * @throws Exception + * @internal param \message $string the error message + * @internal param \code $string the error code if any + * @internal param \email $string the email address to notify of this situation * * @return void * @static @@ -576,6 +581,8 @@ class CRM_Core_Error extends PEAR_ErrorStack { /** * Obtain a reference to the error log * + * @param string $comp + * * @return Log */ static function createDebugLogger($comp = '') { diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php index bd212a6ed0..052c71ec02 100644 --- a/CRM/Core/Form.php +++ b/CRM/Core/Form.php @@ -213,16 +213,22 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * Simple easy to use wrapper around addElement. Deal with * simple validation rules * - * @param string type of html element to be added - * @param string name of the html element - * @param string display label for the html element - * @param string attributes used for this element. + * @param $type + * @param $name + * @param string $label + * @param string $attributes + * @param bool $required + * @param null $extra + * + * @internal param \type $string of html element to be added + * @internal param \name $string of the html element + * @internal param \display $string label for the html element + * @internal param \attributes $string used for this element. * These are not default values - * @param bool is this a required field + * @internal param \is $bool this a required field * * @return HTML_QuickForm_Element could be an error object * @access public - * */ function &add($type, $name, $label = '', $attributes = '', $required = FALSE, $extra = NULL @@ -1457,13 +1463,16 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * * * {/if} + * * @param array $profiles ids of profiles that are on the form (to be autofilled) - * @param array $field metadata of field to use as selector including + * @param array $autoCompleteField + * + * @internal param array $field metadata of field to use as selector including * - name_field * - id_field * - url (for ajax lookup) * - * @todo add data attributes so we can deal with multiple instances on a form + * @todo add data attributes so we can deal with multiple instances on a form */ function addAutoSelector($profiles = array(), $autoCompleteField = array()) { $autoCompleteField = array_merge(array( @@ -1522,8 +1531,11 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Set default values on form for given contact (or no contact defaults) + * * @param mixed $profile_id (can be id, or profile name) * @param integer $contactID + * + * @return array */ function getProfileDefaults($profile_id = 'Billing', $contactID = NULL) { try{ diff --git a/CRM/Core/Form/Date.php b/CRM/Core/Form/Date.php index 66f25e1834..6bb19371ad 100644 --- a/CRM/Core/Form/Date.php +++ b/CRM/Core/Form/Date.php @@ -73,6 +73,7 @@ Class CRM_Core_Form_Date { /** * This function is to retrieve the date range - relative or absolute * and assign it to the form + * * @param object $form - the form the dates should be added to * @param string $fieldName * @param integer $count @@ -82,7 +83,7 @@ Class CRM_Core_Form_Date { * @param boolean $required * @param array $operators Additional value pairs to add * @param string $dateFormat - * @param string $displayTime + * @param bool|string $displayTime * * * @static diff --git a/CRM/Core/Form/Tag.php b/CRM/Core/Form/Tag.php index f7ffb32f57..f0065cf828 100644 --- a/CRM/Core/Form/Tag.php +++ b/CRM/Core/Form/Tag.php @@ -43,15 +43,15 @@ class CRM_Core_Form_Tag { /** * Function to build tag widget if correct parent is passed * - * @param CRM_Core_Form $form form object - * @param string $parentNames parent name ( tag name) - * @param string $entityTable entitytable 'eg: civicrm_contact' - * @param int $entityId entityid 'eg: contact id' + * @param CRM_Core_Form $form form object + * @param string $parentNames parent name ( tag name) + * @param string $entityTable entitytable 'eg: civicrm_contact' + * @param int $entityId entityid 'eg: contact id' * @param boolean $skipTagCreate true if tag need be created using ajax * @param boolean $skipEntityAction true if need to add entry in entry table via ajax - * @param boolean $searchMode true if widget is used in search eg: advanced search - * @param string $tagsetElementName if you need to create tagsetlist with specific name + * @param string $tagsetElementName if you need to create tagsetlist with specific name * + * @internal param bool $searchMode true if widget is used in search eg: advanced search * @return void * @access public * @static diff --git a/CRM/Core/I18n.php b/CRM/Core/I18n.php index c9f3dd9861..a84e8b4060 100644 --- a/CRM/Core/I18n.php +++ b/CRM/Core/I18n.php @@ -50,7 +50,7 @@ class CRM_Core_I18n { * * @param $locale string the base of this certain object's existence * - * @return void + * @return \CRM_Core_I18n */ function __construct($locale) { if ($locale != '' and $locale != 'en_US') { diff --git a/CRM/Core/IDS.php b/CRM/Core/IDS.php index aa067289a6..a6e68cf2f8 100644 --- a/CRM/Core/IDS.php +++ b/CRM/Core/IDS.php @@ -205,7 +205,10 @@ class CRM_Core_IDS { * This function writes an entry about the intrusion * to the intrusion database * - * @param array $results + * @param $result + * @param int $reaction + * + * @internal param array $results * * @return boolean */ diff --git a/CRM/Core/Invoke.php b/CRM/Core/Invoke.php index c11ec176d5..0a3e7a58ab 100644 --- a/CRM/Core/Invoke.php +++ b/CRM/Core/Invoke.php @@ -342,6 +342,9 @@ class CRM_Core_Invoke { * * @param $action * + * @param $contact_type + * @param $contact_sub_type + * * @static * @access public */ diff --git a/CRM/Core/Key.php b/CRM/Core/Key.php index 9d96edaaa7..fbe914552b 100644 --- a/CRM/Core/Key.php +++ b/CRM/Core/Key.php @@ -72,7 +72,10 @@ class CRM_Core_Key { * Generate a form key based on form name, the current user session * and a private key. Modelled after drupal's form API * - * @param string $value name of the form + * @param $name + * @param bool $addSequence + * + * @internal param string $value name of the form * @paeam boolean $addSequence should we add a unique sequence number to the end of the key * * @return string valid formID @@ -95,9 +98,12 @@ class CRM_Core_Key { /** * Validate a form key based on the form name * - * @param string $formKey + * @param $key * @param string $name * + * @param bool $addSequence + * + * @internal param string $formKey * @return string $formKey if valid, else null * @static * @acess public diff --git a/CRM/Core/Lock.php b/CRM/Core/Lock.php index d4e91da363..405cda99de 100644 --- a/CRM/Core/Lock.php +++ b/CRM/Core/Lock.php @@ -44,16 +44,15 @@ class CRM_Core_Lock { /** * Initialize the constants used during lock acquire / release * - * @param string $name name of the lock. Please prefix with component / functionality + * @param string $name name of the lock. Please prefix with component / functionality * e.g. civimail.cronjob.JOB_ID - * @param int $timeout the number of seconds to wait to get the lock. 1 if not set + * @param int $timeout the number of seconds to wait to get the lock. 1 if not set * @param boolean $serverWideLock should this lock be applicable across your entire mysql server * this is useful if you have mutliple sites running on the same * mysql server and you want to limit the number of parallel cron * jobs - CRM-91XX * - * @return object the lock object - * + * @return \CRM_Core_Lock the lock object */ function __construct($name, $timeout = NULL, $serverWideLock = FALSE) { $config = CRM_Core_Config::singleton(); diff --git a/CRM/Core/ManagedEntities.php b/CRM/Core/ManagedEntities.php index bd053f6e30..0b114d3281 100644 --- a/CRM/Core/ManagedEntities.php +++ b/CRM/Core/ManagedEntities.php @@ -94,7 +94,7 @@ class CRM_Core_ManagedEntities { /** * Create, update, and delete entities declared by an active module * - * @param $module string + * @param \CRM_Core_Module|string $module string * @param $todos array $name => array() */ public function reconcileEnabledModule(CRM_Core_Module $module, $todos) { @@ -204,6 +204,8 @@ class CRM_Core_ManagedEntities { } /** + * @param $modules + * * @return array indexed by is_active,name */ protected static function createModuleIndex($modules) { @@ -215,6 +217,9 @@ class CRM_Core_ManagedEntities { } /** + * @param $moduleIndex + * @param $declarations + * * @return array indexed by module,name */ protected static function createDeclarationIndex($moduleIndex, $declarations) { diff --git a/CRM/Core/Page/AJAX.php b/CRM/Core/Page/AJAX.php index b9abf02faa..5e7ac4eb66 100644 --- a/CRM/Core/Page/AJAX.php +++ b/CRM/Core/Page/AJAX.php @@ -137,6 +137,8 @@ class CRM_Core_Page_AJAX { * @param string $type 'method'|'class'|'' * @param string $className 'Class_Name' * @param string $fnName method name + * + * @return bool */ static function checkAuthz($type, $className, $fnName = null) { switch ($type) { diff --git a/CRM/Core/Page/Basic.php b/CRM/Core/Page/Basic.php index 710a405cfe..d49644c706 100644 --- a/CRM/Core/Page/Basic.php +++ b/CRM/Core/Page/Basic.php @@ -363,6 +363,9 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { * @param int $mode - what mode for the form ? * @param int $id - id of the entity (for update, view operations) * + * @param bool $imageUpload + * @param bool $pushUserContext + * * @return void */ function edit($mode, $id = NULL, $imageUpload = FALSE, $pushUserContext = TRUE) { diff --git a/CRM/Core/Payment/AuthorizeNet.php b/CRM/Core/Payment/AuthorizeNet.php index 9ec56c4418..1edfe38d8f 100644 --- a/CRM/Core/Payment/AuthorizeNet.php +++ b/CRM/Core/Payment/AuthorizeNet.php @@ -42,7 +42,9 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * - * @return void + * @param $paymentProcessor + * + * @return \CRM_Core_Payment_AuthorizeNet */ function __construct($mode, &$paymentProcessor) { $this->_mode = $mode; diff --git a/CRM/Core/Payment/BaseIPN.php b/CRM/Core/Payment/BaseIPN.php index 1ad0d37b20..ad3cf45306 100644 --- a/CRM/Core/Payment/BaseIPN.php +++ b/CRM/Core/Payment/BaseIPN.php @@ -52,8 +52,10 @@ class CRM_Core_Payment_BaseIPN { /** * Store input array on the class + * * @param array $parameters - * @throws CRM_Core_Exceptions + * + * @throws CRM_Core_Exception */ function setInputParameters($parameters) { if(!is_array($parameters)) { diff --git a/CRM/Core/Payment/Dummy.php b/CRM/Core/Payment/Dummy.php index 6f439608b0..4491ba8987 100644 --- a/CRM/Core/Payment/Dummy.php +++ b/CRM/Core/Payment/Dummy.php @@ -39,7 +39,9 @@ class CRM_Core_Payment_Dummy extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * - * @return void + * @param $paymentProcessor + * + * @return \CRM_Core_Payment_Dummy */ function __construct($mode, &$paymentProcessor) { $this->_mode = $mode; diff --git a/CRM/Core/Payment/Elavon.php b/CRM/Core/Payment/Elavon.php index 0a49a80e6a..95c0e33149 100644 --- a/CRM/Core/Payment/Elavon.php +++ b/CRM/Core/Payment/Elavon.php @@ -42,8 +42,11 @@ class CRM_Core_Payment_Elavon extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * - * @return void - **********************************************************/ function __construct($mode, &$paymentProcessor) { + * @param $paymentProcessor + * + * @return \CRM_Core_Payment_Elavon ******************************************************* + */ + function __construct($mode, &$paymentProcessor) { // live or test $this->_mode = $mode; $this->_paymentProcessor = $paymentProcessor; @@ -342,11 +345,13 @@ class CRM_Core_Payment_Elavon extends CRM_Core_Payment { * NOTE: Called by Events and Contribute to check config params are set prior to trying * register any credit card details * - * @param string $mode the mode we are operating in (live or test) - not used + * @return null|string + * @internal param string $mode the mode we are operating in (live or test) - not used * * returns string $errorMsg if any errors found - null if OK * - ********************************************************************************************/ + ****************************************************************************************** + */ // function checkConfig( $mode ) // CiviCRM V1.9 Declaration // CiviCRM V2.0 Declaration function checkConfig() { diff --git a/CRM/Core/Payment/FirstData.php b/CRM/Core/Payment/FirstData.php index d463fa35e4..87ce7263c4 100644 --- a/CRM/Core/Payment/FirstData.php +++ b/CRM/Core/Payment/FirstData.php @@ -67,8 +67,11 @@ class CRM_Core_Payment_FirstData extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * - * @return void - **********************************************************/ function __construct($mode, &$paymentProcessor) { + * @param $paymentProcessor + * + * @return \CRM_Core_Payment_FirstData ******************************************************* + */ + function __construct($mode, &$paymentProcessor) { // live or test $this->_mode = $mode; $this->_paymentProcessor = $paymentProcessor; @@ -79,9 +82,10 @@ class CRM_Core_Payment_FirstData extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * + * @param object $paymentProcessor + * * @return object * @static - * */ static function &singleton($mode, &$paymentProcessor) { $processorName = $paymentProcessor['name']; @@ -356,11 +360,13 @@ class CRM_Core_Payment_FirstData extends CRM_Core_Payment { * NOTE: Called by Events and Contribute to check config params are set prior to trying * register any credit card details * - * @param string $mode the mode we are operating in (live or test) - not used + * @return null|string + * @internal param string $mode the mode we are operating in (live or test) - not used * * returns string $errorMsg if any errors found - null if OK * - ********************************************************************************************/ + ****************************************************************************************** + */ // function checkConfig( $mode ) // CiviCRM V1.9 Declaration // CiviCRM V2.0 Declaration function checkConfig() { diff --git a/CRM/Core/Payment/Form.php b/CRM/Core/Payment/Form.php index 8b0c12f7fe..0ef3495ed2 100644 --- a/CRM/Core/Payment/Form.php +++ b/CRM/Core/Payment/Form.php @@ -52,6 +52,8 @@ class CRM_Core_Payment_Form { /** * create all common fields needed for a credit card or direct debit transaction * + * @param $form + * * @return void * @access protected */ @@ -371,6 +373,11 @@ class CRM_Core_Payment_Form { /** * function to map address fields * + * @param $id + * @param $src + * @param $dst + * @param bool $reverse + * * @return void * @static */ diff --git a/CRM/Core/Payment/Google.php b/CRM/Core/Payment/Google.php index 1b85bf1777..cd7a36ea87 100644 --- a/CRM/Core/Payment/Google.php +++ b/CRM/Core/Payment/Google.php @@ -60,7 +60,9 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * - * @return void + * @param $paymentProcessor + * + * @return \CRM_Core_Payment_Google */ function __construct($mode, &$paymentProcessor) { $this->_mode = $mode; @@ -73,9 +75,10 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * + * @param object $paymentProcessor + * * @return object * @static - * */ static function &singleton($mode, &$paymentProcessor) { $processorName = $paymentProcessor['name']; diff --git a/CRM/Core/Payment/GoogleIPN.php b/CRM/Core/Payment/GoogleIPN.php index e17c5d07cd..c2f291e6e2 100644 --- a/CRM/Core/Payment/GoogleIPN.php +++ b/CRM/Core/Payment/GoogleIPN.php @@ -77,7 +77,9 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN { * * @param string $mode the mode of operation: live or test * - * @return void + * @param $paymentProcessor + * + * @return \CRM_Core_Payment_GoogleIPN */ function __construct($mode, &$paymentProcessor) { parent::__construct(); diff --git a/CRM/Core/Payment/IATS.php b/CRM/Core/Payment/IATS.php index 11788114e1..d4656354e5 100644 --- a/CRM/Core/Payment/IATS.php +++ b/CRM/Core/Payment/IATS.php @@ -53,7 +53,9 @@ class CRM_Core_Payment_IATS extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * - * @return void + * @param $paymentProcessor + * + * @return \CRM_Core_Payment_IATS */ function __construct($mode, &$paymentProcessor) { $this->_paymentProcessor = $paymentProcessor; diff --git a/CRM/Core/Payment/Moneris.php b/CRM/Core/Payment/Moneris.php index 63a1d04ee6..5e68b7472d 100644 --- a/CRM/Core/Payment/Moneris.php +++ b/CRM/Core/Payment/Moneris.php @@ -51,7 +51,9 @@ class CRM_Core_Payment_Moneris extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * - * @return void + * @param $paymentProcessor + * + * @return \CRM_Core_Payment_Moneris */ function __construct($mode, &$paymentProcessor) { $this->_mode = $mode; @@ -81,9 +83,10 @@ class CRM_Core_Payment_Moneris extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * + * @param object $paymentProcessor + * * @return object * @static - * */ static function &singleton($mode, &$paymentProcessor) { $processorName = $paymentProcessor['name']; diff --git a/CRM/Core/Payment/PayJunction.php b/CRM/Core/Payment/PayJunction.php index 1be136f40b..760ad6c038 100644 --- a/CRM/Core/Payment/PayJunction.php +++ b/CRM/Core/Payment/PayJunction.php @@ -33,7 +33,9 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * - * @return void + * @param $paymentProcessor + * + * @return \CRM_Core_Payment_PayJunction */ function __construct($mode, &$paymentProcessor) { //require PayJunction API library diff --git a/CRM/Core/Payment/PayPalImpl.php b/CRM/Core/Payment/PayPalImpl.php index c43996c542..3e1de6f7aa 100644 --- a/CRM/Core/Payment/PayPalImpl.php +++ b/CRM/Core/Payment/PayPalImpl.php @@ -51,7 +51,9 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * - * @return void + * @param $paymentProcessor + * + * @return \CRM_Core_Payment_PayPalImpl */ function __construct($mode, &$paymentProcessor) { $this->_mode = $mode; @@ -77,9 +79,12 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * + * @param object $paymentProcessor + * @param null $paymentForm + * @param bool $force + * * @return object * @static - * */ static function &singleton($mode, &$paymentProcessor, &$paymentForm = NULL, $force = FALSE) { $processorName = $paymentProcessor['name']; diff --git a/CRM/Core/Payment/PayPalProIPN.php b/CRM/Core/Payment/PayPalProIPN.php index 09a92c66b7..f31851b58b 100644 --- a/CRM/Core/Payment/PayPalProIPN.php +++ b/CRM/Core/Payment/PayPalProIPN.php @@ -70,8 +70,11 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN { /** * function exists to get the values from the rp_invoice_id string + * * @param string $name e.g. i, values are stored in the string with letter codes * @param boolean $abort fatal if not found? + * + * @throws CRM_Core_Exception * @return unknown */ function getValue($name, $abort = TRUE) { @@ -123,6 +126,8 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN { * - Integer * @param string $location - deprecated * @param boolean $abort abort if empty + * + * @throws CRM_Core_Exception * @return Ambigous */ function retrieve($name, $type, $location = 'POST', $abort = TRUE) { diff --git a/CRM/Core/Payment/PayflowPro.php b/CRM/Core/Payment/PayflowPro.php index 3ff01c2c0f..27d3a7eae2 100644 --- a/CRM/Core/Payment/PayflowPro.php +++ b/CRM/Core/Payment/PayflowPro.php @@ -41,9 +41,10 @@ class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * + * @param object $paymentProcessor + * * @return object * @static - * */ static function &singleton($mode, &$paymentProcessor) { $processorName = $paymentProcessor['name']; diff --git a/CRM/Core/Payment/PaymentExpress.php b/CRM/Core/Payment/PaymentExpress.php index 29753eb38f..205fdb67ea 100644 --- a/CRM/Core/Payment/PaymentExpress.php +++ b/CRM/Core/Payment/PaymentExpress.php @@ -51,7 +51,9 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * - * @return void + * @param $paymentProcessor + * + * @return \CRM_Core_Payment_PaymentExpress */ function __construct($mode, &$paymentProcessor) { diff --git a/CRM/Core/Payment/PaymentExpressIPN.php b/CRM/Core/Payment/PaymentExpressIPN.php index 42411068ae..b519abb2f0 100644 --- a/CRM/Core/Payment/PaymentExpressIPN.php +++ b/CRM/Core/Payment/PaymentExpressIPN.php @@ -74,7 +74,9 @@ class CRM_Core_Payment_PaymentExpressIPN extends CRM_Core_Payment_BaseIPN { * * @param string $mode the mode of operation: live or test * - * @return void + * @param $paymentProcessor + * + * @return \CRM_Core_Payment_PaymentExpressIPN */ function __construct($mode, &$paymentProcessor) { parent::__construct(); diff --git a/CRM/Core/Payment/Realex.php b/CRM/Core/Payment/Realex.php index 0df509946d..fd0102c6b3 100644 --- a/CRM/Core/Payment/Realex.php +++ b/CRM/Core/Payment/Realex.php @@ -59,7 +59,9 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * - * @return void + * @param $paymentProcessor + * + * @return \CRM_Core_Payment_Realex */ function __construct($mode, &$paymentProcessor) { $this->_mode = $mode; @@ -80,9 +82,10 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { * * @param string $mode the mode of operation: live or test * + * @param object $paymentProcessor + * * @return object * @static - * */ static function &singleton($mode, &$paymentProcessor) { $processorName = $paymentProcessor['name']; diff --git a/CRM/Core/Payment/eWAY.php b/CRM/Core/Payment/eWAY.php index 10f2a3236d..322d108af4 100644 --- a/CRM/Core/Payment/eWAY.php +++ b/CRM/Core/Payment/eWAY.php @@ -472,13 +472,15 @@ class CRM_Core_Payment_eWAY extends CRM_Core_Payment { * NOTE: Called by Events and Contribute to check config params are set prior to trying * register any credit card details * - * @param string $mode the mode we are operating in (live or test) - not used but could be + * @return null|string + * @internal param string $mode the mode we are operating in (live or test) - not used but could be * to check that the 'test' mode CustomerID was equal to '87654321' and that the URL was * set to https://www.eway.com.au/gateway_cvn/xmltest/TestPage.asp * * returns string $errorMsg if any errors found - null if OK * - ********************************************************************************************/ + ****************************************************************************************** + */ //function checkConfig( $mode ) // CiviCRM V1.9 Declaration // CiviCRM V2.0 Declaration function checkConfig() { diff --git a/CRM/Core/Permission.php b/CRM/Core/Permission.php index 3c30ad036b..fc40a98898 100644 --- a/CRM/Core/Permission.php +++ b/CRM/Core/Permission.php @@ -374,7 +374,9 @@ class CRM_Core_Permission { * @param string $module component name. * @param $action action to be check across component * - **/ + * + * @return bool + */ static function checkActionPermission($module, $action) { //check delete related permissions. if ($action & CRM_Core_Action::DELETE) { @@ -619,6 +621,8 @@ class CRM_Core_Permission { * @param string $permission * * return string $componentName the name of component. + * + * @return int|null|string * @static */ static function getComponentName($permission) { diff --git a/CRM/Core/Permission/Base.php b/CRM/Core/Permission/Base.php index d94a096514..f6c5d387cf 100644 --- a/CRM/Core/Permission/Base.php +++ b/CRM/Core/Permission/Base.php @@ -41,9 +41,11 @@ class CRM_Core_Permission_Base { /** * Translate permission * - * @param string $name e.g. "administer CiviCRM", "cms:access user record", "Drupal:administer content", "Joomla:action:com_asset" + * @param $perm * @param string $nativePrefix * @param array $map array($portableName => $nativeName) + * + * @internal param string $name e.g. "administer CiviCRM", "cms:access user record", "Drupal:administer content", "Joomla:action:com_asset" * @return NULL|string a permission name */ public function translatePermission($perm, $nativePrefix, $map) { @@ -96,17 +98,17 @@ class CRM_Core_Permission_Base { $this->group(); return $this->groupClause($type, $tables, $whereTables); } + /** * Get all groups from database, filtered by permissions * for this user * - * @param string $groupType type of group(Access/Mailing) - * @param boolen $excludeHidden exclude hidden groups. + * @param string $groupType type of group(Access/Mailing) + * @param bool|\boolen $excludeHidden exclude hidden groups. * * @access public * * @return array - array reference of all groups. - * */ public function group($groupType = NULL, $excludeHidden = TRUE) { return CRM_Core_PseudoConstant::allGroup($groupType, $excludeHidden); @@ -192,6 +194,8 @@ class CRM_Core_Permission_Base { * version has removed permission that were defined in the older version. * * @param array $permissions same format as CRM_Core_Permission::getCorePermissions(). + * + * @throws CRM_Core_Exception * @see CRM_Core_Permission::getCorePermissions */ function upgradePermissions($permissions) { @@ -205,6 +209,8 @@ class CRM_Core_Permission_Base { * Note: At time of writing, this is only used with native extension-modules, so * there's one, predictable calling convention (regardless of CMS). * + * @param $module + * * @return Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions(). * @see CRM_Core_Permission::getCorePermissions */ diff --git a/CRM/Core/Permission/Drupal.php b/CRM/Core/Permission/Drupal.php index 17c6526750..da1ab4b343 100644 --- a/CRM/Core/Permission/Drupal.php +++ b/CRM/Core/Permission/Drupal.php @@ -67,6 +67,8 @@ class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase{ * * @param string $str the permission to check * + * @param null $contactID + * * @return boolean true if yes, else false * @access public */ diff --git a/CRM/Core/Permission/Drupal6.php b/CRM/Core/Permission/Drupal6.php index 8027cd1c4f..a8dd2af914 100644 --- a/CRM/Core/Permission/Drupal6.php +++ b/CRM/Core/Permission/Drupal6.php @@ -66,6 +66,8 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { * * @param string $str the permission to check * + * @param null $contactID + * * @return boolean true if yes, else false * @access public */ diff --git a/CRM/Core/Permission/DrupalBase.php b/CRM/Core/Permission/DrupalBase.php index 56e03e7b1b..d65374b2c5 100644 --- a/CRM/Core/Permission/DrupalBase.php +++ b/CRM/Core/Permission/DrupalBase.php @@ -65,13 +65,12 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { * Get all groups from database, filtered by permissions * for this user * - * @param string $groupType type of group(Access/Mailing) - * @param boolen $excludeHidden exclude hidden groups. + * @param string $groupType type of group(Access/Mailing) + * @param bool|\boolen $excludeHidden exclude hidden groups. * * @access public * * @return array - array reference of all groups. - * */ public function group($groupType = NULL, $excludeHidden = TRUE) { if (!isset($this->_viewPermissionedGroups)) { diff --git a/CRM/Core/Permission/Joomla.php b/CRM/Core/Permission/Joomla.php index 71809cadd5..db2a31eff7 100644 --- a/CRM/Core/Permission/Joomla.php +++ b/CRM/Core/Permission/Joomla.php @@ -70,7 +70,9 @@ class CRM_Core_Permission_Joomla extends CRM_Core_Permission_Base { } /** - * @param string $name e.g. "administer CiviCRM", "cms:access user record", "Drupal:administer content", "Joomla:example.action:com_some_asset" + * @param $perm + * + * @internal param string $name e.g. "administer CiviCRM", "cms:access user record", "Drupal:administer content", "Joomla:example.action:com_some_asset" * @return ALWAYS_DENY_PERMISSION|ALWAYS_ALLOW_PERMISSION|array(0 => $joomlaAction, 1 => $joomlaAsset) */ function translateJoomlaPermission($perm) { diff --git a/CRM/Core/PseudoConstant.php b/CRM/Core/PseudoConstant.php index f0df9aac37..febe9249c3 100644 --- a/CRM/Core/PseudoConstant.php +++ b/CRM/Core/PseudoConstant.php @@ -1379,10 +1379,9 @@ WHERE id = %1"; * @access public * @static * - * @param int $id - Optional id to return + * @param bool|int $id - Optional id to return * * @return array - array reference of all Counties - * */ public static function &county($id = FALSE) { if (!self::$county) { @@ -1411,11 +1410,12 @@ WHERE id = %1"; * @access public * @static * - * @param boolean $all - get payment processors - default is to get only active ones. + * @param boolean $all - get payment processors - default is to get only active ones. * @param boolean $test - get test payment processors * - * @return array - array of all payment processors + * @param null $additionalCond * + * @return array - array of all payment processors */ public static function &paymentProcessor($all = FALSE, $test = FALSE, $additionalCond = NULL) { $condition = "is_test = "; @@ -1445,10 +1445,12 @@ WHERE id = %1"; * @access public * @static * - * @param boolean $all - get payment processors - default is to get only active ones. + * @param boolean $all - get payment processors - default is to get only active ones. * - * @return array - array of all payment processor types + * @param null $id + * @param string $return * + * @return array - array of all payment processor types */ public static function &paymentProcessorType($all = FALSE, $id = NULL, $return = 'title') { $cacheKey = $id . '_' .$return; @@ -1466,6 +1468,8 @@ WHERE id = %1"; * * @access public * + * @param bool $id + * * @return array - array reference of all World Regions * @static */ @@ -1496,6 +1500,8 @@ WHERE id = %1"; * @access public * @static * + * @param string $column + * * @return array - array reference of all activity statuses */ public static function &activityStatus($column = 'label') { @@ -1521,8 +1527,9 @@ WHERE id = %1"; * @access public * @static * - * @return array - array reference of all Visibility levels. + * @param string $column * + * @return array - array reference of all Visibility levels. */ public static function &visibility($column = 'label') { if (!isset(self::$visibility)) { @@ -1673,8 +1680,9 @@ WHERE id = %1 * * @param $filter - get All Email Greetings - default is to get only active ones. * - * @return array - array reference of all greetings. + * @param string $columnName * + * @return array - array reference of all greetings. */ public static function greeting($filter, $columnName = 'label') { $index = $filter['greeting_type'] . '_' . $columnName; @@ -1784,8 +1792,10 @@ WHERE id = %1 * * @param boolean $optionGroupName - get All Option Group values- default is to get only active ones. * - * @return array - array reference of all Option Group Name + * @param null $id + * @param null $condition * + * @return array - array reference of all Option Group Name */ public static function accountOptionValues($optionGroupName, $id = null, $condition = null) { $cacheKey = $optionGroupName . '_' . $condition; diff --git a/CRM/Core/QuickForm/Action.php b/CRM/Core/QuickForm/Action.php index eec3f7a5db..23c06f73be 100644 --- a/CRM/Core/QuickForm/Action.php +++ b/CRM/Core/QuickForm/Action.php @@ -46,11 +46,12 @@ class CRM_Core_QuickForm_Action extends HTML_QuickForm_Action { /** * constructor * - * @param object $stateMachine reference to state machine object + * @param object $stateMachine reference to state machine object * - * @return object - * @access public - */ function __construct(&$stateMachine) { + * @return \CRM_Core_QuickForm_Action + @access public + */ + function __construct(&$stateMachine) { $this->_stateMachine = &$stateMachine; } diff --git a/CRM/Core/QuickForm/Action/Back.php b/CRM/Core/QuickForm/Action/Back.php index 1fec9f030e..42d50002fe 100644 --- a/CRM/Core/QuickForm/Action/Back.php +++ b/CRM/Core/QuickForm/Action/Back.php @@ -40,8 +40,8 @@ class CRM_Core_QuickForm_Action_Back extends CRM_Core_QuickForm_Action { * * @param object $stateMachine reference to state machine object * - * @return object - * @access public + * @return \CRM_Core_QuickForm_Action_Back + @access public */ function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Cancel.php b/CRM/Core/QuickForm/Action/Cancel.php index 6e4c10fbe9..0351cf91c4 100644 --- a/CRM/Core/QuickForm/Action/Cancel.php +++ b/CRM/Core/QuickForm/Action/Cancel.php @@ -40,8 +40,8 @@ class CRM_Core_QuickForm_Action_Cancel extends CRM_Core_QuickForm_Action { * * @param object $stateMachine reference to state machine object * - * @return object - * @access public + * @return \CRM_Core_QuickForm_Action_Cancel + @access public */ function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Display.php b/CRM/Core/QuickForm/Action/Display.php index a18581d7fa..a6ec11548a 100644 --- a/CRM/Core/QuickForm/Action/Display.php +++ b/CRM/Core/QuickForm/Action/Display.php @@ -52,8 +52,8 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { * * @param object $stateMachine reference to state machine object * - * @return object - * @access public + * @return \CRM_Core_QuickForm_Action_Display + @access public */ function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Done.php b/CRM/Core/QuickForm/Action/Done.php index e030a5a7ab..ba098a6c61 100644 --- a/CRM/Core/QuickForm/Action/Done.php +++ b/CRM/Core/QuickForm/Action/Done.php @@ -40,8 +40,8 @@ class CRM_Core_QuickForm_Action_Done extends CRM_Core_QuickForm_Action { * * @param object $stateMachine reference to state machine object * - * @return object - * @access public + * @return \CRM_Core_QuickForm_Action_Done + @access public */ function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Jump.php b/CRM/Core/QuickForm/Action/Jump.php index 00f001736c..73276c14e2 100644 --- a/CRM/Core/QuickForm/Action/Jump.php +++ b/CRM/Core/QuickForm/Action/Jump.php @@ -40,8 +40,8 @@ class CRM_Core_QuickForm_Action_Jump extends CRM_Core_QuickForm_Action { * * @param object $stateMachine reference to state machine object * - * @return object - * @access public + * @return \CRM_Core_QuickForm_Action_Jump + @access public */ function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Next.php b/CRM/Core/QuickForm/Action/Next.php index 446b7b22a2..4ebdf964d2 100644 --- a/CRM/Core/QuickForm/Action/Next.php +++ b/CRM/Core/QuickForm/Action/Next.php @@ -40,8 +40,8 @@ class CRM_Core_QuickForm_Action_Next extends CRM_Core_QuickForm_Action { * * @param object $stateMachine reference to state machine object * - * @return object - * @access public + * @return \CRM_Core_QuickForm_Action_Next + @access public */ function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Process.php b/CRM/Core/QuickForm/Action/Process.php index 5a13858913..8be24345ec 100644 --- a/CRM/Core/QuickForm/Action/Process.php +++ b/CRM/Core/QuickForm/Action/Process.php @@ -40,8 +40,8 @@ class CRM_Core_QuickForm_Action_Process extends CRM_Core_QuickForm_Action { * * @param object $stateMachine reference to state machine object * - * @return object - * @access public + * @return \CRM_Core_QuickForm_Action_Process + @access public */ function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Refresh.php b/CRM/Core/QuickForm/Action/Refresh.php index f893e7a41e..564edfa6e1 100644 --- a/CRM/Core/QuickForm/Action/Refresh.php +++ b/CRM/Core/QuickForm/Action/Refresh.php @@ -40,8 +40,8 @@ class CRM_Core_QuickForm_Action_Refresh extends CRM_Core_QuickForm_Action { * * @param object $stateMachine reference to state machine object * - * @return object - * @access public + * @return \CRM_Core_QuickForm_Action_Refresh + @access public */ function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Reload.php b/CRM/Core/QuickForm/Action/Reload.php index 663d1068c7..352621eb90 100644 --- a/CRM/Core/QuickForm/Action/Reload.php +++ b/CRM/Core/QuickForm/Action/Reload.php @@ -43,8 +43,8 @@ class CRM_Core_QuickForm_Action_Reload extends CRM_Core_QuickForm_Action { * * @param object $stateMachine reference to state machine object * - * @return object - * @access public + * @return \CRM_Core_QuickForm_Action_Reload + @access public */ function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Submit.php b/CRM/Core/QuickForm/Action/Submit.php index edbe64213a..69505b96b1 100644 --- a/CRM/Core/QuickForm/Action/Submit.php +++ b/CRM/Core/QuickForm/Action/Submit.php @@ -40,8 +40,8 @@ class CRM_Core_QuickForm_Action_Submit extends CRM_Core_QuickForm_Action { * * @param object $stateMachine reference to state machine object * - * @return object - * @access public + * @return \CRM_Core_QuickForm_Action_Submit + @access public */ function __construct(&$stateMachine) { parent::__construct($stateMachine); diff --git a/CRM/Core/QuickForm/Action/Upload.php b/CRM/Core/QuickForm/Action/Upload.php index 99383accae..15d90e4e39 100644 --- a/CRM/Core/QuickForm/Action/Upload.php +++ b/CRM/Core/QuickForm/Action/Upload.php @@ -51,12 +51,13 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action { * class constructor * * @param object $stateMachine reference to state machine object - * @param string $uploadDir directory to store the uploaded files - * @param array $uploadNames element names of the various uploadable files + * @param string $uploadDir directory to store the uploaded files + * @param array $uploadNames element names of the various uploadable files * - * @return object - * @access public - */ function __construct(&$stateMachine, $uploadDir, $uploadNames) { + * @return \CRM_Core_QuickForm_Action_Upload + @access public + */ + function __construct(&$stateMachine, $uploadDir, $uploadNames) { parent::__construct($stateMachine); $this->_uploadDir = $uploadDir; diff --git a/CRM/Core/Region.php b/CRM/Core/Region.php index c3b25ec0e5..5cde68767e 100644 --- a/CRM/Core/Region.php +++ b/CRM/Core/Region.php @@ -94,6 +94,8 @@ class CRM_Core_Region { * - jquery: string, Javascript code which runs inside a jQuery(function($){...}); block * - style: string, CSS code * - styleUrl: string, URL of a CSS file + * + * @return array */ public function add($snippet) { static $types = array('markup', 'template', 'callback', 'scriptUrl', 'script', 'jquery', 'style', 'styleUrl'); diff --git a/CRM/Core/Report/Excel.php b/CRM/Core/Report/Excel.php index e81ea88968..b4aed5ee2a 100644 --- a/CRM/Core/Report/Excel.php +++ b/CRM/Core/Report/Excel.php @@ -34,9 +34,12 @@ class CRM_Core_Report_Excel { * Outputs a result set with a given header * in the string buffer result * - * @param string $header (reference ) column headers - * @param string $rows (reference ) result set rows - * @param boolean $print should the output be printed + * @param string $header (reference ) column headers + * @param string $rows (reference ) result set rows + * @param null $titleHeader + * @param boolean $print should the output be printed + * + * @param bool $outputHeader * * @return mixed empty if output is printed, else output * diff --git a/CRM/Core/Session.php b/CRM/Core/Session.php index 059fb22bdd..50a8ff605b 100644 --- a/CRM/Core/Session.php +++ b/CRM/Core/Session.php @@ -79,7 +79,7 @@ class CRM_Core_Session { * This constructor is invoked whenever any module requests an instance of * the session and one is not available. * - * @return void + * @return \CRM_Core_Session */ function __construct() { $this->_session = null; diff --git a/CRM/Core/ShowHideBlocks.php b/CRM/Core/ShowHideBlocks.php index 1beece8d4c..0d432db148 100644 --- a/CRM/Core/ShowHideBlocks.php +++ b/CRM/Core/ShowHideBlocks.php @@ -61,8 +61,7 @@ class CRM_Core_ShowHideBlocks { * @param array $show initial value of show array * @param array $hide initial value of hide array * - * @return Object the newly created object - * @access public + * @return \CRM_Core_ShowHideBlocks the newly created object@access public */ function __construct($show = NULL, $hide = NULL) { if (!empty($show)) { diff --git a/CRM/Core/Smarty.php b/CRM/Core/Smarty.php index 0e55b1fa27..0da5594db8 100644 --- a/CRM/Core/Smarty.php +++ b/CRM/Core/Smarty.php @@ -189,6 +189,8 @@ class CRM_Core_Smarty extends Smarty { * @param string $cache_id * @param string $compile_id * @param boolean $display + * + * @return bool|mixed|string */ function fetch($resource_name, $cache_id = NULL, $compile_id = NULL, $display = FALSE) { if (preg_match( '/^(\s+)?string:/', $resource_name)) { diff --git a/CRM/Core/Smarty/plugins/block.crmRegion.php b/CRM/Core/Smarty/plugins/block.crmRegion.php index f100c49834..504fe8ff18 100644 --- a/CRM/Core/Smarty/plugins/block.crmRegion.php +++ b/CRM/Core/Smarty/plugins/block.crmRegion.php @@ -5,9 +5,11 @@ * * @see CRM_Core_Regions * - * @param array $params must define 'name' - * @param string $content Default content - * @param object $smarty the Smarty object + * @param array $params must define 'name' + * @param string $content Default content + * @param object $smarty the Smarty object + * + * @param $repeat * * @return string */ diff --git a/CRM/Core/Smarty/plugins/block.crmScope.php b/CRM/Core/Smarty/plugins/block.crmScope.php index b02efd10fe..ec45c53a5e 100644 --- a/CRM/Core/Smarty/plugins/block.crmScope.php +++ b/CRM/Core/Smarty/plugins/block.crmScope.php @@ -15,9 +15,11 @@ * {/tsScope} * @endcode * - * @param array $params must define 'name' - * @param string $content Default content - * @param object $smarty the Smarty object + * @param array $params must define 'name' + * @param string $content Default content + * @param object $smarty the Smarty object + * + * @param $repeat * * @return string */ @@ -47,4 +49,4 @@ function _smarty_block_crmScope_applyFrame(&$smarty, $frame) { foreach ($frame as $key => $value) { $smarty->assign($key, $value); } -} \ No newline at end of file +} diff --git a/CRM/Core/Smarty/plugins/function.crmResURL.php b/CRM/Core/Smarty/plugins/function.crmResURL.php index 16d644f98a..8b9dc8a7e1 100644 --- a/CRM/Core/Smarty/plugins/function.crmResURL.php +++ b/CRM/Core/Smarty/plugins/function.crmResURL.php @@ -39,6 +39,9 @@ * @param $params array with keys: * - ext: string, extension name. see CRM_Core_Resources::getUrl * - file: string, relative file path. see CRM_Core_Resources::getUrl + * @param $smarty + * + * @return string */ function smarty_function_crmResURL($params, &$smarty) { $res = CRM_Core_Resources::singleton(); diff --git a/CRM/Core/Smarty/plugins/function.crmScript.php b/CRM/Core/Smarty/plugins/function.crmScript.php index 013eb6099b..f6096eb703 100644 --- a/CRM/Core/Smarty/plugins/function.crmScript.php +++ b/CRM/Core/Smarty/plugins/function.crmScript.php @@ -42,6 +42,9 @@ * - url: string. see CRM_Core_Resources::addScriptURL * - weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0) * - region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header') + * @param $smarty + * + * @throws Exception */ function smarty_function_crmScript($params, &$smarty) { $res = CRM_Core_Resources::singleton(); diff --git a/CRM/Core/Smarty/plugins/function.crmStyle.php b/CRM/Core/Smarty/plugins/function.crmStyle.php index fee4192ce4..37eb7cea4d 100644 --- a/CRM/Core/Smarty/plugins/function.crmStyle.php +++ b/CRM/Core/Smarty/plugins/function.crmStyle.php @@ -42,6 +42,9 @@ * - url: string. see CRM_Core_Resources::addStyleURL * - weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0) * - region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header') + * @param $smarty + * + * @throws Exception */ function smarty_function_crmStyle($params, &$smarty) { $res = CRM_Core_Resources::singleton(); diff --git a/CRM/Core/Smarty/plugins/function.simpleActivityContacts.php b/CRM/Core/Smarty/plugins/function.simpleActivityContacts.php index 5a09d02e9a..a1f4a7453c 100644 --- a/CRM/Core/Smarty/plugins/function.simpleActivityContacts.php +++ b/CRM/Core/Smarty/plugins/function.simpleActivityContacts.php @@ -11,12 +11,14 @@ * Note: This will perform like a dog, but who cares -- at most, we deal with O(100) iterations * as part of a background task. * - * @param $params, array with keys: + * @param $params , array with keys: * - activity_id: int, required * - target_var: string, optional; name of a variable which will store the first/only target contact; default "target" * - assignee_var: string, optional; name of a variable which will store the first/only assignee contact; default "assignee" * - return: string, optional; comma-separated list of fields to return for each contact * + * @param $smarty + * * @return empty */ function smarty_function_simpleActivityContacts($params, &$smarty) { diff --git a/CRM/Core/Smarty/plugins/modifier.crmBtnType.php b/CRM/Core/Smarty/plugins/modifier.crmBtnType.php index 5d24102271..cb71859c9d 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmBtnType.php +++ b/CRM/Core/Smarty/plugins/modifier.crmBtnType.php @@ -36,7 +36,9 @@ /** * Grab the button type from a passed button element 'name' by checking for reserved QF button type strings * - * @param string $btnId + * @param $btnName + * + * @internal param string $btnId * * @return string button type, one of: 'upload', 'next', 'back', 'cancel', 'refresh' * 'submit', 'done', 'display', 'jump' 'process' diff --git a/CRM/Core/Smarty/plugins/modifier.crmDate.php b/CRM/Core/Smarty/plugins/modifier.crmDate.php index 1b2b5c288a..805c81bbdc 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmDate.php +++ b/CRM/Core/Smarty/plugins/modifier.crmDate.php @@ -38,6 +38,9 @@ * * @param string $dateString date which needs to converted to human readable format * + * @param null $dateFormat + * @param bool $onlyTime + * * @return string human readable date format | invalid date message * @access public */ diff --git a/CRM/Core/Smarty/plugins/modifier.crmFirstWord.php b/CRM/Core/Smarty/plugins/modifier.crmFirstWord.php index 92663b94c7..404cb7a814 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmFirstWord.php +++ b/CRM/Core/Smarty/plugins/modifier.crmFirstWord.php @@ -39,9 +39,10 @@ * no replacement is mentioned the value is inserted at the end of * the form element * - * @param string $string the html to be tweaked with - * @param string $attribute the attribute to modify - * @param string $value the new attribute value + * @param string $string the html to be tweaked with + * + * @internal param string $attribute the attribute to modify + * @internal param string $value the new attribute value * * @return string the new modified html string * @access public diff --git a/CRM/Core/Smarty/plugins/modifier.crmICalDate.php b/CRM/Core/Smarty/plugins/modifier.crmICalDate.php index 549d189330..ba9a4622d5 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmICalDate.php +++ b/CRM/Core/Smarty/plugins/modifier.crmICalDate.php @@ -38,6 +38,8 @@ * * @param string $str * + * @param bool $gdata + * * @return string formatted text * @access public */ diff --git a/CRM/Core/Smarty/plugins/modifier.crmMoney.php b/CRM/Core/Smarty/plugins/modifier.crmMoney.php index 8fad62359a..8acf7b9847 100644 --- a/CRM/Core/Smarty/plugins/modifier.crmMoney.php +++ b/CRM/Core/Smarty/plugins/modifier.crmMoney.php @@ -36,8 +36,11 @@ /** * Format the given monetary amount (and currency) for display * - * @param float $amount the monetary amount up for display - * @param string $currency the (optional) currency + * @param float $amount the monetary amount up for display + * @param string $currency the (optional) currency + * + * @param null $format + * @param bool $onlyNumber * * @return string formatted monetary amount * @access public diff --git a/CRM/Core/State.php b/CRM/Core/State.php index 5f65d674b8..48d67bbb9c 100644 --- a/CRM/Core/State.php +++ b/CRM/Core/State.php @@ -79,14 +79,20 @@ class CRM_Core_State { /** * constructor * - * @param string the internal name of the state - * @param int the state type - * @param object the state that precedes this state - * @param object the state that follows this state - * @param object the statemachine that this states belongs to + * @param $name + * @param $type + * @param $back + * @param $next + * @param $stateMachine * - * @return object - * @access public + * @internal param \the $string internal name of the state + * @internal param \the $int state type + * @internal param \the $object state that precedes this state + * @internal param \the $object state that follows this state + * @internal param \the $object statemachine that this states belongs to + * + * @return \CRM_Core_State + @access public */ function __construct($name, $type, $back, $next, &$stateMachine) { $this->_name = $name; diff --git a/CRM/Core/TemporaryErrorScope.php b/CRM/Core/TemporaryErrorScope.php index 1873c90885..311f047456 100644 --- a/CRM/Core/TemporaryErrorScope.php +++ b/CRM/Core/TemporaryErrorScope.php @@ -40,6 +40,8 @@ class CRM_Core_TemporaryErrorScope { /** * @param mixed $callback + * @param null $modeException + * * @return CRM_Core_TemporaryErrorScope */ public static function create($callback, $modeException = NULL) { diff --git a/CRM/Custom/Form/CustomData.php b/CRM/Custom/Form/CustomData.php index c4d03c0e77..e1f721438c 100644 --- a/CRM/Custom/Form/CustomData.php +++ b/CRM/Custom/Form/CustomData.php @@ -45,6 +45,8 @@ class CRM_Custom_Form_CustomData { * @param null|int $groupCount * @param null|String $type * @param null|int $entityID + * @param null $onlySubType + * * @return void */ static function preProcess(&$form, $subName = NULL, $subType = NULL, diff --git a/CRM/Custom/Form/Field.php b/CRM/Custom/Form/Field.php index e7d043cda6..10b3b1da92 100644 --- a/CRM/Custom/Form/Field.php +++ b/CRM/Custom/Form/Field.php @@ -561,7 +561,10 @@ class CRM_Custom_Form_Field extends CRM_Core_Form { /** * global validation rules for the form * - * @param array $fields (referance) posted values of the form + * @param array $fields (referance) posted values of the form + * + * @param $files + * @param $self * * @return array if errors then list of errors to be posted back to the form, * true otherwise diff --git a/CRM/Dashlet/Page/Blog.php b/CRM/Dashlet/Page/Blog.php index 4c58e37c6b..1e225d4a29 100644 --- a/CRM/Dashlet/Page/Blog.php +++ b/CRM/Dashlet/Page/Blog.php @@ -102,6 +102,8 @@ class CRM_Dashlet_Page_Blog extends CRM_Core_Page { /** * Parse rss feed and cache results * + * @param $url + * * @return array|NULL array of blog items; or NULL if not available * * @access public diff --git a/CRM/Dedupe/BAO/RuleGroup.php b/CRM/Dedupe/BAO/RuleGroup.php index 825c2b3b59..28048a1c60 100644 --- a/CRM/Dedupe/BAO/RuleGroup.php +++ b/CRM/Dedupe/BAO/RuleGroup.php @@ -368,10 +368,11 @@ class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup { /** * To find fields related to a rule group. * - * @param array contains the rule group property to identify rule group + * @param $params * - * @return (rule field => weight) array and threshold associated to rule group - * @access public + * @internal param \contains $array the rule group property to identify rule group + * + * @return array (rule field => weight) array and threshold associated to rule group@access public */ static function dedupeRuleFieldsWeight($params) { $rgBao = new CRM_Dedupe_BAO_RuleGroup(); diff --git a/CRM/Dedupe/Merger.php b/CRM/Dedupe/Merger.php index 28bb854c95..f68d4471cf 100644 --- a/CRM/Dedupe/Merger.php +++ b/CRM/Dedupe/Merger.php @@ -488,6 +488,7 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m * @param array $main contact details * @param array $other contact details * + * @return array * @static */ static function findDifferences($main, $other) { @@ -521,16 +522,19 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m /** * Function to batch merge a set of contacts based on rule-group and group. * - * @param int $rgid rule group id - * @param int $gid group id - * @param array $cacheParams prev-next-cache params based on which next pair of contacts are computed. - * Generally used with batch-merge. - * @param string $mode helps decide how to behave when there are conflicts. + * @param int $rgid rule group id + * @param int $gid group id + * @param string $mode helps decide how to behave when there are conflicts. * A 'safe' value skips the merge if there are any un-resolved conflicts. * Does a force merge otherwise. - * @param boolean $autoFlip wether to let api decide which contact to retain and which to delete. + * @param boolean $autoFlip wether to let api decide which contact to retain and which to delete. + * * + * @param bool $redirectForPerformance * + * @return array|bool + * @internal param array $cacheParams prev-next-cache params based on which next pair of contacts are computed. + * Generally used with batch-merge. * @static * @access public */ @@ -564,15 +568,18 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m /** * Function to merge given set of contacts. Performs core operation. * - * @param array $dupePairs set of pair of contacts for whom merge is to be done. - * @param array $cacheParams prev-next-cache params based on which next pair of contacts are computed. + * @param array $dupePairs set of pair of contacts for whom merge is to be done. + * @param array $cacheParams prev-next-cache params based on which next pair of contacts are computed. * Generally used with batch-merge. - * @param string $mode helps decide how to behave when there are conflicts. + * @param string $mode helps decide how to behave when there are conflicts. * A 'safe' value skips the merge if there are any un-resolved conflicts. * Does a force merge otherwise (aggressive mode). - * @param boolean $autoFlip wether to let api decide which contact to retain and which to delete. + * @param boolean $autoFlip wether to let api decide which contact to retain and which to delete. * * + * @param bool $redirectForPerformance + * + * @return array|bool * @static * @access public */ @@ -653,13 +660,14 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m * A function which uses various rules / algorithms for choosing which contact to bias to * when there's a conflict (to handle "gotchas"). Plus the safest route to merge. * - * @param int $mainId main contact with whom merge has to happen - * @param int $otherId duplicate contact which would be deleted after merge operation - * @param array $migrationInfo array of information about which elements to merge. - * @param string $mode helps decide how to behave when there are conflicts. + * @param int $mainId main contact with whom merge has to happen + * @param int $otherId duplicate contact which would be deleted after merge operation + * @param array $migrationInfo array of information about which elements to merge. + * @param string $mode helps decide how to behave when there are conflicts. * A 'safe' value skips the merge if there are any un-resolved conflicts. * Does a force merge otherwise (aggressive mode). * + * @return bool * @static * @access public */ @@ -764,9 +772,10 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m /** * A function to build an array of information required by merge function and the merge UI. * - * @param int $mainId main contact with whom merge has to happen - * @param int $otherId duplicate contact which would be deleted after merge operation + * @param int $mainId main contact with whom merge has to happen + * @param int $otherId duplicate contact which would be deleted after merge operation * + * @return array|bool|int * @static * @access public */ @@ -1142,9 +1151,12 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m * other contact to the main one - be it Location / CustomFields or Contact .. related info. * A superset of moveContactBelongings() function. * - * @param int $mainId main contact with whom merge has to happen - * @param int $otherId duplicate contact which would be deleted after merge operation + * @param int $mainId main contact with whom merge has to happen + * @param int $otherId duplicate contact which would be deleted after merge operation + * + * @param $migrationInfo * + * @return bool * @static * @access public */ @@ -1516,7 +1528,7 @@ INNER JOIN civicrm_membership membership2 ON membership1.membership_type_id = m */ static function getContactFields() { $contactFields = CRM_Contact_DAO_Contact::fields(); - $invalidFields = array('api_key', 'contact_is_deleted', 'created_date', 'display_name', 'hash', 'id', 'modified_date', + $invalidFields = array('api_key', 'contact_is_deleted', 'created_date', 'display_name', 'hash', 'id', 'modified_date', 'primary_contact_id', 'sort_name', 'user_unique_id'); foreach ($contactFields as $field => $value) { if (in_array($field, $invalidFields)) { diff --git a/CRM/Event/BAO/Event.php b/CRM/Event/BAO/Event.php index 4f8a9cdd18..d62dcf05fd 100644 --- a/CRM/Event/BAO/Event.php +++ b/CRM/Event/BAO/Event.php @@ -180,8 +180,9 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { /** * Function to delete the event * - * @param int $id event id + * @param int $id event id * + * @return mixed|null * @access public * @static * @@ -257,10 +258,11 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { * @param $all int 0 returns current and future events * 1 if events all are required * 2 returns events since 3 months ago - * @param $id int id of a specific event to return + * @param bool|int $id int id of a specific event to return * @param $isActive boolean true if you need only active events * @param $checkPermission boolean true if you need to check permission else false * + * @return array * @static */ static function getEvents($all = 0, @@ -557,12 +559,14 @@ LIMIT 0, 10 /** * Function to get participant count * + * @param $eventId * @param boolean $considerStatus consider status for participant count. - * @param boolean $status consider counted participant. - * @param boolean $considerRole consider role for participant count. - * @param boolean $role consider counted( is filter role) participant. - * @param array $eventIds consider participants from given events. - * @param boolean $countWithStatus retrieve participant count w/ each participant status. + * @param boolean $status consider counted participant. + * @param boolean $considerRole consider role for participant count. + * @param boolean $role consider counted( is filter role) participant. + * + * @internal param array $eventIds consider participants from given events. + * @internal param bool $countWithStatus retrieve participant count w/ each participant status. * * @access public * @@ -1358,6 +1362,8 @@ WHERE civicrm_event.is_active = 1 * @param array $groupTitle Profile Group Title. * @param array $values formatted array of key value * + * @param array $profileFields + * * @return void * @access public * @static @@ -1615,14 +1621,16 @@ WHERE id = $cfID /** * Function to build the array for Additional participant's information array of priamry and additional Ids * - *@param int $participantId id of Primary participant - *@param array $values key/value event info - *@param int $contactId contact id of Primary participant - *@param boolean $isTest whether test or live transaction - *@param boolean $isIdsArray to return an array of Ids + * @param int $participantId id of Primary participant + * @param array $values key/value event info + * @param int $contactId contact id of Primary participant + * @param boolean $isTest whether test or live transaction + * @param boolean $isIdsArray to return an array of Ids + * + * @param bool $skipCancel * - *@return array $customProfile array of Additional participant's info OR array of Ids. - *@access public + * @return array $customProfile array of Additional participant's info OR array of Ids. + * @access public */ static function buildCustomProfile($participantId, $values, @@ -1861,8 +1869,11 @@ WHERE ce.loc_block_id = $locBlockId"; /** * make sure that the user has permission to access this event * - * @param int $id the id of the event - * @param int $name the name or title of the event + * @param null $eventId + * @param int $type + * + * @internal param int $id the id of the event + * @internal param int $name the name or title of the event * * @return string the permission that the user has (or null) * @access public diff --git a/CRM/Event/BAO/Query.php b/CRM/Event/BAO/Query.php index 5352e135ed..af63922018 100644 --- a/CRM/Event/BAO/Query.php +++ b/CRM/Event/BAO/Query.php @@ -52,6 +52,8 @@ class CRM_Event_BAO_Query { /** * build select for CiviEvent * + * @param $query + * * @return void * @access public */ diff --git a/CRM/Event/Form/EventFees.php b/CRM/Event/Form/EventFees.php index d68f442226..b57cf83e10 100644 --- a/CRM/Event/Form/EventFees.php +++ b/CRM/Event/Form/EventFees.php @@ -42,6 +42,8 @@ class CRM_Event_Form_EventFees { /** * Function to set variables up before form is built * + * @param $form + * * @return void * @access public */ @@ -124,7 +126,7 @@ class CRM_Event_Form_EventFees { if ($form->_action == CRM_Core_Action::ADD && !$form->_mode && $form->_isPaidEvent) { $defaults[$form->_pId]['record_contribution'] = 1; } - + //CRM-13420 if (empty($defaults['payment_instrument_id'])) { $defaults[$form->_pId]['payment_instrument_id'] = key(CRM_Core_OptionGroup::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1')); @@ -254,6 +256,10 @@ class CRM_Event_Form_EventFees { * * @access public * + * @param $participantID + * @param null $eventID + * @param bool $includeQtyZero + * * @return void */ static function setDefaultPriceSet($participantID, $eventID = NULL, $includeQtyZero = TRUE) { diff --git a/CRM/Event/Form/ManageEvent/Registration.php b/CRM/Event/Form/ManageEvent/Registration.php index a759512289..7f8237f0c1 100644 --- a/CRM/Event/Form/ManageEvent/Registration.php +++ b/CRM/Event/Form/ManageEvent/Registration.php @@ -206,8 +206,9 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent /** * Fix what blocks to show/hide based on the default values set * - * @param array $defaults the array of default values - * @param boolean $force should we set show hide based on input defaults + * @param array $defaults the array of default values + * + * @internal param bool $force should we set show hide based on input defaults * * @return void */ diff --git a/CRM/Event/Form/Registration.php b/CRM/Event/Form/Registration.php index 875aa5ac39..7a55d39b56 100644 --- a/CRM/Event/Form/Registration.php +++ b/CRM/Event/Form/Registration.php @@ -567,6 +567,10 @@ class CRM_Event_Form_Registration extends CRM_Core_Form { /** * Function to add the custom fields * + * @param $id + * @param $name + * @param bool $viewOnly + * * @return void * @access public */ diff --git a/CRM/Event/Form/Registration/AdditionalParticipant.php b/CRM/Event/Form/Registration/AdditionalParticipant.php index 0050b08cc8..9340542365 100644 --- a/CRM/Event/Form/Registration/AdditionalParticipant.php +++ b/CRM/Event/Form/Registration/AdditionalParticipant.php @@ -367,9 +367,11 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R /** * global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any - * @param array $options additional user data + * @param array $fields the input form values + * @param array $files the uploaded files if any + * @param $self + * + * @internal param array $options additional user data * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Event/PseudoConstant.php b/CRM/Event/PseudoConstant.php index f603e35b80..1438e8f5ca 100644 --- a/CRM/Event/PseudoConstant.php +++ b/CRM/Event/PseudoConstant.php @@ -97,6 +97,10 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param null $id + * @param bool $all + * @param null $condition + * * @return array - array of all events if any * @static */ @@ -207,6 +211,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @access public * + * @param null $id + * * @return array - array reference of all participant listings if any * @static */ @@ -247,6 +253,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { /** * get event template titles * + * @param null $id + * * @return array of event id → template title pairs */ public static function &eventTemplates($id = NULL) { diff --git a/CRM/Event/Selector/Search.php b/CRM/Event/Selector/Search.php index 1755c04297..49b4c423fc 100644 --- a/CRM/Event/Selector/Search.php +++ b/CRM/Event/Selector/Search.php @@ -211,9 +211,12 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * - View * - Edit * + * @param null $qfKey + * @param null $context + * @param null $compContext + * * @return array * @access public - * */ static function &links($qfKey = NULL, $context = NULL, $compContext = NULL) { $extraParams = NULL; diff --git a/CRM/Event/StateMachine/Registration.php b/CRM/Event/StateMachine/Registration.php index 521b0a0676..85f58ced2b 100644 --- a/CRM/Event/StateMachine/Registration.php +++ b/CRM/Event/StateMachine/Registration.php @@ -42,10 +42,11 @@ class CRM_Event_StateMachine_Registration extends CRM_Core_StateMachine { /** * class constructor * - * @param object CRM_Event_Controller - * @param int $action + * @param object $controller + * @param \const|int $action * - * @return object CRM_Event_StateMachine + * @internal param \CRM_Event_Controller $object + * @return \CRM_Event_StateMachine_Registration CRM_Event_StateMachine */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); @@ -89,7 +90,7 @@ class CRM_Event_StateMachine_Registration extends CRM_Core_StateMachine { ); $pages = array_merge($pages, $additionalPages); - + // CRM-11182 - Optional confirmation screen if (!$is_confirm_enabled && !$is_monetary) { unset($pages['CRM_Event_Form_Registration_Confirm']); diff --git a/CRM/Event/StateMachine/Search.php b/CRM/Event/StateMachine/Search.php index 6b6318f2ae..512beaa0c8 100644 --- a/CRM/Event/StateMachine/Search.php +++ b/CRM/Event/StateMachine/Search.php @@ -77,6 +77,8 @@ class CRM_Event_StateMachine_Search extends CRM_Core_StateMachine { * * @param CRM_Core_Controller $controller the controller object * + * @param string $formName + * * @return string the name of the form that will handle the task * @access protected */ diff --git a/CRM/Extension/Info.php b/CRM/Extension/Info.php index c818c4ad93..c0cde01ffd 100644 --- a/CRM/Extension/Info.php +++ b/CRM/Extension/Info.php @@ -63,6 +63,8 @@ class CRM_Extension_Info { * Load extension info a string * * @param string $string XML content + * + * @throws CRM_Extension_Exception_ParseException * @return CRM_Extension_Info */ public static function loadFromString($string) { diff --git a/CRM/Extension/Manager.php b/CRM/Extension/Manager.php index 41e273fefd..4409765447 100644 --- a/CRM/Extension/Manager.php +++ b/CRM/Extension/Manager.php @@ -358,6 +358,8 @@ class CRM_Extension_Manager { /** * Determine the status of an extension * + * @param $key + * * @return string constant (STATUS_INSTALLED, STATUS_DISABLED, STATUS_UNINSTALLED, STATUS_UNKNOWN) */ public function getStatus($key) { @@ -415,8 +417,10 @@ class CRM_Extension_Manager { /** * Find the $info and $typeManager for a $key * - * @return array (0 => CRM_Extension_Info, 1 => CRM_Extension_Manager_Interface) + * @param $key + * * @throws CRM_Extension_Exception + * @return array (0 => CRM_Extension_Info, 1 => CRM_Extension_Manager_Interface) */ private function _getInfoTypeHandler($key) { $info = $this->mapper->keyToInfo($key); // throws Exception diff --git a/CRM/Extension/Mapper.php b/CRM/Extension/Mapper.php index 7dbaa89972..b581fd8d64 100755 --- a/CRM/Extension/Mapper.php +++ b/CRM/Extension/Mapper.php @@ -163,6 +163,10 @@ class CRM_Extension_Mapper { /** * @param string $key extension fully-qualified-name + * @param bool $fresh + * + * @throws CRM_Extension_Exception + * @throws Exception * @return object CRM_Extension_Info */ public function keyToInfo($key, $fresh = FALSE) { diff --git a/CRM/Financial/BAO/FinancialType.php b/CRM/Financial/BAO/FinancialType.php index 4fc6d1e23a..7559b1f23f 100644 --- a/CRM/Financial/BAO/FinancialType.php +++ b/CRM/Financial/BAO/FinancialType.php @@ -120,7 +120,10 @@ class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType { /** * Function to delete financial Types * - * @param int $contributionTypeId + * @param $financialTypeId + * + * @return array|bool + * @internal param int $contributionTypeId * @static */ static function del($financialTypeId) { diff --git a/CRM/Financial/BAO/FinancialTypeAccount.php b/CRM/Financial/BAO/FinancialTypeAccount.php index 5395f8b258..f22c0992ab 100644 --- a/CRM/Financial/BAO/FinancialTypeAccount.php +++ b/CRM/Financial/BAO/FinancialTypeAccount.php @@ -165,6 +165,8 @@ class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFin * @param string $entityTable * * @param string $columnName Column to fetch + * + * @return null|string * @static */ static function getFinancialAccount($entityId, $entityTable, $columnName = 'name') { @@ -188,6 +190,7 @@ AND entity_id = %2"; * * @param int $paymentInstrumentValue payment instrument value * + * @return array|null|string * @static */ static function getInstrumentFinancialAccount($paymentInstrumentValue = NULL) { @@ -219,7 +222,10 @@ WHERE cog.name = 'payment_instrument' "; * for financial type * CRM-12470 * - * @param int $financialTypeId financial type id + * @param $financialType + * + * @return array + * @internal param int $financialTypeId financial type id * * @static */ diff --git a/CRM/Financial/BAO/PaymentProcessor.php b/CRM/Financial/BAO/PaymentProcessor.php index 574bd20162..69bc61bb86 100644 --- a/CRM/Financial/BAO/PaymentProcessor.php +++ b/CRM/Financial/BAO/PaymentProcessor.php @@ -147,7 +147,10 @@ class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProces /** * Function to delete payment processor * - * @param int $paymentProcessorId ID of the processor to be deleted. + * @param $paymentProcessorID + * + * @return null + * @internal param int $paymentProcessorId ID of the processor to be deleted. * * @access public * @static diff --git a/CRM/Financial/BAO/PaymentProcessorType.php b/CRM/Financial/BAO/PaymentProcessorType.php index ae967b42bc..23e27696b9 100644 --- a/CRM/Financial/BAO/PaymentProcessorType.php +++ b/CRM/Financial/BAO/PaymentProcessorType.php @@ -108,12 +108,13 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr * Function to add the payment-processor type in the db * * @param array $params (reference ) an assoc array of name/value pairs - * @param array $ids the array that holds all the db ids + * + * @throws Exception + * @internal param array $ids the array that holds all the db ids * * @return object CRM_Financial_DAO_PaymentProcessorType * @access public * @static - * */ static function create(&$params) { $paymentProcessorType = new CRM_Financial_DAO_PaymentProcessorType(); @@ -177,8 +178,9 @@ class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentPr /** * Function to delete payment processor * - * @param int $paymentProcessorTypeId ID of the processor to be deleted. + * @param int $paymentProcessorTypeId ID of the processor to be deleted. * + * @return bool * @access public * @static */ @@ -219,8 +221,10 @@ WHERE pp.payment_processor_type_id = ppt.id AND ppt.id = %1"; * @see CRM_Core_DAO::buildOptions * * @param String $fieldName - * @param String $context: @see CRM_Core_DAO::buildOptionsContext - * @param Array $props: whatever is known about this dao object + * @param String $context : @see CRM_Core_DAO::buildOptionsContext + * @param Array $props : whatever is known about this dao object + * + * @return Array|bool */ public static function buildOptions($fieldName, $context = NULL, $props = array()) { $params = array(); diff --git a/CRM/Financial/Page/Batch.php b/CRM/Financial/Page/Batch.php index d08abb2ef2..41499e470b 100644 --- a/CRM/Financial/Page/Batch.php +++ b/CRM/Financial/Page/Batch.php @@ -92,7 +92,7 @@ class CRM_Financial_Page_Batch extends CRM_Core_Page_Basic { /** * browse all entities. * - * @param int $action + * @internal param int $action * * @return void * @access public diff --git a/CRM/Friend/BAO/Friend.php b/CRM/Friend/BAO/Friend.php index 7d7389ea1a..f158fb3e56 100644 --- a/CRM/Friend/BAO/Friend.php +++ b/CRM/Friend/BAO/Friend.php @@ -288,6 +288,9 @@ class CRM_Friend_BAO_Friend extends CRM_Friend_DAO_Friend { * @params int $contactId contact id * @params array $values associative array of name/value pair * + * @param $contactID + * @param $values + * * @return void * @access public */ diff --git a/CRM/Grant/BAO/Grant.php b/CRM/Grant/BAO/Grant.php index a1687b38aa..ff5414b878 100644 --- a/CRM/Grant/BAO/Grant.php +++ b/CRM/Grant/BAO/Grant.php @@ -53,6 +53,8 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { * * @static * + * @param bool $admin + * * @return array Array of event summary values */ static function getGrantSummary($admin = FALSE) { @@ -248,8 +250,9 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { * function to create the event * * @param array $params reference array contains the values submitted by the form - * @param array $ids reference array contains the id + * @param array $ids reference array contains the id * + * @return object * @access public * @static * @@ -309,11 +312,13 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { /** * Function to delete the Contact * - * @param int $cid contact id + * @param $id + * + * @return bool + * @internal param int $cid contact id * * @access public * @static - * */ static function deleteContact($id) { $grant = new CRM_Grant_DAO_Grant(); @@ -325,8 +330,9 @@ class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant { /** * Function to delete the grant * - * @param int $id grant id + * @param int $id grant id * + * @return bool|mixed * @access public * @static * diff --git a/CRM/Grant/BAO/Query.php b/CRM/Grant/BAO/Query.php index a87cd069f3..591739a307 100644 --- a/CRM/Grant/BAO/Query.php +++ b/CRM/Grant/BAO/Query.php @@ -43,6 +43,8 @@ class CRM_Grant_BAO_Query { /** * build select for CiviGrant * + * @param $query + * * @return void * @access public */ @@ -294,6 +296,8 @@ class CRM_Grant_BAO_Query { * * @access public * + * @param $form + * * @return void * @static */ diff --git a/CRM/Grant/Form/Task.php b/CRM/Grant/Form/Task.php index 05fa6c415f..79fa644cd3 100644 --- a/CRM/Grant/Form/Task.php +++ b/CRM/Grant/Form/Task.php @@ -145,7 +145,10 @@ class CRM_Grant_Form_Task extends CRM_Core_Form { * the form with a customized title for the main Submit * * @param string $title title of the main button - * @param string $type button type for the form after processing + * @param string $nextType + * @param string $backType + * + * @internal param string $type button type for the form after processing * * @return void * @access public diff --git a/CRM/Grant/Selector/Search.php b/CRM/Grant/Selector/Search.php index 4c4f4ee02c..e286fbd249 100644 --- a/CRM/Grant/Selector/Search.php +++ b/CRM/Grant/Selector/Search.php @@ -137,14 +137,16 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co /** * Class constructor * - * @param array $queryParams array of parameters for query - * @param int $action - action of search basic or advanced. - * @param string $grantClause if the caller wants to further restrict the search + * @param array $queryParams array of parameters for query + * @param \const|int $action - action of search basic or advanced. + * @param string $grantClause if the caller wants to further restrict the search * @param boolean $single are we dealing only with one contact? - * @param int $limit how many participations do we want returned + * @param int $limit how many participations do we want returned * - * @return CRM_Contact_Selector - * @access public + * @param string $context + * + * @return \CRM_Grant_Selector_Search + @access public */ function __construct(&$queryParams, $action = CRM_Core_Action::NONE, @@ -181,9 +183,10 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * - View * - Edit * + * @param null $key + * * @return array * @access public - * */ static function &links($key = NULL) { $cid = CRM_Utils_Request::retrieve('cid', 'Integer', $this); @@ -226,7 +229,10 @@ class CRM_Grant_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co /** * getter for array of the parameters required for creating pager. * - * @param + * @param $action + * @param $params + * + * @internal param $ * @access public */ function getPagerParams($action, &$params) { diff --git a/CRM/Grant/StateMachine/Search.php b/CRM/Grant/StateMachine/Search.php index 68a8c813ae..689aec8852 100644 --- a/CRM/Grant/StateMachine/Search.php +++ b/CRM/Grant/StateMachine/Search.php @@ -76,6 +76,8 @@ class CRM_Grant_StateMachine_Search extends CRM_Core_StateMachine { * * @param CRM_Core_Controller $controller the controller object * + * @param string $formName + * * @return string the name of the form that will handle the task * @access protected */ diff --git a/CRM/Group/Form/Edit.php b/CRM/Group/Form/Edit.php index 82b3060723..f43d5426de 100644 --- a/CRM/Group/Form/Edit.php +++ b/CRM/Group/Form/Edit.php @@ -306,6 +306,9 @@ class CRM_Group_Form_Edit extends CRM_Core_Form { * * @param array $fields posted values of the form * + * @param $fileParams + * @param $options + * * @return array list of errors to be posted back to the form * @static * @access public diff --git a/CRM/Group/Page/Group.php b/CRM/Group/Page/Group.php index d1482a8b3d..a7e197af87 100644 --- a/CRM/Group/Page/Group.php +++ b/CRM/Group/Page/Group.php @@ -80,6 +80,8 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { /** * return user context uri to return to * + * @param null $mode + * * @return string * @access public */ @@ -90,6 +92,8 @@ class CRM_Group_Page_Group extends CRM_Core_Page_Basic { /** * return user context uri params * + * @param null $mode + * * @return string * @access public */ diff --git a/CRM/Import/Parser.php b/CRM/Import/Parser.php index b5fbab2cfc..c3a0e8ea3b 100644 --- a/CRM/Import/Parser.php +++ b/CRM/Import/Parser.php @@ -206,8 +206,10 @@ abstract class CRM_Import_Parser { /** * Set and validate field values * - * @param $elements: array - * @param $erroneousField: reference + * @param $elements : array + * @param $erroneousField : reference + * + * @return int */ function setActiveFieldValues($elements, &$erroneousField) { $maxCount = count($elements) < $this->_activeFieldCount ? count($elements) : $this->_activeFieldCount; diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php index 021a051216..4495d2d3c2 100644 --- a/CRM/Mailing/BAO/Mailing.php +++ b/CRM/Mailing/BAO/Mailing.php @@ -845,6 +845,8 @@ ORDER BY i.contact_id, i.{$tempColumn} * * @params array $params contains form values * + * @param $testParams + * * @return void * @access public */ @@ -951,12 +953,12 @@ ORDER BY civicrm_email.is_bulkmail DESC /** * static wrapper for getting verp and urls * - * @param int $job_id ID of the Job associated with this message - * @param int $event_queue_id ID of the EventQueue - * @param string $hash Hash of the EventQueue - * @param string $email Destination address + * @param int $job_id ID of the Job associated with this message + * @param int $event_queue_id ID of the EventQueue + * @param string $hash Hash of the EventQueue + * @param string $email Destination address * - * @return (reference) array array ref that hold array refs to the verp info and urls + * @return array (reference) array array ref that hold array refs to the verp info and urls */ static function getVerpAndUrls($job_id, $event_queue_id, $hash, $email) { // create a skeleton object and set its properties that are required by getVerpAndUrlsAndHeaders() @@ -973,13 +975,14 @@ ORDER BY civicrm_email.is_bulkmail DESC /** * get verp, urls and headers * - * @param int $job_id ID of the Job associated with this message - * @param int $event_queue_id ID of the EventQueue - * @param string $hash Hash of the EventQueue - * @param string $email Destination address + * @param int $job_id ID of the Job associated with this message + * @param int $event_queue_id ID of the EventQueue + * @param string $hash Hash of the EventQueue + * @param string $email Destination address * - * @return (reference) array array ref that hold array refs to the verp info, urls, and headers - * @access private + * @param bool $isForward + * + * @return array (reference) array array ref that hold array refs to the verp info, urls, and headers@access private */ private function getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email, $isForward = FALSE) { $config = CRM_Core_Config::singleton(); @@ -1064,15 +1067,19 @@ ORDER BY civicrm_email.is_bulkmail DESC /** * Compose a message * - * @param int $job_id ID of the Job associated with this message - * @param int $event_queue_id ID of the EventQueue - * @param string $hash Hash of the EventQueue - * @param string $contactId ID of the Contact - * @param string $email Destination address - * @param string $recipient To: of the recipient - * @param boolean $test Is this mailing a test? - * @param boolean $isForward Is this mailing compose for forward? - * @param string $fromEmail email address of who is forwardinf it. + * @param int $job_id ID of the Job associated with this message + * @param int $event_queue_id ID of the EventQueue + * @param string $hash Hash of the EventQueue + * @param string $contactId ID of the Contact + * @param string $email Destination address + * @param string $recipient To: of the recipient + * @param boolean $test Is this mailing a test? + * @param $contactDetails + * @param $attachments + * @param boolean $isForward Is this mailing compose for forward? + * @param string $fromEmail email address of who is forwardinf it. + * + * @param null $replyToEmail * * @return object The mail object * @access public @@ -1643,9 +1650,11 @@ ORDER BY civicrm_email.is_bulkmail DESC * Generate a report. Fetch event count information, mailing data, and job * status. * - * @param int $id The mailing id to report + * @param int $id The mailing id to report * @param boolean $skipDetails whether return all detailed report * + * @param bool $isSMS + * * @return array Associative array of reporting data * @access public * @static @@ -2217,9 +2226,12 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id /** * Get the rows for a browse operation * - * @param int $offset The row number to start from - * @param int $rowCount The nmber of rows to return - * @param string $sort The sql string that describes the sort order + * @param int $offset The row number to start from + * @param int $rowCount The nmber of rows to return + * @param string $sort The sql string that describes the sort order + * + * @param null $additionalClause + * @param null $additionalParams * * @return array The rows * @access public @@ -2310,6 +2322,7 @@ LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id * * @param int $id * + * @return string * @static * @access public */ @@ -2556,8 +2569,9 @@ SELECT $mailing.id as mailing_id * * @param $form reference of this * - * @return $report array content/component. - * @access public + * @param bool $isSMS + * + * @return array $report array content/component.@access public */ static function getMailingContent(&$report, &$form, $isSMS = FALSE) { $htmlHeader = $textHeader = NULL; diff --git a/CRM/Mailing/BAO/Query.php b/CRM/Mailing/BAO/Query.php index 3f29d2fc08..e41adc503d 100644 --- a/CRM/Mailing/BAO/Query.php +++ b/CRM/Mailing/BAO/Query.php @@ -50,6 +50,8 @@ class CRM_Mailing_BAO_Query { /** * if mailings are involved, add the specific Mailing fields * + * @param $query + * * @return void * @access public */ @@ -414,6 +416,8 @@ class CRM_Mailing_BAO_Query { * @param $fieldName * @param $fieldTitle * + * @param $valueTitles + * * @return void */ static function mailingEventQueryBuilder(&$query, &$values, $tableName, $fieldName, $fieldTitle, &$valueTitles) { diff --git a/CRM/Mailing/BAO/Spool.php b/CRM/Mailing/BAO/Spool.php index 0de6e7333e..2d45073702 100644 --- a/CRM/Mailing/BAO/Spool.php +++ b/CRM/Mailing/BAO/Spool.php @@ -44,17 +44,20 @@ class CRM_Mailing_BAO_Spool extends CRM_Mailing_DAO_Spool { /** * Store Mails into Spool table. * - * @param mixed $recipients Either a comma-seperated list of recipients - * (RFC822 compliant), or an array of recipients, - * each RFC822 valid. This may contain recipients not - * specified in the headers, for Bcc:, resending - * messages, etc. - * + * @param $recipient * @param array $headers The string of headers to send with the mail. * * @param string $body The full text of the message body, including any * Mime parts, etc. * + * @param null $job_id + * + * @internal param mixed $recipients Either a comma-seperated list of recipients + * (RFC822 compliant), or an array of recipients, + * each RFC822 valid. This may contain recipients not + * specified in the headers, for Bcc:, resending + * messages, etc. + * * @return mixed Returns true on success, or a CRM_Eore_Error * containing a descriptive error message on * failure. diff --git a/CRM/Mailing/Event/BAO/Subscribe.php b/CRM/Mailing/Event/BAO/Subscribe.php index 4a9d3919cd..33bfedcfd1 100644 --- a/CRM/Mailing/Event/BAO/Subscribe.php +++ b/CRM/Mailing/Event/BAO/Subscribe.php @@ -361,8 +361,14 @@ SELECT civicrm_email.id as email_id * @params int $contactId Currently used during event registration/contribution. * Specifically to avoid linking group to wrong duplicate contact * during event registration. + * * @public * + * @param $groups + * @param $params + * @param null $contactId + * @param null $context + * * @return void * @static * @access public diff --git a/CRM/Mailing/MailStore.php b/CRM/Mailing/MailStore.php index 245759421c..c7f2ce5a0c 100644 --- a/CRM/Mailing/MailStore.php +++ b/CRM/Mailing/MailStore.php @@ -39,8 +39,9 @@ class CRM_Mailing_MailStore { /** * Return the proper mail store implementation, based on config settings * - * @param string $name name of the settings set from civimail_mail_settings to use (null for default) + * @param string $name name of the settings set from civimail_mail_settings to use (null for default) * + * @throws Exception * @return object mail store implementation for processing CiviMail-bound emails */ function getStore($name = NULL) { @@ -135,8 +136,9 @@ class CRM_Mailing_MailStore { /** * Point to (and create if needed) a local Maildir for storing retrieved mail * - * @param string $name name of the Maildir + * @param string $name name of the Maildir * + * @throws Exception * @return string path to the Maildir's cur directory */ function maildir($name) { diff --git a/CRM/Mailing/MailStore/Localdir.php b/CRM/Mailing/MailStore/Localdir.php index 5dec460d9d..cf032d7d7c 100644 --- a/CRM/Mailing/MailStore/Localdir.php +++ b/CRM/Mailing/MailStore/Localdir.php @@ -109,8 +109,9 @@ class CRM_Mailing_MailStore_Localdir extends CRM_Mailing_MailStore { /** * Fetch the specified message to the local ignore folder * - * @param integer $file file location of the message to fetch + * @param integer $file file location of the message to fetch * + * @throws Exception * @return void */ function markIgnored($file) { @@ -126,8 +127,9 @@ class CRM_Mailing_MailStore_Localdir extends CRM_Mailing_MailStore { /** * Fetch the specified message to the local processed folder * - * @param integer $file file location of the message to fetch + * @param integer $file file location of the message to fetch * + * @throws Exception * @return void */ function markProcessed($file) { diff --git a/CRM/Mailing/MailStore/Maildir.php b/CRM/Mailing/MailStore/Maildir.php index ad27b66d1c..cbc5abb1e6 100644 --- a/CRM/Mailing/MailStore/Maildir.php +++ b/CRM/Mailing/MailStore/Maildir.php @@ -91,8 +91,9 @@ class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore { /** * Fetch the specified message to the local ignore folder * - * @param integer $file file location of the message to fetch + * @param integer $file file location of the message to fetch * + * @throws Exception * @return void */ function markIgnored($file) { @@ -108,8 +109,9 @@ class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore { /** * Fetch the specified message to the local processed folder * - * @param integer $file file location of the message to fetch + * @param integer $file file location of the message to fetch * + * @throws Exception * @return void */ function markProcessed($file) { diff --git a/CRM/Mailing/Page/View.php b/CRM/Mailing/Page/View.php index 9877b6c7d6..d61bc62be9 100644 --- a/CRM/Mailing/Page/View.php +++ b/CRM/Mailing/Page/View.php @@ -73,6 +73,11 @@ class CRM_Mailing_Page_View extends CRM_Core_Page { /** * run this page (figure out the action needed and perform it). * + * @param null $id + * @param null $contactID + * @param bool $print + * @param bool $allowID + * * @return void */ function run($id = NULL, $contactID = NULL, $print = TRUE, $allowID = FALSE) { diff --git a/CRM/Member/BAO/MembershipBlock.php b/CRM/Member/BAO/MembershipBlock.php index f68f4b3904..f4367a2210 100644 --- a/CRM/Member/BAO/MembershipBlock.php +++ b/CRM/Member/BAO/MembershipBlock.php @@ -63,6 +63,8 @@ class CRM_Member_BAO_MembershipBlock extends CRM_Member_DAO_MembershipBlock { * Function to delete membership Blocks * * @param int $id + * + * @return bool * @static */ static function del($id) { diff --git a/CRM/Member/BAO/MembershipLog.php b/CRM/Member/BAO/MembershipLog.php index 06c4fd4023..a7347f9f22 100644 --- a/CRM/Member/BAO/MembershipLog.php +++ b/CRM/Member/BAO/MembershipLog.php @@ -58,7 +58,10 @@ class CRM_Member_BAO_MembershipLog extends CRM_Member_DAO_MembershipLog { /** * Function to delete membership log record * - * @param int $membershipTypeId + * @param $membershipID + * + * @return mixed + * @internal param int $membershipTypeId * @static */ diff --git a/CRM/Member/BAO/MembershipPayment.php b/CRM/Member/BAO/MembershipPayment.php index 126a7e59f1..14c0541d90 100644 --- a/CRM/Member/BAO/MembershipPayment.php +++ b/CRM/Member/BAO/MembershipPayment.php @@ -66,6 +66,8 @@ class CRM_Member_BAO_MembershipPayment extends CRM_Member_DAO_MembershipPayment * Function to delete membership Payments * * @param int $id + * + * @return bool * @static */ static function del($id) { diff --git a/CRM/Member/BAO/MembershipStatus.php b/CRM/Member/BAO/MembershipStatus.php index 5a32db7f01..0ba2814704 100644 --- a/CRM/Member/BAO/MembershipStatus.php +++ b/CRM/Member/BAO/MembershipStatus.php @@ -178,7 +178,9 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { * Function to delete membership Types * * @param int $membershipStatusId - * @param + * + * @throws CRM_Core_Exception + * @internal param $ * @static */ static function del($membershipStatusId) { @@ -365,8 +367,8 @@ class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus { /** * Function that return the status ids whose is_current_member is set * - * @return - * @static + * @return array + @static */ public static function getMembershipStatusCurrent() { $statusIds = array(); diff --git a/CRM/Member/BAO/MembershipType.php b/CRM/Member/BAO/MembershipType.php index a9ac9bf2a8..99ee45ae87 100644 --- a/CRM/Member/BAO/MembershipType.php +++ b/CRM/Member/BAO/MembershipType.php @@ -129,6 +129,9 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { * Function to delete membership Types * * @param int $membershipTypeId + * + * @throws CRM_Core_Exception + * @return bool|mixed * @static */ static function del($membershipTypeId) { @@ -223,7 +226,10 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { /** * Function to get membership Types * - * @param int $membershipTypeId + * @param bool $public + * + * @return array + * @internal param int $membershipTypeId * @static */ static function getMembershipTypes($public = TRUE) { @@ -246,6 +252,8 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { * Function to get membership Type Details * * @param int $membershipTypeId + * + * @return array|null * @static */ static function getMembershipTypeDetails($membershipTypeId) { @@ -592,10 +600,14 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType { return $memTypeOrgs; } - /** The function returns all the Organization for all membershiptypes . - * @param array $allmembershipTypes array of allMembershipTypes - * with organization id Key - value pairs. + /** + * The function returns all the Organization for all membershiptypes . * + * @param null $membershipTypeId + * + * @return array + * @internal param array $allmembershipTypes array of allMembershipTypes + * with organization id Key - value pairs. */ static function getMembershipTypeOrganization($membershipTypeId = NULL) { $allmembershipTypes = array(); diff --git a/CRM/Member/Form/Task/PDFLetterCommon.php b/CRM/Member/Form/Task/PDFLetterCommon.php index 6d864e8d3b..e85cd80508 100644 --- a/CRM/Member/Form/Task/PDFLetterCommon.php +++ b/CRM/Member/Form/Task/PDFLetterCommon.php @@ -12,6 +12,12 @@ class CRM_Member_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDFLett * in fixing the existing pdfLetter classes to be suitably generic * @access public * + * @param $form + * @param $membershipIDs + * @param $skipOnHold + * @param $skipDeceased + * @param $contactIDs + * * @return void */ static function postProcessMembers(&$form, $membershipIDs, $skipOnHold, $skipDeceased, $contactIDs) { diff --git a/CRM/Member/Import/Parser.php b/CRM/Member/Import/Parser.php index f201b62329..cf06c15946 100644 --- a/CRM/Member/Import/Parser.php +++ b/CRM/Member/Import/Parser.php @@ -384,10 +384,11 @@ abstract class CRM_Member_Import_Parser extends CRM_Import_Parser { /** * Export data to a CSV file * - * @param string $filename + * @param $fileName * @param array $header * @param data $data * + * @internal param string $filename * @return void * @access public */ diff --git a/CRM/Member/Import/Parser/Membership.php b/CRM/Member/Import/Parser/Membership.php index 34db6049b4..8c9d6a4c5f 100644 --- a/CRM/Member/Import/Parser/Membership.php +++ b/CRM/Member/Import/Parser/Membership.php @@ -607,19 +607,21 @@ class CRM_Member_Import_Parser_Membership extends CRM_Member_Import_Parser { } } } + /** * @deprecated - this function formats params according to v2 standards but * need to be sure about the impact of not calling it so retaining on the import class * take the input parameter list as specified in the data model and * convert it into the same format that we use in QF and BAO object * - * @param array $params Associative array of property name/value + * @param array $params Associative array of property name/value * pairs to insert in new contact. - * @param array $values The reformatted properties that we can use internally + * @param array $values The reformatted properties that we can use internally * - * @param array $create Is the formatted Values array going to + * @param array|bool $create Is the formatted Values array going to * be used for CRM_Member_BAO_Membership:create() * + * @throws Exception * @return array|error * @access public */ diff --git a/CRM/Member/StateMachine/Search.php b/CRM/Member/StateMachine/Search.php index c4c5490da1..22460d863d 100644 --- a/CRM/Member/StateMachine/Search.php +++ b/CRM/Member/StateMachine/Search.php @@ -74,6 +74,8 @@ class CRM_Member_StateMachine_Search extends CRM_Core_StateMachine { * * @param CRM_Core_Controller $controller the controller object * + * @param string $formName + * * @return string the name of the form that will handle the task * @access protected */ diff --git a/CRM/PCP/BAO/PCP.php b/CRM/PCP/BAO/PCP.php index 4e8b910bd2..196a26356a 100644 --- a/CRM/PCP/BAO/PCP.php +++ b/CRM/PCP/BAO/PCP.php @@ -441,7 +441,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; $pcp_supporter_text .= "You can support it as well - once you complete the donation, you will be able to create your own Personal Campaign Page!"; } } - + $page->assign('pcpSupporterText', $pcp_supporter_text); } $page->assign('pcp', TRUE); @@ -568,10 +568,11 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0"; * * @param int $id campaign page id * + * @param $is_active + * * @return null * @access public * @static - * */ static function setIsActive($id, $is_active) { switch ($is_active) { diff --git a/CRM/PCP/Page/PCP.php b/CRM/PCP/Page/PCP.php index e8971b564c..dd4f470070 100644 --- a/CRM/PCP/Page/PCP.php +++ b/CRM/PCP/Page/PCP.php @@ -375,6 +375,8 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic { /** * Get user context. * + * @param null $mode + * * @return string user context. */ function userContext($mode = NULL) { diff --git a/CRM/PCP/StateMachine/PCP.php b/CRM/PCP/StateMachine/PCP.php index 0d92a4e292..a414441a84 100644 --- a/CRM/PCP/StateMachine/PCP.php +++ b/CRM/PCP/StateMachine/PCP.php @@ -42,10 +42,11 @@ class CRM_PCP_StateMachine_PCP extends CRM_Core_StateMachine { /** * class constructor * - * @param object CRM_Contact_Import_Controller - * @param int $action + * @param object $controller + * @param \const|int $action * - * @return object CRM_Contact_Import_StateMachine + * @internal param \CRM_Contact_Import_Controller $object + * @return \CRM_PCP_StateMachine_PCP CRM_Contact_Import_StateMachine */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/CRM/Pledge/BAO/Pledge.php b/CRM/Pledge/BAO/Pledge.php index 654ca965ac..0ca89e6768 100644 --- a/CRM/Pledge/BAO/Pledge.php +++ b/CRM/Pledge/BAO/Pledge.php @@ -255,8 +255,9 @@ class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge { /** * Function to delete the pledge * - * @param int $id pledge id + * @param int $id pledge id * + * @return mixed * @access public * @static * diff --git a/CRM/Pledge/BAO/PledgeBlock.php b/CRM/Pledge/BAO/PledgeBlock.php index f969d17a69..4deb2714af 100644 --- a/CRM/Pledge/BAO/PledgeBlock.php +++ b/CRM/Pledge/BAO/PledgeBlock.php @@ -149,8 +149,9 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { /** * Function to delete the pledgeBlock * - * @param int $id pledgeBlock id + * @param int $id pledgeBlock id * + * @return mixed|null * @access public * @static */ @@ -175,7 +176,10 @@ class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock { /** * Function to return Pledge Block info in Contribution Pages * - * @param int $pageId contribution page id + * @param $pageID + * + * @return array + * @internal param int $pageId contribution page id * * @static */ diff --git a/CRM/Pledge/BAO/PledgePayment.php b/CRM/Pledge/BAO/PledgePayment.php index 42924c87e6..ff728e358d 100644 --- a/CRM/Pledge/BAO/PledgePayment.php +++ b/CRM/Pledge/BAO/PledgePayment.php @@ -220,7 +220,9 @@ WHERE pledge_id = %1 /** * Delete pledge payment * - * @param array $params associate array of field + * @param $id + * + * @internal param array $params associate array of field * * @return pledge payment id * @static @@ -247,8 +249,9 @@ WHERE pledge_id = %1 /** * Function to delete all pledge payments * - * @param int $id pledge id + * @param int $id pledge id * + * @return bool * @access public * @static * @@ -281,8 +284,9 @@ WHERE pledge_id = %1 /** * On delete contribution record update associated pledge payment and pledge. * - * @param int $contributionID contribution id + * @param int $contributionID contribution id * + * @return bool * @access public * @static */ @@ -604,11 +608,12 @@ WHERE civicrm_pledge.id = %2 * Function to update pledge payment table * * @param int $pledgeId pledge id - * @param array $paymentIds payment ids to be updated * @param int $paymentStatusId payment status id to set - * @param float $actualAmount, actual amount being paid - * @param int $contributionId, Id of associated contribution when payment is recorded - * @param bool $isScriptUpdate, is function being called from bin script? + * @param array $paymentIds payment ids to be updated + * @param float|int $actualAmount , actual amount being paid + * @param int $contributionId , Id of associated contribution when payment is recorded + * @param bool $isScriptUpdate , is function being called from bin script? + * * @static */ static function updatePledgePayments($pledgeId, diff --git a/CRM/Pledge/StateMachine/Search.php b/CRM/Pledge/StateMachine/Search.php index 7b4f5cb2cc..c24073e67c 100644 --- a/CRM/Pledge/StateMachine/Search.php +++ b/CRM/Pledge/StateMachine/Search.php @@ -76,6 +76,8 @@ class CRM_Pledge_StateMachine_Search extends CRM_Core_StateMachine { * * @param CRM_Core_Controller $controller the controller object * + * @param string $formName + * * @return string the name of the form that will handle the task * @access protected */ diff --git a/CRM/Price/BAO/LineItem.php b/CRM/Price/BAO/LineItem.php index a487536b58..efb7957048 100644 --- a/CRM/Price/BAO/LineItem.php +++ b/CRM/Price/BAO/LineItem.php @@ -257,6 +257,7 @@ AND li.entity_id = {$entityId} * @param int $entityId * @param int $entityTable * + * @return bool * @access public * @static */ diff --git a/CRM/Price/BAO/PriceField.php b/CRM/Price/BAO/PriceField.php index cfdd8d5f3d..fc3aa872aa 100644 --- a/CRM/Price/BAO/PriceField.php +++ b/CRM/Price/BAO/PriceField.php @@ -48,8 +48,9 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { * price field object. the params array could contain additional unused name/value * pairs * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $ids the array that holds all the db ids + * @param array $params (reference ) an assoc array of name/value pairs + * + * @internal param array $ids the array that holds all the db ids * * @return object CRM_Price_BAO_PriceField object * @access public @@ -215,13 +216,18 @@ class CRM_Price_BAO_PriceField extends CRM_Price_DAO_PriceField { /** * This function for building custom fields * - * @param object $qf form object (reference) - * @param string $elementName name of the custom field + * @param object $qf form object (reference) + * @param string $elementName name of the custom field + * @param $fieldId * @param boolean $inactiveNeeded - * @param boolean $useRequired true if required else false - * @param boolean $search true if used for search else false - * @param string $label label for custom field + * @param boolean $useRequired true if required else false + * @param string $label label for custom field + * + * @param null $fieldOptions + * @param array $feezeOptions * + * @return null + * @internal param bool $search true if used for search else false * @access public * @static */ diff --git a/CRM/Price/BAO/PriceFieldValue.php b/CRM/Price/BAO/PriceFieldValue.php index eb4db3781d..579450d375 100644 --- a/CRM/Price/BAO/PriceFieldValue.php +++ b/CRM/Price/BAO/PriceFieldValue.php @@ -44,6 +44,8 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { * * @param array $params (reference), array $ids * + * @param $ids + * * @return object CRM_Price_DAO_PriceFieldValue object * @access public * @static @@ -71,6 +73,8 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { * * @param array $params (reference), array $ids * + * @param $ids + * * @return object CRM_Price_DAO_PriceFieldValue object * @access public * @static @@ -218,15 +222,16 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { $fieldValueDAO->id = $id; return $fieldValueDAO->delete(); } - + /** - * Update civicrm_price_field_value.financial_type_id + * Update civicrm_price_field_value.financial_type_id * when financial_type_id of contribution_page or event is changed * - * @param int $entityId Id - * @param String $entityTable entity table + * @param int $entityId Id + * @param String $entityTable entity table * @param String $financialTypeID financial type id * + * @return bool * @access public * @static */ @@ -245,8 +250,8 @@ class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue { $join = " LEFT JOIN civicrm_discount cd ON cd.price_set_id = cps.id AND cd.entity_id = %1 AND cd.entity_table = %2 "; $where = ' OR cd.id IS NOT NULL '; } - $sql = "UPDATE civicrm_price_set cps -LEFT JOIN civicrm_price_set_entity cpse ON cpse.price_set_id = cps.id AND cpse.entity_id = %1 AND cpse.entity_table = %2 + $sql = "UPDATE civicrm_price_set cps +LEFT JOIN civicrm_price_set_entity cpse ON cpse.price_set_id = cps.id AND cpse.entity_id = %1 AND cpse.entity_table = %2 LEFT JOIN civicrm_price_field cpf ON cpf.price_set_id = cps.id LEFT JOIN civicrm_price_field_value cpfv ON cpf.id = cpfv.price_field_id {$join} @@ -257,7 +262,7 @@ SET cpfv.financial_type_id = CASE END, cps.financial_type_id = %3 WHERE cpse.id IS NOT NULL {$where}"; - + CRM_Core_DAO::executeQuery($sql, $params); } } diff --git a/CRM/Price/BAO/PriceSet.php b/CRM/Price/BAO/PriceSet.php index d36047d098..691badd6e5 100644 --- a/CRM/Price/BAO/PriceSet.php +++ b/CRM/Price/BAO/PriceSet.php @@ -332,6 +332,8 @@ WHERE ct.id = cp.financial_type_id AND * * @param string $entityTable * @param integer $entityId + * + * @return mixed */ public static function removeFrom($entityTable, $entityId) { $dao = new CRM_Price_DAO_PriceSetEntity(); @@ -345,8 +347,11 @@ WHERE ct.id = cp.financial_type_id AND * Used For value for events:1, contribution:2, membership:3 * * @param string $entityTable - * @param int $entityId - * @param int $usedFor ( price set that extends/used for particular component ) + * @param int $entityId + * @param int $usedFor ( price set that extends/used for particular component ) + * + * @param null $isQuickConfig + * @param null $setName * * @return integer|false price_set_id, or false if none found */ @@ -411,8 +416,8 @@ WHERE ct.id = cp.financial_type_id AND /** * Return an associative array of all price sets * - * @param bool $withInactive whether or not to include inactive entries - * @param string $extendComponentName name of the component like 'CiviEvent','CiviContribute' + * @param bool $withInactive whether or not to include inactive entries + * @param bool|string $extendComponentName name of the component like 'CiviEvent','CiviContribute' * * @return array associative array of id => name */ @@ -835,9 +840,9 @@ WHERE id = %1"; // CRM-14492 Admin price fields should show up on event registration if user has 'administer CiviCRM' permissions $adminFieldVisible = false; if (CRM_Core_Permission::check('administer CiviCRM')) { - $adminFieldVisible = true; + $adminFieldVisible = true; } - + foreach ($feeBlock as $id => $field) { if (CRM_Utils_Array::value('visibility', $field) == 'public' || (CRM_Utils_Array::value('visibility', $field) == 'admin' && $adminFieldVisible == true) || @@ -993,6 +998,8 @@ WHERE id = %1"; * This function is to check price set permission * * @param int $sid the price set id + * + * @return bool */ static function checkPermission($sid) { if ($sid && self::eventPriceSetDomainID()) { @@ -1010,6 +1017,9 @@ WHERE id = %1"; * * @param int $sid the price set id * + * @param bool $onlyActive + * + * @return int|null|string * @access public * @static */ diff --git a/CRM/Price/Form/Field.php b/CRM/Price/Form/Field.php index 514ddf5c89..54be353b08 100644 --- a/CRM/Price/Form/Field.php +++ b/CRM/Price/Form/Field.php @@ -391,7 +391,10 @@ class CRM_Price_Form_Field extends CRM_Core_Form { /** * global validation rules for the form * - * @param array $fields (referance) posted values of the form + * @param array $fields (referance) posted values of the form + * + * @param $files + * @param $form * * @return array if errors then list of errors to be posted back to the form, * true otherwise diff --git a/CRM/Price/Form/Option.php b/CRM/Price/Form/Option.php index a0c6e7c683..4413967daf 100644 --- a/CRM/Price/Form/Option.php +++ b/CRM/Price/Form/Option.php @@ -271,7 +271,10 @@ class CRM_Price_Form_Option extends CRM_Core_Form { /** * global validation rules for the form * - * @param array $fields (referance) posted values of the form + * @param array $fields (referance) posted values of the form + * + * @param $files + * @param $form * * @return array if errors then list of errors to be posted back to the form, * true otherwise diff --git a/CRM/Price/Page/Field.php b/CRM/Price/Page/Field.php index 4d96a616c1..fb5453e592 100644 --- a/CRM/Price/Page/Field.php +++ b/CRM/Price/Page/Field.php @@ -316,7 +316,9 @@ class CRM_Price_Page_Field extends CRM_Core_Page { /** * Preview price field * - * @param int $id price field id + * @param $fid + * + * @internal param int $id price field id * * @return void * @access public diff --git a/CRM/Price/Page/Set.php b/CRM/Price/Page/Set.php index 9eb07b630b..199b9db755 100644 --- a/CRM/Price/Page/Set.php +++ b/CRM/Price/Page/Set.php @@ -201,9 +201,10 @@ class CRM_Price_Page_Set extends CRM_Core_Page { /** * edit price set * - * @param int $id price set id - * @param string $action the action to be invoked + * @param $sid + * @param string $action the action to be invoked * + * @internal param int $id price set id * @return void * @access public */ @@ -223,7 +224,9 @@ class CRM_Price_Page_Set extends CRM_Core_Page { /** * Preview price set * - * @param int $id price set id + * @param $sid + * + * @internal param int $id price set id * * @return void * @access public diff --git a/CRM/Profile/Form/Dynamic.php b/CRM/Profile/Form/Dynamic.php index f4569fddef..19edf78cd9 100644 --- a/CRM/Profile/Form/Dynamic.php +++ b/CRM/Profile/Form/Dynamic.php @@ -98,8 +98,10 @@ class CRM_Profile_Form_Dynamic extends CRM_Profile_Form { * global form rule * * @param array $fields the input form values - * @param array $files the uploaded files if any - * @param array $options additional user data + * @param array $files the uploaded files if any + * @param object $form + * + * @internal param array $options additional user data * * @return true if no errors, else array of errors * @access public diff --git a/CRM/Profile/Page/Dynamic.php b/CRM/Profile/Page/Dynamic.php index e8cd0aa4e0..cfe5561307 100644 --- a/CRM/Profile/Page/Dynamic.php +++ b/CRM/Profile/Page/Dynamic.php @@ -107,11 +107,15 @@ class CRM_Profile_Page_Dynamic extends CRM_Core_Page { /** * class constructor * - * @param int $id the contact id + * @param int $id the contact id * @param int $gid the group id * - * @return void - * @access public + * @param $restrict + * @param bool $skipPermission + * @param null $profileIds + * + * @return \CRM_Profile_Page_Dynamic + @access public */ function __construct($id, $gid, $restrict, $skipPermission = FALSE, $profileIds = NULL) { parent::__construct(); diff --git a/CRM/Profile/Page/Listings.php b/CRM/Profile/Page/Listings.php index c63557312d..32b537741a 100644 --- a/CRM/Profile/Page/Listings.php +++ b/CRM/Profile/Page/Listings.php @@ -400,7 +400,10 @@ class CRM_Profile_Page_Listings extends CRM_Core_Page { /** * Function to get the list of contacts for a profile * - * @param $form object + * @param $gid + * + * @return array + * @internal param object $form * * @access public */ diff --git a/CRM/Profile/Page/MultipleRecordFieldsListing.php b/CRM/Profile/Page/MultipleRecordFieldsListing.php index 139a837f19..9e34a82d13 100644 --- a/CRM/Profile/Page/MultipleRecordFieldsListing.php +++ b/CRM/Profile/Page/MultipleRecordFieldsListing.php @@ -383,6 +383,8 @@ class CRM_Profile_Page_MultipleRecordFieldsListing extends CRM_Core_Page_Basic { /** * Get user context * + * @param null $mode + * * @return string user context */ function userContext($mode = NULL) { diff --git a/CRM/Profile/Page/Router.php b/CRM/Profile/Page/Router.php index cf27885829..54da11af2f 100644 --- a/CRM/Profile/Page/Router.php +++ b/CRM/Profile/Page/Router.php @@ -43,6 +43,7 @@ class CRM_Profile_Page_Router extends CRM_Core_Page { * * @param $args array this array contains the arguments of the url * + * @return string|void * @static * @access public */ @@ -146,4 +147,4 @@ class CRM_Profile_Page_Router extends CRM_Core_Page { return; } -} \ No newline at end of file +} diff --git a/CRM/Profile/Selector/Listings.php b/CRM/Profile/Selector/Listings.php index ae43ba1e75..2e3e558a10 100644 --- a/CRM/Profile/Selector/Listings.php +++ b/CRM/Profile/Selector/Listings.php @@ -132,13 +132,20 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR protected $_profileIds = array(); protected $_multiRecordTableName = NULL; + /** * Class constructor * + * @param $params + * @param $customFields * @param string params the params for the where clause * - * @return CRM_Contact_Selector_Profile - * @access public + * @param bool $map + * @param bool $editLink + * @param bool $linkToUF + * + * @return \CRM_Profile_Selector_Listings + @access public */ function __construct( &$params, @@ -207,9 +214,13 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR /** * This method returns the links that are given for each search row. * + * @param bool $map + * @param bool $editLink + * @param bool $ufLink + * @param null $gids + * * @return array * @access public - * */ static function &links($map = FALSE, $editLink = FALSE, $ufLink = FALSE, $gids = NULL) { if (!self::$_links) { @@ -270,7 +281,10 @@ class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CR /** * getter for array of the parameters required for creating pager. * - * @param + * @param $action + * @param $params + * + * @internal param $ * @access public */ function getPagerParams($action, &$params) { diff --git a/CRM/Queue/Queue.php b/CRM/Queue/Queue.php index fd2b8c6e32..dc40190114 100644 --- a/CRM/Queue/Queue.php +++ b/CRM/Queue/Queue.php @@ -90,7 +90,7 @@ abstract class CRM_Queue_Queue { * Add a new item to the queue * * @param $data serializable PHP object or array - * @param $options queue-dependent options; for example, if this is a + * @param array|\queue $options queue-dependent options; for example, if this is a * priority-queue, then $options might specify the item's priority * * @return bool, TRUE on success @@ -107,7 +107,7 @@ abstract class CRM_Queue_Queue { /** * Get the next item * - * @param $lease_time seconds + * @param int|\seconds $lease_time seconds * * @return object with key 'data' that matches the inputted data */ @@ -116,7 +116,7 @@ abstract class CRM_Queue_Queue { /** * Get the next item, even if there's an active lease * - * @param $lease_time seconds + * @param int|\seconds $lease_time seconds * * @return object with key 'data' that matches the inputted data */ diff --git a/CRM/Queue/Queue/Memory.php b/CRM/Queue/Queue/Memory.php index 18a46dfe72..ff7585774c 100644 --- a/CRM/Queue/Queue/Memory.php +++ b/CRM/Queue/Queue/Memory.php @@ -95,7 +95,7 @@ class CRM_Queue_Queue_Memory extends CRM_Queue_Queue { * Add a new item to the queue * * @param $data serializable PHP object or array - * @param $options queue-dependent options; for example, if this is a + * @param array|\queue $options queue-dependent options; for example, if this is a * priority-queue, then $options might specify the item's priority * * @return bool, TRUE on success diff --git a/CRM/Queue/Queue/Sql.php b/CRM/Queue/Queue/Sql.php index ddc0892a4d..ec42b368da 100644 --- a/CRM/Queue/Queue/Sql.php +++ b/CRM/Queue/Queue/Sql.php @@ -84,7 +84,7 @@ class CRM_Queue_Queue_Sql extends CRM_Queue_Queue { * Add a new item to the queue * * @param $data serializable PHP object or array - * @param $options queue-dependent options; for example, if this is a + * @param array|\queue $options queue-dependent options; for example, if this is a * priority-queue, then $options might specify the item's priority * * @return bool, TRUE on success @@ -116,7 +116,7 @@ class CRM_Queue_Queue_Sql extends CRM_Queue_Queue { /** * Get the next item * - * @param $lease_time seconds + * @param int|\seconds $lease_time seconds * * @return object with key 'data' that matches the inputted data */ diff --git a/CRM/Queue/Runner.php b/CRM/Queue/Runner.php index b0dc87f913..f776f4fd1b 100644 --- a/CRM/Queue/Runner.php +++ b/CRM/Queue/Runner.php @@ -269,6 +269,9 @@ class CRM_Queue_Runner { } /** + * + * @param $isOK + * @param null $exception * * @return array(is_error => bool, is_continue => bool, numberOfItems => int) */ diff --git a/CRM/Queue/Service.php b/CRM/Queue/Service.php index 2d3029007d..f5df41abd8 100644 --- a/CRM/Queue/Service.php +++ b/CRM/Queue/Service.php @@ -56,6 +56,8 @@ class CRM_Queue_Service { * becomes available. * * @param $forceNew bool + * + * @return \CRM_Queue_Service */ static function &singleton($forceNew = FALSE) { if ($forceNew || !self::$_singleton) { diff --git a/CRM/Queue/Task.php b/CRM/Queue/Task.php index 5c12e5e044..d5d76c5efa 100644 --- a/CRM/Queue/Task.php +++ b/CRM/Queue/Task.php @@ -66,7 +66,10 @@ class CRM_Queue_Task { /** * Perform the task * - * @param $taskContext array with keys: + * @param $taskCtx + * + * @throws Exception + * @internal param array $taskContext with keys: * - log: object 'Log' * * @return bool, TRUE if task completes successfully diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php index ab56388125..bb1559e861 100644 --- a/CRM/Report/Form.php +++ b/CRM/Report/Form.php @@ -277,7 +277,7 @@ class CRM_Report_Form extends CRM_Core_Form { public $_havingClauses = array(); /** - * dashBoardRowCount Dashboard row count + * dashBoardRowCount Dashboard row count * @var Integer */ public $_dashBoardRowCount; @@ -351,7 +351,7 @@ class CRM_Report_Form extends CRM_Core_Form { 'Boolean', CRM_Core_DAO::$_nullObject ); - + $this->_dashBoardRowCount = CRM_Utils_Request::retrieve( 'rowCount', @@ -1391,7 +1391,7 @@ class CRM_Report_Form extends CRM_Core_Form { $clause = "{$field['dbAlias']} REGEXP '[[:<:]]" . implode('|', $value) . "[[:>:]]'"; } break; - + case 'mnot': // mnot == multiple is not one of if ($value !== NULL && count($value) > 0) { @@ -2693,7 +2693,7 @@ WHERE cg.extends IN ('" . implode("','", $this->_customGroupExtends) . "') AND function limit($rowCount = self::ROW_COUNT_LIMIT) { // lets do the pager if in html mode $this->_limit = NULL; - + // CRM-14115, over-ride row count if rowCount is specified in URL if ($this->_dashBoardRowCount) { $rowCount = $this->_dashBoardRowCount; @@ -3188,8 +3188,12 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a * and also accepts an array of options rather than a long list * * function for adding address fields to construct function in reports + * * @param bool $groupBy Add GroupBy? Not appropriate for detail report * @param bool $orderBy Add GroupBy? Not appropriate for detail report + * @param bool $filters + * @param array $defaults + * * @return array address fields for construct clause */ function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = array( diff --git a/CRM/SMS/Form/Upload.php b/CRM/SMS/Form/Upload.php index 515d32e815..37d24a0c2a 100644 --- a/CRM/SMS/Form/Upload.php +++ b/CRM/SMS/Form/Upload.php @@ -292,6 +292,9 @@ class CRM_SMS_Form_Upload extends CRM_Core_Form { * * @param array $params (ref.) an assoc array of name/value pairs * + * @param $files + * @param $self + * * @return mixed true or array of errors * @access public * @static diff --git a/CRM/SMS/Provider.php b/CRM/SMS/Provider.php index 496dfb18f0..3aaf7ca516 100644 --- a/CRM/SMS/Provider.php +++ b/CRM/SMS/Provider.php @@ -48,9 +48,11 @@ abstract class CRM_SMS_Provider { /** * singleton function used to manage this object * + * @param array $providerParams + * @param bool $force + * * @return object * @static - * */ static function &singleton($providerParams = array( ), $force = FALSE) { diff --git a/CRM/SMS/StateMachine/Send.php b/CRM/SMS/StateMachine/Send.php index bab3ce03df..8a982c2a75 100644 --- a/CRM/SMS/StateMachine/Send.php +++ b/CRM/SMS/StateMachine/Send.php @@ -42,10 +42,11 @@ class CRM_SMS_StateMachine_Send extends CRM_Core_StateMachine { /** * class constructor * - * @param object CRM_SMS_Controller - * @param int $action + * @param object $controller + * @param \const|int $action * - * @return object CRM_SMS_StateMachine + * @internal param \CRM_SMS_Controller $object + * @return \CRM_SMS_StateMachine_Send CRM_SMS_StateMachine */ function __construct($controller, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/CRM/UF/Form/AdvanceSetting.php b/CRM/UF/Form/AdvanceSetting.php index 67106cfa16..d02d092291 100644 --- a/CRM/UF/Form/AdvanceSetting.php +++ b/CRM/UF/Form/AdvanceSetting.php @@ -39,6 +39,8 @@ class CRM_UF_Form_AdvanceSetting extends CRM_UF_Form_Group { * * @access public * + * @param $form + * * @return void */ public static function buildAdvanceSetting(&$form) { diff --git a/CRM/UF/Form/Field.php b/CRM/UF/Form/Field.php index 769a0b7a70..61a2360faa 100644 --- a/CRM/UF/Form/Field.php +++ b/CRM/UF/Form/Field.php @@ -289,7 +289,7 @@ class CRM_UF_Form_Field extends CRM_Core_Form { $this->_location_types = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'); $defaultLocationType = CRM_Core_BAO_LocationType::getDefault(); $this->_website_types = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id'); - + /** * FIXME: dirty hack to make the default option show up first. This * avoids a mozilla browser bug with defaults on dynamically constructed @@ -750,6 +750,9 @@ class CRM_UF_Form_Field extends CRM_Core_Form { * * @param array $fields posted values of the form * + * @param $files + * @param $self + * * @return array list of errors to be posted back to the form * @static * @access public diff --git a/CRM/UF/Page/Field.php b/CRM/UF/Page/Field.php index 148142be55..f1803eebb8 100644 --- a/CRM/UF/Page/Field.php +++ b/CRM/UF/Page/Field.php @@ -278,7 +278,10 @@ class CRM_UF_Page_Field extends CRM_Core_Page { /** * Preview custom field * - * @param int $id custom field id + * @param $fieldId + * @param $groupId + * + * @internal param int $id custom field id * * @return void * @access public diff --git a/CRM/UF/Page/Group.php b/CRM/UF/Page/Group.php index d007fe2e40..3437297b4c 100644 --- a/CRM/UF/Page/Group.php +++ b/CRM/UF/Page/Group.php @@ -380,6 +380,8 @@ class CRM_UF_Page_Group extends CRM_Core_Page { * * @param int $id uf group id * + * @param $action + * * @return void * @access public */ diff --git a/CRM/UF/Page/ProfileEditor.php b/CRM/UF/Page/ProfileEditor.php index 582315d17a..6b2b33282b 100644 --- a/CRM/UF/Page/ProfileEditor.php +++ b/CRM/UF/Page/ProfileEditor.php @@ -89,6 +89,8 @@ class CRM_UF_Page_ProfileEditor extends CRM_Core_Page { * Get a list of Backbone-Form models * * @param array $entityTypes model names ("IndividualModel") + * + * @throws CRM_Core_Exception * @return array; keys are model names ("IndividualModel") and values describe 'sections' and 'schema' * @see js/model/crm.core.js * @see js/model/crm.mappedcore.js diff --git a/CRM/Upgrade/Form.php b/CRM/Upgrade/Form.php index 60c313fcea..e6fa97e301 100644 --- a/CRM/Upgrade/Form.php +++ b/CRM/Upgrade/Form.php @@ -367,6 +367,9 @@ SET version = '$version' /** * Determine if $currentVer can be upgraded to $latestVer * + * @param $currentVer + * @param $latestVer + * * @return mixed, a string error message or boolean 'false' if OK */ function checkUpgradeableVersion($currentVer, $latestVer) { @@ -418,6 +421,9 @@ SET version = '$version' /** * Determine if $currentver already matches $latestVer * + * @param $currentVer + * @param $latestVer + * * @return mixed, a string error message or boolean 'false' if OK */ function checkCurrentVersion($currentVer, $latestVer) { @@ -503,10 +509,13 @@ SET version = '$version' /** * Perform an incremental version update * + * @param CRM_Queue_TaskContext $ctx * @param $rev string, the target (intermediate) revision e.g '3.2.alpha1' - * @param $currentVer string, the original revision - * @param $latestVer string, the target (final) revision - * @param $postUpgradeMessageFile string, path of a modifiable file which lists the post-upgrade messages + * + * @return bool + * @internal param string $currentVer , the original revision + * @internal param string $latestVer , the target (final) revision + * @internal param string $postUpgradeMessageFile , path of a modifiable file which lists the post-upgrade messages */ static function doIncrementalUpgradeStart(CRM_Queue_TaskContext $ctx, $rev) { $upgrade = new CRM_Upgrade_Form(); @@ -521,10 +530,13 @@ SET version = '$version' /** * Perform an incremental version update * + * @param CRM_Queue_TaskContext $ctx * @param $rev string, the target (intermediate) revision e.g '3.2.alpha1' * @param $currentVer string, the original revision * @param $latestVer string, the target (final) revision * @param $postUpgradeMessageFile string, path of a modifiable file which lists the post-upgrade messages + * + * @return bool */ static function doIncrementalUpgradeStep(CRM_Queue_TaskContext$ctx, $rev, $currentVer, $latestVer, $postUpgradeMessageFile) { $upgrade = new CRM_Upgrade_Form(); @@ -593,10 +605,13 @@ SET version = '$version' /** * Perform an incremental version update * + * @param CRM_Queue_TaskContext $ctx * @param $rev string, the target (intermediate) revision e.g '3.2.alpha1' * @param $currentVer string, the original revision * @param $latestVer string, the target (final) revision * @param $postUpgradeMessageFile string, path of a modifiable file which lists the post-upgrade messages + * + * @return bool */ static function doIncrementalUpgradeFinish(CRM_Queue_TaskContext $ctx, $rev, $currentVer, $latestVer, $postUpgradeMessageFile) { $upgrade = new CRM_Upgrade_Form(); @@ -639,6 +654,8 @@ SET version = '$version' * object. * * @param $preUpgradeMessage string, alterable + * @param $currentVer + * @param $latestVer */ function setPreUpgradeMessage(&$preUpgradeMessage, $currentVer, $latestVer) { CRM_Upgrade_Incremental_Legacy::setPreUpgradeMessage($preUpgradeMessage, $currentVer, $latestVer); diff --git a/CRM/Upgrade/Headless.php b/CRM/Upgrade/Headless.php index 7c0f96ef70..3125ce06dd 100644 --- a/CRM/Upgrade/Headless.php +++ b/CRM/Upgrade/Headless.php @@ -33,9 +33,12 @@ class CRM_Upgrade_Headless { /** * Perform an upgrade without using the web-frontend * + * @param bool $enablePrint + * + * @throws + * @throws Exception * @return array, with keys: * - message: string, HTML-ish blob - * @throws Exception */ function run($enablePrint = TRUE) { // lets get around the time limit issue if possible for upgrades diff --git a/CRM/Upgrade/Incremental/Legacy.php b/CRM/Upgrade/Incremental/Legacy.php index 85d694725d..26f8904995 100644 --- a/CRM/Upgrade/Incremental/Legacy.php +++ b/CRM/Upgrade/Incremental/Legacy.php @@ -43,6 +43,8 @@ class CRM_Upgrade_Incremental_Legacy { * Compute any messages which should be displayed before upgrade * * @param $preUpgradeMessage string, alterable + * @param $currentVer + * @param $latestVer */ static function setPreUpgradeMessage(&$preUpgradeMessage, $currentVer, $latestVer) { $upgrade = new CRM_Upgrade_Form(); diff --git a/CRM/Upgrade/Incremental/php/FourFour.php b/CRM/Upgrade/Incremental/php/FourFour.php index fecd07291e..e8c705767d 100644 --- a/CRM/Upgrade/Incremental/php/FourFour.php +++ b/CRM/Upgrade/Incremental/php/FourFour.php @@ -99,7 +99,7 @@ WHERE ceft.entity_table = 'civicrm_contribution' AND cft.payment_instrument_id I } } if ($rev == '4.4.6'){ - $postUpgradeMessage .= '

'. ts('Your contact image urls have been upgraded. If your contact image urls did not follow the standard format for image Urls they have not been upgraded. Please check the log to see image urls that were not upgraded.'); + $postUpgradeMessage .= '

'. ts('Your contact image urls have been upgraded. If your contact image urls did not follow the standard format for image Urls they have not been upgraded. Please check the log to see image urls that were not upgraded.'); } } @@ -322,7 +322,7 @@ ALTER TABLE civicrm_dashboard static function upgradeImageUrls(CRM_Queue_TaskContext $ctx, $startId, $endId){ $sql = "CREATE INDEX index_image_url ON civicrm_contact (image_url);"; - $dao = CRM_Core_DAO::executeQuery($sql); + $dao = CRM_Core_DAO::executeQuery($sql); $sql = " SELECT id, image_url FROM civicrm_contact @@ -356,7 +356,7 @@ AND id BETWEEN %1 AND %2 $failures[$dao->id] = $dao->image_url; } } - else{ + else{ $failures[$dao->id] = $dao->image_url; } } @@ -367,6 +367,8 @@ AND id BETWEEN %1 AND %2 /** * Update activity contacts CRM-12274 * + * @param CRM_Queue_TaskContext $ctx + * * @return bool TRUE for success */ static function activityContacts(CRM_Queue_TaskContext $ctx) { diff --git a/CRM/Upgrade/Incremental/php/FourThree.php b/CRM/Upgrade/Incremental/php/FourThree.php index e8091fe593..eb4b2f4a20 100644 --- a/CRM/Upgrade/Incremental/php/FourThree.php +++ b/CRM/Upgrade/Incremental/php/FourThree.php @@ -45,8 +45,11 @@ class CRM_Upgrade_Incremental_php_FourThree { * Note: This function is called iteratively for each upcoming * revision to the database. * - * @param $postUpgradeMessage string, alterable + * @param $preUpgradeMessage * @param $rev string, a version number, e.g. '4.3.alpha1', '4.3.beta3', '4.3.0' + * @param null $currentVer + * + * @internal param string $postUpgradeMessage , alterable * @return void|bool */ function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) { @@ -73,21 +76,21 @@ class CRM_Upgrade_Incremental_php_FourThree { } } } - + if ($rev == '4.3.6') { $constraintArray = array( 'civicrm_contact' => 'contact_id', - 'civicrm_payment_processor' => 'payment_processor_id', + 'civicrm_payment_processor' => 'payment_processor_id', ); - - if (version_compare('4.1alpha1', $currentVer) <= 0) { + + if (version_compare('4.1alpha1', $currentVer) <= 0) { $constraintArray['civicrm_campaign'] = 'campaign_id'; } - - if (version_compare('4.3alpha1', $currentVer) <= 0) { + + if (version_compare('4.3alpha1', $currentVer) <= 0) { $constraintArray['civicrm_financial_type'] = 'financial_type_id'; } - + foreach ($constraintArray as $key => $value) { $query = "SELECT contri_recur.id FROM civicrm_contribution_recur contri_recur LEFT JOIN {$key} ON contri_recur.{$value} = {$key}.id WHERE {$key}.id IS NULL"; @@ -373,7 +376,7 @@ ADD CONSTRAINT `FK_civicrm_financial_item_contact_id` FOREIGN KEY (`contact_id`) $this->addTask('Update financial_account_id in financial_trxn table', 'updateFinancialTrxnData', $rev); $this->addTask('Update Line Item Data', 'updateLineItemData', $rev); } - + //CRM-11636 function assignFinancialTypeToPriceRecords() { $upgrade = new CRM_Upgrade_Form(); @@ -912,7 +915,7 @@ ALTER TABLE civicrm_financial_account return TRUE; } - + /** * change index and add missing constraints for civicrm_contribution_recur */ @@ -924,9 +927,9 @@ ALTER TABLE civicrm_financial_account CRM_Core_DAO::executeQuery('ALTER TABLE civicrm_contribution_recur ADD INDEX UI_contribution_recur_payment_instrument_id (payment_instrument_id)'); } $constraintArray = array( - 'contact_id' => " ADD CONSTRAINT `FK_civicrm_contribution_recur_contact_id` FOREIGN KEY (`contact_id`) REFERENCES `civicrm_contact` (`id`) ON DELETE CASCADE ", - 'payment_processor_id' => " ADD CONSTRAINT `FK_civicrm_contribution_recur_payment_processor_id` FOREIGN KEY (`payment_processor_id`) REFERENCES `civicrm_payment_processor` (`id`) ON DELETE SET NULL ", - 'financial_type_id' => " ADD CONSTRAINT `FK_civicrm_contribution_recur_financial_type_id` FOREIGN KEY (`financial_type_id`) REFERENCES `civicrm_financial_type` (`id`) ON DELETE SET NULL ", + 'contact_id' => " ADD CONSTRAINT `FK_civicrm_contribution_recur_contact_id` FOREIGN KEY (`contact_id`) REFERENCES `civicrm_contact` (`id`) ON DELETE CASCADE ", + 'payment_processor_id' => " ADD CONSTRAINT `FK_civicrm_contribution_recur_payment_processor_id` FOREIGN KEY (`payment_processor_id`) REFERENCES `civicrm_payment_processor` (`id`) ON DELETE SET NULL ", + 'financial_type_id' => " ADD CONSTRAINT `FK_civicrm_contribution_recur_financial_type_id` FOREIGN KEY (`financial_type_id`) REFERENCES `civicrm_financial_type` (`id`) ON DELETE SET NULL ", 'campaign_id' => " ADD CONSTRAINT `FK_civicrm_contribution_recur_campaign_id` FOREIGN KEY (`campaign_id`) REFERENCES `civicrm_campaign` (`id`) ON DELETE SET NULL ", ); $constraint = array(); @@ -940,23 +943,23 @@ ALTER TABLE civicrm_financial_account $query = "ALTER TABLE civicrm_contribution_recur " . implode(' , ', $constraint); CRM_Core_DAO::executeQuery($query); } - return TRUE; + return TRUE; } /** * Update financial_account_id for bad data in financial_trxn table * CRM-12844 - * + * */ function updateFinancialTrxnData(CRM_Queue_TaskContext $ctx) { $upgrade = new CRM_Upgrade_Form(); - $sql = "SELECT cc.id contribution_id, cc.contribution_recur_id, cft.payment_processor_id, + $sql = "SELECT cc.id contribution_id, cc.contribution_recur_id, cft.payment_processor_id, cft.id financial_trxn_id, cfi.entity_table, cft.from_financial_account_id, cft.to_financial_account_id FROM `civicrm_contribution` cc LEFT JOIN civicrm_entity_financial_trxn ceft ON ceft.entity_id = cc.id LEFT JOIN civicrm_financial_trxn cft ON cft.id = ceft.financial_trxn_id -LEFT JOIN civicrm_entity_financial_trxn ceft1 ON ceft1.financial_trxn_id = ceft.financial_trxn_id +LEFT JOIN civicrm_entity_financial_trxn ceft1 ON ceft1.financial_trxn_id = ceft.financial_trxn_id LEFT JOIN civicrm_financial_item cfi ON cfi.id = ceft1.entity_id WHERE ceft.entity_table = 'civicrm_contribution' AND cc.contribution_recur_id IS NOT NULL AND ceft1.entity_table = 'civicrm_financial_item' AND cft.id IS NOT NULL AND cft.payment_instrument_id = %1 @@ -981,7 +984,7 @@ ORDER BY cft.id "; } } elseif (!array_key_exists($dao->contribution_id, $financialTrxn[$dao->contribution_recur_id])) { - if (($dao->entity_table == 'civicrm_line_item' && $dao->to_financial_account_id == $financialTrxn[$dao->contribution_recur_id]['from_financial_account_id']) + if (($dao->entity_table == 'civicrm_line_item' && $dao->to_financial_account_id == $financialTrxn[$dao->contribution_recur_id]['from_financial_account_id']) || ($dao->entity_table == 'civicrm_financial_trxn' && $dao->from_financial_account_id == $financialTrxn[$dao->contribution_recur_id]['from_financial_account_id'])) { continue; } @@ -996,8 +999,8 @@ ORDER BY cft.id "; else { $field = 'to_financial_account_id'; } - $sql = "UPDATE civicrm_financial_trxn SET $field = " . $financialTrxn[$dao->contribution_recur_id]['from_financial_account_id'] . ', -payment_processor_id = ' . $financialTrxn[$dao->contribution_recur_id]['payment_processor_id'] . ' WHERE + $sql = "UPDATE civicrm_financial_trxn SET $field = " . $financialTrxn[$dao->contribution_recur_id]['from_financial_account_id'] . ', +payment_processor_id = ' . $financialTrxn[$dao->contribution_recur_id]['payment_processor_id'] . ' WHERE id IN (' . implode(',', $val) . ')'; CRM_Core_DAO::executeQuery($sql); } @@ -1008,11 +1011,11 @@ id IN (' . implode(',', $val) . ')'; /** * Update financial_account_id for bad data in financial_trxn table * CRM-12844 - * + * */ function updateLineItemData(CRM_Queue_TaskContext $ctx) { $sql = "SELECT cc.id contribution_id, cc.contribution_recur_id, -cc.financial_type_id contribution_financial_type, +cc.financial_type_id contribution_financial_type, cli.financial_type_id line_financial_type_id, cli.price_field_id, cli.price_field_value_id, cli.label, cli.id line_item_id, cfi.financial_account_id @@ -1022,9 +1025,9 @@ LEFT JOIN civicrm_financial_item cfi ON cfi.entity_id = cli.id LEFT JOIN civicrm_price_field cpf ON cpf.id = cli.price_field_id LEFT JOIN civicrm_price_set cps ON cps.id = cpf.price_set_id LEFT JOIN civicrm_price_field_value cpfv ON cpfv.id = cli.price_field_value_id -WHERE cfi.entity_table = 'civicrm_line_item' +WHERE cfi.entity_table = 'civicrm_line_item' AND cli.entity_table = 'civicrm_contribution' -AND cps.is_quick_config = 1 AND cc.contribution_recur_id IS NOT NULL +AND cps.is_quick_config = 1 AND cc.contribution_recur_id IS NOT NULL ORDER BY cli.id"; $dao = CRM_Core_DAO::executeQuery($sql); $financialTrxn = $subsequentPayments = array(); @@ -1048,14 +1051,14 @@ ORDER BY cli.id"; foreach ($subsequentPayments as $key => $value) { $sql = "UPDATE civicrm_line_item cli LEFT JOIN civicrm_financial_item cfi ON cli.id = cfi.entity_id -SET +SET cli.label = %1, cli.price_field_id = %2, cli.price_field_value_id = %3, cfi.financial_account_id = %4, cfi.description = %5, cli.financial_type_id = %6 -WHERE cfi.entity_table = 'civicrm_line_item' +WHERE cfi.entity_table = 'civicrm_line_item' AND cli.entity_table = 'civicrm_contribution' AND cli.id IN (" . implode(',', $value). ');'; $params = array( 1 => array($financialTrxn[$key]['label'], 'String'), @@ -1150,6 +1153,8 @@ AND cli.entity_table = 'civicrm_contribution' AND cli.id IN (" . implode(',', $v * Add ON DELETE options for constraint if not present * CRM-13088 && CRM-12156 * + * @param CRM_Queue_TaskContext $ctx + * * @return bool TRUE for success */ function task_4_3_x_checkConstraints(CRM_Queue_TaskContext $ctx) { @@ -1169,14 +1174,14 @@ AND cli.entity_table = 'civicrm_contribution' AND cli.id IN (" . implode(',', $v "'FK_civicrm_grant_financial_type_id'", ); - $sql = "SELECT DELETE_RULE, TABLE_NAME, CONSTRAINT_NAME + $sql = "SELECT DELETE_RULE, TABLE_NAME, CONSTRAINT_NAME FROM information_schema.REFERENTIAL_CONSTRAINTS WHERE CONSTRAINT_NAME IN (" . implode(',', $constraintArray) . ") AND CONSTRAINT_SCHEMA = %1"; $params = array(1 => array($dbname['database'], 'String')); $onDelete = CRM_Core_DAO::executeQuery($sql, $params, TRUE, FALSE); while ($onDelete->fetch()) { - if (($onDelete->TABLE_NAME != 'civicrm_financial_item' && $onDelete->DELETE_RULE != 'SET NULL') || + if (($onDelete->TABLE_NAME != 'civicrm_financial_item' && $onDelete->DELETE_RULE != 'SET NULL') || ($onDelete->TABLE_NAME == 'civicrm_financial_item' && $onDelete->DELETE_RULE != 'CASCADE')) { $tableName = 'civicrm_financial_type'; $onDeleteOption = ' SET NULL '; @@ -1207,6 +1212,8 @@ AND CONSTRAINT_SCHEMA = %1"; /** * Check/Add INDEX CRM-12141 * + * @param CRM_Queue_TaskContext $ctx + * * @return bool TRUE for success */ function task_4_3_x_checkIndexes(CRM_Queue_TaskContext $ctx) { @@ -1230,6 +1237,8 @@ ADD INDEX UI_entity_financial_trxn_entity_id (entity_id); /** * Update phones CRM-11292 * + * @param CRM_Queue_TaskContext $ctx + * * @return bool TRUE for success */ static function phoneNumeric(CRM_Queue_TaskContext $ctx) { diff --git a/CRM/Upgrade/Incremental/php/FourTwo.php b/CRM/Upgrade/Incremental/php/FourTwo.php index aff3cd9cb1..e72b43c60f 100644 --- a/CRM/Upgrade/Incremental/php/FourTwo.php +++ b/CRM/Upgrade/Incremental/php/FourTwo.php @@ -47,8 +47,11 @@ class CRM_Upgrade_Incremental_php_FourTwo { * Note: This function is called iteratively for each upcoming * revision to the database. * - * @param $postUpgradeMessage string, alterable + * @param $preUpgradeMessage * @param $rev string, a version number, e.g. '4.2.alpha1', '4.2.beta3', '4.2.0' + * @param null $currentVer + * + * @internal param string $postUpgradeMessage , alterable * @return void */ function setPreUpgradeMessage(&$preUpgradeMessage, $rev, $currentVer = NULL) { @@ -558,8 +561,11 @@ WHERE cpse.price_set_id IS NULL"; * Find any contribution records and create corresponding line-item * records. * + * @param CRM_Queue_TaskContext $ctx * @param $startId int, the first/lowest contribution ID to convert * @param $endId int, the last/highest contribution ID to convert + * + * @return bool */ static function task_4_2_alpha1_convertContributions(CRM_Queue_TaskContext $ctx, $startId, $endId) { $upgrade = new CRM_Upgrade_Form(); @@ -701,8 +707,11 @@ WHERE cpf.price_set_id = %1 * Find any participant records and create corresponding line-item * records. * + * @param CRM_Queue_TaskContext $ctx * @param $startId int, the first/lowest participant ID to convert * @param $endId int, the last/highest participant ID to convert + * + * @return bool */ static function task_4_2_alpha1_convertParticipants(CRM_Queue_TaskContext $ctx, $startId, $endId) { $upgrade = new CRM_Upgrade_Form(); diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php index b482b5f874..5c4136ecbf 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Field.php @@ -205,13 +205,18 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field extends CRM_Upgrade_Snapshot_V4p /** * This function for building custom fields * - * @param object $qf form object (reference) - * @param string $elementName name of the custom field + * @param object $qf form object (reference) + * @param string $elementName name of the custom field + * @param $fieldId * @param boolean $inactiveNeeded - * @param boolean $useRequired true if required else false - * @param boolean $search true if used for search else false - * @param string $label label for custom field + * @param boolean $useRequired true if required else false + * @param string $label label for custom field * + * @param null $fieldOptions + * @param array $feezeOptions + * + * @return null + * @internal param bool $search true if used for search else false * @access public * @static */ diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php index d3e1cf29d4..eaa8b0e31f 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php @@ -126,7 +126,7 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapsho * @param int $fieldId price_field_id * @param array $values (reference ) to hold the values * @param string $orderBy for order by, default weight - * @param int $isActive is_active, default false + * @param bool|int $isActive is_active, default false * * @return array $values * diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php index 5ae916f9cb..a52d059009 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php @@ -99,6 +99,8 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem extends CRM_Upgrade_Snapshot_ * @param $entityId int participant/contribution id * @param $entity string participant/contribution. * + * @param null $isQuick + * * @return array of line items */ static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL) { @@ -233,6 +235,7 @@ WHERE %2.id = %1"; * @param int $entityId * @param int $entityTable * + * @return bool * @access public * @static */ diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php index c3e35ba05c..215526c7cd 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php @@ -85,8 +85,10 @@ class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_ /** * update the is_active flag in the db * - * @param int $id id of the database record - * @param boolean $is_active value we want to set the is_active field + * @param int $id id of the database record + * @param $isActive + * + * @internal param bool $is_active value we want to set the is_active field * * @return Object DAO object on sucess, null otherwise * @static @@ -155,8 +157,8 @@ WHERE ps.name = '{$entityName}' /** * Return a list of all forms which use this price set. * - * @param int $id id of price set - * @param str $simpleReturn - get raw data. Possible values: 'entity', 'table' + * @param int $id id of price set + * @param bool|\str $simpleReturn - get raw data. Possible values: 'entity', 'table' * * @return array */ @@ -326,6 +328,8 @@ WHERE ct.id = cp.contribution_type_id AND * * @param string $entityTable * @param integer $entityId + * + * @return mixed */ public static function removeFrom($entityTable, $entityId) { $dao = new CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity(); @@ -339,8 +343,11 @@ WHERE ct.id = cp.contribution_type_id AND * Used For value for events:1, contribution:2, membership:3 * * @param string $entityTable - * @param int $entityId - * @param int $usedFor ( price set that extends/used for particular component ) + * @param int $entityId + * @param int $usedFor ( price set that extends/used for particular component ) + * + * @param null $isQuickConfig + * @param null $setName * * @return integer|false price_set_id, or false if none found */ @@ -405,8 +412,8 @@ WHERE ct.id = cp.contribution_type_id AND /** * Return an associative array of all price sets * - * @param bool $withInactive whether or not to include inactive entries - * @param string $extendComponentName name of the component like 'CiviEvent','CiviContribute' + * @param bool $withInactive whether or not to include inactive entries + * @param bool|string $extendComponentName name of the component like 'CiviEvent','CiviContribute' * * @return array associative array of id => name */ @@ -450,7 +457,11 @@ WHERE ct.id = cp.contribution_type_id AND * * An array containing price set details (including price fields) is returned * - * @param int $setId - price set id whose details are needed + * @param $setID + * @param bool $required + * @param bool $validOnly + * + * @internal param int $setId - price set id whose details are needed * * @return array $setTree - array consisting of field details */ @@ -738,12 +749,14 @@ WHERE id = %1"; $params['amount'] = $totalPrice; } -/** - * Function to build the price set form. - * - * @return void - * @access public - */ + /** + * Function to build the price set form. + * + * @param $form + * + * @return void + * @access public + */ static function buildPriceSet(&$form) { $priceSetId = $form->get('priceSetId'); $userid = $form->getVar('_userID'); @@ -939,11 +952,13 @@ CRM_Utils_Hook::copy('Set', $copy); return $copy; } -/** - * This function is to check price set permission - * - * @param int $sid the price set id - */ + /** + * This function is to check price set permission + * + * @param int $sid the price set id + * + * @return bool + */ function checkPermission($sid) { if ($sid && self::eventPriceSetDomainID() @@ -956,15 +971,18 @@ CRM_Core_Error::fatal(ts('You do not have permission to access this page')); return TRUE; } -/** - * Get the sum of participant count - * for all fields of given price set. - * - * @param int $sid the price set id - * - * @access public - * @static - */ + /** + * Get the sum of participant count + * for all fields of given price set. + * + * @param int $sid the price set id + * + * @param bool $onlyActive + * + * @return int|null|string + * @access public + * @static + */ public static function getPricesetCount($sid, $onlyActive = TRUE) { $count = 0; if (!$sid) { diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php index c6074b1ab9..844bf0f897 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Field.php @@ -181,12 +181,13 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field extends CRM_Core_DAO * @var int unsigned */ public $visibility_id; - /** - * class constructor - * - * @access public - * @return civicrm_price_field - */ + + /** + * class constructor + * + * @access public + * @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field + */ function __construct() { $this->__table = 'civicrm_price_field'; diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php index 954cfbe118..2e90a00be6 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/FieldValue.php @@ -152,12 +152,13 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue extends CRM_Core_DAO * @var boolean */ public $is_active; - /** - * class constructor - * - * @access public - * @return civicrm_price_field_value - */ + + /** + * class constructor + * + * @access public + * @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue + */ function __construct() { $this->__table = 'civicrm_price_field_value'; diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php index de17ace401..0ace871a34 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/LineItem.php @@ -140,12 +140,13 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem extends CRM_Core_DAO * @var int unsigned */ public $price_field_value_id; - /** - * class constructor - * - * @access public - * @return civicrm_line_item - */ + + /** + * class constructor + * + * @access public + * @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem + */ function __construct() { $this->__table = 'civicrm_line_item'; diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php index 39b6fe2de2..c6437c2e89 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/Set.php @@ -152,12 +152,13 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set extends CRM_Core_DAO * @var boolean */ public $is_reserved; - /** - * class constructor - * - * @access public - * @return civicrm_price_set - */ + + /** + * class constructor + * + * @access public + * @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set + */ function __construct() { $this->__table = 'civicrm_price_set'; diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php index 65c117f05d..1589a9a8f8 100644 --- a/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php +++ b/CRM/Upgrade/Snapshot/V4p2/Price/DAO/SetEntity.php @@ -104,12 +104,13 @@ class CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity extends CRM_Core_DAO * @var int unsigned */ public $price_set_id; - /** - * class constructor - * - * @access public - * @return civicrm_price_set_entity - */ + + /** + * class constructor + * + * @access public + * @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity + */ function __construct() { $this->__table = 'civicrm_price_set_entity'; diff --git a/CRM/Upgrade/StateMachine.php b/CRM/Upgrade/StateMachine.php index a54512aea2..815dbbc9c9 100644 --- a/CRM/Upgrade/StateMachine.php +++ b/CRM/Upgrade/StateMachine.php @@ -42,10 +42,12 @@ class CRM_Upgrade_StateMachine extends CRM_Core_StateMachine { /** * class constructor * - * @param object CRM_Upgrade_Controller_base - * @param int $action + * @param object $controller + * @param const $pages + * @param \const|int $action * - * @return object CRM_Upgrade_StateMachine_Base + * @internal param \CRM_Upgrade_Controller_base $object + * @return \CRM_Upgrade_StateMachine CRM_Upgrade_StateMachine_Base */ function __construct(&$controller, &$pages, $action = CRM_Core_Action::NONE) { parent::__construct($controller, $action); diff --git a/CRM/Utils/API/AbstractFieldCoder.php b/CRM/Utils/API/AbstractFieldCoder.php index f71f2378ba..fa679d3d38 100644 --- a/CRM/Utils/API/AbstractFieldCoder.php +++ b/CRM/Utils/API/AbstractFieldCoder.php @@ -127,6 +127,8 @@ abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper { } /** + * @param $key + * * @return bool */ protected function isApiControlField($key) { diff --git a/CRM/Utils/API/MatchOption.php b/CRM/Utils/API/MatchOption.php index 31a3ae7ded..4dde9ba5e4 100644 --- a/CRM/Utils/API/MatchOption.php +++ b/CRM/Utils/API/MatchOption.php @@ -165,8 +165,10 @@ class CRM_Utils_API_MatchOption implements API_Wrapper { /** * Create APIv3 "get" parameters to lookup an existing record using $keys * - * @param array $apiRequest + * @param $origParams * @param array $keys list of keys to match against + * + * @internal param array $apiRequest * @return array APIv3 $params */ function createGetParams($origParams, $keys) { diff --git a/CRM/Utils/API/NullOutputCoder.php b/CRM/Utils/API/NullOutputCoder.php index e614e4f3aa..03d1131ce2 100644 --- a/CRM/Utils/API/NullOutputCoder.php +++ b/CRM/Utils/API/NullOutputCoder.php @@ -57,7 +57,8 @@ class CRM_Utils_API_NullOutputCoder extends CRM_Utils_API_AbstractFieldCoder { * submitted values across XSS vulnerability. * * @param array|string $values - * @param bool $castToString If TRUE, all scalars will be filtered (and therefore cast to strings) + * + * @internal param bool $castToString If TRUE, all scalars will be filtered (and therefore cast to strings) * If FALSE, then non-string values will be preserved */ public function encodeInput(&$values) { diff --git a/CRM/Utils/Cache.php b/CRM/Utils/Cache.php index 314c47b331..e2cdd2d52c 100644 --- a/CRM/Utils/Cache.php +++ b/CRM/Utils/Cache.php @@ -95,6 +95,8 @@ class CRM_Utils_Cache { /** * Get cache relevant settings * + * @param $cachePlugin + * * @return array * associative array of settings for the cache * @static diff --git a/CRM/Utils/Cache/APCcache.php b/CRM/Utils/Cache/APCcache.php index 9bd6765068..042c4600d4 100644 --- a/CRM/Utils/Cache/APCcache.php +++ b/CRM/Utils/Cache/APCcache.php @@ -57,9 +57,9 @@ class CRM_Utils_Cache_APCcache { /** * Constructor * - * @param array $config an array of configuration params + * @param array $config an array of configuration params * - * @return void + * @return \CRM_Utils_Cache_APCcache */ function __construct(&$config) { if (isset($config['timeout'])) { diff --git a/CRM/Utils/Cache/ArrayCache.php b/CRM/Utils/Cache/ArrayCache.php index 050860d9c9..a7745a82fe 100644 --- a/CRM/Utils/Cache/ArrayCache.php +++ b/CRM/Utils/Cache/ArrayCache.php @@ -9,9 +9,9 @@ class CRM_Utils_Cache_Arraycache implements CRM_Utils_Cache_Interface { /** * Constructor * - * @param array $config an array of configuration params + * @param array $config an array of configuration params * - * @return void + * @return \CRM_Utils_Cache_Arraycache */ function __construct($config) { $this->_cache = array(); diff --git a/CRM/Utils/Cache/Memcache.php b/CRM/Utils/Cache/Memcache.php index a1f7539d53..c84f5cc34d 100644 --- a/CRM/Utils/Cache/Memcache.php +++ b/CRM/Utils/Cache/Memcache.php @@ -80,9 +80,9 @@ class CRM_Utils_Cache_Memcache { /** * Constructor * - * @param array $config an array of configuration params + * @param array $config an array of configuration params * - * @return void + * @return \CRM_Utils_Cache_Memcache */ function __construct($config) { if (isset($config['host'])) { diff --git a/CRM/Utils/Cache/NoCache.php b/CRM/Utils/Cache/NoCache.php index d85145d609..cf700d7380 100644 --- a/CRM/Utils/Cache/NoCache.php +++ b/CRM/Utils/Cache/NoCache.php @@ -47,9 +47,9 @@ class CRM_Utils_Cache_NoCache implements CRM_Utils_Cache_Interface { /** * Constructor * - * @param array $config an array of configuration params + * @param array $config an array of configuration params * - * @return void + * @return \CRM_Utils_Cache_NoCache */ function __construct($config) { } diff --git a/CRM/Utils/Cache/SerializeCache.php b/CRM/Utils/Cache/SerializeCache.php index 9e78f04408..9d87b23bab 100644 --- a/CRM/Utils/Cache/SerializeCache.php +++ b/CRM/Utils/Cache/SerializeCache.php @@ -35,9 +35,9 @@ class CRM_Utils_Cache_SerializeCache implements CRM_Utils_Cache_Interface { /** * Constructor * - * @param array $config an array of configuration params + * @param array $config an array of configuration params * - * @return void + * @return \CRM_Utils_Cache_SerializeCache */ function __construct($config) { $this->_cache = array(); diff --git a/CRM/Utils/Cache/SqlGroup.php b/CRM/Utils/Cache/SqlGroup.php index 7898537f3c..d128bdc8b4 100644 --- a/CRM/Utils/Cache/SqlGroup.php +++ b/CRM/Utils/Cache/SqlGroup.php @@ -60,12 +60,13 @@ class CRM_Utils_Cache_SqlGroup implements CRM_Utils_Cache_Interface { /** * Constructor * - * @param array $config an array of configuration params + * @param array $config an array of configuration params * - group: string * - componentID: int * - prefetch: bool, whether to preemptively read the entire cache group; default: TRUE * - * @return void + * @throws RuntimeException + * @return \CRM_Utils_Cache_SqlGroup */ function __construct($config) { if (isset($config['group'])) { diff --git a/CRM/Utils/Geocode/Google.php b/CRM/Utils/Geocode/Google.php index d9ceaed012..4db6f2e31d 100644 --- a/CRM/Utils/Geocode/Google.php +++ b/CRM/Utils/Geocode/Google.php @@ -59,7 +59,10 @@ class CRM_Utils_Geocode_Google { * address. Note that at a later stage, we could make this function also clean up * the address into a more valid format * - * @param object $address + * @param $values + * @param bool $stateName + * + * @internal param object $address * * @return boolean true if we modified the address, false otherwise * @static diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php index 615fdbc969..db7c036bd9 100644 --- a/CRM/Utils/Hook.php +++ b/CRM/Utils/Hook.php @@ -1574,7 +1574,8 @@ abstract class CRM_Utils_Hook { * @param type $mainCaseId * @param type $otherContactId * @param type $otherCaseId - * @param type $changeClient + * @param bool|\type $changeClient + * * @return void */ static function post_case_merge($mainContactId, $mainCaseId = NULL, $otherContactId = NULL, $otherCaseId = NULL, $changeClient = FALSE) { diff --git a/CRM/Utils/Hook/DrupalBase.php b/CRM/Utils/Hook/DrupalBase.php index 47f793311d..1561ff3dee 100644 --- a/CRM/Utils/Hook/DrupalBase.php +++ b/CRM/Utils/Hook/DrupalBase.php @@ -56,16 +56,18 @@ class CRM_Utils_Hook_DrupalBase extends CRM_Utils_Hook { /** * - *@see CRM_Utils_Hook::invoke() - *@param integer $numParams Number of parameters to pass to the hook - *@param unknown $arg1 parameter to be passed to the hook - *@param unknown $arg2 parameter to be passed to the hook - *@param unknown $arg3 parameter to be passed to the hook - *@param unknown $arg4 parameter to be passed to the hook - *@param unknown $arg5 parameter to be passed to the hook - *@param string $fnSuffix function suffix, this is effectively the hook name - *@return Ambigous + * @see CRM_Utils_Hook::invoke() * + * @param integer $numParams Number of parameters to pass to the hook + * @param unknown $arg1 parameter to be passed to the hook + * @param unknown $arg2 parameter to be passed to the hook + * @param unknown $arg3 parameter to be passed to the hook + * @param unknown $arg4 parameter to be passed to the hook + * @param unknown $arg5 parameter to be passed to the hook + * @param mixed $arg6 + * @param string $fnSuffix function suffix, this is effectively the hook name + * + * @return Ambigous */ function invoke($numParams, &$arg1, &$arg2, &$arg3, &$arg4, &$arg5, &$arg6, @@ -102,4 +104,4 @@ class CRM_Utils_Hook_DrupalBase extends CRM_Utils_Hook { } } } -} \ No newline at end of file +} diff --git a/CRM/Utils/Migrate/Export.php b/CRM/Utils/Migrate/Export.php index 5390691689..54c06fbd70 100644 --- a/CRM/Utils/Migrate/Export.php +++ b/CRM/Utils/Migrate/Export.php @@ -541,6 +541,8 @@ class CRM_Utils_Migrate_Export { * @param string $name tag name * @param string $value text * @param string $prefix + * + * @throws Exception * @return string XML */ function renderTextTag($name, $value, $prefix = '') { diff --git a/CRM/Utils/PDF/Label.php b/CRM/Utils/PDF/Label.php index b16272acfd..69d6b520a5 100644 --- a/CRM/Utils/PDF/Label.php +++ b/CRM/Utils/PDF/Label.php @@ -91,7 +91,7 @@ class CRM_Utils_PDF_Label extends TCPDF { * * @param $format Either the name of a Label Format in the Option Value table * or an array of Label Format values. - * @param $unit Unit of measure for the PDF document + * @param string|\Unit $unit Unit of measure for the PDF document * * @access public */ diff --git a/CRM/Utils/SQL/Select.php b/CRM/Utils/SQL/Select.php index 3a10253a85..cc029a59bf 100644 --- a/CRM/Utils/SQL/Select.php +++ b/CRM/Utils/SQL/Select.php @@ -183,6 +183,7 @@ class CRM_Utils_SQL_Select { * * PHP NULL's will be treated as SQL NULL's. The PHP string "null" will be treated as a string. * + * @throws CRM_Core_Exception * @return string SQL expression */ public function interpolate($expr, $args) { diff --git a/CRM/Utils/System.php b/CRM/Utils/System.php index 546821a252..7573b034be 100644 --- a/CRM/Utils/System.php +++ b/CRM/Utils/System.php @@ -544,6 +544,8 @@ class CRM_Utils_System { /** * @param bool $abort * (optional) Whether to exit; defaults to true. + * + * @return bool */ static function authenticateKey($abort = TRUE) { // also make sure the key is sent and is valid diff --git a/CRM/Utils/System/Base.php b/CRM/Utils/System/Base.php index aeb5411a44..1571c417aa 100644 --- a/CRM/Utils/System/Base.php +++ b/CRM/Utils/System/Base.php @@ -82,6 +82,9 @@ abstract class CRM_Utils_System_Base { * * @param string $url * + * @param bool $addLanguagePart + * @param bool $removeLanguagePart + * * @return string $url, formatted url. * @static */ diff --git a/CRM/Utils/Type.php b/CRM/Utils/Type.php index d226544199..5192000e2e 100644 --- a/CRM/Utils/Type.php +++ b/CRM/Utils/Type.php @@ -70,9 +70,7 @@ class CRM_Utils_Type { * * @param $type integer datatype * - * @return $string String datatype respective to integer datatype - * - * @access public + * @return string $string String datatype respective to integer datatype@access public * @static */ static function typeToString($type) { diff --git a/Civi/Core/Container.php b/Civi/Core/Container.php index e251f2adf9..38b9fbbb5d 100644 --- a/Civi/Core/Container.php +++ b/Civi/Core/Container.php @@ -35,6 +35,7 @@ class Container { /** * @var ContainerBuilder + * @return \Symfony\Component\DependencyInjection\ContainerBuilder */ public function createContainer() { $civicrm_base_path = dirname(dirname(__DIR__)); diff --git a/api/Wrapper.php b/api/Wrapper.php index 54927fdca9..73bd8043ec 100644 --- a/api/Wrapper.php +++ b/api/Wrapper.php @@ -3,11 +3,16 @@ interface API_Wrapper { /** + * @param $apiRequest + * * @return modified $apiRequest */ function fromApiInput($apiRequest); /** + * @param $apiRequest + * @param $result + * * @return modified $result */ function toApiOutput($apiRequest, $result); diff --git a/api/v3/Acl.php b/api/v3/Acl.php index 896cb79af8..2ad97bc28c 100644 --- a/api/v3/Acl.php +++ b/api/v3/Acl.php @@ -41,6 +41,8 @@ * {@getfields acl_create} * @example aclCreate.php * + * @param $params + * * @return array of newly created acl property values. * @access public */ @@ -55,6 +57,8 @@ function civicrm_api3_acl_create($params) { * {@getfields acl_get} * @example aclCreate.php * + * @param $params + * * @return array of retrieved acl property values. * @access public */ @@ -69,6 +73,8 @@ function civicrm_api3_acl_get($params) { * {@getfields acl_delete} * @example aclCreate.php * + * @param $params + * * @return array of deleted values. * @access public */ diff --git a/api/v3/AclRole.php b/api/v3/AclRole.php index 377691826b..05a3712028 100644 --- a/api/v3/AclRole.php +++ b/api/v3/AclRole.php @@ -41,6 +41,8 @@ * {@getfields acl_role_create} * @example acl_roleCreate.php * + * @param $params + * * @return array of newly created acl_role property values. * @access public */ @@ -55,6 +57,8 @@ function civicrm_api3_acl_role_create($params) { * {@getfields acl_role_get} * @example acl_roleCreate.php * + * @param $params + * * @return array of retrieved acl_role property values. * @access public */ @@ -69,6 +73,8 @@ function civicrm_api3_acl_role_get($params) { * {@getfields acl_role_delete} * @example acl_roleCreate.php * + * @param $params + * * @return array of deleted values. * @access public */ diff --git a/api/v3/Activity.php b/api/v3/Activity.php index e9d62d1ac7..c7d033ec6a 100644 --- a/api/v3/Activity.php +++ b/api/v3/Activity.php @@ -41,16 +41,16 @@ /** * Creates or updates an Activity. See the example for usage * - * @param array $params Associative array of property name/value + * @param array $params Associative array of property name/value * pairs for the activity. * {@getfields activity_create} * + * @throws API_Exception * @return array Array containing 'is_error' to denote success or failure and details of the created activity * * @example ActivityCreate.php Standard create example * @example Activity/ContactRefCustomField.php Create example including setting a contact reference custom field * {@example ActivityCreate.php 0} - * */ function civicrm_api3_activity_create($params) { diff --git a/api/v3/ActivityContact.php b/api/v3/ActivityContact.php index c6ca5ae86c..c180ae9e64 100644 --- a/api/v3/ActivityContact.php +++ b/api/v3/ActivityContact.php @@ -43,6 +43,8 @@ * * @example ActivityContact.php * + * @param $params + * * @return array of newly created activity contact records. * @access public */ @@ -67,7 +69,7 @@ function _civicrm_api3_activity_contact_create_spec(&$params) { * @param array $params * * @return array Api Result - * + * * @example ActivityContact.php * @access public */ diff --git a/api/v3/ActivityType.php b/api/v3/ActivityType.php index 273ff8959d..e70ce15d0d 100644 --- a/api/v3/ActivityType.php +++ b/api/v3/ActivityType.php @@ -42,6 +42,8 @@ /** * Function to retrieve activity types * + * @param $params + * * @return array $activityTypes activity types keyed by id * @access public * diff --git a/api/v3/Address.php b/api/v3/Address.php index a00126d4fd..2de12df07a 100644 --- a/api/v3/Address.php +++ b/api/v3/Address.php @@ -43,6 +43,8 @@ * {@getfields address_create} * {@example AddressCreate.php} * + * @param $params + * * @return array of newly created tag property values. * @access public */ diff --git a/api/v3/Batch.php b/api/v3/Batch.php index 1d6a4f95bc..93af82e0cc 100644 --- a/api/v3/Batch.php +++ b/api/v3/Batch.php @@ -41,6 +41,8 @@ * {@getfields batch_create} * @example BatchCreate.php * + * @param $params + * * @return array of newly created batch property values. * @access public */ @@ -73,6 +75,8 @@ function _civicrm_api3_batch_create_spec(&$params) { * {@getfields batch_get} * @example BatchCreate.php * + * @param $params + * * @return array of retrieved batch property values. * @access public */ @@ -87,6 +91,8 @@ function civicrm_api3_batch_get($params) { * {@getfields batch_delete} * @example BatchCreate.php * + * @param $params + * * @return array of deleted values. * @access public */ diff --git a/api/v3/Case.php b/api/v3/Case.php index afad807393..7a6bf6c61d 100644 --- a/api/v3/Case.php +++ b/api/v3/Case.php @@ -189,6 +189,7 @@ function _civicrm_api3_case_delete_spec(&$params) { * * {@getfields case_get} * + * @throws API_Exception * @return array (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found@access public * @todo Erik Hommel 16 dec 2010 check if all DB fields are returned */ @@ -339,13 +340,14 @@ function civicrm_api3_case_update($params) { /** * Delete a specified case. * - * @param array( - //REQUIRED: + * @param array ( + * //REQUIRED: * 'id' => int * * //OPTIONAL * 'move_to_trash' => bool (defaults to false) * + * @throws API_Exception * @return boolean: true if success, else false * {@getfields case_delete} * @access public diff --git a/api/v3/CaseType.php b/api/v3/CaseType.php index f877bdea32..0c95a85935 100644 --- a/api/v3/CaseType.php +++ b/api/v3/CaseType.php @@ -62,9 +62,10 @@ function civicrm_api3_case_type_create($params) { /** * Function to retrieve case types * + * @param $params + * * @return array $caseTypes case types keyed by id * @access public - * */ function civicrm_api3_case_type_get($params) { civicrm_api3_verify_mandatory($params); diff --git a/api/v3/Contact.php b/api/v3/Contact.php index a059e7c675..438544a5ae 100644 --- a/api/v3/Contact.php +++ b/api/v3/Contact.php @@ -40,12 +40,13 @@ /** * Create or update a contact (note you should always call this via civicrm_api() & never directly) * - * @param array $params input parameters + * @param array $params input parameters * * Allowed @params array keys are: * {@getfields contact_create} * * + * @throws API_Exception * @example ContactCreate.php Example of Create Call * * @return array API Result Array @@ -398,6 +399,7 @@ function _civicrm_api3_contact_update($params, $contactID = NULL) { * @param $params Associative array of property name/value * pairs to insert in new contact. * + * @throws API_Exception * @return array (reference ) null on success, error message otherwise * * @access public diff --git a/api/v3/CustomField.php b/api/v3/CustomField.php index 9fbc50ed7f..e14a9b0f97 100644 --- a/api/v3/CustomField.php +++ b/api/v3/CustomField.php @@ -110,6 +110,8 @@ function _civicrm_api3_custom_field_create_spec(&$params) { * Use this API to delete an existing custom group field. * * @param $params Array id of the field to be deleted + * + * @return array * @example CustomFieldDelete.php * * {@example CustomFieldDelete.php 0} @@ -130,7 +132,10 @@ function civicrm_api3_custom_field_delete($params) { * Use this API to get existing custom fields. * * @param array $params Array to search on - *{@getfields CustomField_get} + *{* + * + * @return array +@getfields CustomField_get} * @access public * **/ @@ -158,6 +163,11 @@ function civicrm_api3_custom_field_get($params) { * @params Array $fieldDetails Field Details * @params Array $errors Collect validation errors * + * @param $fieldName + * @param $value + * @param $fieldDetails + * @param array $errors + * * @return Array Validation errors * @todo remove this function - not in use but need to review functionality before * removing as it might be useful in wrapper layer diff --git a/api/v3/CustomGroup.php b/api/v3/CustomGroup.php index d1c9285451..c5cb7ca4a4 100644 --- a/api/v3/CustomGroup.php +++ b/api/v3/CustomGroup.php @@ -120,6 +120,7 @@ function civicrm_api3_custom_group_delete($params) { * * @param array $params Array to search on * + * @return array * @access public * {@getfields CustomGroup_get} * @example CustomGroupGet.php diff --git a/api/v3/CustomSearch.php b/api/v3/CustomSearch.php index 26458cb4e4..5dd797e05d 100644 --- a/api/v3/CustomSearch.php +++ b/api/v3/CustomSearch.php @@ -5,7 +5,9 @@ * * FIXME This is a bare-minimum placeholder * - * @param array $ params input parameters + * @param $params + * + * @internal param $array $ params input parameters * * {@example OptionValueGet.php 0} * @example OptionValueGet.php @@ -29,6 +31,8 @@ function civicrm_api3_custom_search_get($params) { * * {@example OptionValueCreate.php} * + * @param $params + * * @return array of newly created option_value property values. * {@getfields OptionValue_create} * @access public diff --git a/api/v3/CustomValue.php b/api/v3/CustomValue.php index fb40aa9243..1ae1f8e14f 100644 --- a/api/v3/CustomValue.php +++ b/api/v3/CustomValue.php @@ -47,28 +47,28 @@ * * @param $params expected keys are in format custom_fieldID:recordID or custom_groupName:fieldName:recordID * for example: - // entity ID. You do not need to specify entity type, we figure it out based on the fields you're using + * // entity ID. You do not need to specify entity type, we figure it out based on the fields you're using * 'entity_id' => 123, - // (omitting :id) inserts or updates a field in a single-valued group + * // (omitting :id) inserts or updates a field in a single-valued group * 'custom_6' => 'foo', - // custom_24 is checkbox or multiselect, so pass items as an array + * // custom_24 is checkbox or multiselect, so pass items as an array * 'custom_24' => array('bar', 'baz'), - // in this case custom_33 is part of a multi-valued group, and we're updating record id 5 + * // in this case custom_33 is part of a multi-valued group, and we're updating record id 5 * 'custom_33:5' => value, - // inserts new record in multi-valued group + * // inserts new record in multi-valued group * 'custom_33:-1' => value, - // inserts another new record in multi-valued group + * // inserts another new record in multi-valued group * 'custom_33:-2' => value, - // you can use group_name:field_name instead of ID + * // you can use group_name:field_name instead of ID * 'custom_some_group:my_field => 'myinfo', - // updates record ID 8 in my_other_field in multi-valued some_big_group + * // updates record ID 8 in my_other_field in multi-valued some_big_group * 'custom_some_big_group:my_other_field:8 => 'myinfo', * * + * @throws Exception * @return array('values' => TRUE) or array('is_error' => 1, 'error_message' => 'what went wrong') * * @access public - * */ function civicrm_api3_custom_value_create($params) { // @todo it's not clear where the entity_table is used as CRM_Core_BAO_CustomValueTable::setValues($create) @@ -122,6 +122,7 @@ function civicrm_api3_custom_value_create($params) { function _civicrm_api3_custom_value_create_spec(&$params) { $params['entity_id']['api.required'] = 1; } + /** * Use this API to get existing custom values for an entity. * @@ -133,6 +134,7 @@ function _civicrm_api3_custom_value_create_spec(&$params) { * Example: 'entity_id' => 123, 'return.custom_6' => 1, 'return.custom_33' => 1 * If you do not know the ID, you may use group name : field name, for example 'return.foo_stuff:my_field' => 1 * + * @throws API_Exception * @return array. * * @access public diff --git a/api/v3/Email.php b/api/v3/Email.php index d40582d96d..fce0646ca8 100644 --- a/api/v3/Email.php +++ b/api/v3/Email.php @@ -43,6 +43,8 @@ * * @example EmailCreate.php Standard Create Example * + * @param $params + * * @return array API result array * {@getfields email_create} * @access public diff --git a/api/v3/EntityTag.php b/api/v3/EntityTag.php index cad3a9e746..d0e20831e6 100644 --- a/api/v3/EntityTag.php +++ b/api/v3/EntityTag.php @@ -111,9 +111,9 @@ function _civicrm_api3_entity_tag_delete_spec(&$params) { /** * * @param $params - * @param $op + * @param string $op * - * @return + * @return array */ function _civicrm_api3_entity_tag_common($params, $op = 'add') { diff --git a/api/v3/Extension.php b/api/v3/Extension.php index 1552ef23e7..2e9d56857f 100644 --- a/api/v3/Extension.php +++ b/api/v3/Extension.php @@ -145,15 +145,15 @@ function civicrm_api3_extension_uninstall($params) { /** * Download and install an extension * - * @param array $params input parameters + * @param array $params input parameters * - key: string, eg "com.example.myextension" * - url: string eg "http://repo.com/myextension-1.0.zip" * + * @throws API_Exception * @return array API result * @static void * @access public * @example ExtensionDownload.php - * */ function civicrm_api3_extension_download($params) { if (! array_key_exists('key', $params)) { @@ -230,11 +230,12 @@ function civicrm_api3_extension_refresh($params) { /** * Get a list of available extensions * + * @param $params + * * @return array API result * @static void * @access public * @example ExtensionGet.php - * */ function civicrm_api3_extension_get($params) { $statuses = CRM_Extension_System::singleton()->getManager()->getStatuses(); diff --git a/api/v3/File.php b/api/v3/File.php index a5766a97be..41086c6ee3 100644 --- a/api/v3/File.php +++ b/api/v3/File.php @@ -128,11 +128,12 @@ function &civicrm_api3_file_update($params) { * This API is used for deleting a file * Required parameters : id of a file * - * @param Int $fileId Id of the file to be deleted + * @param $params + * + * @internal param Int $fileId Id of the file to be deleted * * @return null if successfull, object of CRM_Core_Error otherwise * @access public - */ function civicrm_api3_file_delete($params) { diff --git a/api/v3/FinancialAccount.php b/api/v3/FinancialAccount.php index 42e8219fe6..c39f061732 100644 --- a/api/v3/FinancialAccount.php +++ b/api/v3/FinancialAccount.php @@ -41,6 +41,8 @@ * {@getfields financial_account_create} * @example financial_accountCreate.php * + * @param $params + * * @return array of newly created financial_account property values. * @access public */ @@ -55,6 +57,8 @@ function civicrm_api3_financial_account_create($params) { * {@getfields financial_account_get} * @example financial_accountCreate.php * + * @param $params + * * @return array of retrieved financial_account property values. * @access public */ @@ -69,6 +73,8 @@ function civicrm_api3_financial_account_get($params) { * {@getfields financial_account_delete} * @example financial_accountCreate.php * + * @param $params + * * @return array of deleted values. * @access public */ diff --git a/api/v3/FinancialType.php b/api/v3/FinancialType.php index 9afe0ab262..c0cb44c7ff 100644 --- a/api/v3/FinancialType.php +++ b/api/v3/FinancialType.php @@ -41,6 +41,8 @@ * {@getfields financial_type_create} * @example financial_typeCreate.php * + * @param $params + * * @return array of newly created financial_type property values. * @access public */ @@ -55,6 +57,8 @@ function civicrm_api3_financial_type_create($params) { * {@getfields financial_type_get} * @example financial_typeCreate.php * + * @param $params + * * @return array of retrieved financial_type property values. * @access public */ @@ -69,6 +73,8 @@ function civicrm_api3_financial_type_get($params) { * {@getfields financial_type_delete} * @example financial_typeCreate.php * + * @param $params + * * @return array of deleted values. * @access public */ diff --git a/api/v3/Generic.php b/api/v3/Generic.php index 06804ad4b3..504e6be63f 100644 --- a/api/v3/Generic.php +++ b/api/v3/Generic.php @@ -137,6 +137,7 @@ function civicrm_api3_generic_getfields($apiRequest) { * * @param array $apiRequest api request as an array. Keys are * + * @throws API_Exception * @return integer count of results */ function civicrm_api3_generic_getcount($apiRequest) { @@ -258,7 +259,9 @@ function civicrm_api3_generic_getoptions($apiRequest) { * @todo - if may be we should define a 'resolve' key on the psuedoconstant for when these rules are not fine enough * * This function is only split out for the purpose of code clarity / comment block documentation + * * @param array $metadata the array of metadata that will form the result of the getfields function + * @param $apiRequest * @param string $fieldname field currently being processed * @param array $fieldSpec metadata for that field * @param array $fieldsToResolve anny field resolutions specifically requested diff --git a/api/v3/Generic/Update.php b/api/v3/Generic/Update.php index b025b6a9e4..68e4fe5e66 100644 --- a/api/v3/Generic/Update.php +++ b/api/v3/Generic/Update.php @@ -41,6 +41,8 @@ * - version: string * - function: callback (mixed) * - params: array, varies + * + * @return array|int|mixed */ function civicrm_api3_generic_update($apiRequest) { //$key_id = strtolower ($apiRequest['entity'])."_id"; diff --git a/api/v3/GroupContact.php b/api/v3/GroupContact.php index fa668214a5..09acf2d259 100644 --- a/api/v3/GroupContact.php +++ b/api/v3/GroupContact.php @@ -122,8 +122,7 @@ function civicrm_api3_group_contact_create($params) { * * @param $params * - * @return - * @deprecated + * @return array @deprecated */ function civicrm_api3_group_contact_delete($params) { $params['status'] = CRM_Utils_Array::value('status', $params, empty($params['skip_undelete']) ? 'Removed' : 'Deleted'); @@ -143,8 +142,7 @@ function _civicrm_api3_group_contact_delete_spec(&$params) { * * @param $params * - * @return - * @deprecated + * @return array|int @deprecated */ function civicrm_api3_group_contact_pending($params) { $params['status'] = 'Pending'; diff --git a/api/v3/Im.php b/api/v3/Im.php index b256fd763c..fd5e78230d 100644 --- a/api/v3/Im.php +++ b/api/v3/Im.php @@ -40,6 +40,8 @@ * Allowed @params array keys are: * {@getfields im_create} * + * @param $params + * * @return array of newly created IM property values. * @access public */ diff --git a/api/v3/Job.php b/api/v3/Job.php index 1b8452128b..19405ceb30 100644 --- a/api/v3/Job.php +++ b/api/v3/Job.php @@ -246,10 +246,11 @@ function civicrm_api3_job_mail_report($params) { * * id - Integer - greetings option group * + * @param $params + * * @return boolean true if success, else false * @static * @access public - * */ function civicrm_api3_job_update_greeting($params) { diff --git a/api/v3/LocationType.php b/api/v3/LocationType.php index 21d637ec86..c0097ebadd 100644 --- a/api/v3/LocationType.php +++ b/api/v3/LocationType.php @@ -43,6 +43,8 @@ * * @example LocationTypeCreate.php Standard Create Example * + * @param $params + * * @return array API result array * {@getfields email_create} * @access public diff --git a/api/v3/Mailing.php b/api/v3/Mailing.php index be6b021b21..116a4b021c 100644 --- a/api/v3/Mailing.php +++ b/api/v3/Mailing.php @@ -45,6 +45,8 @@ * Handle a create event. * * @param array $params + * @param array $ids + * * @return array API Success Array */ function civicrm_api3_mailing_create($params, $ids = array()) { @@ -70,6 +72,8 @@ function _civicrm_api3_mailing_create_spec(&$params) { * Handle a delete event. * * @param array $params + * @param array $ids + * * @return array API Success Array */ function civicrm_api3_mailing_delete($params, $ids = array()) { @@ -92,6 +96,7 @@ function civicrm_api3_mailing_get($params) { * * @param array $params * + * @throws API_Exception * @return array */ function civicrm_api3_mailing_event_bounce($params) { diff --git a/api/v3/MailingEventConfirm.php b/api/v3/MailingEventConfirm.php index f0e5243714..c1b64a4d7c 100644 --- a/api/v3/MailingEventConfirm.php +++ b/api/v3/MailingEventConfirm.php @@ -40,9 +40,10 @@ /** * Handle a confirm event * - * @param array $params Associative array of property + * @param array $params Associative array of property * name/value pairs to insert in new 'survey' * + * @throws Exception * @return array api result array * {@getfields mailing_event_confirm_create} * @access public diff --git a/api/v3/MailingEventSubscribe.php b/api/v3/MailingEventSubscribe.php index 1df072a408..b312d7820d 100644 --- a/api/v3/MailingEventSubscribe.php +++ b/api/v3/MailingEventSubscribe.php @@ -40,9 +40,10 @@ /** * Subscribe from mailing group * - * @param array $params Associative array of property + * @param array $params Associative array of property * name/value pairs to insert in new 'survey' * + * @throws API_Exception * @return array api result array * {@getfields mailing_event_subscribe_create} * @access public diff --git a/api/v3/MailingRecipients.php b/api/v3/MailingRecipients.php index 4b788c48dd..2cf2d2ff0a 100644 --- a/api/v3/MailingRecipients.php +++ b/api/v3/MailingRecipients.php @@ -45,7 +45,9 @@ /** * Returns array of Mailing Recipients * - * @param array $params Array of one or more valid + * @param array $params Array of one or more valid + * @param array $ids + * * @return array API return Array of matching mailing jobs * {@getfields mailing_recipient_get} * @access public diff --git a/api/v3/MembershipStatus.php b/api/v3/MembershipStatus.php index c44dc6639a..a02cd3c484 100644 --- a/api/v3/MembershipStatus.php +++ b/api/v3/MembershipStatus.php @@ -142,8 +142,11 @@ function civicrm_api3_membership_status_delete($params) { * This API is used for deriving Membership Status of a given Membership * record using the rules encoded in the membership_status table. * - * @param Int $membershipID Id of a membership - * @param String $statusDate + * @param $membershipParams + * + * @throws API_Exception + * @internal param Int $membershipID Id of a membership + * @internal param String $statusDate * * @return Array Array of status id and status name * @public diff --git a/api/v3/Note.php b/api/v3/Note.php index 30e6db4d53..73059ca3a4 100644 --- a/api/v3/Note.php +++ b/api/v3/Note.php @@ -81,6 +81,8 @@ function _civicrm_api3_note_create_spec(&$params) { * @params array $paramsarray including id of the note to be deleted * {@getfields note_delete} * + * @param $params + * * @return null * @access public */ diff --git a/api/v3/Participant.php b/api/v3/Participant.php index f7a1e24f5f..a746e8a00e 100644 --- a/api/v3/Participant.php +++ b/api/v3/Participant.php @@ -168,9 +168,11 @@ function _civicrm_api3_participant_get_spec(&$params) { * * This API is used for deleting a contact participant * - * @param array $params Array containing Id of the contact participant to be deleted + * @param array $params Array containing Id of the contact participant to be deleted * * {@getfields participant_delete} + * @throws Exception + * @return array * @access public */ function civicrm_api3_participant_delete($params) { diff --git a/api/v3/ParticipantPayment.php b/api/v3/ParticipantPayment.php index 750b3c1cb0..bc6be79be3 100644 --- a/api/v3/ParticipantPayment.php +++ b/api/v3/ParticipantPayment.php @@ -85,7 +85,9 @@ function _civicrm_api3_participant_payment_create_spec(&$params) { * * This API is used for deleting a Participant Payment * - * @param Int $participantPaymentID Id of the Participant Payment to be deleted + * @param $params + * + * @internal param Int $participantPaymentID Id of the Participant Payment to be deleted * * @return array API result * @example ParticipantPaymentDelete.php diff --git a/api/v3/PaymentProcessor.php b/api/v3/PaymentProcessor.php index ae328d0569..a80cea3f8e 100644 --- a/api/v3/PaymentProcessor.php +++ b/api/v3/PaymentProcessor.php @@ -40,6 +40,8 @@ * Allowed @params array keys are: * {@getfields payment_processor_create} * + * @param $params + * * @return array of newly created PaymentProcessor property values. * @access public */ diff --git a/api/v3/Phone.php b/api/v3/Phone.php index 8ac7b84043..00127310f8 100644 --- a/api/v3/Phone.php +++ b/api/v3/Phone.php @@ -43,6 +43,8 @@ * {@getfields phone_create} * @example PhoneCreate.php * + * @param $params + * * @return array of newly created phone property values. * @access public */ diff --git a/api/v3/Pledge.php b/api/v3/Pledge.php index 52eb53e0a7..9955b91299 100644 --- a/api/v3/Pledge.php +++ b/api/v3/Pledge.php @@ -155,11 +155,13 @@ function _civicrm_api3_pledge_get_defaults() { * take the input parameter list as specified in the data model and * convert it into the same format that we use in QF and BAO object * - * @param array $params Associative array of property name/value - * pairs to insert in new contact. - * @param array $values The reformatted properties that we can use internally + * @param array $values The reformatted properties that we can use internally * ' * + * @param bool $create + * + * @internal param array $params Associative array of property name/value + * pairs to insert in new contact. * @return array|CRM_Error * @access public */ diff --git a/api/v3/PledgePayment.php b/api/v3/PledgePayment.php index 0d17e10965..81b6fe59bb 100644 --- a/api/v3/PledgePayment.php +++ b/api/v3/PledgePayment.php @@ -137,6 +137,8 @@ function updatePledgePayments($pledgeId, $paymentStatusId, $paymentIds) { /** * Gets field for civicrm_pledge_payment functions * + * @param $params + * * @return array fields valid for other functions */ function civicrm_api3_pledge_payment_get_spec(&$params) { diff --git a/api/v3/PrintLabel.php b/api/v3/PrintLabel.php index f66ddc8152..f1016fc120 100644 --- a/api/v3/PrintLabel.php +++ b/api/v3/PrintLabel.php @@ -41,6 +41,8 @@ * {@getfields print_label_create} * @example print_labelCreate.php * + * @param $params + * * @return array of newly created print_label property values. * @access public */ @@ -55,6 +57,8 @@ function civicrm_api3_print_label_create($params) { * {@getfields print_label_get} * @example print_labelCreate.php * + * @param $params + * * @return array of retrieved print_label property values. * @access public */ @@ -69,6 +73,8 @@ function civicrm_api3_print_label_get($params) { * {@getfields print_label_delete} * @example print_labelCreate.php * + * @param $params + * * @return array of deleted values. * @access public */ diff --git a/api/v3/Relationship.php b/api/v3/Relationship.php index e3ae1509ae..2dede0b650 100644 --- a/api/v3/Relationship.php +++ b/api/v3/Relationship.php @@ -40,15 +40,15 @@ /** * Add or update a relationship * - * @param array $params input parameters + * @param array $params input parameters * + * @throws API_Exception * @example RelationshipCreate.php Std Create example * * @return array API Result Array * {@getfields relationship_create} * @static void * @access public - * */ function civicrm_api3_relationship_create($params) { @@ -171,11 +171,12 @@ function civicrm_api3_relationship_get($params) { * take the input parameter list as specified in the data model and * convert it into the same format that we use in QF and BAO object * - * @param array $params Associative array of property name/value + * @param array $params Associative array of property name/value * pairs to insert in new contact. - * @param array $values The reformatted properties that we can use internally + * @param array $values The reformatted properties that we can use internally * ' * + * @throws Exception * @return array|CRM_Error * @access public */ diff --git a/api/v3/ReportInstance.php b/api/v3/ReportInstance.php index ec2fa1a3be..ace2fef3a8 100644 --- a/api/v3/ReportInstance.php +++ b/api/v3/ReportInstance.php @@ -13,7 +13,9 @@ function civicrm_api3_report_instance_get($params) { } /** - * Add or update a report instance. + * Add or update a report instance. + * + * @param $params * * @return array of newly created report instance property values. * @access public diff --git a/api/v3/ReportTemplate.php b/api/v3/ReportTemplate.php index f83a8f4e4c..2976162973 100644 --- a/api/v3/ReportTemplate.php +++ b/api/v3/ReportTemplate.php @@ -5,7 +5,9 @@ * * FIXME This is a bare-minimum placeholder * - * @param array $ params input parameters + * @param $params + * + * @internal param $array $ params input parameters * * {@example OptionValueGet.php 0} * @example OptionValueGet.php @@ -29,6 +31,8 @@ function civicrm_api3_report_template_get($params) { * * {@example OptionValueCreate.php} * + * @param $params + * * @return array of newly created option_value property values. * {@getfields OptionValue_create} * @access public diff --git a/api/v3/SmsProvider.php b/api/v3/SmsProvider.php index 39dcdfb077..9eda0c7dc3 100644 --- a/api/v3/SmsProvider.php +++ b/api/v3/SmsProvider.php @@ -41,6 +41,8 @@ * {@getfields sms_provider_create} * @example sms_providerCreate.php * + * @param $params + * * @return array of newly created sms_provider property values. * @access public */ @@ -55,6 +57,8 @@ function civicrm_api3_sms_provider_create($params) { * {@getfields sms_provider_get} * @example sms_providerCreate.php * + * @param $params + * * @return array of retrieved sms_provider property values. * @access public */ @@ -69,6 +73,8 @@ function civicrm_api3_sms_provider_get($params) { * {@getfields sms_provider_delete} * @example sms_providerCreate.php * + * @param $params + * * @return array of deleted values. * @access public */ diff --git a/api/v3/Tag.php b/api/v3/Tag.php index a629289786..fd87dfde70 100644 --- a/api/v3/Tag.php +++ b/api/v3/Tag.php @@ -42,6 +42,8 @@ * * {@example TagCreate.php} * + * @param $params + * * @return array of newly created tag property values. * {@getfields tag_create} * @access public diff --git a/api/v3/Website.php b/api/v3/Website.php index cc444c5864..63cb1d6907 100644 --- a/api/v3/Website.php +++ b/api/v3/Website.php @@ -44,6 +44,8 @@ * @example WebsiteCreate.php * {@example WebsiteCreate.php} * + * @param $params + * * @return array of newly created website property values. * @access public * @todo convert to using basic create - BAO function non-std diff --git a/api/v3/utils.php b/api/v3/utils.php index fa4df07602..aa81220ba0 100644 --- a/api/v3/utils.php +++ b/api/v3/utils.php @@ -151,7 +151,7 @@ function civicrm_api3_create_error($msg, $data = array()) { /** * Format array in result output styple * - * @param array $values values generated by API operation (the result) + * @param array|int $values values generated by API operation (the result) * @param array $params parameters passed into API call * @param string $entity the entity being acted on * @param string $action the action passed to the API @@ -1766,10 +1766,11 @@ function _civicrm_api3_api_match_pseudoconstant_value(&$value, $options, $fieldN /** * Returns the canonical name of a field - * @param $entity: api entity name (string should already be standardized - no camelCase) - * @param $fieldName: any variation of a field's name (name, unique_name, api.alias) * - * @return (string|bool) fieldName or FALSE if the field does not exist + * @param $entity : api entity name (string should already be standardized - no camelCase) + * @param $fieldName : any variation of a field's name (name, unique_name, api.alias) + * + * @return bool|string (string|bool) fieldName or FALSE if the field does not exist */ function _civicrm_api3_api_resolve_alias($entity, $fieldName) { if (strpos($fieldName, 'custom_') === 0 && is_numeric($fieldName[7])) { diff --git a/bin/givi b/bin/givi index 1769577571..c0f3f5c07f 100755 --- a/bin/givi +++ b/bin/givi @@ -534,6 +534,9 @@ class Givi { * FIXME: only supports $refs like "foo" (implicit origin) or "myremote/foo" * * @param $ref + * @param string $defaultRemote + * + * @throws Exception * @return array */ function parseBranchRepo($ref, $defaultRemote = 'origin') { @@ -554,8 +557,10 @@ class Givi { * * Any items after $command will be escaped and added to $command * + * @param $repoName * @param string $runDir * @param string $command + * * @return string */ function run($repoName, $runDir, $command) { @@ -589,6 +594,8 @@ class Givi { /** * @param string $default branch to use by default + * @param $overrides + * * @return array ($repoName => $gitRef) */ function resolveBranches($default, $overrides) { @@ -617,6 +624,8 @@ class Givi { /** * @param string $filter e.g. "all" or "repo1,repo2" * @param array $repos ($repoName => $repoDir) + * + * @throws Exception * @return array ($repoName => $repoDir) */ function filterRepos($filter, $repos) { @@ -669,8 +678,9 @@ class HttpClient { * * Any items after $command will be escaped and added to $command * - * @param string $runDir * @param string $command + * + * @internal param string $runDir * @return string */ static function run($command) { diff --git a/sql/GenerateData.php b/sql/GenerateData.php index 4f71a05fe7..be420a2242 100644 --- a/sql/GenerateData.php +++ b/sql/GenerateData.php @@ -805,6 +805,8 @@ class CRM_GCD { * * @param $cid int: contact id * @param $masterContactId int: set if this is a shared address + * + * @return array */ private function _addAddress($cid, $masterContactId = NULL) { @@ -862,6 +864,8 @@ class CRM_GCD { * Add a phone number for a contact * * @param $cid int: contact id + * + * @return array */ private function _addPhone($cid) { $area = $this->probability(.5) ? '' : mt_rand(201, 899); @@ -882,6 +886,10 @@ class CRM_GCD { * Add an email for a contact * * @param $cid int: contact id + * @param $email + * @param $locationType + * + * @return array */ private function _addEmail($cid, $email, $locationType) { $params = array( @@ -899,6 +907,8 @@ class CRM_GCD { * * @param $cid int: contact id * @param $name str: contact name + * + * @return array */ private function _addWebsite($cid, $name) { $part = array_pad(split(' ', strtolower($name)), 3, ''); @@ -933,8 +943,11 @@ class CRM_GCD { /** * Create an email address based on a person's name * Using common naming patterns + * * @param $contact obj: individual contact record * @param $domain str: supply a domain (i.e. for a work address) + * + * @return string */ private function _individualEmail($contact, $domain = NULL) { $first = $contact->first_name; diff --git a/tests/phpunit/CiviTest/CiviMailUtils.php b/tests/phpunit/CiviTest/CiviMailUtils.php index d466ab1121..1d0cd8d05c 100644 --- a/tests/phpunit/CiviTest/CiviMailUtils.php +++ b/tests/phpunit/CiviTest/CiviMailUtils.php @@ -252,9 +252,12 @@ class CiviMailUtils extends PHPUnit_Framework_TestCase { /** * Check contents of mail log + * * @param array $strings strings that should be included * @param array $absentStrings strings that should not be included + * @param string $prefix * + * @return \ezcMail|string */ function checkMailLog($strings, $absentStrings = array(), $prefix = '') { $mail = $this->getMostRecentEmail('raw'); diff --git a/tests/phpunit/CiviTest/CiviUnitTestCase.php b/tests/phpunit/CiviTest/CiviUnitTestCase.php index 31e618722d..a93f34f8f2 100644 --- a/tests/phpunit/CiviTest/CiviUnitTestCase.php +++ b/tests/phpunit/CiviTest/CiviUnitTestCase.php @@ -727,6 +727,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * This function exists to wrap api functions * so we can ensure they succeed & throw exceptions without litterering the test with checks + * * @param string $entity * @param string $action * @param array $params @@ -734,6 +735,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * getcount, getsingle. Note that for getvalue the type is checked rather than the value * for getsingle the array is compared against an array passed in - the id is not compared (for * better or worse ) + * + * @return array|int */ function callAPISuccess($entity, $action, $params, $checkAgainst = NULL) { $params = array_merge(array( @@ -759,6 +762,7 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * This function exists to wrap api getValue function & check the result * so we can ensure they succeed & throw exceptions without litterering the test with checks * There is a type check in this + * * @param string $entity * @param array $params * @param string $type - per http://php.net/manual/en/function.gettype.php possible types @@ -768,6 +772,8 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { * - string * - array * - object + * + * @return array|int */ function callAPISuccessGetValue($entity, $params, $type = NULL) { $params += array( @@ -1223,7 +1229,9 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Add entity(s) to the tag * - * @param array $params + * @param array $params + * + * @return bool */ function entityTagAdd($params) { $result = $this->callAPISuccess('entity_tag', 'create', $params); @@ -1233,8 +1241,9 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to create contribution * - * @param int $cID contact_id - * @param int $cTypeID id of financial type + * @param int $cID contact_id + * + * @internal param int $cTypeID id of financial type * * @return int id of created contribution */ @@ -2072,8 +2081,10 @@ class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase { /** * Function to create custom field with Option Values * - * @param array $customGroup - * @param string $name name of custom field + * @param array $customGroup + * @param string $name name of custom field + * + * @return array|int */ function customFieldOptionValueCreate($customGroup, $name) { $fieldParams = array( -- 2.25.1