Jump to content

Recommended Posts

Page Query Boss

Build complex nested queries containing multiple fields and pages and return an array or JSON. This is useful to fetch data for SPA and PWA.

You can use the Module to transform a ProcessWire Page or PageArray – even RepeaterMatrixPageArrays – into an array or JSON. Queries can be nested and contain closures as callback functions. Some field-types are transformed automatically, like Pageimages or MapMarker.

Installation

Via ProcessWire Backend

It is recommended to install the Module via the ProcessWire admin "Modules" > "Site" > "Add New" > "Add Module from Directory" using the PageQueryBoss class name.

Manually

Download the files from Github or the ProcessWire repository: https://modules.processwire.com/modules/page-query-builder/

  1. Copy all of the files for this module into /site/modules/PageQueryBoss/
  2. Go to “Modules > Refresh” in your admin, and then click “install” for the this module.

Module Methods

There are two main methods:

Return query as JSON

$page->pageQueryJson($query);

Return query as Array

$page->pageQueryArray($query);

Building the query

The query can contain key and value pairs, or only keys. It can be nested and 
contain closures for dynamic values. To illustrate a short example:

// simple query:
$query = [
	'height',
	'floors',
];
$pages->find('template=skyscraper')->pageQueryJson($query);

Queries can be nested, contain page names, template names or contain functions and ProcessWire selectors:

// simple query:
$query = [
	'height',
	'floors',
	'images', // < some fileds contain default sub-queries to return data
	'files' => [ // but you can also overrdide these defaults:
		'filename'
		'ext',
		'url',
	],
	// Assuming there are child pages with the architec template, or a
	// field name with a page relation to architects
	'architect' => [ // sub-query
		'name',
		'email'
	],
	// queries can contain closure functions that return dynamic content
	'querytime' => function($parent){
		return "Query for $parent->title was built ".time();
	}
];
$pages->find('template=skyscraper')->pageQueryJson($query);

Keys:

  1. A single fieldname; height or floors or architects 
    The Module can handle the following fields:

    • Strings, Dates, Integer… any default one-dimensional value
    • Page references
    • Pageimages
    • Pagefiles
    • PageArray
    • MapMarker
    • FieldtypeFunctional
  2. A template name; skyscraper or city

  3. Name of a child page (page.child.name=pagename); my-page-name
  4. A ProcessWire selector; template=building, floors>=25

  5. A new name for the returned index passed by a # delimiter:

     // the field skyscraper will be renamed to "building":
     $query = ["skyscraper`#building`"]

     

Key value pars:

  1. Any of the keys above (1-5) with an new nested sub-query array:

    $query = [
    	'skyscraper' => [
    		'height',
    		'floors'
    	],
    	'architect' => [
    		'title',
    		'email'
    	],
    ]

     

  2. A named key and a closure function to process and return a query. The closure gets the parent object as argument:

    $query = [
    	'architecs' => function($parent)
    		{
    			$architects = $parent->find('template=architect');
    			return $architects->arrayQuery(['name', 'email']);
    			// or return $architects->explode('name, email');
    		}
    ]

Real life example:

$query = [
	'title',
	'subtitle',
	// naming the key invitation
	'template=Invitation, limit=1#invitation' => [
		'title',
		'subtitle',
		'body',
	],
	// returns global speakers and local ones...
	'speakers' => function($page){
		$speakers = $page->speaker_relation;
		$speakers = $speakers->prepend(wire('pages')->find('template=Speaker, global=1, sort=-id'));

		// build a query of the speakers with
		return $speakers->arrayQuery([
			'title#name', // rename title field to name
			'subtitle#ministry', // rename subtitle field to ministry
			'links' => [
				'linklabel#label', // rename linklabel field to minlabelistry
				'link'
			],
		]);
	},
	'Program' => [ // Child Pages with template=Program
		'title',
		'summary',
		'start' => function($parent){ // calculate the startdate from timetables
			return $parent->children->first->date;
		},
		'end' => function($parent){ // calculate the endate from timetables
			return $parent->children->last->date;
		},
		'Timetable' => [
			'date', // date
			'timetable#entry'=> [
				'time#start', // time
				'time_until#end', // time
				'subtitle#description', // entry title
			],
		],
	],
	// ProcessWire selector, selecting children > name result "location"
	'template=Location, limit=1#location' => [
		'title#city', // summary title field to city
		'body',
		'country',
		'venue',
		'summary#address', // rename summary field to address
		'link#tickets', // rename ticket link
		'map', // Mapmarker field, automatically transformed
		'images',
		'infos#categories' => [ // repeater matrix! > rename to categories
			'title#name', // rename title field to name
			'entries' => [ // nested repeater matrix!
				'title',
				'body'
			]
		],
	],
];

if ($input->urlSegment1 === 'json') {
	header('Content-type: application/json');
	echo $page->pageQueryJson($query);
	exit();
}

Module default settings

The modules settings are public. They can be directly modified, for example:

$modules->get('PageQueryBoss')->debug = true;
$modules->get('PageQueryBoss')->defaults = []; // reset all defaults

Default queries for fields:

Some field-types or templates come with default selectors, like Pageimages etc. These are the default queries:

// Access and modify default queries: $modules->get('PageQueryBoss')->defaults['queries'] …
public $defaults = [
	'queries' => [
		'Pageimages' => [
			'basename',
			'url',
			'httpUrl',
			'description',
			'ext',
			'focus',
		],
		'Pagefiles' => [
			'basename',
			'url',
			'httpUrl',
			'description',
			'ext',
			'filesize',
			'filesizeStr',
			'hash',
		],
		'MapMarker' => [
			'lat',
			'lng',
			'zoom',
			'address',
		],
		'User' => [
			'name',
			'email',
		],
	],
];

These defaults will only be used if there is no nested sub-query for the respective type. If you query a field with complex data and do not provide a sub-query, it will be transformed accordingly:

$page->pageQueryArry(['images']);

// returns something like this
'images' => [
	'basename',
	'url',
	'httpUrl',
	'description',
	'ext',
	'focus'=> [
		'top',
		'left',
		'zoom',
		'default',
		'str',
	]
];

You can always provide your own sub-query, so the defaults will not be used:

$page->pageQueryArry([
	'images' => [
		'filename',
		'description'
	],
]);

Overriding default queries:

You can also override the defaults, for example

$modules->get('PageQueryBoss')->defaults['queries']['Pageimages'] = [
	'basename',
	'url',
	'description',
];

Index of nested elements

The index for nested elements can be adjusted. This is also done with defaults. There are 3 possibilities:

  1. Nested by name (default)
  2. Nested by ID
  3. Nested by numerical index

Named index (default):

This is the default setting. If you have a field that contains sub-items, the name will be the key in the results:

// example
$pagesByName = [
	'page-1-name' => [
		'title' => "Page one title",
		'name' => 'page-1-name',
	],
	'page-2-name' => [
		'title' => "Page two title",
		'name' => 'page-2-name',
	]
]

ID based index:

If an object is listed in $defaults['index-id'] the id will be the key in the results. Currently, no items are listed as defaults for id-based index:

// Set pages to get ID based index:
$modules->get('PageQueryBoss')->defaults['index-id']['Page'];
// Example return array:
$pagesById = [
	123 => [
		'title' => "Page one title",
		'name' => 123,
	],
	124 => [
		'title' => "Page two title",
		'name' => 124,
	]
]

Number based index

By default, a couple of fields are transformed automatically to contain numbered indexes:

// objects or template names that should use numerical indexes for children instead of names
$defaults['index-n'] => [
	'Pageimage',
	'Pagefile',
	'RepeaterMatrixPage',
];

// example
$images = [
	0 => [
		'filename' => "image1.jpg",
	],
	1 => [
		'filename' => "image2.jpg",
	]
]

Tipp: When you remove the key 'Pageimage' from $defaults['index-n'], the index will again be name-based.

 

Help-fill closures & tipps:

These are few helpfill closure functions you might want to use or could help as a
starting point for your own (let me know if you have your own):


Get an overview of languages:

    $query = ['languages' => function($page){
        $ar = [];
        $l=0;
        foreach (wire('languages') as $language) {
            // build the json url with segment 1
            $ar[$l]['url']= $page->localHttpUrl($language).wire('input')->urlSegment1;
            $ar[$l]['name'] = $language->name == 'default' ? 'en' : $language->name;
            $ar[$l]['title'] = $language->getLanguageValue($language, 'title');
            $ar[$l]['active'] = $language->id == wire('user')->language->id;
            $l++;
        }
        return $ar;
    }];

Get county info from ContinentsAndCountries Module

Using the [ContinentsAndCountries Module](https://modules.processwire.com/modules/continents-and-countries/) you can extract iso
code and names for countries:

    $query = ['country' => function($page){
        $c = wire('modules')->get('ContinentsAndCountries')->findBy('countries', array('name', 'iso', 'code'),['code' =>$page->country]);
        return count($c) ? (array) $c[count($c)-1] : null;
    }];

Custom strings from a RepeaterTable for interface

Using a RepeaterMatrix you can create template string for your frontend. This is
usefull for buttons, labels etc. The following code uses a repeater with the
name `strings` has a `key` and a `body` field, the returned array contains the `key` field as,
you guess, keys and the `body` field as values:

    // build custom translations
    $query = ['strings' => function($page){
        return array_column($page->get('strings')->each(['key', 'body']), 'body', 'key');
    }];

Multilanguage with default language fallback

Using the following setup you can handle multilanguage and return your default
language if the requested language does not exist. The url is composed like so:
`page/path/{language}/{content-type}` for example: `api/icf/zurich/conference/2019/de/json`
 

    // get contenttype and language (or default language if not exists)
    $lang = wire('languages')->get($input->urlSegment1);
    if(!$lang instanceof Nullpage){
        $user->language = $lang;
    } else {
        $lang = $user->language;
    }

    // contenttype segment 2 or 1 if language not present
    $contenttype = $input->urlSegment2 ? $input->urlSegment2 : $input->urlSegment1;

    if ($contenttype === 'json') {
        header('Content-type: application/json');
        echo $page->pageQueryJson($query);
        exit();
    }

Debug

The module respects wire('config')->debug. It integrates with TracyDebug. You can override it like so:

// turns on debug output no mather what:
$modules->get('PageQueryBoss')->debug = true;

Todos

Make defaults configurable via Backend. How could that be done in style with the default queries?

Module in alpha Stage: Subject to change

This module is in alpha stage … Query behaviour (especially selecting child-templates, renaming, naming etc)  could change ;)

  • Like 26
  • Thanks 1

Share this post


Link to post
Share on other sites

@noelboss, this is BEAUTIFUL!!

Very easy to understand. I'm eager to play with it and create a front-end using Vuejs and another with Gatsbyjs.

Many thanks for this module!!

  • Like 3

Share this post


Link to post
Share on other sites

Wow, da hätt glaubs öpper gschaffed... trotz de Früehligs-Polle :-)

From just a very quick first glance, this looks really nice. I'm sure I'll install this when I have some spare time and play around with it.

I don't actually have a real use-case myself atm, but since we're experimenting with conversational interface stuff lately (chatbots etc.), Dialogflow Webhooks etc., this could come in very handy for REST/API-like scenarios.

  • Like 2

Share this post


Link to post
Share on other sites
18 hours ago, kongondo said:

Looks great, thanks!

I've just had a quick look. Any reason why the module is autoload?

Thank you @kongondo :D No, no reason – I'm new to PW and Module development and had issues with Modules without autoload before – and the module I was taking clues from had autoload true as well. I probably have to look into it a bit more. Any good resources about that? Should I not use it?

Share this post


Link to post
Share on other sites
3 hours ago, Noel Boss said:

Thank you @kongondo :D No, no reason – I'm new to PW and Module development and had issues with Modules without autoload before – and the module I was taking clues from had autoload true as well. I probably have to look into it a bit more. Any good resources about that? Should I not use it?

You only use autoload if the module needs to load automatically when ProcessWire boots so that you can listen to every single request and typically attach hooks to some event of interest. Don't let this confuse you though. Modules can hook into events without being autoload modules. An example autoload module is Blog module's Publish Date. It listens to when Blog Posts are published and sets a publish date. As such, it needs to be auto-loaded.

Does your module need to boot with ProcessWire or does one call it when one needs it? If the latter, then it means presently, it is just loading and using up resources when it doesn't need to. Can your module work like this?

$pageQuery = $modules->get('PageQueryBoss');
$query = $pages->find('template=skyscraper');
$json = $pageQuery->pageQueryJson($query);

It doesn't seem to me like it needs to autoload, but I've only had a brief look, so I could be wrong.

You can read a bit more about autoload modules in the module class docs here.

  • Like 3

Share this post


Link to post
Share on other sites

Thank you for the detailed response @kongondo ! The above code does not work, the plugin extends $page so you can directly call ‚pageQueryJson‘ on a Page or a PageArray you call it - altough you need to specify what results you‘d like to receive;

$json = $pages->find('template=skyscraper')->pageQueryJson(['title']);

from what you describe, it probably does not need to autoload :) I’ll change that with the next release. Thanks again!

  • Like 1

Share this post


Link to post
Share on other sites
On 4/28/2018 at 5:22 PM, kongondo said:

@Noel Boss,

Looks great, thanks!

I've just had a quick look. Any reason why the module is autoload?

I have just released an updated version without autoload. I also added a few helpfull closures to the readme, as well as hook-able methods:

https://github.com/noelboss/PageQueryBoss#helpfull-closures--tipps

  • Like 3

Share this post


Link to post
Share on other sites
On 4/29/2018 at 5:47 PM, Noel Boss said:

The above code does not work, the plugin extends $page so you can directly call ‚pageQueryJson‘ on a Page or a PageArray you call it - altough you need to specify what results you‘d like to receive;

Hi @Noel Boss,

In your case, if the module extends (not in a PHP technical sense) $page, then it will have to be an autoload module. Your module adds methods to the  Page and WireArray classes. Hence, if it is not an autoload module, I don't see how it will work just by doing this:

$json = $pages->find('template=skyscraper')->pageQueryJson(['title']);

You will definitely get a PHP error about Method PageArray::pageQueryJson does not exist etc.

Maybe I'm missing something. Did it work for you with the new changes? 

Sorry if I am taking your round in circles 😊.

 

  • Like 1

Share this post


Link to post
Share on other sites

Hi @Noel Boss,

now I get exactly the problem 

Exception: Method PageArray::pageQueryJson does not exist or is not callable in this context

as @kongondo mentioned. I've tried a minimal version of the pageQueryBoss:

<?php namespace ProcessWire; 
  $query = [
      "title"
  ];
echo $pages->find('template=portal-entry')->pageQueryJson($query);

But still with this error. Setting autoload to true does not change anything...
Do you have any idea to solve this?

 

Many thanks in advance - for your module but also for your medium article!

 

Share this post


Link to post
Share on other sites

Oh, now I got it!
Setting module autoload and singular to true again and clearing all caches helped... 

Thanks for this great module!

  • Like 1

Share this post


Link to post
Share on other sites

Perhaps I am missing something here, but where is the "singular" and "isAutoload" at for the module? I am running into the same issue that kongondo mentioned, but can not find anything to change.

Share this post


Link to post
Share on other sites

Hey Noel,

I just had a quick question for you regarding pageQueryBoss. I was just trying to get a simple example up and running (using the most up to date version),  I got it working by adding in autoload true to to the config. However, I am a bit stumped. I really need a query set up to return something like:
 

Parent Page
  - Grandchild Page
    - field
    - field
  - Grandchild Page
    - field
    - field
  - Grandchild Page
    - field
    - field

Though no matter what I try, I can not seem to wrap my ahead around how to return the desired result. 

Share this post


Link to post
Share on other sites

This looks very nice @Noel Boss,

is there a way to support repeater fields?

 

EDIT: Sorry for my silly question, found it in your docs.

This works for me:

$query = ['repeater' => function($page){
        return array_column($page->get('repeater')->each(['key', 'body']), 'body', 'key');

 

  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites

Hi @Noel Boss

Thank you so much for the plugin! I'm still trying to figure out how to make it do precisely what I need it to do, so I just have a quick question about formatting. 

Basically I'm trying to get this kind of json output: 

[
  {
    "title": "Paul Rand",
    "year": [
      "1993"
    ],
    "authors": [
      "Abrams, Janet"
    ],
    "categories": [
      "Criticism",
      "Design",
      "Design Histories"
    ]
  }
]

But I'm getting this instead:

{
  paul-rand: {
    title: "Paul Rand",
    year: [
    "1993"
    ],
    authors: [
    "Abrams, Janet"
    ],
    categories: [
    "Criticism",
    "Design",
    "Design Histories"
    ]
  }
}

This is the query I'm currently using: 

header("Content-type: application/json");
$modules->get('PageQueryBoss')->debug = true;
$query = [
  'title',
  'year.title#year',
  'authors.title#authors',
  'categories.title#categories'
];
echo $pages->find('template=book, sort=authors.title')->pageQueryJson($query);

Is there some setting I'm missing, or is the problem with how I'm structuring the query?

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Robin S
      First a note about my other modules...
      I have three existing modules that are similar in that they allow restrictions to be placed on repeating inputfields: Limit Repeater, Limit PageTable, Limit Table
      Restrict Repeater Matrix takes a different approach to the module configuration from those other modules. The module settings for Restrict Repeater Matrix are applied in the field settings rather in a module config screen. I think this new approach is better, but it means that it isn't practical to create different settings for different roles via the admin interface. Instead the module has a hookable method, allowing roles to be targeted and other advanced usages to be achieved via a hook. The result is that the module is more flexible.
      I intend to transition my other modules to the same approach over the coming weeks, but because this will result in breaking changes I will be releasing the updated modules under new names ("Restrict Repeater", etc) to avoid users upgrading via the Upgrades module without full awareness of the changes. The old modules will be marked as deprecated.
      Restrict Repeater Matrix
      A module for ProcessWire CMS/CMF. Allows restrictions and limits to be placed on Repeater Matrix fields. Requires ProcessWire >= v3.0.0 and FieldtypeRepeaterMatrix >= v0.0.5.
      For any matrix type in a Repeater Matrix field you have the option to:
      Disable settings for items (cannot change matrix type) Prevent drag-sorting of items Prevent cloning of items Prevent toggling of the published state of items Prevent trashing of items Limit the number of items that may be added to the inputfield. When the limit is reached the "Add new" button for the matrix type will be removed and the matrix type will not be available for selection in the "Type" dropdown of other matrix items. Please note that restrictions and limits are applied with CSS/JS so should not be considered tamper-proof.
      Usage
      Install the Restrict Repeater Matrix module.
      For each matrix type created in the Repeater Matrix field settings, a "Restrictions" fieldset is added at the bottom of the matrix type settings:

      For newly added matrix types, the settings must be saved first in order for the Restrictions fieldset to appear. Set restrictions for each matrix type as needed. A limit of zero means that no items of that matrix type may be added to the inputfield.
      Setting restrictions via a hook
      Besides setting restrictions in the field settings, you can also apply or modify restrictions by hookingRestrictRepeaterMatrix::checkRestrictions. This allows for more focused restrictions, for example, applying restrictions depending on the template of the page being edited or depending on the role of the user.
      The checkRestrictions() method receives the following arguments:
      $field This Repeater Matrix field $inputfield This Repeater Matrix inputfield $matrix_types An array of matrix types for this field. Each key is the matrix type name and the value is the matrix type integer. $page The page that is open in ProcessPageEdit The method returns a multi-dimensional array of matrix types and restrictions for each of those types. An example of a returned array:

      Example hooks
      Prevent the matrix type "images_block" from being added to "my_matrix_field" in a page with the "basic-page" template:
      $wire->addHookAfter('RestrictRepeaterMatrix::checkRestrictions', function(HookEvent $event) { $field = $event->arguments('field'); $page = $event->arguments('page'); $type_restrictions = $event->return; if($field->name === 'my_matrix_field' && $page->template->name === 'basic-page') { $type_restrictions['images_block']['limit'] = 0; } $event->return = $type_restrictions; }); Prevent non-superusers from trashing any Repeater Matrix items in "my_matrix_field":
      $wire->addHookAfter('RestrictRepeaterMatrix::checkRestrictions', function(HookEvent $event) { $field = $event->arguments('field'); $type_restrictions = $event->return; if($field->name === 'my_matrix_field' && !$this->user->isSuperuser()) { foreach($type_restrictions as $key => $value) { $type_restrictions[$key]['notrash'] = true; } } $event->return = $type_restrictions; }); http://modules.processwire.com/modules/restrict-repeater-matrix/
      https://github.com/Toutouwai/RestrictRepeaterMatrix
    • By BitPoet
      Here's a little text formatter module that redirects all external links found in a textarea (e.g. for hit counting) to a given URL.
      TextformatterExternalRedirect
      GitHub repo
      As TextFormatters do, this module modifies the contents of the textarea (HTML) at rendering time. It prepends the given URL to the link address for external links (http and https), optionally makes sure that the link is opened in a new window and allows you to add css classes to such links.
      All options can be configured in the module's configuration settings.
      Usage:
      Download the zip archive and extract it to site/modules, the rename the top folder to TextformatterExternalRedirect Go to the backend and select "Modules" -> "Refresh", then click "Install" for "External Link Redirect" Click "Settings" and configure the module
      Go into the field configuration for the field(s) you want this formatter to apply to and add it from the dropdown
      Done, now any external links in the configured fields will have the configured settings applied Feel free to leave feedback and post and questions you have here.
       
    • By teppo
      Hey folks!
      Took a couple of late nights, but managed to turn this old gist of mine into a proper module. The name is SearchEngine, and currently it provides support for indexing page contents (into a hidden textarea field created automatically), and also includes a helper feature ("Finder") for querying said contents. No fancy features like stemming here yet, but something along those lines might be added later if it seems useful (and if I find a decent implementation to integrate).
      Though the API and selector engine make it really easy to create site search pages, I pretty much always end up duplicating the same features from site to site. Also – since it takes a bit of extra time – it's tempting to skip over some accessibility related things, and leave features like text highlighting out. Overall I think it makes sense to bundle all that into a module, which can then be reused over and over again 🙂
      Note: markup generation is not yet built into the module, which is why the examples below use PageArray::render() method to produce a simple list of results. This will be added later on, as a part of the same module or a separate Markup module. There's also no fancy JS API or anything like that (yet).
      This is an early release, so be kind – I got the find feature working last night (or perhaps this morning), and some final tweaks and updates were made just an hour ago 😅
      GitHub repository: https://github.com/teppokoivula/SearchEngine Modules directory: https://modules.processwire.com/modules/search-engine/ Demo: https://wireframe-framework.com/search/ Usage
      Install SearchEngine module. Note: the module will automatically create an index field install time, so be sure to define a custom field (via site config) before installation if you don't want it to be called "search_index". You can change the field name later as well, but you'll have to update the "index_field" option in site config or module settings (in Admin) after renaming it.
      Add the site search index field to templates you want to make searchable. Use selectors to query values in site search index. Note: you can use any operator for your selectors, you will likely find the '=' and '%=' operators most useful here. You can read more about selector operators from ProcessWire's documentation.
      Options
      By default the module will create a search index field called 'search_index' and store values from Page fields title, headline, summary, and body to said index field when a page is saved. You can modify this behaviour (field name and/or indexed page fields) either via the Module config screen in the PocessWire Admin, or by defining $config->SearchEngine array in your site config file or other applicable location:
      $config->SearchEngine = [ 'index_field' => 'search_index', 'indexed_fields' => [ 'title', 'headline', 'summary', 'body', ], 'prefixes' => [ 'link' => 'link:', ], 'find_args' => [ 'limit' => 25, 'sort' => 'sort', 'operator' => '%=', 'query_param' => null, 'selector_extra' => '', ], ]; You can access the search index field just like any other ProcessWire field with selectors:
      if ($q = $sanitizer->selectorValue($input->get->q)) { $results = $pages->find('search_index%=' . $query_string . ', limit=25'); echo $results->render(); echo $results->renderPager(); } Alternatively you can delegate the find operation to the SearchEngine module as well:
      $query = $modules->get('SearchEngine')->find($input->get->q); echo $query->resultsString; // alias for $query->results->render() echo $query->pager; // alias for $query->results->renderPager() Requirements
      ProcessWire >= 3.0.112 PHP >= 7.1.0 Note: later versions of the module may require Composer, or alternatively some additional features may require installing via Composer. This is still under consideration – so far there's nothing here that would really depend on it, but advanced features like stemming most likely would.
      Installing
      It's the usual thing: download or clone the SearchEngine directory into your /site/modules/ directory and install via Admin. Alternatively you can install SearchEngine with Composer by executing composer require teppokoivula/search-engine in your site directory.
    • By teppo
      MarkupMenu is a markup module for generating menu trees. When provided a root page as a starting point, it generates a navigation tree (by default as a HTML "<ul>" element wrapped by a "<nav>" element) from that point onwards. If you've also provided it with current (active) page, the menu will be rendered accordingly, with current item highlighted and items rendered up to that item and its children (unless you disable the "collapsed" option, in which case the full page tree will be rendered instead).
      Modules directory: https://modules.processwire.com/modules/markup-menu/ GitHub repository: https://github.com/teppokoivula/MarkupMenu Usage
      As a markup module, MarkupMenu is intended for front-end use, but you can of course use it in a module as well. Typically you'll only need the render() method, which takes an array of options as its only argument:
      echo $modules->get('MarkupMenu')->render([ 'root_page' => $pages->get(1), 'current_page' => $page, ]); Note: if you omit root_page, site root page is used by default. If you omit current_page, the menu will be rendered, but current (active) page won't be highlighted etc.
      A slightly more complex example, based on what I'm using on one of my own sites to render a (single-level) top menu:
      echo $modules->get('MarkupMenu')->render([ 'current_page' => $page, 'templates' => [ 'nav' => '<nav class="{classes} menu--{menu_class_modifier}" aria-label="{aria_label}">%s</nav>', 'item_current' => '<a class="menu__item menu__item--current" href="{item.url}" tabindex="0" aria-label="Current page: {item.title}">{item.title}</a>', ], 'placeholders' => [ 'menu_class_modifier' => 'top', 'aria_label' => 'Main navigation', ], 'include' => [ 'root_page' => true, ], 'exclude' => [ 'level_greater_than' => 1, ], ]); Note: some things you see above may not be entirely sensible, such as the use of {menu_class_modifier} and {aria_label} placeholders. On the actual site the "nav" template is defined in site config, so I can define just these parts on a case-by-case basis while actual nav markup is maintained in one place.
      Please check out the README file for available render options. I'd very much prefer not to keep this list up to date in multiple places. Basically there are settings for defining "templates" for different parts of the menu (list, item, etc.), include array for defining rules for including in the menu and exclude array for the opposite effect, classes and placeholders arrays for overriding default classes and injecting custom placeholders, etc. 🙂
      MarkupMenu vs. MarkupSimpleNavigation
      TL;DR: this is another take on the same concept. There are many similarities, but also some differences – especially when it comes to the supported options and syntax. If you're currently using MarkupSimpleNavigation then there's probably no reason to switch over.
      I'd be surprised if someone didn't draw lines between this module and Soma's awesome MarkupSimpleNavigation. Simply put I've been using MSN (...) for years, and it's been great – but there are some issues with it, particularly in the markup generation area, and it also does some things in a way that doesn't quite work for me – the xtemplates thing being one of these. In some ways less about features, and more about style, I guess 🙂
      Anyhow, in MarkupMenu I've tried to correct those little hiccups, modernise the default markup, and allow for more flexibility with placeholder variables and additional / different options. MarkupMenu was built for ProcessWire 3.0.112+ and with PHP 7.1+ in mind, it's installable with Composer, and I have a few additional ideas (such as conditional placeholders) still on my todo list.
      One more small(ish) difference is that MarkupMenu supports overriding default options via $config->MarkupMenu. I find myself redefining the default markup for every site, which until now meant that each site had a wrapper function for MarkupSimpleNavigation (to avoid code / config repetition), and this way I've been able to leave that out 🙂
      Requirements
      ProcessWire >= 3.0.112 PHP >= 7.1.0 If you're working on an earlier version of ProcessWire or PHP, use MarkupSimpleNavigation instead.
    • By DooM
      Hello guys,
      I'm trying to figure out how to sync fields and templates between staging and production environments.
      I've found Migrations module by Lostkobrakai, but with use of it all the fields and templates must be created by API, which is kind of uncomfortable.
      I also tried ProcessDatabaseBackups module which can export only certain tables, but I don't think it's the best practice to do that.
      How do you guys solve this problem? It's very annoying to setup everything three times (dev, staging, production).
      Thanks a lot :)
×
×
  • Create New...