Download the PHP package datlechin/flarum-references without Composer

On this page you can find all versions of the php package datlechin/flarum-references. 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 datlechin/flarum-references

Informations about the package flarum-references

References

A Flarum extension that tracks links between discussions. When a post links to another discussion, the linked discussion shows where it was linked from.

Features

What counts as a link

A link from one discussion to a different discussion. These are not recorded:

Linking the same target more than once in a post counts once.

Moderation

Open a discussion's moderation menu and choose Manage links. From there you can:

Installation

Requires Flarum 2.0 and PHP 8.2.

The backfill command records references in posts written before the extension was installed. Run it once.

Updating

Settings

Go to Admin → Extensions → References.

Setting Default Description
Record links On Turns recording on or off. Existing links are kept.
Record pasted links On Record links to other discussions and posts.
Record typed references On Record @"Title"#d12 references.
Record post mentions On Record mentions of posts in other discussions. Requires Mentions.
Links shown in the sidebar 4 How many links each sidebar list shows.
Announce new links in the discussion Off Adds an event post to the linked discussion.
Show related discussions On Shows related discussions in the sidebar.
Cache duration 300 Seconds to cache related discussions and the map. 0 disables caching.
Graph depth 2 How many steps the map follows.
Notify followers On Notify users following the linked discussion. Requires Subscriptions.
Keep broken references 365 Days to keep links to deleted content. 0 keeps them forever.

Permissions

Permission Default Allows
Create and edit references Moderators Adding, editing and removing links.
See broken references Moderators The broken references report.
See reference analytics Admins The analytics report and CSV export.

Notifications

Users can turn each type on or off in their notification settings.

Post mentions are announced by Mentions, so the post author is not notified twice.

Commands

Command Description
references:backfill Records references in existing posts. Use --from-id to resume.
references:reconcile Recalculates the reference counts. Runs daily.
references:build-daily-rollup Builds the analytics data. Runs daily.
references:purge-broken Deletes broken references older than the retention period. Runs daily.

Daily commands run through Flarum's scheduler (php flarum schedule:run).

For developers

Register a new reference target, such as a wiki page:

WikiPageTarget implements Datlechin\References\Contract\ReferenceTarget. Its query() method must apply whereVisibleTo($actor), otherwise reference counts can include items the user cannot see.

Links

All versions of flarum-references with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
flarum/core Version ^2.0.0-rc.7
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 datlechin/flarum-references contains the following files

Loading the files please wait ...