heimrichhannot/contao-newsalert

A contao module to subscribe to news topics

Contao Newsalert Module

, _(*1)

Contao 3 backport from Contao Newsalert Bundle, _(*2)

A contao module, to let website visitor subscribe to a news topic., _(*3)

The module comes with an interface to add custom news topic, for example categories, tags, authors., _(*4)

Features

• subscribe form module
• add custom topic sources
• send notifications to user subscribed to topics with notification center
• use contao cron to trigger send
• security features
  • captcha in form field
  • opt-in process after subscribe
  • token secured opt-out links
• dublicate entry check
  • when dublicate entry is not confirmed, resend activation link instead of showing error message
• archive informations about sent messages
• bundled topic source for news archives

Requirements

• Contao 3.5
• PHP >= 7.0
• Contao Notification Center
• Formhybrid

Installation

Install via composer, _(*5)

composer require heimrichhannot/contao-newsalert

Afterwards call the Contao install procedure to update the database., _(*6)

Setup

• add topic sources
• set up notification center notifications
  • hh_newsalert for newsalert messages
  • formhybrid-opt-in for opt-in mails
• add frontend registration module and configure it
• activate newsalert in news archive you want newsalert for

Cronjob

For performance reasons, we insist on disabling the "Command-Scheduler" in Settings (enable tl_settings.disableCron) and run the cron jobs by a dedicated cronjob within your servers crontab., _(*7)

Contao 3:, _(*8)

* * * * * wget -O /dev/null -q https://[DOMAIN-NAME]/system/cron/cron.php --no-check-certificate

Usage

The module adds a checkbox to news archive to activate (or deactivate) newsalert for archives. It also add a checkbox to the news articles form to set (or unset) an article sent (by setting unsent newsalert will be triggered again for said article)., _(*9)

The overview about sent messages is placed within the news archive section (News -> Newsalert). The management of the receivers is found withing the newsalert section (News -> Newsalert -> Newsalert receivers), _(*10)

Developers

Add topic source

To add a topic source, your topics class needs to implement the NewsTopicInterface and has to be registered within $GLOBALS['HUH_NEWSALERT']['TOPIC_SOURCE']., _(*11)

Example:, _(*12)

$GLOBALS['HUH_NEWSALERT']['TOPIC_SOURCE']['newsarchives'] = \HeimrichHannot\ContaoNewsAlertBundle\Components\NewsArchiveTopics::class;

Notification center tokens

ContaoNewsalert uses Notification Center for e-mail sending. Following tokens are added to news_posted type (in addition to the default ones):, _(*13)

huh_newsalert_topic_recipient## | Emailaddress of the subscriber

huh_newsalert_news_headline## | Title of the news for which newsalert is triggered

huh_newsalert_news_subheadline## | SUbheadline of the news for which newsalert is triggered

huh_newsalert_news_teaser## | Teaser text of the news article

huh_newsalert_news_content## | Article content

huh_newsalert_news_url## | Relative url to the article

huh_newsalert_recipient_topics## | The intersection of news topics and subscribed topics of the receiver

huh_newsalert_recipient_topic_count##| The the number of topics from ##hh_newsalert_recipient_topics

huh_newsalert_opt_out_html## | A list of all recipients topics and the corresponding unsubscribe links in html format (Topic: Link)

huh_newsalert_opt_out_text## | Same list as above, but textonly

huh_newsalert_year## | The current year

huh_newsalert_root_url## | Root url

Hooks

Frontend autocompletion

We recommend Chosen to add a search field to the topic select element. It's already used by Contao in the backend., _(*14)