Download the PHP package heimrichhannot/contao-watchlist-bundle without Composer

On this page you can find all versions of the php package heimrichhannot/contao-watchlist-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of heimrichhannot/contao-watchlist-bundle

Informations about the package contao-watchlist-bundle

Contao Watchlist Bundle

This utility bundle offers a flexible watch list for the Contao CMS.

Features

Impressions

Watch list in frontend (here: bootstrap 5 template with modal integration)

Installation & configuration

  1. Run composer require heimrichhannot/contao-watchlist-bundle and update your database.
  2. Create a watch list config (select bootstrap 5 templates if applicable).
  3. Important: Assign the watch list config to your root page.
  4. Create a frontend module of type watchlist and add it to a layout area of your website so that it comes with each and every sub page. Select bootstrap 5 custom template if needed.
  5. Identify the template you'd like to integrate a link for adding this item to the watch list. Common situations are:
    1. ce_download.html5
    2. ce_downloads.html5
    3. news_full.html5
    4. ...
  6. Integrate the link for adding an item to the current watch list to any template by using inserttag or WatchlistLinkGenerator service.

Item types

A watch list in the context of this bundle can have multiple types of items:

  1. File: Any file in the contao file manager
  2. Entity: Any database record (aka "entity"), e.g. tl_news, tl_member -> downloads aren't possible at the moment

Sharing watch lists

  1. Do the steps mentioned in "Installation & configuration"
  2. Create a target page for shared watch lists.
  3. In your watch list config activate the sharing feature.

  4. Create the list module for the share page. You have 2 options:

    1. For simpler needs and file-only watch lists: Create a frontend module of the type "watchlist_share_list". This module fulfills simple needs. Image watch list items are downloadable, entity items are reachable by link.
    2. For more complex needs (like internal areas, filtering, ...): Create a list using heimrichhannot/contao-list-bundle and a reader using heimrichhannot/contao-reader-bundle.
      1. Activate the option actAsWatchlistShareTarget in the list and reader configs.
      2. Make sure, the detailsUrl in the list item template contains the watchlist GET parameter. For example, you could create a block for the detailsUrl, extend your default template and override the detailsUrl:
  5. Place the module created in the previous step on the page created in the second page.

Permission handling

A watch list is private to its owner. Who is the owner depends on the context, the watch list is used in:

Context Who is the watch list's owner?
Anonymous The current PHP session ID is used as the author
Frontend login available The current frontend user (member) is used as the author

Hint: As watch lists are currently not transferable from session to member, consider showing the watch list only after login. If you have no frontend login situation, you can ignore that, of course.

Insert tags

The following new insert tags are available. These take into account the translated jumpTo url and alias.

Name Example
{{watchlist_add_item_link::file::<file uuid (string)>::<optional: title>::<optional: watch list uuid>}} {{watchlist_add_item_link::file::2e6b6f54-e4af-11eb-b4fc-001e678385c6}}
{{watchlist_add_item_link::entity::<entity table>::<entity id>::<title>::<optional: entity url>::<optional: preview file uuid (string)>::<optional: watch list uuid>}} {{watchlist_add_item_link::entity::tl_news::1::My headline::https://example.org/my-entity::2e6b6f54-e4af-11eb-b4fc-001e678385c6}}

Developers

WatchlistLinkGenerator

Add the "Add to watchlist" button from your code:

Symfony Events

Event Description
WatchlistItemDataEvent Modify the watchlist item before output to the watchlist module.

JavaScript events

Event Description
huh_watchlist_list_updated Is dispatched after the watchlist content is updated.

All versions of contao-watchlist-bundle with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
ext-zip Version *
ext-json Version *
contao/core-bundle Version ^4.9
doctrine/dbal Version ^2.10 || ^3.0
heimrichhannot/contao-encore-contracts Version ^1.0
heimrichhannot/contao-utils-bundle Version ^2.199
heimrichhannot/contao-inserttagcollection-bundle Version ^1.1
heimrichhannot/contao-twig-support-bundle Version ^1.6
symfony/config Version ^4.4 || ^5.4
symfony/dependency-injection Version ^4.4 || ^5.4
symfony/event-dispatcher-contracts Version ^1.0 || ^2.0 || ^3.0
symfony/http-foundation Version ^4.4 || ^5.4
symfony/http-kernel Version ^4.4 || ^5.4
symfony/routing Version ^4.4 || ^5.4
symfony/translation-contracts Version ^1.0 || ^2.0 || ^3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package heimrichhannot/contao-watchlist-bundle contains the following files

Loading the files please wait ....