Jump to content

SearchEngine


teppo

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
Link to comment
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).

Link to comment
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
Link to comment
Share on other sites

  • 2 weeks later...

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
Link to comment
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
Link to comment
Share on other sites

  • 2 weeks later...
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 🙂

Link to comment
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 3
Link to comment
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
Link to comment
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
Link to comment
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
Link to comment
Share on other sites

  • 3 weeks later...

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.

Link to comment
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
Link to comment
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

Link to comment
Share on other sites

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},
Link to comment
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: "./",)?



 

Link to comment
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
Link to comment
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
Link to comment
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.

Link to comment
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?

 

Link to comment
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!

Link to comment
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
Link to comment
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 monollonom
      PageMjmlToHtml
      Github: https://github.com/romaincazier/PageMjmlToHtml
      Modules directory: https://processwire.com/modules/page-mjml-to-html/
      A module allowing you to write your Processwire template using MJML and get a converted HTML output using MJML API.
      This is considered to be in alpha and as such needs some testing before being used in production!

      About
      Created by Mailjet, MJML is a markup language making it a breeze to create newsletters displayed consistently across all email clients.
      Write your template using MJML combined with Processwire’s API and this module will automatically convert your code into a working newsletter thanks to their free-to-use Rest API.
      Prerequisite
      For this module to work you will need to get an API key and paste it in the module’s configuration.
      Usage
      Once your credentials are validated, select the template(s) in which you’re using the MJML syntax, save and go visualize your page(s) to see if everything’s good. You will either get error/warning messages or your email properly formatted and ready-to-go.
      From there you can copy/paste the raw generated code in an external mailing service or distribute your newsletter using ProMailer.
      Features
      The MJML output is cached to avoid repetitive API calls Not cached if there are errors/warnings Cleared if the page is saved Cleared if the template file has been modified A simple (dumb?) code viewer highlights lines with errors/warnings A button is added to quickly copy the raw code of the generated newsletter Not added if the page is rendered outside of a PageView Only visible to users with the page’s edit permission A shortcut is also added under “View” in the edit page to open the raw code in a new tab Multi-languages support
      Notes
      The code viewer is only shown to superusers. If there’s an error the page will display:
      Only its title for guests Its title and a message inviting to contact the administrator for editors If you are using the markup regions output strategy, it might be best to not append files to preserve your MJML markup before calling the MJML API. This option is available in the module’s settings.
    • By Marco Ro
      Hi guys!
      I'm a bit anxious because this is the first module I present! (beta modulo) But I will finally be able to share something with the community too! :)
      This is a BETA version of the PayPal payment system called: PayPal Commerce Platform.
      It is an advanced system (Business Pro account is needed) that brings various benefits in terms of fees and above all integrates direct payment with credit/debit cards. 
      The module integrates with Padloper 0.0.2, which is the current installation I'm using.
      This system integrates the classic PayPal buy button, the alternative or local payment method and the new payment system: credit/debit cards that doesn't go through the PayPal account. It is a Stripe-style payment, it connects directly with the bank and integrates 3D security validation.
      I say that it is a BETA because this module currently only works with Sandbox account, to put it live you need to change API url manually (manually for the moment).
      Because this module is not ready for live:
      I would like to have your opinion on how I built the module (is the first one I do). I don't want to share something that is not fish but I need a comparison with someone more experienced than me, for be sure that this is the best way to code the module.
      If you want to try this I created a git, you will find all the instructions for installation and correct operation. (Git has a MIT licensed)
      https://github.com/MarcooRo/processwire-PayPal-Commerce-Platform I hope I did something that you guys can like :)
    • By monollonom
      (once again I was surprised to see a work of mine pop up in the newsletter, this time without even listing the module on PW modules website 😅. Thx @teppo !)
      FieldtypeQRCode
      Github: https://github.com/romaincazier/FieldtypeQRCode
      Modules directory: https://processwire.com/modules/fieldtype-qrcode/
      A simple fieldtype generating a QR Code from the public URL of the page, and more.
      Using the PHP library QR Code Generator by Kazuhiko Arase.

      Options
      In the field’s Details tab you can change between .gif or .svg formats. If you select .svg you will have the option to directly output the markup instead of a base64 image. SVG is the default.
      You can also change what is used to generate the QR code and even have several sources. The accepted sources (separated by a comma) are: httpUrl, editUrl, or the name of any text/URL/file/image field.
      If LanguageSupport is installed the compatible sources (httpUrl, text field, ...) will return as many QR codes as there are languages. Note however that when outputting on the front-end, only the languages visible to the user will be generated.
      Formatting
      Unformatted value
      When using $page->getUnformatted("qrcode_field") it returns an array with the following structure:
      [ [ "label" => string, // label used in the admin "qr" => string, // the qrcode image "source" => string, // the source, as defined in the configuration "text" => string // and the text used to generate the qrcode ], ... ] Formatted value
      The formatted value is an <img>/<svg> (or several right next to each other). There is no other markup.
      Should you need the same markup as in the admin you could use:
      $field = $fields->get("qrcode_field"); $field->type->markupValue($page, $field, $page->getUnformatted("qrcode_field")); But it’s a bit cumbersome, plus you need to import the FieldtypeQRCode's css/js. Best is to make your own markup using the unformatted value.
      Static QR code generator
      You can call FieldtypeQRCode::generateQRCode to generate any QR code you want. Its arguments are:
      string $text bool $svg Generate the QR code as svg instead of gif ? (default=true) bool $markup If svg, output its markup instead of a base64 ? (default=false) Hooks
      Please have a look at the source code for more details about the hookable functions.
      Examples
      $wire->addHookAfter("FieldtypeQRCode::getQRText", function($event) { $page = $event->arguments("page"); $event->return = $page->title; // or could be: $event->return = "Your custom text"; }) $wire->addHookAfter("FieldtypeQRCode::generateQRCodes", function($event) { $qrcodes = $event->return; // keep everything except the QR codes generated from editUrl foreach($qrcodes as $key => &$qrcode) { if($qrcode["source"] === "editUrl") { unset($qrcodes[$key]); } } unset($qrcode); $event->return = $qrcodes; })
    • By Sebi
      AppApiFile adds the /file endpoint to the AppApi routes definition. Makes it possible to query files via the api. 
      This module relies on the base module AppApi, which must be installed before AppApiFile can do its work.
      Features
      You can access all files that are uploaded at any ProcessWire page. Call api/file/route/in/pagetree?file=test.jpg to access a page via its route in the page tree. Alternatively you can call api/file/4242?file=test.jpg (e.g.,) to access a page by its id. The module will make sure that the page is accessible by the active user.
      The GET-param "file" defines the basename of the file which you want to get.
      The following GET-params (optional) can be used to manipulate an image:
      width height maxwidth maxheight cropX cropY Use GET-Param format=base64 to receive the file in base64 format.
    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
×
×
  • Create New...