Jump to content
horst

Croppable Image 3

Recommended Posts

3 hours ago, horst said:

@PWaddict

I may seem a little impatient now, but I still don't understand what you want after all your posts. Please just write down 2 or three variation names where I can see what is and what should be. Otherwise I cannot deal with it any further. (I have three deadlines this week!)

Ok on the Crop Settings of a "Croppable Image 3" field I have "thumbnail,1200,600" so when I upload an image to that field I'm getting the following files inside site/assets/files folder:

myimage.jpg (original)
myimage.0x260.jpg (original variation)

myimage.-thumbnail.jpg (crop)
myimage.-thumbnail.0x48n.jpg (crop variation)

All I want is the cropped images with the ".-thumbnail" to include a timestamp of their modification time (mtime) so the site/assets/files folder should contain ONLY the following files:

myimage.jpg (original)
myimage.0x260.jpg (original variation)

myimage.-thumbnail-1543078585.jpg (crop)
myimage.-thumbnail-1543078585.0x48n.jpg (crop variation)

Everytime the crop is modified the timestamp on the filename should renamed with the new one.

I hope you understand now.

Share this post


Link to post
Share on other sites

If you want to cache-busting the image, you may add the following to ready.php

$wire->addHookAfter('Pagefile::url', 'addTimeStamp');
$wire->addHookAfter('Pagefile::httpUrl', 'addTimeStamp');

function addTimeStamp($event){
	if($event->page->template == 'admin') return;

	$modified = $event->object->modified;
	$event->return = $event->return . "?v=$modified";

}

 

Share this post


Link to post
Share on other sites
56 minutes ago, Karl_T said:

If you want to cache-busting the image, you may add the following to ready.php

Query strings are no longer work on Facebook. Page url or filename must be renamed in order for Facebook to fetch the new image.

Share this post


Link to post
Share on other sites

@horst problem solved on renaming images by using "Custom Upload Names" module which does really good job with timestamps and also giving automatically better names in general.

Now about "Croppable Image 3" module today I noticed a "hidden" error on the cropping page if you have debug mode on and the image is inside repeater:

Quote

Notice: Only variables should be passed by reference in C:\xampp\htdocs\mysite\site\modules\CroppableImage3\ProcessCroppableImage3\ProcessCroppableImage3.module on line 67

Here is the screenshot with the "hidden" error:

issue.thumb.jpg.de2bd63ade54c0dcc48874f7d18f1b4d.jpg

  • Like 1

Share this post


Link to post
Share on other sites

@PWaddict

Good to hear that you solved together with adrian the timestamp issue, and thanks for reporting the Notice.
Please can you try if the following code solves it?
 

// replace the old lines 66 - 69 with this lines:
66        if(preg_match("/_repeater[0-9]+$/", $field)) {
67            $explodeArray = explode("_repeater", $field); 
68            $pages_id = intval(end($explodeArray));
69            $field = str_replace("_repeater{$pages_id}", '', $field);
70        } else {

 

Share this post


Link to post
Share on other sites
2 hours ago, horst said:

@PWaddict

Good to hear that you solved together with adrian the timestamp issue, and thanks for reporting the Notice.
Please can you try if the following code solves it?
 


// replace the old lines 66 - 69 with this lines:
66        if(preg_match("/_repeater[0-9]+$/", $field)) {
67            $explodeArray = explode("_repeater", $field); 
68            $pages_id = intval(end($explodeArray));
69            $field = str_replace("_repeater{$pages_id}", '', $field);
70        } else {

 

I'm getting "The process returned no content." with the error:

Quote

Notice: Undefined variable: fieldName in C:\xampp\htdocs\mysite\site\modules\CroppableImage3\ProcessCroppableImage3\ProcessCroppableImage3.module on line 99

 

  • Like 1

Share this post


Link to post
Share on other sites

Ok thanks for trying. It was a shot into the blue. I will setup a repeater field locally and debug it. (Maybe tomorrow) 

  • Like 1

Share this post


Link to post
Share on other sites

Hello, 

I have problem with this plugin. I did every step in intro (new filed with Croppable3, field assigned to template project, 4 crop settings with no template restrictions). When I try it on frontend I got

"Exception: There is no crop setting for the template 'project' called 'portrait'"

When I debug $inputFieldInstance->cropSetting on 202line of plugin, I got NULL. What is more interesting, in admin section debug outputs right settings (landscape,900,600 portrait .. etc). I am really desperate, maybe I am missing something? 

ProcessWire 3.0.62 - it's existing project..

I will grateful for any help! Thanks in advance 🙂

Share this post


Link to post
Share on other sites

Have you done a quick test with adding the templatename to the portrait-cropsetting? Does this behave different?

portrait,300,500,project

?

Share this post


Link to post
Share on other sites

I installed Croppable Image 3 yesterday and am currently trying to configure and install it in the template.

I have just on the page where directly the images are deposited this message.

Fatal error: Uncaught Error: Call to a member function getCrop() on boolean in /home/frawanbd/estate.frawal.net/site/templates/_main.php:92 Stack trace: #0 /home/frawanbd/estate.frawal.net/wire/core/TemplateFile.php(297): require() #1 /home/frawanbd/estate.frawal.net/wire/core/Wire.php(380): ProcessWire\TemplateFile->___render() #2 /home/frawanbd/estate.frawal.net/wire/core/WireHooks.php(723): ProcessWire\Wire->_callMethod('___render', Array) #3 /home/frawanbd/estate.frawal.net/wire/core/Wire.php(442): ProcessWire\WireHooks->runHooks(Object(ProcessWire\TemplateFile), 'render', Array) #4 /home/frawanbd/estate.frawal.net/wire/modules/PageRender.module(514): ProcessWire\Wire->__call('render', Array) #5 /home/frawanbd/estate.frawal.net/wire/core/Wire.php(383): ProcessWire\PageRender->___renderPage(Object(ProcessWire\HookEvent)) #6 /home/frawanbd/estate.frawal.net/wire/core/WireHooks.php(723): ProcessWire\Wire->_callMethod('___renderPage', Array) #7 /home/frawanbd/estate.frawal.net/wire/core/Wire.php(442): ProcessWire\WireHook in /home/frawanbd/estate.frawal.net/site/templates/_main.php on line 92

Schwerwiegender Fehler: Uncaught Error: Call to a member function getCrop() on boolean in /home/frawanbd/estate.frawal.net/site/templates/_main.php:92
Stack trace:
#0 /home/frawanbd/estate.frawal.net/wire/core/TemplateFile.php(297): require()
#1 /home/frawanbd/estate.frawal.net/wire/core/Wire.php(380): ProcessWire\TemplateFile->___render()
#2 /home/frawanbd/estate.frawal.net/wire/core/WireHooks.php(723): ProcessWire\Wire->_callMethod('___render', Array)
#3 /home/frawanbd/estate.frawal.net/wire/core/Wire.php(442): ProcessWire\WireHooks->runHooks(Object(ProcessWire\TemplateFile), 'render', Array)
#4 /home/frawanbd/estate.frawal.net/wire/modules/PageRender.module(514): ProcessWire\Wire->__call('render', Array)
#5 /home/frawanbd/estate.frawal.net/wire/core/Wire.php(383): ProcessWire\PageRender->___renderPage(Object(ProcessWire\HookEvent))
#6 /home/frawanbd/estate.frawal.net/wire/core/WireHooks.php(723): ProcessWire\Wire->_callMethod('___renderPage', Array)
#7 /home/frawanbd/estate.frawal.net/wire/core/Wire.php(442): ProcessWire\WireHook (Zeile 92 in /home/frawanbd/estate.frawal.net/site/templates/_main.php)

Diese Fehlermeldung wurde angezeigt wegen: Site ist im Debug-Modus. ($config->debug = true; => /site/config.php). Fehler wurde protokolliert.

On the start page I tried to install the pictures and there comes this message

Fehler: Exception: There is no crop setting for the template 'home' called 'square' (in /home/frawanbd/estate.frawal.net/site/modules/CroppableImage3/FieldtypeCroppableImage3/FieldtypeCroppableImage3.module line 209)

#0 /home/frawanbd/estate.frawal.net/wire/core/WireHooks.php(822): ProcessWire\FieldtypeCroppableImage3->getCrop(Object(ProcessWire\HookEvent))
#1 /home/frawanbd/estate.frawal.net/wire/core/Wire.php(442): ProcessWire\WireHooks->runHooks(Object(ProcessWire\Pageimage), 'getCrop', Array)
#2 /home/frawanbd/estate.frawal.net/site/templates/_main.php(92): ProcessWire\Wire->__call('getCrop', Array)
#3 /home/frawanbd/estate.frawal.net/wire/core/TemplateFile.php(297): require('/home/frawanbd/...')
#4 /home/frawanbd/estate.frawal.net/wire/core/Wire.php(380): ProcessWire\TemplateFile->___render()
#5 /home/frawanbd/estate.frawal.net/wire/core/WireHooks.php(723): ProcessWire\Wire->_callMethod('___render', Array)
#6 /home/frawanbd/estate.frawal.net/wire/core/Wire.php(442): ProcessWire\WireHooks->ru

Diese Fehlermeldung wurde angezeigt wegen: Site ist im Debug-Modus. ($config->debug = true; => /site/config.php). Fehler wurde protokolliert.

I currently have only one _main.php and I have taken the code from EXAMPLE there.

 

					<div class="gallery">
						<?php
							// get the first image instance of crop setting 'portrait'
							$image = $page->images->first()->getCrop('square');
							echo "<img src='{$image->url}' alt='{$image->description}' />";
						?>
					</div>

Config from Fieldtype:
image.png.e49efb23694a7a81041600ce190fcaf2.png

Share this post


Link to post
Share on other sites
3 hours ago, csaeum said:

Call to a member function getCrop() on boolean

in

3 hours ago, csaeum said:

/site/templates/_main.php:92

Here you call it on a var that is not a pageimage but a boolean! First check if you REALLY have an image, before you call ->getCrop() on it.

 

And which PW version and module version you are using?

Share this post


Link to post
Share on other sites

ProcessWire Core (Master)     ProcessWire master     3.0.123
Croppable Image 3 (Wrapper-Module)     CroppableImage3     1.1.16

Ok my mistake is solved.

My CPI3 Field was gallery and not images, this was the standard field in the PW demo

 

  • Like 1

Share this post


Link to post
Share on other sites

@horst, as mentioned here, it looks like your module is not compatible with the new WebP support added in 3.0.132. Or am I doing it wrong?

Share this post


Link to post
Share on other sites

When I try it, I get something like: 

Notice: Undefined index: _width in \wire\core\Pageimage.php on line 1936

Notice: Undefined index: _height in \wire\core\Pageimage.php on line 1937

These are the new additions from Ryan that I'm currently have not checked how it works, but definetly, if width and height isn't known, the engines cannot create a new variation.
I get this for image objects derived from CAI3 and with the original image too!

Possibly a bug in the new pageimage additions, or a different use case that currently is not covered.

  • Like 1

Share this post


Link to post
Share on other sites
Posted (edited)

Here is a first try with webp support: github webp-dev

!! ATTENTION: DO NOT USE ON PRODUCTION SITES !!

Maybe the cleaning up for unused variations is broken now. Haven't tested!

Also the naming scheme of CAI3->getCrop("suffix") has changed from 
    basename.-suffix.ext
to 
    basename.{width}x{height}-suffix.ext

Would be fine if some of you have time to test and report back in regard of:

  • removing no longer used variations,
  • changing values of already defined crop settings, (and if previously used variations get deleted, etc)
  • ...

Currently there has to be defined true in site/config.php for $config->imageSizerOptions("webpAdd", true);

Then you can use it like with core images:

    $image = $page->images->first->getCrop("suffix");
    echo "<img src='{$image->url}' /> <img src='{$image->webp->url}' />";

 

Edited by horst

Share this post


Link to post
Share on other sites

Hi!

I have an issue when I upload an image into the field. This is one of the log messages ("matalampi" is the crop setting😞

/../site/assets/files/1328/testiimagenodashes-1.-matalampi.0x48.jpg
- Unable to copy /../site/assets/files/1328/testiimagenodashes-1.-matalampi.jpg
=> /../site/assets/cache/WireTempDir/.PFM0.06231100T1568804893RIbnRkmpEmZApFan/0/testiimagenodashes-1.-matalampi.0x48.jpg

Same error comes from all variations.

Apparently the field tries to create file variations from the image immediately after upload, but for some reason it doesn't work and a corrupted file is created. This becomes a problem when I try to check if there exists a cropped version of the image: It thinks that there is one, but since it's corrupted, image doesn't show in site.

Is there a way to prevent variations being created before user actually crops the image?

var_dump of image, if it helps anything ("matalampi", "korkeampi" and "normaali" are crop settings😞

object(ProcessWire\Pageimage)#370 (13) {
	["url"]=> string(71) "/../site/assets/files/1448/img.-normaali.jpg"
	["filename"]=> string(100) "/../site/assets/files/1448/img.-normaali.jpg"
	["filesize"]=> bool(false)
	["description"]=> string(0) ""
	["tags"]=> string(0) ""
	["created"]=> string(18) "17.9.2019 14:09:57"
	["modified"]=> string(18) "17.9.2019 14:09:57"
	["filemtime"]=> string(17) "1.1.1970 02:00:00"
	["width"]=> int(0)
	["height"]=> int(0)
	["suffix"]=> string(0) ""
	["original"]=> string(34) "img.jpg"
	["variations"]=> array(5) { 
		[0]=> string(40) "img.0x260.jpg"
		[1]=> string(50) "img.-matalampi.0x48.jpg"
		[2]=> string(50) "img.-korkeampi.0x48.jpg"
		[3]=> string(50) "img.-normaali.670x0.jpg"
		[4]=> string(49) "img.-normaali.0x48.jpg" 
	}
}

"filemtime" looks kinda fishy: Does it affect anything?

Edit: Aaand as soon as I decided to ask this, it seems that the issue was that my crop setting names had capital letters! So heads up for that to others as well 😄

  • Like 2

Share this post


Link to post
Share on other sites
7 hours ago, iipa said:

Edit: Aaand as soon as I decided to ask this, it seems that the issue was that my crop setting names had capital letters! So heads up for that to others as well 😄

Hi @iipa, after (re)naming the cropsettings lowercase [a-z0-9], the issue is gone, or not?

Share this post


Link to post
Share on other sites
On 9/18/2019 at 9:52 PM, horst said:

Hi @iipa, after (re)naming the cropsettings lowercase [a-z0-9], the issue is gone, or not?

Yes, issue is gone now 🙂

  • Like 1

Share this post


Link to post
Share on other sites

Couple of other questions though:

1. If I have multiple cropping options (normal, higher, lower height), how can I easily control which crop setting should be used? Since it does all crops when uploading the image, I can't simply check if a crop version exists. Also what if I want to use the original image instead of crop versions, how can I select that?

2. Translation file lacks a few fields from the modal: "ESC" and cropped image parameters (imgUrl, suffix, width x height, quality, sharpening). Also cropped image modal title "Save" can't be translated.

Otherwise great module! 🙂

 

 

  • Like 1

Share this post


Link to post
Share on other sites
9 hours ago, iipa said:

If I have multiple cropping options (normal, higher, lower height), how can I easily control which crop setting should be used? Since it does all crops when uploading the image, I can't simply check if a crop version exists.

I don't understand what's the question means ?? When you upload an image to a field with 3 defined crop settings, there will be created 3 default crops. So there ever is a crop present, but not a manually user defined one. ??

 

9 hours ago, iipa said:

Also what if I want to use the original image instead of crop versions, how can I select that?

You can do everything with it what you can do with the regular pw core imagefield. (The CropabbleImge is an extended PW core imagefield)

$image->url;
$image->width(500)->url;
$image->size(300, 400, ['sharpening' => 'medium', 'quality' => 85])->url;

 

9 hours ago, iipa said:

Translation file lacks a few fields from the modal: "ESC" and cropped image parameters (imgUrl, suffix, width x height, quality, sharpening). Also cropped image modal title "Save" can't be translated.

Thanks for pointing me to this!

Share this post


Link to post
Share on other sites
10 hours ago, horst said:

I don't understand what's the question means ?? When you upload an image to a field with 3 defined crop settings, there will be created 3 default crops. So there ever is a crop present, but not a manually user defined one. ??

Yes, there will always be default crops. Problem is that I don't need to use all of them, just one.

I'll try to explain better:

1. User uploads an image.
2. If user thinks the image is good as it is, render the uncropped version.
3. If user wants to crop the image, user selects which crop setting they want to use, and then render that crop version.

Problem is how can I detect which version should I use? I can't check if a version exists, since they always do.

Share this post


Link to post
Share on other sites
7 hours ago, iipa said:

Yes, there will always be default crops. Problem is that I don't need to use all of them, just one.

I'll try to explain better:

1. User uploads an image.
2. If user thinks the image is good as it is, render the uncropped version.
3. If user wants to crop the image, user selects which crop setting they want to use, and then render that crop version.

Problem is how can I detect which version should I use? I can't check if a version exists, since they always do.

Ah ok. There is no build in solution for this. You have to build something yourself. For example, if there is currently no use of tags, (or an expandable usage of tags), with this imagefield, you may setup tags with predefined values, so that the user can select one if he like to. If this is not possible due to restricted other usage of tags, it may become very uncomfortable, as there are currently no other fields bundled together with an image (besides description and tags). I'm not sure if the imageextra module from justb3a is uptodate with the current devstate (?), If so, and if tags are no option, this would be the way to go.

  • Thanks 1

Share this post


Link to post
Share on other sites
On 9/24/2019 at 7:38 PM, horst said:

Ah ok. There is no build in solution for this. You have to build something yourself. For example, if there is currently no use of tags, (or an expandable usage of tags), with this imagefield, you may setup tags with predefined values, so that the user can select one if he like to. If this is not possible due to restricted other usage of tags, it may become very uncomfortable, as there are currently no other fields bundled together with an image (besides description and tags). I'm not sure if the imageextra module from justb3a is uptodate with the current devstate (?), If so, and if tags are no option, this would be the way to go.

Actually I came to a pretty handy solution with my co-dev! Images have information about their modification time saved within them, so using that I came up with following code:

$img = $page->image;

// check if image exists
if($img) {
	// fetch cropped images' modification timestamps
  	$tsNormal = filemtime($img->getCrop('normaali')->filename);
  	$tsHigh = filemtime($img->getCrop('korkeampi')->filename);
  	$tsLow = filemtime($img->getCrop('matalampi')->filename);
  	// check if they have the same modification time => user hasn't cropped the image, so use the original
	if(!($tsNormal == $tsHigh && $tsNormal == $tsLow)) {
		// stamps are not equal => check which is highest aka last modified
  		switch(max($tsNormal, $tsHigh, $tsLow)) {
  			case $tsNormal:
  				$img = $img->getCrop('normaali');
  				break;
  			case $tsHigh:
  				$img = $img->getCrop('korkeampi');
  				break;
  			case $tsLow:
  				$img = $img->getCrop('matalampi');
  				break;
  		}
  	} 
}

Seems to work quite nicely for my purpose 🙂Thought it would be nice to share, if anybody else wants to achieve similar effect!

  • Like 4
  • Thanks 1

Share this post


Link to post
Share on other sites

After updating PW 3 to 1.4.1 today (PHP 7.3) I got fatal errors and had to rollback.

Compile Error:
Cannot make non static method ProcessWire\FieldtypeFile::getModuleConfigInputfields() static in class ProcessWire\FieldtypeCroppableImage3 (line 4 of //site/modules/CroppableImage3/FieldtypeCroppableImage3/FieldtypeCroppableImage3.module)

Anyone else with this problem?

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 Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-11-15 2019-10-18 2019-08-08 2019-06-15 2019-06-02 2019-05-25 If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




    • By Robin S
      I have had this module sitting in a 95% complete state for a while now and have finally made the push to get it out there. Thanks to @teppo for his Hanna Code Helper module which I referred to and borrowed from during development.
      http://modules.processwire.com/modules/hanna-code-dialog/
      https://github.com/Toutouwai/HannaCodeDialog
      HannaCodeDialog
      Provides a number of enhancements for working with Hanna Code tags in CKEditor. The main enhancement is that Hanna tags in a CKEditor field may be double-clicked to edit their attributes using core ProcessWire inputfields in a modal dialog.
      Requires the Hanna Code module and >= ProcessWire v3.0.0.
      Installation
      Install the HannaCodeDialog module using any of the normal methods.
      For any CKEditor field where you want the "Insert Hanna tag" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "HannaDropdown" to the "CKEditor Toolbar" settings field.
      Module configuration
      Visit the module configuration screen to set any of the following:
      Exclude prefix: Hanna tags named with this prefix will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Exclude Hanna tags: Hanna tags selected here will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Background colour of tag widgets: you can customise the background colour used for Hanna tags in CKEditor if you like. Dialog width: in pixels Dialog height: in pixels Features
      Insert tag from toolbar dropdown menu
      Place the cursor in the CKEditor window where you want to insert your Hanna tag, then select the tag from the "Insert Hanna tag" dropdown.

      Advanced: if you want to control which tags appear in the dropdown on particular pages or templates you can hook HannaCodeDialog::getDropdownTags. See the forum support thread for examples .
      Edit tag attributes in modal dialog
      Insert a tag using the dropdown or double-click an existing tag in the CKEditor window to edit the tag attributes in a modal dialog.

      Tags are widgets
      Hanna tags that have been inserted in a CKEditor window are "widgets" - they have a background colour for easy identification, are protected from accidental editing, and can be moved within the text by drag-and-drop.

      Options for tag attributes may be defined
      You can define options for a tag attribute so that editors must choose an option rather than type text. This is useful for when only certain strings are valid for an attribute and also has the benefit of avoiding typos.
      Add a new attribute for the Hanna tag, named the same as the existing attribute you want to add options for, followed by "__options". The options themselves are defined as a string, using a pipe character as a delimiter between options. Example for an existing attribute named "vegetables":
      vegetables__options=Spinach|Pumpkin|Celery|Tomato|Brussels Sprout|Potato You can define a default for an attribute as normal. Use a pipe delimiter if defining multiple options as the default, for example:
      vegetables=Tomato|Potato Dynamic options
      Besides defining static options as above, you can use one Hanna tag to dynamically generate options for another. For instance, you could create a Hanna tag that generates options based on images that have been uploaded to the page, or the titles of children of the page.
      Your Hanna tag that generates the options should echo a string of options delimited by pipe characters (i.e. the same format as a static options string).
      You will probably want to name the Hanna tag that generates the options so that it starts with an underscore (or whatever prefix you have configured as the "exclude" prefix in the module config), to avoid it appearing as an insertable tag in the HannaCodeDialog dropdown menu.
      Example for an existing attribute named "image":
      image__options=[[_images_on_page]] And the code for the _images_on_page tag:
      <?php $image_names = array(); $image_fields = $page->fields->find('type=FieldtypeImage')->explode('name'); foreach($image_fields as $image_field) { $image_names = array_unique( array_merge($image_names, $page->$image_field->explode('name') ) ); } echo implode('|', $image_names); Choice of inputfield for attribute
      You can choose the inputfield that is used for an attribute in the dialog.
      For text attributes the supported inputfields are text (this is the default inputfield for text attributes so it isn't necessary to specify it if you want it) and textarea. Note: any manual line breaks inside a textarea are removed because these will break the CKEditor tag widget.
      Inputfields that support the selection of a single option are select (this is the default inputfield for attributes with options so it isn't necessary to specify it if you want it) and radios.
      Inputfields that support the selection of multiple options are selectmultiple, asmselect and checkboxes.
      You can also specify a checkbox inputfield - this is not for attributes with defined options but will limit an attribute to an integer value of 1 or 0.
      The names of the inputfield types are case-insensitive.
      Example for an existing attribute named "vegetables":
      vegetables__type=asmselect Descriptions and notes for inputfields
      You can add a description or notes to an attribute and these will be displayed in the dialog.
      Example for an existing attribute named "vegetables":
      vegetables__description=Please select vegetables for your soup. vegetables__notes=Pumpkin and celery is a delicious combination. Notes
      When creating or editing a Hanna tag you can view a basic cheatsheet outlining the HannaCodeDialog features relating to attributes below the "Attributes" config inputfield.
      Advanced
      Define or manipulate options in a hook
      You can hook HannaCodeDialog::prepareOptions to define or manipulate options for a Hanna tag attribute. Your Hanna tag must include a someattribute__options attribute in order for the hook to fire. The prepareOptions method receives the following arguments that can be used in your hook:
      options_string Any existing string of options you have set for the attribute attribute_name The name of the attribute the options are for tag_name The name of the Hanna tag page The page being edited If you hook after HannaCodeDialog::prepareOptions then your hook should set $event->return to an array of option values, or an associative array in the form of $value => $label.
      Build entire dialog form in a hook
      You can hook after HannaCodeDialog::buildForm to add inputfields to the dialog form. You can define options for the inputfields when you add them. Using a hook like this can be useful if you prefer to configure inputfield type/options/descriptions/notes in your IDE rather than as extra attributes in the Hanna tag settings. It's also useful if you want to use inputfield settings such as showIf.
      When you add the inputfields you must set both the name and the id of the inputfield to match the attribute name.
      You only need to set an inputfield value in the hook if you want to force the value - otherwise the current values from the tag are automatically applied.
      To use this hook you only have to define the essential attributes (the "fields" for the tag) in the Hanna Code settings and then all the other inputfield settings can be set in the hook.
      Example buildForm() hook
      The Hanna Code attributes defined for tag "meal" (a default value is defined for "vegetables"):
      vegetables=Carrot meat cooking_style comments The hook code in /site/ready.php:
      $wire->addHookAfter('HannaCodeDialog::buildForm', function(HookEvent $event) { // The Hanna tag that is being opened in the dialog $tag_name = $event->arguments(0); // Other arguments if you need them /* @var Page $edited_page */ $edited_page = $event->arguments(1); // The page open in Page Edit $current_attributes = $event->arguments(2); // The current attribute values $default_attributes = $event->arguments(3); // The default attribute values // The form rendered in the dialog /* @var InputfieldForm $form */ $form = $event->return; if($tag_name === 'meal') { $modules = $event->wire('modules'); /* @var InputfieldCheckboxes $f */ $f = $modules->InputfieldCheckboxes; $f->name = 'vegetables'; // Set name to match attribute $f->id = 'vegetables'; // Set id to match attribute $f->label = 'Vegetables'; $f->description = 'Please select some vegetables.'; $f->notes = "If you don't eat your vegetables you can't have any pudding."; $f->addOptions(['Carrot', 'Cabbage', 'Celery'], false); $form->add($f); /* @var InputfieldRadios $f */ $f = $modules->InputfieldRadios; $f->name = 'meat'; $f->id = 'meat'; $f->label = 'Meat'; $f->addOptions(['Pork', 'Beef', 'Chicken', 'Lamb'], false); $form->add($f); /* @var InputfieldSelect $f */ $f = $modules->InputfieldSelect; $f->name = 'cooking_style'; $f->id = 'cooking_style'; $f->label = 'How would you like it cooked?'; $f->addOptions(['Fried', 'Boiled', 'Baked'], false); $form->add($f); /* @var InputfieldText $f */ $f = $modules->InputfieldText; $f->name = 'comments'; $f->id = 'comments'; $f->label = 'Comments for the chef'; $f->showIf = 'cooking_style=Fried'; $form->add($f); } }); Troubleshooting
      HannaCodeDialog includes and automatically loads the third-party CKEditor plugins Line Utilities and Widget. If you have added these plugins to your CKEditor field already for some purpose and experience problems with HannaCodeDialog try deactivating those plugins from the CKEditor field settings.
    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
       
      Here are Ryans announcement.



      Current Version 0.4.2
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.


      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
       
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; }  
      A MORE ADVANCED DEBUG METHOD!
      You can add some debug code into a template file and call a page with it:
      $to = array('me@example.com'); $subject = 'Wiremail-SMTP Test ' . date('H:i:s') . ' äöü ÄÖÜ ß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; } else { $mail->from = '--INSERT YOUR SENDER ADDRESS HERE --'; // <--- !!!! $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body("Titel\n\ntext text TEXT text text\n"); $mail->bodyHTML("<h1>Titel</h1><p>text text <strong>TEXT</strong> text text</p>"); $dump = $mail->debugSend(1); } So, in short, instead of using $mail->send(), use $mail->debugSend(1) to get output on a frontend testpage.
      The output is PRE formatted and contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection, like this one:
       
      Following are a ...


      List of all options and features


      testConnection () - returns true on success, false on failures


      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)


      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

       
      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here


      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification


      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename


      send () - send the message(s) and return number of successful sent messages


      debugSend(1) - returns and / or outputs a (pre formatted) dump that contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection. (See above the example code under ADVANCED DEBUG METHOD for further instructions!)


      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,


      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
       
       
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
       
       
    • By Robin S
      Sanitizer EasySlugger
      Allows the use of the EasySlugger library as Sanitizer methods.
      Installation
      Install the Sanitizer EasySlugger module.
      Usage
      The module adds four new sanitizer methods.
      slugger($string, $options)
      Similar to $sanitizer->pageName() - I'm not sure if there are any advantages over that method. Included because it is one of the methods offered by EasySlugger.
      $slug = $sanitizer->slugger('Lorem Ipsum'); // Result: lorem-ipsum utf8Slugger($string, $options)
      Creates slugs from non-latin alphabets.
      $slug = $sanitizer->utf8Slugger('这个用汉语怎么说'); // Result: zhe-ge-yong-han-yu-zen-me-shuo seoSlugger($string, $options)
      Augments the string before turning it into a slug. The conversions are related to numbers, currencies, email addresses and other common symbols.
      $slug = $sanitizer->seoSlugger('The price is $5.99'); // Result: the-price-is-5-dollars-99-cents See the EasySlugger readme for some more examples.
      seoUtf8Slugger($string, $options)
      A combination of utf8Slugger() and seoSlugger().
      $slug = $sanitizer->seoUtf8Slugger('价钱是 $5.99'); // Result: jia-qian-shi-5-dollars-99-cents $options argument
      Each of the methods can take an $options array as a second argument.
      separator (string): the character that separates words in the slug. Default: - unique (bool): Determines whether a random suffix is added at the end of the slug. Default: false $slug = $sanitizer->utf8Slugger('这个用汉语怎么说', ['separator' => '_', 'unique' => true]); // Result: zhe_ge_yong_han_yu_zen_me_shuo_3ad66c4  
      https://github.com/Toutouwai/SanitizerEasySlugger
      https://modules.processwire.com/modules/sanitizer-easy-slugger/
    • By Robin S
      If you've ever needed to insert links to a large number of files within CKEditor you may have found that the standard PW link modal is a somewhat slow way to do it.
      This module provides a quicker way to insert links to files on the page being edited. You can insert a link to an individual file, or insert an unordered list of links to all files on the page with a single click.
      CKEditor Link Files
      Adds a menu to CKEditor to allow the quick insertion of links to files on the page being edited.

      Features
      Hover a menu item to see the "Description" of the corresponding file (if present). Click a menu item to insert a link to the corresponding file at the current cursor position. The filename is used as the link text. If you Alt-click a menu item the file description is used as the link text (with fallback to filename if no description entered). If text is currently selected in the editor then the selected text is used as the link text. Click "* Insert links to all files *" to insert an unordered list of links to all files on the page. Also works with the Alt-click option. Menu is built via AJAX so newly uploaded files are included in the menu without the page needing to be saved. However, descriptions are not available for newly uploaded files until the page is saved. There is an option in the module config to include files from Repeater fields in the edited page. Nested Repeater fields (files inside a Repeater inside another Repeater) are not supported. Installation
      Install the CKEditor Link Files module.
      For any CKEditor field where you want the "Insert link to file" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "LinkFilesMenu" to the "CKEditor Toolbar" settings field.
       
      http://modules.processwire.com/modules/cke-link-files/
      https://github.com/Toutouwai/CkeLinkFiles
×
×
  • Create New...