Jump to content
horst

Page Image Manipulator 1

Recommended Posts

Horst: Thanks for the very detailed explanation, It is just happening on the last image or two. It must be a PHP memory getting low (shared hosting account). I will use the PNG watermark method instead.  (thanks for the code example).

Update: my shared hosting account on this site is giving me 64mb of RAM memory limit. I think that might be the issue right there. I tried the PNG method of watermarking, but my site still hangs my server or larger batches 20 images@1,000px.

Share this post


Link to post
Share on other sites

 Update: my shared hosting account on this site is giving me 64mb of RAM memory limit. I think that might be the issue right there. I tried the PNG method of watermarking, but my site still hangs my server or larger batches 20 images@1,000px.

Have you tried to increase it in the .htaccess file?

php_value memory_limit 128M
#php_value memory_limit 256M
  • Like 1

Share this post


Link to post
Share on other sites

Still looking for a workaround to my problem. I'm going to try running it on a slightly newer server configuration to see if it helps.

Does anyone know if would it be possible to implement this as a hook when I upload images using a certain field?

Share this post


Link to post
Share on other sites

Hi, horst!

After updating PW to the latest dev yesterday, i've getting this on pimLoad():
 

Fatal error: Exception: You do not have permission to execute this module - ProcessCropImage (in D:\OpenServer\domains\5520.pro\wire\core\Modules.php line 717)
#0 D:\OpenServer\domains\5520.pro\wire\core\Modules.php(668): Modules->getModule('ProcessCropImag...')
#1 D:\OpenServer\domains\5520.pro\site\modules\PageImageManipulator\ImageManipulator.class.php(254): Modules->get('ProcessCropImag...')
#2 D:\OpenServer\domains\5520.pro\site\modules\PageImageManipulator\PageImageManipulator.module(185): ImageManipulator->__construct(Object(Pageimage), Array, false)
#3 D:\OpenServer\domains\5520.pro\wire\core\Wire.php(381): PageImageManipulator->getPageImageManipulator(Object(HookEvent))
#4 D:\OpenServer\domains\5520.pro\wire\core\Wire.php(317): Wire->runHooks('pimLoad', Array)
#5 D:\OpenServer\domains\5520.pro\site\templates\docs-product.php(12): Wire->__call('pimLoad', Array) #6 D:\OpenServer\domains\5520.pro\site\templates\docs-product.php(12): Pageimage->pimLoad('test')
#7 D:\OpenServer\domains\5520.pro\wire\core\TemplateFile in D:\OpenServer\domains\5520.pro\index.php on line 220

any suggestions?

Share this post


Link to post
Share on other sites

Hello everyone,

New to PW and modules etc, so this is a steep learning curve for me at the moment but enjoyable

Using the code below I am getting images to display without problem, now I would like to add a watermark to the images

  • I have installed the PageImageManipulator
  • Have read through the postings on using it but still confused

Is the watermark image stored in the images file or does it have to form part of a template and page?

I have made a template called watermark

  • Should I know make a page called template and upload an image into it?
  • How do I get the watermark to work with the code below

<?php
$images = $page->new_images_field;
foreach($images as $image){

  echo "<img src='{$image->url}' />";
  echo "<br><br><br>";

}

?>

Thank you - Mel

Share this post


Link to post
Share on other sites

@Mel: here is a post that describes how to use a watermark that is uploaded into a single image field (to make an image field a single image field you have to setup the field to only allow 1 file, otherwise, 0 or greater 1 it is a multiple files field): https://processwire.com/talk/topic/4264-release-page-image-manipulator/#entry41883

The general how to you can read in the initial post here in this thread:

* watermarkLogo

watermarkLogo($pngAlphaImage, $position='center', $padding=2)

  • param: $pngAlphaImage - mixed [systemfilepath or PageImageObject] to/from a PNG with transparency
  • param: $position - (string) is one out of: N, E, S, W, C, NE, SE, SW, NW,
    - or: north, east, south, west, center, northeast, southeast, southwest, northwest
    default is 'center'
  • param: $padding - (integer) 0 - 25, default is 5, padding to the borders in percent of the images length!
  • return: pim - (class handle)

You can pass a transparent image with its filename or as a PageImage to the method. If the watermark is bigger than the destination-image, it gets shrinked to fit into the targetimage. If it is a small watermark image you can define the position of it:

The $pngAlphaImage can be a filename (full path and not an url!) or a pageimage.

Example with filename, assumed you have uploaded a png watermark image per FTP to your server into a directory besides wire and site, called "_mystuff":

$png = $_SERVER['DOCUMENT_ROOT'] . '/_mystuff/' . 'basename-of-my-watermark.png';

foreach($images as $image) {
    $watermarked_image = $image->pimLoad('tw', true)->width(500)->watermarkLogo($png, 'southeast', 0)->pimSave();
    echo "<img src='{$watermarked_image->url}' />";
}

An example with png from an imagefield, assumed it is called 'watermarkfield' and is on a page with the name/url '/tools/'. The tools page isn't visible from the frontpage, it is only a page that holds some fields and stuff that I need around the site on different places:

// assumed the watermarkfield is a single image field:
$png = $pages->get('/tools/')->watermarkfield;

// assumed the watermarkfield can have multiple images and I want use the first one:
$png = $pages->get('/tools/')->watermarkfield->first();

foreach($images as $image) {
    $watermarked_image = $image->pimLoad('tw', true)->width(500)->watermarkLogo($png, 'northwest', 0)->pimSave();
    echo "<img src='{$watermarked_image->url}' />";
}

  • Like 3

Share this post


Link to post
Share on other sites

Hello Horst,

Thank you for the instructions on how to use the watermarkLogo it works really well, I used the second example above using the tools page - which also taught me a bit more about how templates and pages interact with each other.

Thanks again - Mel

  • Like 1

Share this post


Link to post
Share on other sites

Hi Horst

Got a little problem.

I have just upgraded my server to apache 2.4 and, more importantly, php 5.5.9

On one dev site I am suddenly getting the following error - it was fine on the old server and older version of php:

Error: Call to undefined function imagecreatefromstring() (line 837 of /home/sanglier/public_html/site/modules/PageImageManipulator/ImageManipulator.class.php) 

What do you reckon?

Share this post


Link to post
Share on other sites

Okay, ignore me....

GD wasn't installed.

Damn, I thought I had done that too.

Share this post


Link to post
Share on other sites

@Joss: you should not use the PHP 5.5.9 - it has a buggy GD-lib, (if has a installed one  :P )

You should use one greater than 5.5.11!

You should run processdiagnostics when starting with new server setups. This one would have told you everything at once.

Edited by horst
  • Like 1

Share this post


Link to post
Share on other sites

Don't even go there!

This is the one that ships with the most recent Ubuntu

Its working now though

  • Like 1

Share this post


Link to post
Share on other sites

I'm trying to use this module to convert a bunch of png files to jpg. It works fine with a handful of images, but then it get's slower and slower. Here is my testing code:

$images = $page->images;

if ($images) {
	foreach ($images as $image) {
		$jpg = $image->pimLoad()->setOutputFormat('jpg')->pimSave();
	}
}

And here are the debug times in seconds - every number at the beginning of the line shows the loop count (it equals the number of images converted):

1: 0.21
2: 0.41
3: 0.67
4: 1.08
5: 1.96
6: 4.42
7: 12.79

In fact it's always the same image with a different name (1.png, 2.png and so on).

Anybody facing the same?

Share this post


Link to post
Share on other sites

Hi horst - great module (I'm a bit late to the party ;)).

Here's an example using Apeisa's Thumbnails module - I had trouble with this because the thumbnail URL is relative to the homepage and therefore doesn't contain the whole server path to load the thumbnail with.

// First we get the thumbnail - replace thumbname with your thumbnail name as set in the Thumbnails module
$relativePath = $page->images->first()->getThumb('thumbname');
 
// Then we add the root path (note: will not work in a subdirectory - not sure about localhost either - you may have to hardcode this bit unless someone has an idea?
$fullPath = $config->paths->root . $relativePath;
 
// Now do your nice manipulations if the image doesn't already exist (we only want to convert it once)
if (!file_exists($fullPath)) {
    $modules->get('PageImageManipulator')->imLoad($fullPath, array('outputFormat'=>'jpg', 'targetFilename' => '$page->images->path . 'test.jpg'))->save();
}
 
echo "<img src='" . $page->images->url . "test.jpg' />

This was typed in the browser and my actual code is for a different scenario so this may require some modification!

EDIT: Of course, once you've generated the file once then you will want to check for that rather than keep recreating the file - modified my example to show this.

EDIT2: It would probably be a good idea if you are using this example to have a module that clears any existing test.jpg files on page save (or image changes but not sure how) for the relevant templates so that if someone changes the image the PIM runs again when the image is next viewed on the site.

  • Like 1

Share this post


Link to post
Share on other sites

Possible bug?

If I use it on a normal PageImage and use the targetFilename option, it creates a new file whenever the code is run, appending _1, _2 etc to the end of the targetFilename. If I run the same code without the targetFilename option it creates the file once and doesn't overwrite or create duplicates.

Basically I want to name my file in a specific way, but I don't want to create it each time or create duplicates - to achieve this I have to use the if (file_exists... code from my example in the previous post but I'm not sure I should need to?

Share this post


Link to post
Share on other sites

@Pete: I'm not sure if I have updated the Pim after that post here: https://processwire.com/talk/topic/4264-release-page-image-manipulator/page-5#entry60648

possibly not. So best you do not pass your options with the class-init but with the ->setOptions($options) method or with individual methods ->setTargetfilename ->setOutputformat,

Can you test it and report back please?

Edited by horst

Share this post


Link to post
Share on other sites

@Pete: regarding your "test.jpg", you only need to build a name that matches the new naming conventions of PW core Pageimage. That way all is fine because PW will do the dishes for you.

It takes care of all image variations belonging to an original image. You only need to tell the system that this is a derivative image. :)

The naming scheme now is aware of suffixes. You simply can use the original filename and add a suffix to it. (in fact it isn't limited to only one suffix, it can have multiple of them). Following the original image is named basename.ext

If you want create one or more derivatives you should go with this scheme:

      basename.-suffix.ext

      basename.-suffix1-suffix2.ext

following i change your above example in a detailed manner:


// define suffix, and fileformat if needed
$suffix = 'yoursuffix';               // allowed are: a-z 0-9 and underscore !! not more!
$ext    = 'png';                      // your desired outputformat

$image = $page->images->first();      // get the image
$info  = pathinfo($image->filename);

$dir   = $info['dirname'];            // dir to the page assets/files/ folder
$name  = $info['filename'];           // basename without extension
$ext   = $info['extension'];          // only if you want use the same fileformat as the original is !!

// build the targetfilename and the URL
$targetFilename = $dir .'/'. $name .'-'. $suffix .'.'. $ext;

$targetURL = dirname($image->url) .'/'. $name .'-'. $suffix .'.'. $ext;

$sourceFilename = $dir .'/'. basename($image->getThumb('thumbname'));

// Now do your nice manipulations if the image doesn't already exist (we only want to convert it once)
if (!file_exists($targetFilename)) {
    $modules->get('PageImageManipulator')->imLoad($sourceFilename)->setOutputFormat($ext)->setTargetFilename($targetFilename)->save();
    // or this way
    $modules->get('PageImageManipulator')->imLoad($sourceFilename)->setOptions(array('outputFormat'=>$ext, 'targetFilename'=>$targetFilename))->save();
}
 
echo "<img src='{$targetURL}' />";

.

.

Additionally, if you use Pia to assist you while developing a site, your code should ask her if you are actually online and like to refresh all images:

// Now do your nice manipulations if the image doesn't already exist or if you (Pete) are actually online, testing something and want force recreate images
if (!file_exists($targetFilename) || true === $config->imageSizerOptions['forceNew']) {
...
I love it when a plan comes together!    a-team-240x300.jpg
 
  • Like 1

Share this post


Link to post
Share on other sites

Hi, horst!

After updating PW to the latest dev yesterday, i've getting this on pimLoad():

Fatal error: Exception: You do not have permission to execute this module - ProcessCropImage (in D:\OpenServer\domains\5520.pro\wire\core\Modules.php line 717)
#0 D:\OpenServer\domains\5520.pro\wire\core\Modules.php(668): Modules->getModule('ProcessCropImag...')
#1 D:\OpenServer\domains\5520.pro\site\modules\PageImageManipulator\ImageManipulator.class.php(254): Modules->get('ProcessCropImag...')
#2 D:\OpenServer\domains\5520.pro\site\modules\PageImageManipulator\PageImageManipulator.module(185): ImageManipulator->__construct(Object(Pageimage), Array, false)
#3 D:\OpenServer\domains\5520.pro\wire\core\Wire.php(381): PageImageManipulator->getPageImageManipulator(Object(HookEvent))
#4 D:\OpenServer\domains\5520.pro\wire\core\Wire.php(317): Wire->runHooks('pimLoad', Array)
#5 D:\OpenServer\domains\5520.pro\site\templates\docs-product.php(12): Wire->__call('pimLoad', Array) #6 D:\OpenServer\domains\5520.pro\site\templates\docs-product.php(12): Pageimage->pimLoad('test')
#7 D:\OpenServer\domains\5520.pro\wire\core\TemplateFile in D:\OpenServer\domains\5520.pro\index.php on line 220

any suggestions?

Horst - I'm experiencing this at the moment and have found the solution.

I think the line in your module here is problematic:

$a = wire('modules')->get('ProcessCropImage')->getModuleInfo();

That line will run fine when you are logged into ProcessWire, but I think it somehow loads into memory the actual page using the ProcessCropImage process module which is only accessible by admins so doesn't work when viewing as a guest (that's the only crazy theory I have for now :)).

It's a tricky issue to track down, but basically replacing that whole block of code with this stops it from happening (essentially turning thumbnail boost off!):

// check if we can be used to boost the thumbnail module, - is it installed?
            if(true === ($this->thumbnailBoost = (bool)wire('modules')->isInstalled('ProcessCropImage'))) {
                // now check that at least the minimum version number of ProcessCropImage is installed:
                $needed = '1.0.2';
                //$a = wire('modules')->get('ProcessCropImage')->getModuleInfo();
                //$actual = preg_replace('/(\d)(?=\d)/', '$1.', str_pad("{$a['version']}", 3, "0", STR_PAD_LEFT));
                //$this->thumbnailBoost = version_compare($actual, $needed, '<') ? false : true;
                $this->thumbnailBoost = false;
            }

Share this post


Link to post
Share on other sites

@Pete: thanks for tracking this down! ^-^

I have updated the module and changed the code by adding a check for the permission 'image-crop' here.

(this needs further investigation, here it is a quick solution to stop the error.)

If you can find some time, would you be so kind and test it if this work at your end?

Edited by horst
removed first post content and wrote something useful

Share this post


Link to post
Share on other sites

Hi.

I've got some problems after creating an PIM image. I'm using PHP 5.5.19 and tried it on the current 2.5.2 and on the latest dev from this morning. Server is lightning.pw, so usual this setup doesn't make any problems. I'm using the default 2.5 image settings in the config.php

Task: First, resize the image to a given width, then grayscale() it and then overlay a transparent gradient.  Afterwards use it on different position in the HTML code. This is my function to create this image variation:

function getBrandImage($image,$width=1080,$prefix='branded') {
	if($image->name != '') {
	
	//$image->pimLoad($prefix)->removePimVariations();
	
	//Path to the overlay png depending on orientation
	$overlay_path = wire('config')->paths->templates . 'assets/overlay-landscape.png';
	
	if($image->width < $image->height) 
		$overlay_path = wire('config')->paths->templates . 'assets/overlay-vertical.png';
	
	//Output
	$o = array('outputFormat'=>'jpg');
	
	// apply it together with other actions
	$result = $image->pimLoad($prefix,true)->setOptions($o)->width($width)->grayscale()->watermarkLogoTiled($overlay_path)->pimSave();	
	
	}
	return $result;
}

It will create an image variation that has the desired effect. But now starts the weird stuff I can't figure out.

1) On my homepage, I'm calling this function with the default width of 1080 and I get back the PageImage. I now pass this PI to a simple function that renders and srcset html output by generating 3 variations of this image with the PW image functions.  This function works when I just pass a regular $page->image->size(120,120) PI object.

//Renders an image as srcset
function renderImage($image,$class='',$sizes='auto',$sets=array(400,767,1080,2120)) {
	$out = '';
	
	if($image->name != '') {
		if($class != '') $class = ' ' . $class;
		
		$o = array( 'upscaling' => true, 'cropping' => true, 'quality' => 40);
		
		//Start
		$out .= "<img src='{$image->width(260,0,$o)->url}' alt='{$image->description}' data-srcset='";
		foreach($sets as $s) {
			$img = $image->size($s,0)->url;
			$out .= "{$img} {$s}w, ";	
		}		
		$out = substr($out,0,-2);
		$out .= "' data-sizes='{$sizes}' class='lazyload{$class}'/>";
	}	

The $image here is the $result from the function above. It will create the first image in srcset (inside the foreach). The other images will output with 0x0 in the filename and are not created. 

2) On another page, where I need smaller images but only in 1 resolution, I'm calling the getBrandImage() function again but this time with width of 400. It will create the image but I think it crashes because the file permissions are set wrong, so the files can only be seen directly on a file level. 

I get the same results when I resize the image before I pass it to PIM or try different combinations.

When I just leave out the PIM stuff and create the image inside PIM with PW (and without the gradient/grayscale) everything works. That why I think this is an issue with PIM but I can't figure out anymore. The errrors.txt file doesn't show anyting. When I turn on debug, those messages appear. They don't appear when I comment out the PIM part.

Warning: imagecreatetruecolor(): Invalid image dimensions in /lightning/version/2.5.10.5/wire/core/ImageSizer.php on line 1417

Warning: imagecopy() expects parameter 1 to be resource, boolean given in /lightning/version/2.5.10.5/wire/core/ImageSizer.php on line 1438

Warning: imageconvolution() expects parameter 1 to be resource, boolean given in /lightning/version/2.5.10.5/wire/core/ImageSizer.php on line 1439

Warning: imagedestroy() expects parameter 1 to be resource, boolean given in /lightning/version/2.5.10.5/wire/core/ImageSizer.php on line 1528

Warning: imagedestroy() expects parameter 1 to be resource, boolean given in /lightning/version/2.5.10.5/wire/core/ImageSizer.php on line 1529

Warning: imagegammacorrect() expects parameter 1 to be resource, boolean given in /lightning/version/2.5.10.5/wire/core/ImageSizer.php on line 1354

Warning: imagejpeg() expects parameter 1 to be resource, boolean given in /lightning/version/2.5.10.5/wire/core/ImageSizer.php on line 429

Sorry for the long report, but just want to make sure that I didn't overlooked something. Help would be appreciated, thanks :)

Share this post


Link to post
Share on other sites

Hi Philipp,

ähm, may I say that this sounds confusing? :)

It will create an image variation that has the desired effect. But now starts the weird stuff I can't figure out.

You only need to double check here if it returns a valid pageimage and has created the derivative file. If both is yes, PiM has done it work successful.

If you further do not call PiM anymore, it has nothing to do with PiM! - Ready!

-------------------------------

Looking at your code:

$out .= "<img src='{$image->width(260,0,$o)->url}'

What is width 260, 0, $o ?

You have done the same things wrong like in earlier posts. Passing a zero as second option to width, what should be an array with options! Ryan has changed pageimage::size to silently fail with this instead of crashing the process. This was a wish by yourself!

Another thing is that you has run into timeouts with imagesizer in the past. I have posted a solution to you and maybe over 10 times more here in the forums: include a set_time_limit() in every loop that calls imagesizer. ( foreach($sets as $s)!

There are two options for the set_time_limit() now: please add it into your loops or only use PW >= 2.5.10 in the future, because PW since 2.5.10 has an own set_time_limit() call in ImageSizer! :)

Share this post


Link to post
Share on other sites

Thanks for the answer. If I replace the single line where I call PIM

$result = $image->pimLoad(....)->pimSave()

with

$result = $image->size(123,123) 

all the following functions and stuff works. Yes, you've found a bug/problem in the rest of my code (thanks), but my question is, why does it totally fail with the PI object from PIM and not with the one from PWire? I rewrite all those image stuff this evening and try again.

I'm using the latest dev build (2.5.10 the latest version on the dev branch as of yesterday 18:00 GMT time) and the time limit is 60 seconds. A try with 120seconds did also fail (with a single image at 2000x1333). Memory limit is 128M.

_

I never requested it fo fail silently. The problem was, that an error a developer could made in the past and that is now fixed, affects all future operations with an image because a half-way created image exists on the file system.

Share this post


Link to post
Share on other sites

Hhm, it wasn't clear to me that you have encountered differences between Pageimages derived from Pageimage or derived from PiM. (or I may have overlooked it in all that examples)
 
I think it would have avoided some confusion if you just have asked / told that the objects behave different, without (partly wrong) code and lots of error messages.
 
You are also speaking about filenames generated with .0x0 in its name.?! Pageimage::size generates the filenames before any manipulatiuon through ImageSizer and only according the passed values for width and height. So, at that point you may check what values you are passing to the functions.

------

But lets focus on that objects thing:

I will try to replicate and compare that. Just to clarify a few things:

  • You have checked that after your PiM call a Pageimage Object is returned?
  • Have you tried it with a PiM that does other manipulations, maybe just pimLoad()->pimSave(). Does it behave the same or is it different?

Pim generates the PageimageObjects this way: https://github.com/horst-n/PageImageManipulator/blob/master/ImageManipulator.class.php#L751
It looks the same like Pageimage::size does it: https://github.com/ryancramerdesign/ProcessWire/blob/dev/wire/core/Pageimage.php#L316

 
So, we need to compare the objects, first try with simple objects that only should differ in the name:

$size = $image->size($image->width, $image->height);

$pim = $image->pimLoad('test')->pimSave();

And then with a manipulated one from your example.

------
 

I never requested it fo fail silently. The problem was, that an error a developer could made in the past and that is now fixed, affects all future operations with an image because a half-way created image exists on the file system.


Ah, ok! Sorry for remember me wrong!

  • Like 1

Share this post


Link to post
Share on other sites

Finally found time so rewrite the thing. In short, it is now working but I can't figure out what didn't work before.

1) My $size was set to 0. This was my mistake. The width() options just ignored the $options array.

2) I manually removed all pages including the image files and re-upload them. This made PIM PageImage objects work as well as the ProcessWire ones.

Sorry, this seems like a fault on my side. PIM works fine once you get the things around right.

  • Like 2

Share this post


Link to post
Share on other sites

Horst, thanks a lot for this wonderful module. It is extremely useful to me and I'm impressed by its complex possibilities!

I've got a question regarding the caching and rendering: While regular images are cached, those images I process using PageImage Manipulator seem to be recreated on every access of the frontend page containing the image.

Is this a desired behaviour, or did I just miss setting the right parameters?

Here's the code used in my template to output an image with added watermark on the website:

        $img = $page->special_image;

        // choose file containing watermark sample
        $watermark = $pages->get("/special/watermark")->images->first();

        // add watermark to image
        $imagewithwatermark = $img->pimLoad('tw',true)->width(800)->watermarkLogoTiled($watermark->filename)->pimSave();

		// output image
        $content .= '<img src="'.$imagewithwatermark->url.'" title="'.$page->title.'" style="height: '.$imagewithwatermark->height.'px; width: '.$imagewithwatermark->width.'px;" /><br />';

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 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
    • By David Karich
      ProcessWire InputfieldRepeaterMatrixDuplicate
      Thanks to the great ProModule "RepeaterMatrix" I have the possibility to create complex repeater items. With it I have created a quite powerful page builder. Many different content modules, with many more possible design options. The RepeaterMatrix module supports the cloning of items, but only within the same page. Now I often have the case that very design-intensive pages and items are created. If you want to use a content module on a different page (e.g. in the same design), you have to rebuild each item manually every time.
      This module extends the commercial ProModule "RepeaterMatrix" by the function to duplicate repeater items from one page to another page. The condition is that the target field is the same matrix field from which the item is duplicated. This module is currently understood as proof of concept. There are a few limitations that need to be considered. The intention of the module is that this functionality is integrated into the core of RepeaterMatrix and does not require an extra module.
      Check out the screencast
      What the module can do
      Duplicate a repeater item from one page to another No matter how complex the item is Full support for file and image fields Multilingual support Support of Min and Max settings Live synchronization of clipboard between multiple browser tabs. Copy an item and simply switch the browser tab to the target page and you will immediately see the past button Support of multiple RepeaterMatrix fields on one page Configurable which roles and fields are excluded Duplicated items are automatically pasted to the end of the target field and set to hidden status so that changes are not directly published Automatic clipboard update when other items are picked Automatically removes old clipboard data if it is not pasted within 6 hours Delete clipboard itself by clicking the selected item again Benefit: unbelievably fast workflow and content replication What the module can't do
      Before an item can be duplicated in its current version, the source page must be saved. This means that if you make changes to an item and copy this, the old saved state will be duplicated Dynamic loading is currently not possible. Means no AJAX. When pasting, the target page is saved completely No support for nested repeater items. Currently only first level items can be duplicated. Means a repeater field in a repeater field cannot be duplicated. Workaround: simply duplicate the parent item Dynamic reloading and adding of repeater items cannot be registered. Several interfaces and events from the core are missing. The initialization occurs only once after the page load event Changelog
      1.0.4
      Bug fix: Various bug fixes and improvements in live synchronization Bug fix: Items are no longer inserted when the normal save button is clicked. Only when the past button is explicitly clicked Feature: Support of multiple repeater fields in one page Feature: Support of repeater Min/Max settings Feature: Configurable roles and fields Enhancement: Improved clipboard management Enhancement: Documentation improvement Enhancement: Corrected few typos #1 1.0.3
      Feature: Live synchronization Enhancement: Load the module only in the backend Enhancement: Documentation improvement 1.0.2
      Bug fix: Various bug fixes and improvements in JS functions Enhancement: Documentation improvement Enhancement: Corrected few typos 1.0.1
      Bug fix: Various bug fixes and improvements in the duplication process 1.0.0
      Initial release Support this module
      If this module is useful for you, I am very thankful for your small donation: Donate 5,- Euro (via PayPal – or an amount of your choice. Thank you!)
      Download this module
      > Github: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate
      > PW module directory: https://modules.processwire.com/modules/inputfield-repeater-matrix-duplicate/
×
×
  • Create New...