Merge pull request #23925 from seamuslee001/type_hints_2
[civicrm-core.git] / release-notes / 5.6.0.md
index 63122d54e22f332d304d8658a7c70ec10f507bba..9ee222620c12afabd1dfa1b6e48f84c72c884bbf 100644 (file)
@@ -95,8 +95,6 @@ Released October 3, 2018
   This change Bumps the recommended php version to 7.1 and min recommended to
   7.0
 
-### CiviReport
-
 - **Add SQL modes to developer tab
   ([12656](https://github.com/civicrm/civicrm-core/pull/12656))**
 
@@ -115,13 +113,13 @@ Released October 3, 2018
   groups. Prior to this change one could onlt filter this report by static
   groups.
 
-### CiviMember
+### CiviCase
 
-- **Enable custom data display on MembershipType form
-  ([12738](https://github.com/civicrm/civicrm-core/pull/12738))**
+- **Make contact name into a link on Manage Case for single client
+  ([12619](https://github.com/civicrm/civicrm-core/pull/12619))**
 
-  This makes it so if Membership Type custom fields are configured they are
-  displayed on the Membership Type form.
+  On the Manage Case page for a single client, this change makes the contact
+  name linked to that contact's summary page.
 
 ### CiviContribute
 
@@ -138,6 +136,14 @@ Released October 3, 2018
   domain_id optional and setting it to use the current domain as the default if
   a domain_id is not sent.
 
+### CiviMember
+
+- **Enable custom data display on MembershipType form
+  ([12738](https://github.com/civicrm/civicrm-core/pull/12738))**
+
+  This makes it so if Membership Type custom fields are configured they are
+  displayed on the Membership Type form.
+
 ### Drupal Integration
 
 - **[dev/core#237](https://lab.civicrm.org/dev/core/issues/237) Hide Drupal8
@@ -152,219 +158,8 @@ Released October 3, 2018
   This change makes it so in Drupal Views one can configure a relationship
   between CiviCRM Events and CiviCRM Participants.
 
-### CiviCase
-
-- **Make contact name into a link on Manage Case for single client
-  ([12619](https://github.com/civicrm/civicrm-core/pull/12619))**
-
-  On the Manage Case page for a single client, this change makes the contact
-  name linked to that contact's summary page.
-
 ## <a name="bugs"></a>Bugs resolved
 
-### CiviCase
-
-- **[dev/core#297](https://lab.civicrm.org/dev/core/issues/297) permission
-  "access my cases and activities" is broken by CRM-21461
-  ([12613](https://github.com/civicrm/civicrm-core/pull/12613))**
-
-  This change fixes the permission "access my cases and activites".
-
-- **[dev/core#361](https://lab.civicrm.org/dev/core/issues/361) Mistake in Case
-  api spec description
-  ([12726](https://github.com/civicrm/civicrm-core/pull/12726))**
-
-  This changes the text in the API Explorer for the entity Case for the
-  parameter Tags to read "Find cases with specified tags." before this change it
-  read "Find activities with specified tags.".
-
-- **[dev/core#245](https://lab.civicrm.org/dev/core/issues/245) Duplicate
-  activities shown on case tab
-  ([12444](https://github.com/civicrm/civicrm-core/pull/12444))**
-
-  This change fixes a bug where If there were multiple assignee/target contacts on
-  an activity, the activities were being duplicated on the case activities tab.
-  Additionally this change fixes a bug where if the activity is only allowed a
-  single instance and the user tried to add another, the link had an invalid
-  activity Id.
-
-- **Don't duplicate activity when filing on case
-  ([12620](https://github.com/civicrm/civicrm-core/pull/12620))**
-
-  This change fixes a bug where filing an activity on a case using the "File On
-  Case" link on the actvitytab/activity detail view  would result in two
-  activities one related to the case and one not.
-
-### CiviMember
-
-- **BASW-240: 'Network Error' when creating membership type from contact
-  membership tab ([12700](https://github.com/civicrm/civicrm-core/pull/12700))**
-
-  This Change fixes a Network Error that was appearing when creating a membership
-  type from a contacts membership tab.
-
-### CiviEvent
-
-- **Fix Undefined index: params in CRM_Event_BAO_Event::buildCustomProfile()
-  ([12678](https://github.com/civicrm/civicrm-core/pull/12678))**
-
-  This change suppresses an undefined index notice that was showing when one
-  comes to an Event from an online payment provider.
-
-- **[dev/core#344](https://lab.civicrm.org/dev/core/issues/344) Tell a Friend
-  mail does not include event title
-  ([12699](https://github.com/civicrm/civicrm-core/pull/12699))**
-
-  This fixes a bug where when using the Tell-A-Friend option to send an email
-  the title of the event was appearing in the subject of the email, so that the
-  title of the event does appear in the subject of the email.
-
-- **Ensure users with the perm "CiviEvent: access CiviEvent " can edit events
-  they have created.
-  ([12424](https://github.com/civicrm/civicrm-core/pull/12424))**
-
-  This change fixes a bug where users with the permission "CiviEvent: access
-  CiviEvent" could create but not edit their events so that they can create and
-  edit their events.
-
-- **GL-44 admin price field options on event info page
-  ([11923](https://github.com/civicrm/civicrm-core/pull/11923))**
-
-  This change ensures that on event info pages price set field options with the
-  visibility "admin" are only shown to admins.
-
-### CiviReport
-
-- **[dev/core#325](https://lab.civicrm.org/dev/core/issues/325) Fatal error 'DB Error: no
-  such field' on Contribution detail report
-  ([12660](https://github.com/civicrm/civicrm-core/pull/12660))**
-
-  This change fixes a bug where on the Contribution Detail report, selecting the
-  "Age" column would result in a fatal error so that the report includes Age as
-  expected.
-
-- **Fix ReportInstance BAO to call post hook after save (instead of calling pre
-  twice). ([12722](https://github.com/civicrm/civicrm-core/pull/12722))**
-
-  This change improves the hook functionality in the ReportInstance BAO so that
-  one can call post hook after save and so that the pre hook is only called
-  once.
-
-- **[dev/core#341](https://lab.civicrm.org/dev/core/issues/341) "Contributions
-  made in Year X and not Year Y" custom search ignores date field
-  ([12686](https://github.com/civicrm/civicrm-core/pull/12686))**
-
-  This fixes a bug where custom searches using the "Contributions made in Year X
-  and not Year Y" were not respecting the date parameters, so that date
-  parameters are respected.
-
-- **[dev/core#327](https://lab.civicrm.org/dev/core/issues/327) PHP Fatal error:
-  Call to undefined method - Contribution Details report
-  ([12661](https://github.com/civicrm/civicrm-core/pull/12661))**
-
-  This fixes a bug where checking the Gender column field on the Contribution
-  Details report resulted in a fatal error so that one can include a gender
-  column in this report.
-
-### CiviMail
-
-- **[dev/mail#20](https://lab.civicrm.org/dev/mail/issues/20) Preview screen
-  don't open until recipients list is built on mail compose screen
-  ([12509](https://github.com/civicrm/civicrm-core/pull/12509))**
-
-  This change fixes a bug where when drafting a mailing one could not open the
-  preview mailing screen until the recipient count query had completed.
-
-- **[dev/core#352](https://lab.civicrm.org/dev/core/issues/352) Ensure that when
-  adding recipients of previous mailings that contacts who are being excluded
-  are removed ([12712](https://github.com/civicrm/civicrm-core/pull/12712))**
-
-  This change makes sure when using recipients from a previous mailing as the
-  recipients of a mailing That any exclusions are respected.
-
-- **[dev/mail#21](https://lab.civicrm.org/dev/mail/issues/21) send test email
-  may create duplicate contacts
-  ([12599](https://github.com/civicrm/civicrm-core/pull/12599))**
-
-  This change fixes a bug where sending a test email to two contacts seperated
-  by a space and a comma would sometimes result in a duplicate contact being
-  created.
-
-- **pass mailingJobId to hook_tokenValues
-  ([12026](https://github.com/civicrm/civicrm-core/pull/12026))**
-
-  This change ensures the mailingJobId is sent to hook_tokenValues.
-
-### CiviContribute
-
-- **[dev/core#299](https://lab.civicrm.org/dev/core/issues/299) Decimal point
-  error. ([12684](https://github.com/civicrm/civicrm-core/pull/12684))
-  (Continuation of work)**
-
-  This change localizes the display of the amount on the update payment details
-  form.
-
-- **[dev/core#334](https://lab.civicrm.org/dev/core/issues/334) Public
-  contribution form and Checksums: billing information not loaded if using
-  multiple processors
-  ([12679](https://github.com/civicrm/civicrm-core/pull/12679))**
-
-  This fixes a bug where when a user goes to a contribution page that is
-  configured to use multiple payment processors via a checksum link the billing
-  address section was not pre-populating so that the billing section does
-  pre-populate.
-
-- **[dev/core#119](https://lab.civicrm.org/dev/core/issues/119) Notice error
-  ([12626](https://github.com/civicrm/civicrm-core/pull/12626))**
-
-  When recording a payment on a site that is configured not to use decimal
-  thousand separators, that configuration was not being respected for the
-  default amount. This change fixes the default amount to be localized
-  appropriately.
-
-- **[dev/core#322](https://lab.civicrm.org/dev/core/issues/322) Contribution
-  page, completing this form on behalf of someone else: JavaScript error for
-  checkbox field ([12652](https://github.com/civicrm/civicrm-core/pull/12652))**
-
-  This fixes a bug on contribution pages configured to accept donations onbehalf
-  of someone else and to include a profile with a checkbox where checking the
-  checkbox in the profile would result in a javascript error, additionally it
-  ensures that the form is  populated with the onbehalf of contact's data.
-
-- **Use cached version of payment processor.
-  ([12627](https://github.com/civicrm/civicrm-core/pull/12627))**
-
-  This change fixes a bug where some payment processors when combined with Redis
-  were failing to complete transactions because Redis was caching the call to
-  completetransaction.
-
-### Joomla Integration
-
-- **[dev/joomla#2](https://lab.civicrm.org/dev/joomla/issues/2) Joomla
-  cron.php/cli.php fail on Windows server
-  ([12692](https://github.com/civicrm/civicrm-core/pull/12692))**
-
-  This fixes a bug where on Joomla sites on Windows cron was failing so that
-  cron works for Joomla stes on Windows.
-
-- **Make sure Joomla timezone is set for cron jobs
-  ([12609](https://github.com/civicrm/civicrm-core/pull/12609))**
-
-  This change ensures that the CRON job is executed using the same timezone as
-  Joomla (and the same timezone that is configured for Joomla/CiviCRM/database
-  when running via web). Prior to this change the CRON job was being executed
-  with timezone set to UTC.
-
-### Drupal Integration
-
-- **[dev/core#311](https://lab.civicrm.org/dev/core/issues/311) Upgrading
-  multilingual site causes DB Error
-  ([12636](https://github.com/civicrm/civicrm-core/pull/12636))**
-
-  This change fixes a bug where upgrading a multilingual drupal site from
-  CiviCRM 4.4.7 to 5.4.0 causes a DB error so that one can upgrade a
-  multilingual drupal site without a DB error.
-
 ### Core CiviCRM
 
 - **Handle smart groups created in previous Civis which include
@@ -489,6 +284,211 @@ Released October 3, 2018
   This change improves performance when searching on email_greeting,
   postal_greeting, address.
 
+- **Fix ReportInstance BAO to call post hook after save (instead of calling pre
+  twice). ([12722](https://github.com/civicrm/civicrm-core/pull/12722))**
+
+  This change improves the hook functionality in the ReportInstance BAO so that
+  one can call post hook after save and so that the pre hook is only called
+  once.
+
+### CiviCase
+
+- **[dev/core#297](https://lab.civicrm.org/dev/core/issues/297) permission
+  "access my cases and activities" is broken by CRM-21461
+  ([12613](https://github.com/civicrm/civicrm-core/pull/12613))**
+
+  This change fixes the permission "access my cases and activites".
+
+- **[dev/core#361](https://lab.civicrm.org/dev/core/issues/361) Mistake in Case
+  api spec description
+  ([12726](https://github.com/civicrm/civicrm-core/pull/12726))**
+
+  This changes the text in the API Explorer for the entity Case for the
+  parameter Tags to read "Find cases with specified tags." before this change it
+  read "Find activities with specified tags.".
+
+- **[dev/core#245](https://lab.civicrm.org/dev/core/issues/245) Duplicate
+  activities shown on case tab
+  ([12444](https://github.com/civicrm/civicrm-core/pull/12444))**
+
+  This change fixes a bug where If there were multiple assignee/target contacts on
+  an activity, the activities were being duplicated on the case activities tab.
+  Additionally this change fixes a bug where if the activity is only allowed a
+  single instance and the user tried to add another, the link had an invalid
+  activity Id.
+
+- **Don't duplicate activity when filing on case
+  ([12620](https://github.com/civicrm/civicrm-core/pull/12620))**
+
+  This change fixes a bug where filing an activity on a case using the "File On
+  Case" link on the actvitytab/activity detail view  would result in two
+  activities one related to the case and one not.
+
+### CiviContribute
+
+- **[dev/core#299](https://lab.civicrm.org/dev/core/issues/299) Decimal point
+  error. ([12684](https://github.com/civicrm/civicrm-core/pull/12684))
+  (Continuation of work)**
+
+  This change localizes the display of the amount on the update payment details
+  form.
+
+- **[dev/core#334](https://lab.civicrm.org/dev/core/issues/334) Public
+  contribution form and Checksums: billing information not loaded if using
+  multiple processors
+  ([12679](https://github.com/civicrm/civicrm-core/pull/12679))**
+
+  This fixes a bug where when a user goes to a contribution page that is
+  configured to use multiple payment processors via a checksum link the billing
+  address section was not pre-populating so that the billing section does
+  pre-populate.
+
+- **[dev/core#119](https://lab.civicrm.org/dev/core/issues/119) Notice error
+  ([12626](https://github.com/civicrm/civicrm-core/pull/12626))**
+
+  When recording a payment on a site that is configured not to use decimal
+  thousand separators, that configuration was not being respected for the
+  default amount. This change fixes the default amount to be localized
+  appropriately.
+
+- **[dev/core#322](https://lab.civicrm.org/dev/core/issues/322) Contribution
+  page, completing this form on behalf of someone else: JavaScript error for
+  checkbox field ([12652](https://github.com/civicrm/civicrm-core/pull/12652))**
+
+  This fixes a bug on contribution pages configured to accept donations onbehalf
+  of someone else and to include a profile with a checkbox where checking the
+  checkbox in the profile would result in a javascript error, additionally it
+  ensures that the form is  populated with the onbehalf of contact's data.
+
+- **Use cached version of payment processor.
+  ([12627](https://github.com/civicrm/civicrm-core/pull/12627))**
+
+  This change fixes a bug where some payment processors when combined with Redis
+  were failing to complete transactions because Redis was caching the call to
+  completetransaction.
+
+- **[dev/core#325](https://lab.civicrm.org/dev/core/issues/325) Fatal error 'DB Error: no
+  such field' on Contribution detail report
+  ([12660](https://github.com/civicrm/civicrm-core/pull/12660))**
+
+  This change fixes a bug where on the Contribution Detail report, selecting the
+  "Age" column would result in a fatal error so that the report includes Age as
+  expected.
+
+- **[dev/core#386](https://lab.civicrm.org/dev/core/issues/386)
+  Contribution Detail Report shows no amount if set to Soft Credit Only
+  ([12860](https://github.com/civicrm/civicrm-core/pull/12860))**
+
+- **[dev/core#341](https://lab.civicrm.org/dev/core/issues/341) "Contributions
+  made in Year X and not Year Y" custom search ignores date field
+  ([12686](https://github.com/civicrm/civicrm-core/pull/12686))**
+
+  This fixes a bug where custom searches using the "Contributions made in Year X
+  and not Year Y" were not respecting the date parameters, so that date
+  parameters are respected.
+
+- **[dev/core#327](https://lab.civicrm.org/dev/core/issues/327) PHP Fatal error:
+  Call to undefined method - Contribution Details report
+  ([12661](https://github.com/civicrm/civicrm-core/pull/12661))**
+
+  This fixes a bug where checking the Gender column field on the Contribution
+  Details report resulted in a fatal error so that one can include a gender
+  column in this report.
+
+### CiviEvent
+
+- **Fix Undefined index: params in CRM_Event_BAO_Event::buildCustomProfile()
+  ([12678](https://github.com/civicrm/civicrm-core/pull/12678))**
+
+  This change suppresses an undefined index notice that was showing when one
+  comes to an Event from an online payment provider.
+
+- **[dev/core#344](https://lab.civicrm.org/dev/core/issues/344) Tell a Friend
+  mail does not include event title
+  ([12699](https://github.com/civicrm/civicrm-core/pull/12699))**
+
+  This fixes a bug where when using the Tell-A-Friend option to send an email
+  the title of the event was appearing in the subject of the email, so that the
+  title of the event does appear in the subject of the email.
+
+- **Ensure users with the perm "CiviEvent: access CiviEvent " can edit events
+  they have created.
+  ([12424](https://github.com/civicrm/civicrm-core/pull/12424))**
+
+  This change fixes a bug where users with the permission "CiviEvent: access
+  CiviEvent" could create but not edit their events so that they can create and
+  edit their events.
+
+- **GL-44 Admin price field options on event info page
+  ([11923](https://github.com/civicrm/civicrm-core/pull/11923))**
+
+  This change ensures that on event info pages price set field options with the
+  visibility "admin" are only shown to admins.
+
+### CiviMail
+
+- **[dev/mail#20](https://lab.civicrm.org/dev/mail/issues/20) Preview screen
+  don't open until recipients list is built on mail compose screen
+  ([12509](https://github.com/civicrm/civicrm-core/pull/12509))**
+
+  This change fixes a bug where when drafting a mailing one could not open the
+  preview mailing screen until the recipient count query had completed.
+
+- **[dev/core#352](https://lab.civicrm.org/dev/core/issues/352) Ensure that when
+  adding recipients of previous mailings that contacts who are being excluded
+  are removed ([12712](https://github.com/civicrm/civicrm-core/pull/12712))**
+
+  This change makes sure when using recipients from a previous mailing as the
+  recipients of a mailing That any exclusions are respected.
+
+- **[dev/mail#21](https://lab.civicrm.org/dev/mail/issues/21) "Send test email"
+  may create duplicate contacts
+  ([12599](https://github.com/civicrm/civicrm-core/pull/12599))**
+
+  This change fixes a bug where sending a test email to two contacts seperated
+  by a space and a comma would sometimes result in a duplicate contact being
+  created.
+
+- **pass mailingJobId to hook_tokenValues
+  ([12026](https://github.com/civicrm/civicrm-core/pull/12026))**
+
+  This change ensures the mailingJobId is sent to hook_tokenValues.
+
+### CiviMember
+
+- **BASW-240: 'Network Error' when creating membership type from contact
+  membership tab ([12700](https://github.com/civicrm/civicrm-core/pull/12700))**
+
+  This Change fixes a Network Error that was appearing when creating a membership
+  type from a contacts membership tab.
+
+### Drupal Integration
+
+- **[dev/core#311](https://lab.civicrm.org/dev/core/issues/311) Upgrading
+  multilingual site causes DB Error
+  ([12636](https://github.com/civicrm/civicrm-core/pull/12636))**
+
+  This change fixes a bug where upgrading a multilingual drupal site from
+  CiviCRM 4.4.7 to 5.4.0 causes a DB error so that one can upgrade a
+  multilingual drupal site without a DB error.
+
+### Joomla Integration
+
+- **[dev/joomla#2](https://lab.civicrm.org/dev/joomla/issues/2) Joomla
+  cron.php/cli.php fail on Windows server
+  ([12692](https://github.com/civicrm/civicrm-core/pull/12692))**
+
+  This fixes a bug where on Joomla sites on Windows cron was failing so that
+  cron works for Joomla stes on Windows.
+
+- **Make sure Joomla timezone is set for cron jobs
+  ([12609](https://github.com/civicrm/civicrm-core/pull/12609))**
+
+  This change ensures that the CRON job is executed using the same timezone as
+  Joomla (and the same timezone that is configured for Joomla/CiviCRM/database
+  when running via web). Prior to this change the CRON job was being executed
+  with timezone set to UTC.
+
 ## <a name="misc"></a>Miscellany
 
 - **Stop passing imProviders & phoneTypes - use CRM_Core_PseudoConstant:getLabel
@@ -564,15 +564,28 @@ Released October 3, 2018
 
 This release was developed by the following code authors:
 
-AGH Strategies - Alice Frumin, Andrew Hunt; Andrew Thompson; Australian Greens - Seamus Lee; calbasi; Chris Burgess; chriscant; Circle Interactive - Dave Jenkins; CiviCoop - Klaas Eikelboom; CiviCRM - Coleman Watts, Tim Otten; CiviDesk - Yashodha Chaku; CiviFirst - John Kirk; CompuCorp - Vinu Varshith Sekar; Coop SymbioTIC - Mathieu Lutfy; Fuzion - Jitendra Purohit; JMA Consulting - Monish Deb; John Kingsnorth; Joinery - Allen Shaw; kewljuice; Lemniscus - Noah Miller; Lighthouse Design and Consulting - Brian Shaughnessy; Megaphone Technology Consulting - Jon Goldberg; MillerTech - Chamil Wijesooriya; MJW Consulting - Matthew Wire; Pradeep Nayak; Progressive Technology Project - Jamie McClelland; Richard van Oosterhout; selwyntcy; Semper IT - Karin Gerritsen; Third Sector Design - Michael McAndrew; Wikimedia Foundation - Eileen McNaughton
+AGH Strategies - Alice Frumin, Andie Hunt; Andrew Thompson; Australian Greens -
+Seamus Lee; Calbasi - Joan Cervan Andreu; Calibrate - Wouter Hechtermans; Chris
+Burgess; Circle Interactive - Dave Jenkins; CiviCoop - Klaas Eikelboom; CiviCRM -
+Coleman Watts, Tim Otten; CiviDesk - Yashodha Chaku; CiviFirst - John Kirk;
+CompuCorp - Vinu Varshith Sekar; Coop SymbioTIC - Mathieu Lutfy; Fuzion -
+Jitendra Purohit; JMA Consulting - Monish Deb; John Kingsnorth; Joinery - Allen
+Shaw; Lemniscus - Noah Miller; Lighthouse Design and Consulting - Brian
+Shaughnessy; Megaphone Technology Consulting - Jon Goldberg; MillerTech - Chamil
+Wijesooriya; MJW Consulting - Matthew Wire; PHD Computer Consultants - Chris
+Cant; Pradeep Nayak; Progressive Technology Project - Jamie McClelland; Richard
+van Oosterhout; Selwyn Tang; Semper IT - Karin Gerritsen; Third Sector Design -
+Michael McAndrew; Wikimedia Foundation - Eileen McNaughton
 
 Most authors also reviewed code for this release; in addition, the following
 reviewers contributed their comments:
 
-AGH Strategies - Alice Frumin; Agileware - Justin Freeman; Andrew Thompson; Australian Greens - Seamus Lee; calbasi; Circle Interactive - Dave Jenkins; civibot[bot]; civicrm-builder; CiviCRM - Coleman Watts, Tim Otten; CiviDesk - Yashodha Chaku; CiviFirst - John Kirk; Coop SymbioTIC - Mathieu Lutfy; Fuzion - Jitendra Purohit, Peter Davis; JMA Consulting - Joe Murray, Monish Deb; Joinery - Allen Shaw; Lighthouse Design and Consulting - Brian Shaughnessy; Megaphone Technology Consulting - Jon Goldberg; MillerTech - Chamil Wijesooriya; MJW Consulting - Matthew Wire; Oxfam Germany - Thomas Schüttler; Pradeep Nayak; Richard van Oosterhout; Semper IT - Karin Gerritsen; sleewok; Squiffle Consulting - Aidan Saunders; Third Sector Design - Michael McAndrew; Wikimedia Foundation - Eileen McNaughton
+Agileware - Justin Freeman; Fuzion - Peter Davis; JMA Consulting - Joe Murray;
+MillerTech - Chamil Wijesooriya; Oxfam Germany - Thomas Schüttler; sleewok;
+Squiffle Consulting - Aidan Saunders
 
 ## <a name="feedback"></a>Feedback
 
-These release notes are edited by Alice Frumin and Andrew Hunt.  If you'd like
+These release notes are edited by Alice Frumin and Andie Hunt.  If you'd like
 to provide feedback on them, please log in to https://chat.civicrm.org/civicrm
 and contact `@agh1`.