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

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By adrian
      Tracy Debugger for ProcessWire
      The ultimate “swiss army knife” debugging and development tool for the ProcessWire CMF/CMS

       
      Integrates and extends Nette's Tracy debugging tool and adds 35+ custom tools designed for effective ProcessWire debugging and lightning fast development
      The most comprehensive set of instructions and examples is available at: https://adrianbj.github.io/TracyDebugger
      Modules Directory: http://modules.processwire.com/modules/tracy-debugger/
      Github: https://github.com/adrianbj/TracyDebugger
      A big thanks to @tpr for introducing me to Tracy and for the idea for this module and for significant feedback, testing, and feature suggestions.
    • By adrian
      This module allows you to automatically rename file (including image) uploads according to a configurable format
      This module lets you define as many rules as you need to determine how uploaded files will be named and you can have different rules for different pages, templates, fields, and file extensions, or one rule for all uploads. Renaming works for files uploaded via the admin interface and also via the API, including images added from remote URLs.   Github: https://github.com/adrianbj/CustomUploadNames
      Modules Directory: http://modules.processwire.com/modules/process-custom-upload-names/
      Renaming Rules
      The module config allows you to set an unlimited number of Rename Rules. You can define rules to specific fields, templates, pages, and file extensions. If a rule option is left blank, the rule with be applied to all fields/templates/pages/extensions. Leave Filename Format blank to prevent renaming for a specific field/template/page combo, overriding a more general rule. Rules are processed in order, so put more specific rules before more general ones. You can drag to change the order of rules as needed. The following variables can be used in the filename format: $page, $template, $field, and $file. For some of these (eg. $field->description), if they haven't been filled out and saved prior to uploading the image, renaming won't occur on upload, but will happen on page save (could be an issue if image has already been inserted into RTE/HTML field before page save). Some examples: $page->title mysite-{$template->name}-images $field->label $file->description {$page->name}-{$file->filesize}-kb prefix-[Y-m-d_H-i-s]-suffix (anything inside square brackets is is considered to be a PHP date format for the current date/time) randstring[n] (where n is the number of characters you want in the string) ### (custom number mask, eg. 001 if more than one image with same name on a page. This is an enhanced version of the automatic addition of numbers if required) If 'Rename on Save' is checked files will be renamed again each time a page is saved (admin or front-end via API). WARNING: this setting will break any direct links to the old filename, which is particularly relevant for images inserted into RTE/HTML fields. The Filename Format can be defined using plain text and PW $page variable, for example: mysite-{$page->path} You can preserve the uploaded filename for certain rules. This will allow you to set a general renaming rule for your entire site, but then add a rule for a specific page/template/field that does not rename the uploaded file. Just simply build the rule, but leave the Filename Format field empty. You can specify an optional character limit (to nearest whole word) for the length of the filename - useful if you are using $page->path, $path->name etc and have very long page names - eg. news articles, publication titles etc. NOTE - if you are using ProcessWire's webp features, be sure to use the useSrcExt because if you have jpg and png files on the same page and your rename rules result in the same name, you need to maintain the src extension so they are kept as separate files.
      $config->webpOptions = array(     'useSrcExt' => false, // Use source file extension in webp filename? (file.jpg.webp rather than file.webp) ); Acknowledgments
      The module config settings make use of code from Pete's EmailToPage module and the renaming function is based on this code from Ryan: http://processwire.com/talk/topic/3299-ability-to-define-convention-for-image-and-file-upload-names/?p=32623 (also see this post for his thoughts on file renaming and why it is the lazy way out - worth a read before deciding to use this module). 
       
       
      NOTE:
      This should not be needed on most sites, but I work with lots of sites that host PDFs and photos/vectors that are available for download and I have always renamed the files on upload because clients will often upload files with horrible meaningless filenames like:
      Final ReportV6 web version for John Feb 23.PDF

    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.56
      Composer: rockett/jumplinks
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! :)
×
×
  • Create New...