Module: Image Extra

[adrian]

Sorry @justb3a - another small but critical bug for you. Everything was working fine on my PHP 7.1 local dev, but when I updated a live server running 5.4, the Image Extra fields weren't being inserted.

I have to replace this line: https://github.com/justb3a/processwire-imageextra/blob/master/ImageExtra.module#L1092

    $out = preg_replace('/(<input\sclass=\'InputfieldFileSort\')/', $this->escape_backreference($outAdditional) . '$1', $out);

with:

    $out = preg_replace('/(<input\sclass="InputfieldFileSort")/', $this->escape_backreference($outAdditional) . '$1', $out);

Notice the change: \' to "

Not sure if there have been some updates to PHP's regex engine between 5.4 and 7.1 that are causing this, but that is my guess.

Anyway, that change seems to fix things, but I didn't test the Description field because I have that disabled, so it might be worth checking all regexes. 

You can see here: https://regex101.com/r/0kTOmt/1 how that initial version fails, but this one: https://regex101.com/r/0kTOmt/2 works.

Hope that helps.

[justb3a]

7 hours ago, adrian said:

Notice the change: \' to "

I don't think that this has something to do with the change of the regex engine. The source code contains in one case single quotes in the other one double quotes. While writing the regex I thought about adding a check for double or single quotes - either way, the code now checks both occurrences, so it doesn't matter if the html contains single or double quotes. You can see it here: https://regex101.com/r/emj9Ie/1

[adrian]

15 minutes ago, justb3a said:

I don't think that this has something to do with the change of the regex engine. The source code contains in one case single quotes in the other one double quotes. While writing the regex I thought about adding a check for double or single quotes - either way, the code now checks both occurrences, so it doesn't matter if the html contains single or double quotes. You can see it here: https://regex101.com/r/emj9Ie/1

Yes, of course  I was thrown off by it working on dev server but not live even though both had identical codebase and db content.

Thanks for the fix!

[mauricemoss]

@justb3a Thanks for the great modules. Just what I needed for my last project.

One thing I stumbled upon: I cannot delete text that has been inserted before. Since the existence of the input is a condition for outputting a caption or not it is necessary to have an empty field again.

Doesn't matter if placed inside a repeater or not.

Can you repoduce that, or do I miss something.

Thanks in advance!

[justb3a]

You're right, somehow there was a missing equal sign  Thanks for the feedback, please pull the latest version from Github!

[theoretic]

Hello there! And thanks for a perfect module.

I have an interesting question. How can i programmatically set the values for multilanguage custom image fields? Tried several approaches, everything fails. Will appreciate any help. Thanks in advance!

Approach 1. Trying to switch current lang:

//...somethere inside a module...
$this->page->of(false);
$languageCurr = $this->user->language; //russian
$this->user->language = $this->languages->get("en");
//image retrievinig skipped
$image->title = 'an english title';
$image->save();
$this->user->language = $languageCurr;
$this->page->of(true);

Approach 2. Trying to use setLanguageValue():

$en = $this->languages->get("en");
$image->title->setLanguageValue($en,''an english title'') ; //gives error

Approach 3. Trying to use special names for needed field:

$this->page->of(false);
$image->title_en = 'an english title'; //not stored at fact
$this->page->of(true);

Thanks in advance!

[justb3a]

hi

from the API side you can set the values like this:

$page->setOutputFormatting(false);
$page->images->trackChange('title');
$img = $page->images->first(); // or whatever image you want
$img->title = 'Title in default language';
$img->title($languages->get('fi'), 'Title in Finish');
$img->title($languages->get('de'), 'Title in German');
$page->save();
$page->setOutputFormatting(true);

 

[theoretic]

Thanks justb3a! Works like a charm.

Another tricky question. Let's suppose that i decided to fetch some images with language fields via Ajax request. The endpoint which receives that request is a Processwire page so all Processwire API functions are available. The data structure for each image is like this:

{"name":"dscXXXX.jpg","title":"A multi-language title","uid":"2aa1"}

The endpoint call may include something like ?uid=XXXX&lang=en , so the endpoint is language-aware and should return the title in the desired language.

Fetching image by uid is not a problem, but how to force our endpoint to fetch the multi-lang title for the desired language?

At the moment i found the only solution which is quite hacky. Let's suppose we have the "english" lang page id = 1000. So the data structure for the $image object will be like this:

...
title->'The title in default language',
title1000->'The title in english'
...

So i can get English title like this:

$title_en = $image->title1000;

Could You give me any advice how to fetch the multi-lang image field value for desired language in a less hacky way? Thanks in advance!

 

[justb3a]

This works pretty straight forward 

echo $image->title($languages->get('en'));
// $image->title($languages->get($input->get('lang'));

 

[theoretic]

Thanks again justb3a! You're the best

[Zeka]

HI @justb3a

Does you module support "Page refference" field? 

 

[justb3a]

Hi @Zeka, what do you exactly want to do?  A "Page reference" field references to another page, I'm not quite sure how this is related to image extra fields. 

[Zeka]

4 hours ago, justb3a said:

Hi @Zeka, what do you exactly want to do?  A "Page reference" field references to another page, I'm not quite sure how this is related to image extra fields. 

Hi @justb3a Sorry for being not clear enough. I want to extend image field by page reference field. But if I do so, I get just regular text field instead of page field. So it makes me thinking that your module works only with text-based fields and not with some more complicated.

 

[justb3a]

Ok, that is not possible. If you want to reference to another page, why not using the internal page link field (enable checkbox in field settings in Image Extra Tab)? This saves also a reference to a page, what do you do with that reference is up to you  The only drawback: you can use it only once and it's not possible to define an entry point / parent page, so all pages will be listet. 

[mel47]

Hello,

Thanks for your module; I read all the thread. Last year, it seems impossible to have some html in extra fields, does it works now? Anyway, if so, I'm unable, it always strip out my <a href[...]

Furthermore, I'm seems unable to add more than 1 textformatter, I can just choose one (and I'm not really sure it was applied).

Thanks

Mel

PW 3.0.51

[justb3a]

@mel47 You can only apply one textformatter for a field.

Quote

.. it always strip out my <a href[...]

You're right, I'm using sanitizer textarea to sanitize the input values. And the default option – which will be provided to the textarea() sanitizer – is: 

// strip markup tags
'stripTags' => true,

Therefore all tags are gone. I updated the sanitizer usage and set this option to `false`.

Please update the module and try again! 

[adrian]

@justb3a - what about using the "purify" sanitizer instead of "textarea". Not sure if it suits your needs, but thought I should mention it.

[justb3a]

19 hours ago, adrian said:

@justb3a - what about using the "purify" sanitizer instead of "textarea". Not sure if it suits your needs, but thought I should mention it.

You're completely right. Thanks for the hint, I'll change it. 

`core/Sanitizer.php` function textarea:

/**
 * Sanitize input string as multi-line text without no HTML tags
 *
 * - This sanitizer is useful for user-submitted text from a plain-text `<textarea>` field, 
 *   or any other kind of string value that might have multiple-lines.
 * 
 * - Don't use this sanitizer for values where you want to allow HTML (like rich text fields). 
 *   For those values you should instead use the `$sanitizer->purify()` method. 
 [...]
 */

 

[mel47]

@justb3a Thanks!

[Robin S]

Hi @justb3a,

Do you think the extra field headings could be styled more like the Description label? This might be easier to do if it were a <label> element rather than <strong>. The difference between them looks a bit odd to me:

Also, I'm not sure about this but it looks like the additional fields markup is not placed inside the "InputfieldImageEdit__additional" wrapper div. Is it meant to be?

 

Edit: one more thing...

What is the intention behind this part where the inputfield type is set based on whether or not a textformatter is applied? Is that meant to be a way to choose the type of inputfield you want? What if you would like a Text input but still want a textformatter applied? Maybe the choice between Text and Textarea could be a separate setting alongside the Textformatter dropdown in the table?

[Jon E]

Hi there,

Little stuck on something and have looked around.

I have used the image field extender module but when I'm outputting images in my gallery I want to check if there is a caption before I output the markup.

How would I go about this?

Thanks

 

echo "<li><img src='{$thumbnail1->url}' alt='{$image1->description}' /><p class='caption'><strong>{$image1->imagetitle}</strong> <em>{$image1->imagetext}</em> <span><br>{$image1->role}</span></p></li> ";

 

[kongondo]

42 minutes ago, Jon E said:

image field extender module

Which module is this?

[Harmen]

15 hours ago, Jon E said:

I want to check if there is a caption before I output the markup

I think this can be done with a simple if statement.... Don't have the time to provide a snippet for you at the moment, I'm sorry.

Something like this:

if ($image->caption){
	//Output markup 1
}
else {
	//Output markup 2
}

 

[justb3a]

@Robin S Thanks for your feedback!

1. Label vs. Strong

I'm totally with you, semantically it should be a label but I had a reason why I wrapped it inside a strong tag:
If you have a multilingual installation, the label of the extra field is no longer the title of the field, it'll look something like this (core behaviour, I tried to stand as close as possible):

<div class="InputfieldImageEdit__core">
  <div class="hasLangTabs langTabsContainer">
    <div class="langTabs ui-tabs ui-widget ui-widget-content ui-corner-all">
      <ul class="ui-tabs-nav ui-helper-reset ui-helper-clearfix ui-widget-header ui-corner-all" role="tablist">
        ... <li>...</li> ... 
      </ul>
      <div class="InputfieldFileDescription LanguageSupport ui-tabs-panel ui-widget-content ui-corner-bottom" data-language="1010" id="langTab_images_34c8cc73419393a219a5cb218ebcc4b2__1010" aria-labelledby="ui-id-13" role="tabpanel" aria-expanded="true" aria-hidden="false">
        <label for="description_images_34c8cc73419393a219a5cb218ebcc4b2" class="detail LanguageSupportLabel">English</label>
        <input type="text" name="description_images_34c8cc73419393a219a5cb218ebcc4b2" id="description_images_34c8cc73419393a219a5cb218ebcc4b2" value="">
      </div>
      <div class="InputfieldFileDescription LanguageSupport ui-tabs-panel ui-widget-content ui-corner-bottom" data-language="1012" id="langTab_images_34c8cc73419393a219a5cb218ebcc4b2__1012" aria-labelledby="ui-id-14" role="tabpanel" aria-expanded="false" aria-hidden="true" style="display: none;">
        <label for="description1012_images_34c8cc73419393a219a5cb218ebcc4b2" class="detail LanguageSupportLabel">German</label>
        <input type="text" name="description1012_images_34c8cc73419393a219a5cb218ebcc4b2" id="description1012_images_34c8cc73419393a219a5cb218ebcc4b2" value="">
      </div>
    </div>
  </div>
</div>

For each language you'll have a label and input field wrapped inside a div tag. The label is the currently selected language.
If you haven't only the description field, it's important to mark the field with a title. I chose the `<strong>` tag because it looked the best comparing with headlines. I didn't want to add additional css or inline styles. 

This is how it would look using h1-h4. The `h1` looks most similar to the label, but I don't want to use `h1`'s because semantically it doesn't make any sense at all.
One opportunity would be to use a `label` element if it isn't a multilingual site and a `strong` tag if it is one.  What do you think?

2. Wrapping

On 20/02/2017 at 2:42 AM, Robin S said:

Also, I'm not sure about this but it looks like the additional fields markup is not placed inside the "InputfieldImageEdit__additional" wrapper div. Is it meant to be?

You're right, I'll fix it.

3. type="text" vs textarea

At the moment as soon as a textformatter is applied, `type="text"` will be changed to `textarea`. The idea behind this was that some textformatter like "NewLineToBreak" or "NewLineToListItem" doesn't make that much sense applied to an one liner input element. This could be an additional setting, but I'm not quite sure if it's necessary. I tried to keep it as simple as possible 

[justb3a]

Update 2. Wrapping

Thanks! Having a look where this wrapper comes from, I found another hook which fits the module needs much better.

`<div class="InputfieldImageEdit__additional"></div>` is part of the core (wire/modules/Inputfield/InputfieldImage/InputfieldImage.module).

~/Projects/pw/wire
❯ ag __additional
modules/Inputfield/InputfieldImage/InputfieldImage.module
600: <div class='InputfieldImageEdit__additional'>$additional</div>
634: <div class='InputfieldImageEdit__additional'>$additional</div>

Having a further look, `$additional` comes from a hookable method which is just perfect for this module  

$additional = $this->renderAdditionalFields($pagefile, $id, $n);

/**
 * Render any additional fields (for hooks)
 */
protected function ___renderAdditionalFields($pagefile, $id, $n) { }

Using this hook and rewriting a bit, the HTML looks now this way:

<div class="ImageData" style="width: 77%;">
  <h2 class="InputfieldImageEdit__name"><span contenteditable="true">align-left-2x</span>.png</h2>
  <span class="InputfieldImageEdit__info">143 bytes, 44×30 </span>
  <div class="InputfieldImageEdit__errors">..</div>
  <div class="InputfieldImageEdit__buttons">..</div>
  <div class="InputfieldImageEdit__core">..</div>
  <div class="InputfieldImageEdit__additional">
    <div class="InputfieldImageEdit__additional--custom">..</div>
    <div class="InputfieldImageEdit__additional--title">..</div>
    <div class="InputfieldImageEdit__additional--foo">..</div>
    <div class="InputfieldImageEdit__additional--orientation">..</div>
    <div class="InputfieldImageEdit__additional--link">..</div>
  </div>
  <input class="InputfieldFileSort" type="text" name="sort_images_34c8cc73419393a219a5cb218ebcc4b2" value="0">
  <input class="InputfieldFileReplace" type="hidden" name="replace_images_34c8cc73419393a219a5cb218ebcc4b2">
  <input class="InputfieldFileRename" type="hidden" name="rename_images_34c8cc73419393a219a5cb218ebcc4b2">
</div>