Jump to content
justb3a

Module: Image Extra

Recommended Posts

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.

Share this post


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

  • Like 1

Share this post


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

Share this post


Link to post
Share on other sites

@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!

  • Like 1

Share this post


Link to post
Share on other sites

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

  • Like 2

Share this post


Link to post
Share on other sites

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!

Share this post


Link to post
Share on other sites

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);

 

  • Like 4

Share this post


Link to post
Share on other sites

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!

 

Share this post


Link to post
Share on other sites

This works pretty straight forward :)

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

 

  • Like 3

Share this post


Link to post
Share on other sites

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. 

Share this post


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

 

Share this post


Link to post
Share on other sites

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. 

Share this post


Link to post
Share on other sites

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

Sélection_149.png

Share this post


Link to post
Share on other sites

@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! :)

  • Like 1

Share this post


Link to post
Share on other sites

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

Share this post


Link to post
Share on other sites
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. 
 [...]
 */

 

  • Like 1

Share this post


Link to post
Share on other sites

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:

2017-02-20_143813.png.c5f07fd895566bb2a39bfbc7b74d06e2.png

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?

2017-02-20_143858.png.5041cf6212c38bf8d9d9b230ccdda54d.png

 

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?

Share this post


Link to post
Share on other sites

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> ";

 

Share this post


Link to post
Share on other sites
42 minutes ago, Jon E said:

image field extender module

Which module is this?

Share this post


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

 

Share this post


Link to post
Share on other sites

@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. 

labels.png.5c7a8252bbc150caa21595cfea168bfc.png

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 ^_^

  • Like 2

Share this post


Link to post
Share on other sites

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>

 

  • Like 2

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 bernhard
      --- Please use RockFinder3 ---
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      Since 0.0.4, instructions and changelog can be found in the README only. You can find it here  🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github, thanks!
    • By MoritzLost
      Sorry for the convoluted title. I have a problem with Process modules that define a custom page using the page key through getModuleInfo (as demonstrated in this excellent tutorial by @bernhard). Those pages are created automatically when the module is installed. The problem is that the title of the page only gets set in the current language. That's not a problem if the current language (language of the superuser who is installing the module) is the default language; if it isn't, the Process page is missing a title in the default language. This has the very awkward effect that a user using the backend in the default language (or any other language) will see an empty entry in the setup menu:

      This screenshot comes from my Cache Control module which includes a Process page. Now I realize the description sounds obscure, but for us it's a common setup: We a multiple bilingual sites where the default language is German and the second language is English. While the clients use the CMS in German, as a developer I prefer the English interface, so whenever I install a Process module I get this problem.
      As a module author, is there a way to handle this situation? I guess it would be possible to use post-installation hooks or create the pages manually, but I very much prefer the declarative approach. The page title is already translatable (through the __ function), but of course at the time of installation there is no translation, and as far as I'm aware it's not possible to ship translations with a module so they are used automatically. Could this situation be handled better in the core? I would prefer if the module installation process would always set the title of the Process page in the default language, instead of the language of the current user.
×
×
  • Create New...