Jump to content
horst

Page Image Manipulator | API for 1 & 2

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

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no Javascript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode.

      Detailed records
      View mode "Detailed records" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).

      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
    • By Mike Rockett
      TextformatterTypographer
      A ProcessWire wrapper for the awesome PHP Typography class, originally authored by KINGdesk LLC and enhanced by Peter Putzer in wp-Typography. Like Smartypants, it supercharges text fields with enhanced typography and typesetting, such as smart quotations, hyphenation in 59 languages, ellipses, copyright-, trade-, and service-marks, math symbols, and more.
      It's based on the PHP-Typography library found over at wp-Typography, which is more frequently updated and feature rich that its original by KINGdesk LLC.
      The module itself is fully configurable. I haven't done extensive testing, but there is nothing complex about this, and so I only envisage a typographical bug here and there, if any.
    • By robert
      I often had the need for an overview of all used fields and their contents for a specific page/template while developing new websites without switching to the backend, so I made a small module which lists all the needed information in a readable manner (at least for me):
      Debug Page Fields
      https://github.com/robertweiss/ProcessDebugPageFields
      It adds two new properties to all pages:
      $page->debugFieldValues – returns an object with all (sub-)fields, their labels, fieldtypes and values $page->debugFieldTypes – returns an object with all fieldtypes and their corresponding fields // List all values of a pages $page->debugFieldValues // List a specific field $page->debugFieldValues->fieldname // List all used fieldtypes of a page $page->debugFieldTypes I recommend using it in combination with Tracy Debugger, Ray, Xdebug etc. as it returns an object and is only meant for developing/debugging uses. 
      For now, the fieldtype support includes mostly fieldtypes I use in my projects, but can easily be extended by adding a new FieldtypeFIELDNAME method to the module. I use it with five different client installations (all PW 3.0.*), but of course there might be some (or more) field configurations which are not covered correctly yet.
      Supported fieldtypes
      Button Checkbox Color Combo Datetime Email FieldsetPage * File FontIconPicker Functional Image ImageReference MapMarker Multiplier Mystique Options Page PageIDs PageTitle Radio Repeater * RepeaterMatrix * RockAwesome SeoMaestro Table Text Textarea Textareas Toggle URL * The fields with complete subfield-support also list their corresponding subfields.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. As this is my first ›public‹ module, I hope I did not miss any important things to mention here.
    • 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.6.0
      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 Cybermano
      Food Allergens Module
      A simple List of Food Allergens
      My needs were to provide a simple list of food allergens for our clients with restaurant related activity.
      The idea was to simply output the list (to speed up the data entry) without leaving the food menu editing, eg. opening another page in new tab or window.
      This isn't a perfect solution, but it works fine for my needs and I decided to share the base idea.
      This could also be easily used to show little notes or short "vademecum", not only for the list of food allergens.
      ---
      Main features
      The basis
      All moves from a short editing of the module in this tutorial: How to create custom admin pages by @bernhard
      First of all it creates an empty admin page, with a dedicated permission to let safe-user to see it (this permission has to be created as a new ones, manually or by the module).
      Once the page is created, I have hooked its behaviour into the ready.php, to show the content (basically a list).
      A step further
      With the tips of  @bernhard, @Soma (and many others), see here , the magic happens. 
      The new page will be shown as a panel, so editors will not abandon their data entry to have a quick view to the list.
      A little further
      Why scroll to the top of the page to click a link?
      The next step was to create a sticky button only in the food menu pages.
      Again with a @bernhard tip I moved into the customization of this simple module and the related hook.
      ---
      How to use this module
      After installed, it creates the page /admin/page/allergens/ and the module is to be setted up. The first field is a CKEditor with multi-language. This is the place where to write the informations that will be shown into the page. The next field is a simply text-area where to place a bit of JS that will be appended to the markup of the text (omit the 'script' tags). I also putted a checkbox with a silly statement: this to think at least twice on the safety of the written JS. Now comes the first way to display the link to the page
      Field Note with Link. Enable and save it. The module will display a new row with 4 selects (1 standard and 3 ASM):
      View mode (to show the page as Panel or as Modal PopUp); Templates to select: select one or more and save before proceed, so the  asm-select of the pages will be populated showing all the pages of the selected templates. Pages to select: also here select at least one and save before proceed to populate the asm-select for fields only with the ones that belong to the selected pages. Select the fields where to place the note and save again. That's all: now you will find into the notes of the selected fields the link "See the List of Allergens".
      At the same way, the option for the sticky button, but with a plus
      The field select is obviously unnecessary, but you could play with the last row: the inline styles to fix your sticky button where you like. Here you could set the sticky position of the <div> and the absolute ones of the <a>.

      Video Explanation
      In these screencasts you could see a custom JS that show a "copy" button near a "hanna-code" call.
      This because I've set a specific one for each allergen to show up a tooltip in the front end.

      Registrazione #33.mp4  

      Registrazione #34.mp4 ---
      Last but not the least
      Actually it works fine for my needs, even if it's much improvable: I'm working on the permissions creation, the uninstall section, a separate configs and defaults and how to include the hook into the module leaving free the ready.php. According to a simpler uninstall. Also I would make the link text as a dynamic text field, so it will be more flexible.
      I always learn a lot here, so I would share my code for whom it could be interested.
      I removed the hanna code references, but I provide you the html list of the allergens, English and Italian too, so you can paste them into the "source" of the CKEditor field to have a ready to use module.
      Obviously you are free to modify the code as per your needs.
      Please, keep in mind that I'm not a pro coder and I beg your pardon for my verbosity (speaking and coding). 😉
      I hope be helpful or for inspiration.
      Bye
      ready.phpList-ITA.htmlList-ENG.htmlAllergens.module
      README.md
×
×
  • Create New...