Download the PHP package texnixe/similar without Composer

On this page you can find all versions of the php package texnixe/similar. 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?

Informations about the package similar

GitHub release License Kirby 3 Pluginkit

Kirby Similar

Find related pages or files. Kirby 3 Similar is a Kirby CMS plugin that lets you find items related to the current item based on the similarity between fields. For each given field, the plugin calculates the Jaccard Index and then weighs all indices based on the factor for each field.

Example use case: The current page has a tags field with three values (red, green, blue). You want to find all sibling pages with a minimum Jaccard Index of 0.3 (which possible values between 0 and 1).

Commercial Usage

This plugin is free but if you use it in a commercial project please consider

How is it different from the Kirby 3 Related plugin

A quick example that describes the difference:

Example 1:

Page A: blue, green Page B: blue, green

Matches: 2 Jaccard Index: 2/2 = 1

Example 2:

Page A: blue, green, yellow Page B: blue, green

Matches: 2 Jaccard Index: 2/3 = 0.66666

While both pages have the same number of matches, the Jaccard Index is lower in the second example, because the number of unique tags is taken into account as well.

Installation

Download

Download the files and place them inside site/plugins/kirby-similar.

Git Submodule

You can add the plugin as a Git submodule.

$ cd your/project/root
$ git submodule add https://github.com/texnixe/kirby3-similar.git site/plugins/kirby-similar
$ git submodule update --init --recursive
$ git commit -am "Add Kirby Similar plugin"

Run these commands to update the plugin:

$ cd your/project/root
$ git submodule foreach git checkout master
$ git submodule foreach git pull
$ git commit -am "Update submodules"
$ git submodule update --init --recursive

Usage

Similar pages

Similar files

Options

You can pass an array of options:

index

The collection to search in. Default: $item->siblings(false) (The false argument excludes the current page from the collection)

fields

The name of the field to search in. Default: tags

Single field You can pass a single field as string:

Multiple fields

You can also pass multiple fields as array:

In this case, all fields get the same factor 1.

You can also pass an associative array with a factor for each field:

You might want to change the factor of individual fields when filtering collections to get better result. For example, assign a higher factor dynamically if the filter parameter is set to size:

delimiter

The delimiter that you use to separate values in a field Default: ,

threshold

The minimum Jaccard Index, i.e. a value between 0 (no similarity) and 1 (full similarity) Default: 0.1

languageFilter

Filter similar items by language in a multi-language installation. Default: false

License

Kirby 3 Similar is open-sourced software licensed under the MIT license.

Copyright © 2019 Sonja Broda [email protected] https://sonjabroda.com


All versions of similar with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0.0
getkirby/composer-installer Version ^1.1
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 texnixe/similar contains the following files

Loading the files please wait ....