[4.1] Images in the Smart Search results

[sakiss]

Summary of Changes

The PR allows the use of images in the finder's results.

A new setting was added named "Result Image" both in the com_finder's (aka Smart Search) configuration and it's respective "search" menu item.

Testing Instructions

1. Go to the "Smart Search" component, press the "Clear Index" button and then the "Index".
2. Press the "Options" button to load the configuration and enable the "Result Image" setting.
3. Use the smart search in the site's front-end and check the returned articles that have "Intro Image" set.

Actual result BEFORE applying this Pull Request

Expected result AFTER applying this Pull Request

Sidenotes

Atm only the com_content finder plugin uses the images API function. Support for the rest plugins will be added in a next PR.
No styling is added, though a new setting (Image class) is introduced, according to the setting of com_content's config.
If anyone thinks that additional styling should be applied, plz commit.

Documentation Changes Required

DKN

[richard67]

Code style still bad, using spaces for indentation, see here https://ci.joomla.org/joomla/joomla-cms/40181/1/6 .

Another thing is that 4.0 is already in Beta phase so we have a feature freeze, and this here is a new feature.

So this PR should be made for the 4.1-dev branch.

[ceford]

I see the Intro image in the results list but in one instance followed by an error panel starting:

( ! ) Notice: Undefined variable: extraAttr in /Users/ceford/Sites/joomla-cms-4/components/com_finder/tmpl/search/default_result.php on line 96

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/32450.}

[brianteeman]

Just to be 100% clear. The decision was not to remove all descriptions. The decision was to display descriptions on screen instead of as a popup and only to include descriptions that it was felt were essential.

[richard67]

@brianteeman Thanks for clarifying and explaining it more precise than I did. It's exactly like you say.

[richard67]

Now the problem remains that if this is a new feature then it should go into 4.1.

@zero-24 What's your opinion?

[sakiss]

Just to be 100% clear. The decision was not to remove all descriptions. The decision was to display descriptions on screen instead of as a popup and only to include descriptions that it was felt were essential.

Thanks for clarifying @brianteeman.
Then the addition of a description in a "vague" field name abides with the taken decision. Right?
Of course the answer is subjective to how someone perceives something as vague. But this by no means can be taken as inconsistency.

[zero-24]

Now the problem remains that if this is a new feature then it should go into 4.1.

@zero-24 What's your opinion?

That question should be directed at @bembelimen but i personally would agree to move this to 4.1

[chmst]

Everyting what is a nice idea and improvement, but does not fix a bug should be 4.1. as we did for example with my pr #32223

[universewrld]

@sakiss thanks for your code! I originally wrote about this idea #27815, but it was closed.

[humblehumanbeing]

Sometimes we need to use full article image instead of intro article image. I think this pr should check for full article image also if intro images does not exist.

[ceford]

I have tested this item ✅ successfully on 50afef0

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/32450.}

[Fedik]

please also remove properties, it already handled by __get/__set methods,
see my previous comment

[sakiss]

@bembelimen Unfortunately i am not aware of BS5 and the classes that J4 uses in general. I would appreciate it, if someone more knowledgable on that, have a look. Btw. The image uses the "Image Class" property/setting, which was introduced for the joomla content as well (not sure if this is still valid) and is supposed to provide the styling to the image.

[Fedik]

You mean to get/set the image properties using the __get/__set functions?

Correct, please read the comment for the method:

joomla-cms/administrator/components/com_finder/src/Indexer/Result.php

Lines 200 to 214 in 1a6f5ae

	/**
	* The magic set method is used to push additional values into the elements
	* array in order to preserve the cleanliness of the object.
	*
	* @param string $name The name of the element.
	* @param mixed $value The value of the element.
	*
	* @return void
	*
	* @since 2.5
	*/
	public function __set($name, $value)
	{
	$this->setElement($name, $value);
	}

Then we will have consistency. This allows us to add any extra value to the result object, without introducing extra properties and getters/setters, for each.

[Fedik]

you do not need use empty check, just do:

if ($showImage && $this->result->imageUrl)

Remember we have a __get

[sakiss]

$this->result->imageUrl and $this->result->imageAlt no longer exist, based on the last commit.

The imageUrl and imageAlt are now part of the Joomla\Component\Finder\Administrator\Indexer\Result::$elements
which can only be accessed through the __get() or the getElement() functions.

[Fedik]

Well, do you know what __get()/__set() doing? :)
Please check how the code access to $item->title and other values.

$this->result->imageUrl and $this->result->imageAlt no longer exist

Correct, they not need to exist. That is magic of magic methods.

[sakiss]

Please test your suggestions before writing them down.
$this->result->imageUrl and $this->result->imageAlt are null since they do not exist.

If you want to provide a working example based on that suggestion, please commit.

[Fedik]

it is null only when it empty,
if you set a value while indexing then it will be not null here

[Fedik]

look how $item->title is set, and do the same:

$item->imageUrl = $images->image_intro;
$item->imageAlt = $images->image_intro_alt ?? '';

[sakiss]

This is exactly how it was before pointing me out to use the getters/setters. Probably you are commenting without checking my commits.

[Fedik]

yes, here it was correct before,

before pointing me out to use the getters/setters

It was about Result class

[sakiss]

Sorry i cannot go back and forth. I am closing that as resolved since it works and it's indeed much better than setting public properties. For any further change please commit.

[Fedik]

well, title was a bad example sorry, however please do:

$item->imageUrl = $images->image_intro;
$item->imageAlt = $images->image_intro_alt ?? '';

No need to create any properties, just do this.

[sakiss]

Obviously you did not bother to examine the finder's code, neither to test what you are writing.
Since you are wasting my time and i have no appetite to talk with toddlers, i am closing that.

[richard67]

@sakiss You've closed this by purpose or by accident?

[sakiss]

@richard67 on purpose for obvious reasons