https://github.com/texnixe/kirby-relatedpages

RelatedPages Plugin for Kirby CMS
https://github.com/texnixe/kirby-relatedpages

Last synced: about 2 months ago
JSON representation

RelatedPages Plugin for Kirby CMS

• Host: GitHub
• URL: https://github.com/texnixe/kirby-relatedpages
• Owner: texnixe
• License: mit
• Created: 2014-09-10T05:25:53.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-09-09T21:39:00.000Z (over 10 years ago)
• Last Synced: 2023-08-07T04:38:32.565Z (over 1 year ago)
• Size: 57.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Kirby-RelatedPages

==================

## RelatedPages Plugin for Kirby CMS

The RelatedPages plugin provides an easy, but flexible way of incorporating links (or other data) of related pages to the current page. The relationsship is considered by keywords in an arbitrary field of the content files. Example: If you provide the field 'Tags' in your content file which is rendered together with the RelatedPages plugin, all pages in your site will be searched for any of the *tags* (seperated by comma) in the field 'Tags'.

### Installation

Kirby 1: Save the file `RelatedPages.php.V1` as `RelatedPages.php` into the plugins folder of Kirby 1.

Kirby 2: Save the file `RelatedPages.php.V2` as `RelatedPages.php` into the plugins folder of Kirby 2.

### Basic usage

```php

Pages() as $UID => $Page) {

  echo $Page->title();

}

?>

```

### Methods

- `$MyRelatedPages->Pages()` outputs an array with all related pages. The key of the array is the uid of the related page and the value is the kirby page object.

- `$MyRelatedPages->Count()` outputs an integer with the number of related pages found.

- `$MyRelatedPages->Options()` outputs the options array (see next) in a readable way.

**Note**: If you use the object as string, you will get an array of uids of the pages found in a readable way. Example: ``

### Options

You can control which pages are searched for and which pages are found by a number of options, which should be supplied as an associative array upon instantiation of a new object:

```php

 false,'Depth' => 1);

$MyRelatedPages = new RelatedPages($Options);

?>

```

This will find all pages, not only visible pages, and the depth of recursion is 1, which means 1 level down the page hierachy starting at the root level.

#### Possible options

| Key         | Value   | Default | Description |

|-------------|---------|---------|-------------|

| VisibleOnly | Bool    | true    | If true, searches only visible pages, otherwise all. |

| StartURI    | String  | ''      | Start folder of search. If blank, starts at the root level. Use only folder names without numbers. No trailing slash. Example: '/folder/subfolder' |

| Depth       | Integer | 0       | Depth of recursion into the folder structure. 0 means infinitely. Count starts at StartURI level, this means it is relative to the root level. |

| Field       | String  | 'Tags'  | The name of the field in your content file which holds the keywords. |

| Items       | Array   | array() | A list of keywords which should be searched for. An empty array means that all keywords which are found in the 'Field' will be searched for. |