Download the PHP package visionbites/usage-reference without Composer
On this page you can find all versions of the php package visionbites/usage-reference. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download visionbites/usage-reference
More information about visionbites/usage-reference
Files in visionbites/usage-reference
Package usage-reference
Short Description Show references to a page or file on the objects blueprint.
License MIT
Informations about the package usage-reference
Kirby usage reference plugin
Infosection to display all references to a page or image in a list.
Install
Download Zip file
Copy plugin folder into site/plugins
Git submodule
Composer
Usage
Add a section usageReference
to your blueprint to show references to the current page.
Add a template
key to define the type of pages you are looking for.
Example
Basic setup:
Setup for files:
Options
there are only two options at the moment:
Option | Default | Description |
---|---|---|
expire |
15 |
the cache will expire after n minutes. Minimum is 1 as a indefinite cache makes no sense |
cache |
true |
if set to false will disable the caching of references |
set the options in config.php
:
please keep in mind that this might lead to showing out of date data to the editor if there was another reference added.
Usage in plugins, models and other places
you can use the ReferenceService
that is provided in other places to access the data that is presented in the panel.
E.g. if you have events attached to a place that are not children of the place itself you can
have a events()
method in the PlacePage
model:
todos
- [ ] clear cache for a page on update of a referencing page
- [ ] make it pick up on text links
License
It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia animal abuse, violence or any other form of hate speech.