PHP `include()`s in Blueprints

Kirby 2 Suggestions šŸ’”
1

Can one use php include() to share common blueprint fields across a set of similar blueprints?

1 Like
2

@FabianSperrle wanted to try this: Blueprint Snippets

3

Why you donā€™t just try it and see, if it works? :smiley:

4

@distantnative: I did, but it did not work. Maybe Iā€™m doing something wrong though. Hereā€™s an example blueprint:

<?php if(!defined('KIRBY')) exit ?>

title: Page
pages: true
fields:
  title:
    type: text
    label: Name
    placeholder: Used in navigation and lists.
  opening:
    <? include(kirby()->roots()->site() . DS . 'panel' . DS . 'blueprints' . DS . 'scaffolds' . DS . 'related_pages.php'); ?>
files: false

And the file getting included:

    type: structure
    label: Related Pages
    fields:
      page_uri:
        label: Page
        type: select
        options: query
        query:
          page: containers
          fetch: children
          value: '{{uri}}'
          text: '{{title}}'
    entry: >
      <a href="/panel/#/pages/show/{{page_uri}}/p:1">{{page_uri}}</a>

Any ideas?

5

Just tried it myself, but it doesnā€™t seem to work with an include :confused:

6

Itā€™s probably due to the fact that include() interprets the file getting included as PHP code; and it is YAML. Right, @bastianallgeier?

7

This would be a lovely feature!

8

I just tried this too, but the blueprint file does not seem to execute any custom php inside it, just ignores it.

You could use text pre-processing outside kirby for parsing blueprints from a shared source. Like using grunt and a watcher to append the shared fields at the end of blueprints. I think Iā€™ll try that.

9

Some people would like to use .yaml files instead of .php for blueprints. That would make include() definitely impossible, but not the feature itself. I can imagine an ā€œimportā€ option like:

fields:
  title:
    label: title
    type: text
  import: my_nice_field
ā€¦

Wondering when that would actually be useful. And itā€™s yet another layer of abstraction.
So far Iā€™m happy with cutting & pasting, but Iā€™ve donā€™t have that many shared fields. Mainly the Visual Markdown Editor field in 6 blueprints, and with the exact same options in only 4 of them.

10

One could add a function to index.php which generates all the blueprints based on a template folder using mustache. Or less hacky one could request a new panel hook from @bastianallgeier which gets called ā€˜on opening new pageā€™ popup.

11

@bastianallgeier and his team seams to have listened; blueprint snippets are there at your service: Tutorial: Global field definitions aka blueprint snippets Have fun, M.