Download the PHP package ymcatwincities/openy_activity_finder without Composer
On this page you can find all versions of the php package ymcatwincities/openy_activity_finder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ymcatwincities/openy_activity_finder
More information about ymcatwincities/openy_activity_finder
Files in ymcatwincities/openy_activity_finder
Package openy_activity_finder
Short Description Open Y Activity Finder
License GPL-2.0+
Informations about the package openy_activity_finder
Open Y Activity Finder
Versions
There is currently 1 major version: 4. Open Y distribution prior 9.2.10.0 had
^3.1 || ^4.0
version constraint allowing you to choose which version you want
to use depending on the project requirements.
Deprecations
Outdated implementations are not removed immediately allowing you to update
your projects and migrate to new components without breaking your site pages.
They are marked with [deprecated]
notices in the next version and planned to
be removed in the future releases.
New projects
All the new projects should get the latest available Open Y Activity Finder release.
Existing projects
You have a choice of either staying on the same version you use or to update to the next version. It depends on your project requirements and customizations. We recommend updating to the latest release if you have resources for it.
Update from version 3.x to version 4.x
Activity Finder is a complex functionality, it connects together many different pieces and might require additional steps to make it working. The list of actions below outlines the major steps to get Activity Finder updated to version 4.
- Update the codebase using composer command:
composer require ymcatwincities/openy_activity_finder:"^4.0"
- Run database updates
drush -y updb
- Verify there were no errors and updates went fine
- Install the new "Open Y Paragraph Activity Finder" module,
Machine name:
openy_prgf_activity_finder_4
:drush en openy_prgf_activity_finder_4
- Create new or update existing Landing Page with Activity Finder
- Add Activity Finder paragraph (replace the deprecated paragraph), configure
it and save the page
- Verify the page and Activity Finder functionality is working fine
- The previous version of Activity Finder used 2 landing pages with 2 paragraph types - one for wizard and another one for results - find and remove these pages
- Uninstall "OpenY Paragraph Activity Finder" module,
Machine name:
openy_prgf_activity_finder
- Uninstall "OpenY Paragraph Activity Finder Search" module,
Machine name:
openy_paragraph_activity_finder_search
Activity Finder block options
Title
A text field to display text that will displaying on top banner of the AF block
Limit by category
A reference field where you can select the categories to limit results by these categories
Exclude by category
A reference field where you can select the categories for which you don't want to display results
Legacy mode
A special mode for show some data as on previous version of AF.
What it provides:
- disables a bookmark functionality on the results screen
- doesn't display an age indicator in result card of activity
- changes the days + times wizard step. We can display only days of week, but not times of each day (doesn't support DaysTimes filter)
Hide Home Branch info block
- You can just hide block that related to Home Branch functionality (link to result for Home branch and count of results for this branch)
Background image
- An image field to upload the image for background of top banner of AF block
Limitations with using Daxko backend
- We can't use home branch functionality on start screen
- We have to use Legacy mode
- We can't display count of result for each age on the age's wizard step
- We can't display count of available spots for each activity, before user click by activity details
- Limited pager on results page. We can display only previous and next page link. And can't display count of pages
Trusted redirect host patterns
Activity Finder has a feature to track redirects to 3rd party systems. In order to control the URLs to redirect to you should use the trusted host patterns. This feature works similar to Drupal core trusted_host_patterns setting.
Example - add this section to the settings.php:
It is also recommended to disallow these paths in robots.txt:
Development
How to override processResults in Activity Finder
See openy_activity_finder.api.php
How to add external functionality to analytics event
See openy_af4_vue_app/main.js
Example of custom event
Add custom component in between of results
it allows flexibility in terms of results rendering for the developer:
can be changed to this:
where YGBWAds is custom component to render custom content in between the results. See https://github.com/ymcatwincities/openy_activity_finder/pull/148