Lecteur Markdown
RECOMMEND_DOCUMENTATION_EN
Feature: Recommend #
Vote-based recommendation system. Displays a top 10 of the most recommended items. Votes are secured by MD5 hash to prevent URL manipulation.
---
Installation and Configuration #
Via FTP: Upload the `recommend/` directory into `/plugins/`.
Via package manager: Select `recommend` from the available plugins list.
Paths:
- Main plugin: `/plugins/recommend/recommend.php`
- Configuration: `/plugins/recommend/conf/recommend.conf.inc.php`
Required level: `RECOMMEND_LEVEL_USER`
Required SQL table: `recommend`
---
Usage #
Display #
Top 10 of the most recommended entries, sorted by descending vote count.
Voting #
A vote is triggered via a link containing:
- The entry name Base64-encoded
- A validation MD5 hash: `md5($cfg[17] . $entry)`
If the hash does not match, the vote is rejected.
Integration #
This plugin is intended to be embedded in other pages: a "Recommend this" link is generated with the appropriate encoding and hash.
---
Hooks and Entry Points #
?obj=recommend.php — Top 10
?obj=recommend.php&entry=BASE64&hash=MD5 — Vote for an entry
---
Dependencies #
- `Beamreactor\Database\SQL`
- `$cfg[17]` — secret key for validation hash generation