aiphee/related-content

RelatedContent plugin for CakePHP

, _(*1)

Related content plugin for CakePHP 3

, _(*2)

This is a fast made plugin made for simple maintaining of relationships., _(*3)

You can define that one entry in table has similar entries in other tables., _(*4)

It also has basic element with ajax which relies on Bootstrap 3., _(*5)

Please, be noted that this is not a complex plugin, there may be serious bugs, you are welcome to report or repair them., _(*6)

Installation

• Run migration from plugin or create table manually.

CREATE TABLE `related_contents` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `source_table_name` varchar(255) DEFAULT NULL COMMENT 'Table which you link from',
  `target_table_name` varchar(255) DEFAULT NULL COMMENT 'Table which you link to',
  `source_table_id` int(11) NOT NULL COMMENT 'ID of table you link from',
  `target_table_id` int(11) NOT NULL COMMENT 'ID of table you link to',
  `created` datetime NOT NULL,
  PRIMARY KEY (`id`)
)

• Copy repo content to plugins directory and add to your cakephp composer.json

    "autoload": {
        "psr-4": {
            "App\\": "src",
            "RelatedContent\\": "./plugins/RelatedContent/src",
        }
    }

or use packagist composer require aiphee/related-content, _(*7)

• Add to your bootstrap.php

Plugin::load('RelatedContent', ['routes' => true]);

Usage

• add first behavior to your table for it to be searchable (added to cache for search)

$this->addBehavior('RelatedContent.InRelatedIndex');

• add second behavior which will have Similar

$this->addBehavior('RelatedContent.HasRelated', isset($config['options']) ? $config['options'] : []);

• Add element to your view

<?= $this->element('RelatedContent.managingRelated', ['tables_to_get' => ['ContentNews', 'ContentPages']]) ?>

Parameter tables_to_get is optional, it will allow to search just in some tables., _(*8)

• To get related content with your entry, you have to pass parameter to find

$entity = $this->ContentPages->get($id, [
                'getRelated' => true
            ]);

• You can also use element in view, which model does not have HasRelated behavior, to populate some fields (target_table_name and target_table_id are directly in table)

<?= $this->element('RelatedContent.foreignTableSearch') ?>
<?= $this->Form->input('foreign_table_id', ['type' => 'hidden']) ?>
<?= $this->Form->input('foreign_table_name', ['type' => 'hidden']) ?>

It looks like this then:, _(*9)

, _(*10)