Jump to content
teppo

SearchEngine

Recommended Posts

On 5/31/2020 at 12:29 PM, dynweb said:

Using the module on a multi-language site. When saving a page, I get the following error: "Call to a member function setLanguageValue() on string", File: .../modules/SearchEngine/lib/Indexer.php:99


 98:                        if ($index_field_exists) {
 99:                            $page->get($index_field)->setLanguageValue($language, $index[$language->id]);
101:                        }

I suppose we need a $page->of(false) here before calling setLanguageValue() ?

Actually it sounds like your search_index field could be single-value textarea, instead of textarea (multi-language). If so, you'll have to change the type of the field manually.

Could you check if this is the case?

Either way I should probably add some extra checks to make sure that this doesn't happen.

  • Like 1

Share this post


Link to post
Share on other sites
1 hour ago, teppo said:

Actually it sounds like your search_index field could be single-value textarea, instead of textarea (multi-language). If so, you'll have to change the type of the field manually.

It is multi-language.

As far as I understand, $page->get($field) returns the field value (a string) if output formatting is true, and a field object if output formatting is false (what we need here).

Share this post


Link to post
Share on other sites
On 6/9/2020 at 1:49 PM, dynweb said:

It is multi-language.

As far as I understand, $page->get($field) returns the field value (a string) if output formatting is true, and a field object if output formatting is false (what we need here).

Right — looks like I skimmed too quickly over this part. Was also pretty sure that I had tested this before, but you're right that it doesn't seem to work at the moment. Thanks, I'll take a closer look soon!

  • Like 1

Share this post


Link to post
Share on other sites

I'm quite new to ProcessWire and never finished to learn new things about web development so forgive me if this is a stupid question. What is the exact advantage of this module to the native search function within PW? Because it feels like I could build on the "search"-template and get pretty much the same results.

  • Like 1

Share this post


Link to post
Share on other sites
On 6/24/2020 at 3:36 AM, fruid said:

I'm quite new to ProcessWire and never finished to learn new things about web development so forgive me if this is a stupid question. What is the exact advantage of this module to the native search function within PW? Because it feels like I could build on the "search"-template and get pretty much the same results.

I'm curious as well.

  • Like 1

Share this post


Link to post
Share on other sites
On 6/9/2020 at 1:49 PM, dynweb said:

As far as I understand, $page->get($field) returns the field value (a string) if output formatting is true, and a field object if output formatting is false (what we need here).

In the end I couldn't reproduce this issue: when a page is indexed, output formatting should be disabled, and thus this sort of problem shouldn't happen. Likely there's some scenario I've missed, so in 0.24.0 I switched that get() to getUnformatted(). I hope that resolves the problem — but if not, I may need a bit more information on how to reproduce it 🙂

Share this post


Link to post
Share on other sites
On 6/24/2020 at 12:36 PM, fruid said:

I'm quite new to ProcessWire and never finished to learn new things about web development so forgive me if this is a stupid question. What is the exact advantage of this module to the native search function within PW? Because it feels like I could build on the "search"-template and get pretty much the same results.

Don't worry, it's not a stupid question 🙂

You can definitely build a custom search feature and get great results with that, but things tend to get a little more complicated if your site contains a larger amount of fields, and particularly if you're using Repeater, RepeaterMatrix, PageTable, or other types of fields with repeatable content — or perhaps page reference fields gluing content from different pages together. In other words content that isn't technically (directly) part of the page, but needs to be tied with the page in the context of site search.

Although in many cases you could no doubt include all those fields in your search queries, this can result in pretty complex queries, and such queries also tend to become inefficient. Generally speaking the more fields you join in the query, the more complex the resulting SQL query will get, and the more time and resources it'll take to process. Not a great thing for scalability.

First version of SearchEngine was really just an easy way to reuse bits and pieces of code that were developed over time to mash field values together so that they could be searched more efficiently. Soon after along came the markup generating parts (which now make up a notable portion of the module), a set of features for automatically filtering and sanitizing queries and processing the index, JSON output option (mostly for AJAX requests), indexing support for field types requiring specific handling (core ones as well as third party), etc.

From the initial post in this thread:

Quote

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 🙂

These days in my projects I install SearchEngine, set it up, and trigger the render function. The module takes care of everything else and "just works". In a nutshell SE bundles most of the stuff a typical site search will need into one package, and tries to do it efficiently and following best practices 🙂

Hope this answered your question!

  • Like 1

Share this post


Link to post
Share on other sites
57 minutes ago, teppo said:

when a page is indexed, output formatting should be disabled, and thus this sort of problem shouldn't happen. 🙂

This put me on the right track 🙂 I had a Pages::saved hook that set output formatting to true (when it shouldn't). Thank you!

  • Like 1

Share this post


Link to post
Share on other sites

Quick heads-up: SearchEngine 0.25.0 was just released. This version adds support for the new selector operators added in ProcessWire 3.0.160, and also adds a new details section below the selector operator setting.

If someone has defined the operator in site config ($config->SearchEngine), that's still a valid option and new operators can be used there as well.

  • Like 2

Share this post


Link to post
Share on other sites

I just started tinkering around with this haven't haven't looked under the hood a ton. Is the _auto_desc using a method to generate on the fly or is this being populated in the results somewhere that I can refer to?

Share this post


Link to post
Share on other sites

I got this error during install (pw 3.0.159 dev)

Edit: apparently I solved updating to the latest dev version 3.0.160
image.thumb.png.78bbcaa3b512c65033e2a959aaadf57d.png

Share this post


Link to post
Share on other sites
On 7/15/2020 at 4:03 AM, gornycreative said:

I just started tinkering around with this haven't haven't looked under the hood a ton. Is the _auto_desc using a method to generate on the fly or is this being populated in the results somewhere that I can refer to?

This is generated on the fly when a result is rendered. Behind the scenes Renderer::renderResultDesc() and Renderer::renderResultsJson() both get field values using Renderer::getResultValue(), which in turn calls Renderer::getResultAutoDesc _auto_desc "pseudo field" (as in: not a real field) is requested.

There's currently no public API for accessing this directly, but if you've got a use case that can be solved by adding one, I wouldn't be against it. Though in that case I'd like to know a bit more about the context 🙂

16 hours ago, Sevarf2 said:

I got this error during install (pw 3.0.159 dev)

Edit: apparently I solved updating to the latest dev version 3.0.160
image.thumb.png.78bbcaa3b512c65033e2a959aaadf57d.png

Sorry! Accidentally introduced a dependency for ProcessWire 3.0.160 in the Config class.

This is now fixed: latest module version (0.25.1) provides proper fallbacks for core versions prior to that.

  • Like 2
  • Thanks 1

Share this post


Link to post
Share on other sites

Hi @teppo!
I have just installed / downloaded SeachEngine Module on my PW 3.0.148.
I got the error: 
 

Quote

Parse Error: syntax error, unexpected '?' (line 269 of /var/www/admin/www/*******/site/modules/SearchEngine/SearchEngine.module.php)

It's bloked PW module area.

Share this post


Link to post
Share on other sites
44 minutes ago, Alkrav said:

Hi @teppo!
I have just installed / downloaded SeachEngine Module on my PW 3.0.148.
I got the error: 
 

It's bloked PW module area.

Are you using PHP 7 or above?

'??' is a null coalescing operator added in PHP 7. 

  • Like 2
  • Thanks 1

Share this post


Link to post
Share on other sites

Hi @Outward. Thanks for the answer.
I use 5.6 version. But now i have changed to 7, than it works.

  • Like 1

Share this post


Link to post
Share on other sites

Hello everybody. Nice module look like good continuation of method fieldtype_cache of 2016 .
Is it possible to realize showing results with AJAX like on the pics.
Results is appearing under input, and last searches stored in the same style and showing when mouse click on input field.
And it is good idea for logging searching data for next analize or it can be stored localy.

 

Livesearch_pic.JPG

Share this post


Link to post
Share on other sites
Posted (edited)

Hi. I'll try use jQuery for realize live search on this module. But it doesn't work.
I took these code:
 

$(document).ready(function() {	
	var $result = $('#se-results');
	
	$('#se-form').on('keyup', function(){
		var q = $(this).val();
		if ((q != '') && (q.length > 1)){
			$.ajax({
				type: "POST",
				url: "./",
				data: {'q': q},
				success: function(msg){
					$result.html(msg);
					if(msg != ''){	
						$result.fadeIn();
					} else {
						$result.fadeOut(100);
					}
				}
			});
		 } else {
			$result.html('');
			$result.fadeOut(100);
		 }
	});
 
	$(document).on('click', function(e){
		if (!$(e.target).closest('.search-form').length){
			$result.html('');
			$result.fadeOut(100);
		}
	});
});


What i do wrong? Maybe i use not supported method?

Edited by Alkrav
Changed data: {'q': q},

Share this post


Link to post
Share on other sites

you are sending 'search' which is null, you have to send q

  • Like 2

Share this post


Link to post
Share on other sites

@Sevarf2 thanks.
Interesting reaction: If i delete frome page code  <?= $searchEngine->renderResults() ?> string (beacause there is no reaction) and add <div id="se-results"></div> i'll get loaded the same page in the div.
To whitch URL i need send POST query to get results (url: "./",)?



 

Share this post


Link to post
Share on other sites
1 hour ago, Alkrav said:

@Sevarf2 thanks.
Interesting reaction: If i delete frome page code  <?= $searchEngine->renderResults() ?> string (beacause there is no reaction) and add <div id="se-results"></div> i'll get loaded the same page in the div.
To whitch URL i need send POST query to get results (url: "./",)?



 

I'm sorry but this is going outside this forum scope, I suggest you study php, these are basic issues.

  • Sad 1

Share this post


Link to post
Share on other sites
5 hours ago, Alkrav said:

@Sevarf2 thanks.
Interesting reaction: If i delete frome page code  <?= $searchEngine->renderResults() ?> string (beacause there is no reaction) and add <div id="se-results"></div> i'll get loaded the same page in the div.
To whitch URL i need send POST query to get results (url: "./",)?

Not sure I fully understand what you're doing, but if you want to submit a search query with AJAX you need to post it to the same URL that you normally would post it to — if your search page is /search/, then that's where the AJAX query should go as well.

Note, though, that by default SearchEngine responds to GET requests, not POST requests, so that may be one reason why you're not getting the results you'd expect. Might want to switch to jQuery.get() or change the method from POST to GET in your jQuery.ajax() call.

Just for the record, SearchEngine has a built-in way to render results as JSON. This is what I typically use for AJAX search features. JSON data is pretty easy to handle with JS, and this way I'm not stuck with whatever markup the search results list on the regular ("full") page is using. When you asked if "Is it possible to realize showing results with AJAX like on the pics", the short answer is "it sure is" — but you'll have to create the markup and the JS parts yourself, since SE doesn't provide those out of the box 🙂

  • Thanks 1

Share this post


Link to post
Share on other sites

Thank you for useful answer.  And i understood that you gave base functions for extended using. And logically i tried to implement live search with stadart jQuery function + your module and its must give waited result, but don't.

Thanks for the tip about GET, and i tried and it worked not good and only if i placed result php-string from module and separately <div id="se-results"></div>.
Sorry for my newbie mistakes.

Share this post


Link to post
Share on other sites
2 hours ago, Alkrav said:

Thank you for useful answer.  And i understood that you gave base functions for extended using. And logically i tried to implement live search with stadart jQuery function + your module and its must give waited result, but don't.

Thanks for the tip about GET, and i tried and it worked not good and only if i placed result php-string from module and separately <div id="se-results"></div>.
Sorry for my newbie mistakes.

I must admit that I can't understand all of this. Are you still having problems with the AJAX search feature?

If so, it would be helpful to see a bit of code, to see what you're actually doing. Perhaps you could post your search template code and the JavaScript part via https://gist.github.com/ or something?

 

Share this post


Link to post
Share on other sites
On 6/9/2020 at 9:32 AM, xportde said:

I have a question concerning the savePageIndex-Hook: It works perfectly on saving a single page, but not, when I use the "Index pages now"-function in module settings page. How could I achieve this?

I am also really interested in this concern (and have not found an answer yet). Is it possible to have savePageIndex hooks run on a manual index rebuild? Would be awesome!

Share this post


Link to post
Share on other sites

Sorry @snck and @xportde, looks like I completely missed this question. Just to be clear, you mean the ___savedPageIndex() method?

Running this when the entire index is being rebuilt should be doable, but it looks like I'll have to move a few bits and pieces to another class. I'll take a closer look at this — hopefully later today, or perhaps tomorrow.

  • Like 1

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By teppo
      Needed a really simple solution to embed audio files within page content and couldn't find a module for that, so here we go. Textformatter Audio Embed works a bit like Textformatter Video Embed, converting this:
      <p>https://www.domain.tld/path/to/file.mp3</p> Into this:
      <audio controls class="TextformatterAudioEmbed"> <source src="https://www.domain.tld/path/to/file.mp3" type="audio/mpeg"> </audio> The audio element has pretty good browser support, so quite often this should be enough to get things rolling 🙂
      GitHub repository: https://github.com/teppokoivula/TextformatterAudioEmbed Modules directory: https://modules.processwire.com/modules/textformatter-audio-embed/
    • By Richard Jedlička
      Tense    
      Tense (Test ENvironment Setup & Execution) is a command-line tool to easily run tests agains multiple versions of ProcessWire CMF.
      Are you building a module, or a template and you need to make sure it works in all supported ProcessWire versions? Then Tense is exactly what you need. Write the tests in any testing framework, tell Tense which ProcessWire versions you are interested in and it will do the rest for you.

      See example or see usage in a real project.
      How to use?
      1. Install it: 
      composer global require uiii/tense 2. Create tense.yml config:
      tense init 3. Run it:
      tense run  
      For detailed instructions see Github page: https://github.com/uiii/tense
       
      This is made possible thanks to the great wireshell tool by @justb3a, @marcus and others.
       
      What do you think about it? Do you find it useful? Do you have some idea? Did you find some bug? Tell me you opinion. Write it here or in the issue tracker.
    • By Chris Bennett
      Hi all, I am going round and round in circles and would greatly appreciate if anyone can point me in the right direction.
      I am sure I am doing something dumb, or missing something I should know, but don't. Story of my life 😉

      Playing round with a module and my basic problem is I want to upload an image and also use InputfieldMarkup and other Inputfields.
      Going back and forth between trying an api generated page defining Fieldgroup, Template, Fields, Page and the InputfieldWrapper method.

      InputfieldWrapper method works great for all the markup stuff, but I just can't wrap my head around what I need to do to save the image to the database.
      Can generate a Field for it (thanks to the api investigations) but not sure what I need to do to link the Inputfield to that. Tried a lot of stuff from various threads, of varying dates without luck.
      Undoubtedly not helped by me not knowing enough.

      Defining Fieldgroup etc through the api seems nice and clean and works great for the images but I can't wrap my head around how/if I can add/append/hook the InputfieldWrapper/InputfieldMarkup stuff I'd like to include on that template as well. Not even sure if it should be where it is on ___install with the Fieldtype stuff or later on . Not getting Tracy errors, just nothing seems to happen.
      If anyone has any ideas or can point me in the right direction, that would be great because at the moment I am stumbling round in the dark.
       
      public function ___install() { parent::___install(); $page = $this->pages->get('name='.self::PAGE_NAME); if (!$page->id) { // Create fieldgroup, template, fields and page // Create new fieldgroup $fmFieldgroup = new Fieldgroup(); $fmFieldgroup->name = MODULE_NAME.'-fieldgroup'; $fmFieldgroup->add($this->fields->get('title')); // needed title field $fmFieldgroup->save(); // Create new template using the fieldgroup $fmTemplate = new Template(); $fmTemplate->name = MODULE_NAME; $fmTemplate->fieldgroup = $fmFieldgroup; $fmTemplate->noSettings = 1; $fmTemplate->noChildren = 1; $fmTemplate->allowNewPages = 0; $fmTemplate->tabContent = MODULE_NAME; $fmTemplate->noChangeTemplate = 1; $fmTemplate->setIcon(ICON); $fmTemplate->save(); // Favicon source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFavicon'; $fmField->label = 'Favicon'; $fmField->focusMode = 'off'; $fmField->gridMode = 'grid'; $fmField->extensions = 'svg png'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Favicon Silhouette source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFaviconSilhouette'; $fmField->label = 'SVG Silhouette'; $fmField->notes = 'When creating a silhouette/mask svg version for Safari Pinned Tabs and Windows Tiles, we recommend setting your viewbox for 0 0 16 16, as this is what Apple requires. In many cases, the easiest way to do this in something like illustrator is a sacrificial rectangle with no fill, and no stroke at 16 x 16. This forces the desired viewbox and can then be discarded easily using something as simple as notepad. Easy is good, especially when you get the result you want without a lot of hassle.'; $fmField->focusMode = 'off'; $fmField->extensions = 'svg'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Create: Open Settings Tab $tabOpener = new Field(); $tabOpener->type = new FieldtypeFieldsetTabOpen(); $tabOpener->name = 'fmTab1'; $tabOpener->label = "Favicon Settings"; $tabOpener->collapsed = Inputfield::collapsedNever; $tabOpener->addTag(MODULE_NAME); $tabOpener->save(); // Create: Close Settings Tab $tabCloser = new Field(); $tabCloser->type = new FieldtypeFieldsetClose; $tabCloser->name = 'fmTab1' . FieldtypeFieldsetTabOpen::fieldsetCloseIdentifier; $tabCloser->label = "Close open tab"; $tabCloser->addTag(MODULE_NAME); $tabCloser->save(); // Create: Opens wrapper for Favicon Folder Name $filesOpener = new Field(); $filesOpener->type = new FieldtypeFieldsetOpen(); $filesOpener->name = 'fmOpenFolderName'; $filesOpener->label = 'Wrap Folder Name'; $filesOpener->class = 'inline'; $filesOpener->collapsed = Inputfield::collapsedNever; $filesOpener->addTag(MODULE_NAME); $filesOpener->save(); // Create: Close wrapper for Favicon Folder Name $filesCloser = new Field(); $filesCloser->type = new FieldtypeFieldsetClose(); $filesCloser->name = 'fmOpenFolderName' . FieldtypeFieldsetOpen::fieldsetCloseIdentifier; $filesCloser->label = "Close open fieldset"; $filesCloser->addTag(MODULE_NAME); $filesCloser->save(); // Create Favicon Folder Name $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeText"); $fmField->name = 'folderName'; $fmField->label = 'Favicon Folder:'; $fmField->description = $this->config->urls->files; $fmField->placeholder = 'Destination Folder for your generated favicons, webmanifest and browserconfig'; $fmField->columnWidth = 100; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon('folder'); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($tabOpener); $fmFieldgroup->add($filesOpener); $fmFieldgroup->add($fmField); $fmFieldgroup->add($filesCloser); $fmFieldgroup->add($tabCloser); $fmFieldgroup->save(); /////////////////////////////////////////////////////////////// // Experimental Markup Tests $wrapperFaviconMagic = new InputfieldWrapper(); $wrapperFaviconMagic->attr('id','faviconMagicWrapper'); $wrapperFaviconMagic->attr('title',$this->_('Favicon Magic')); // field show info what $field = $this->modules->get('InputfieldMarkup'); $field->name = 'use'; $field->label = __('How do I use it?'); $field->collapsed = Inputfield::collapsedNever; $field->icon('info'); $field->attr('value', 'Does this even begin to vaguely work?'); $field->columnWidth = 50; $wrapperFaviconMagic->add($field); $fmTemplate->fields->add($wrapperFaviconMagic); $fmTemplate->fields->save(); ///////////////////////////////////////////////////////////// // Create page $page = $this->wire( new Page() ); $page->template = MODULE_NAME; $page->parent = $this->wire('pages')->get('/'); $page->addStatus(Page::statusHidden); $page->title = 'Favicons'; $page->name = self::PAGE_NAME; $page->process = $this; $page->save(); } }  
    • By Sebi
      Since it's featured in ProcessWire Weekly #310, now is the time to make it official:
      Here is Twack!
      I really like the following introduction from ProcessWire Weekly, so I hope it is ok if I use it here, too. Look at the project's README for more details!
      Twack is a new — or rather newish — third party module for ProcessWire that provides support for reusable components in an Angular-inspired way. Twack is implemented as an installable module, and a collection of helper and base classes. Key concepts introduced by this module are:
      Components, which have separate views and controllers. Views are simple PHP files that handle the output for the component, whereas controllers extend the TwackComponent base class and provide additional data handling capabilities. Services, which are singletons that provide a shared service where components can request data. The README for Twack uses a NewsService, which returns data related to news items, as an example of a service. Twack components are designed for reusability and encapsulating a set of features for easy maintainability, can handle hierarchical or recursive use (child components), and are simple to integrate with an existing site — even when said site wasn't originally developed with Twack.
      A very basic Twack component view could look something like this:
      <?php namespace ProcessWire; ?> <h1>Hello World!</h1> And here's how you could render it via the API:
      <?php namespace Processwire; $twack = $modules->get('Twack'); $hello = $twack->getNewComponent('HelloWorld'); ?> <html> <head> <title>Hello World</title> </head> <body> <?= $hello->render() ?> </body> </html> Now, just to add a bit more context, here's a simple component controller:
      <?php namespace ProcessWire; class HelloWorld extends TwackComponent { public function __construct($args) { parent::__construct($args); $this->title = 'Hello World!'; if(isset($args['title'])) { $this->title = $args['title']; } } } As you can see, there's not a whole lot new stuff to learn here if you'd like to give Twack a try in one of your projects. The Twack README provides a really informative and easy to follow introduction to all the key concepts (as well as some additional examples) so be sure to check that out before getting started. 
      Twack is in development for several years and I use it for every new project I build. Also integrated is an easy to handle workflow to make outputs as JSON, so it can be used to build responses for a REST-api as well. I will work that out in one section in the readme as well. 
      If you want to see the module in an actual project, I have published the code of www.musical-fabrik.de in a repository. It runs completely with Twack and has an app-endpoint with ajax-output as well.
      I really look forward to hear, what you think of Twack🥳!
      Features Installation Usage Quickstart: Creating a component Naming conventions & component variants Component Parameters directory page parameters viewname Asset handling Services Named components Global components Ajax-Output Configuration Versioning License Changelog
    • By Robin S
      Page Reference Default Value
      Most ProcessWire core inputfield types that can be used with a Page Reference field support a "Default value" setting. This module extends support for default values to the following core inputfield types:
      Page List Select Page List Select Multiple Page Autocomplete (single and multiple) Seeing as these inputfield types only support the selection of pages a Page List Select / Page List Select Multiple is used for defining the default value instead of the Text / Textarea field used by the core for other inputfield types. This makes defining a default value a bit more user-friendly.
      Note that as per the core "Default value" setting, the Page Reference field must be set to "required" in order for the default value to be used.
      Screenshot

       
      https://github.com/Toutouwai/PageReferenceDefaultValue
      https://modules.processwire.com/modules/page-reference-default-value/
×
×
  • Create New...