Jump to content
horst

Page Image Manipulator 1

Recommended Posts

Wow, good find! ^-^

The ratio is stored as extended info for the image and not used further, so a very good find. (and a very stupid bug, info[2] holds the mimetype  :wacko: )

I will fix this with the next update.

Share this post


Link to post
Share on other sites

Hi Horst, I think I found one more.

PageImageManipulator.module, line 13: $this->optionNames is always NULL, because it doesn't get defined before (the class isn't even included at this point).

In consequence, param 2 and 3 are not working correctly as described here:

pimLoad

pimLoad($prefix, $param2=optional, $param3=optional)

  • param 1: $prefix - (string) = mandatory!
  • param 2: mixed, $forceRecreation or $options
  • param 3: mixed, $forceRecreation or $options

Share this post


Link to post
Share on other sites

Sorry, Horst, I don't want to be pesky, but how does this work:

PageImageManipulator.module, line 142:

if(!in_array(strtolower($outputFormat), array('gif','png','jpg'))) {
	$outputFormat = $p['extension'];
}
$outputFormat = strtolower($outputFormat);
if(empty($targetFilename)) {
	$targetFilename = $p['dirname'] .'/pim_'. $prefix .'_'. $p['filename'] .'.'. $outputFormat;
}

$outputFormat is always NULL, that's how it was defined in line 96.

As a result, $outputFormat is always set to the original extension the image has when it was uploaded. Assuming I'm doing a format conversion (png -> jpg), $targetFilename always points to the wrong extension (png instead of jpg), and this file is non-existant. Meaning: everytime all images are recreated, slowing down the page...

Share this post


Link to post
Share on other sites

titanium, please can you provide the code line for that with pimLoad?

At line 13 there is only comments. Also without need to test, param 2 definitely work, because I often use it to force recreation of a variations. So you cannot be right with this.

Your post regarding outputFormat, have you tested this or do you see this just by reading the code?

Share this post


Link to post
Share on other sites

titanium, please can you provide the code line for that with pimLoad?

Ah sorry, a "1" is missing. It's in line 113.

Regarding the "outputFormat" problem: I noticed that my page was very slow with PageImage Manipulator. I took a closer look and noticed that the image files were created once again every time the page was loaded. After that, I was on a bug hunt...

Share this post


Link to post
Share on other sites

Ok, your first post is wrong, because the second and third param is processed by the function.

But you are right with the post regarding outputFormat. The options passed as 2 or 3 param gets processsed but not assigned to $outputFormat if it is a key in options, and unfortunately $outputFormat overrides $options['outputFormat'] at the end of the function.

It is in the todo now. But as a quick workaround for you, you may completly bypass sending the $options together with pimLoad(). Insteed use it this way:

pimLoad('prefix'[, true | false])->setOptions($options)-> ... ->pimSave();

This works as expected. (I will rewrite the pimLoad to use this internally the same way)

Sorry for the inconvenience.

Share this post


Link to post
Share on other sites

updated to version 0.1.3

  • fixed a bug with ignoring outputFormat when send as $options with method pimLoad found by @titanium
  • added support for php versions with buggy GD-lib for sharpening and unsharpMask
  • added support for the coming module PageimageNamingScheme into pimVariations()
  • Like 2

Share this post


Link to post
Share on other sites

Are there any known limits with this module?

I'm trying to grayscale 10+ images on a single page using $image->first()->width(320)->pimLoad('bw')->grayscale()->pimSave()->url; and it ends up returning the first 9 images correctly, followed by this error:
Error: Maximum execution time of 30 seconds exceeded

This even occurs when the grayscaled images already exist, still getting a timeout. I've resorted to using file_exists() to check for the grayscaled images manually. If they don't it runs the code above, so with a few page refreshes atfer new image uploads I'm able to eventually have all the images converted.

Any suggestions?

Share this post


Link to post
Share on other sites

There are no limits with this module but with your max execution time for PHP.

add one line into your loop like here:

foreach($images as $image) {
    ini_set('max_execution_time', 30);  // this line resets the timer for max_execution_time with every loop.
    // following your code ...

EDIT:

It shouldn't take that long if images are already rendered. Please can you post your code of the loop here?

Edited by horst

Share this post


Link to post
Share on other sites

Sure thing:

<?php foreach ($page->children as $article) {
	$coverimage = $article->cover_image->first()->width(320);
	$bw = $coverimage->pimLoad('bw')->grayscale()->pimSave()->url;
	?>
	<a class="archive-item" href="<?php echo $article->url; ?>">
		<div class="archive-item-img"><img class="archive-item-img-overlay" src="<?php echo $bw; ?>"></div>
		<div class="archive-item-text-container"><div class="archive-item-text">
			<?php
			echo "<div class='archive-item-title'>".$article->title."</div>";
			echo "<div>".$article->contributor->title."</div>";
			?>
		</div></div>
	</a>
<?php } ?>

Share this post


Link to post
Share on other sites

Hhm, you are not looping through images but childpages. You may try to debug the times for the images rendering.

Also you can do the resize to 320 and grayconvert in one step.
 

<?php   
$timerstotal = array();

foreach ($page->children as $article) {
    ini_set('max_execution_time', 30);
    $timers = array();
    $timer = Debug::timer();
    $timers[] = Debug::timer($timer);  // start image rendering
    $bw = $article->cover_image->first()->pimLoad('bw320')->width(320)->grayscale()->pimSave();
    $timers[] = Debug::timer($timer);  // finished image rendering
?>
    <a class="archive-item" href="<?php echo $article->url; ?>">
        <div class="archive-item-img"><img class="archive-item-img-overlay" src="<?php echo $bw->url; ?>"></div>
        <div class="archive-item-text-container"><div class="archive-item-text">
        <?php
            echo "<div class='archive-item-title'>".$article->title."</div>";
            echo "<div>".$article->contributor->title."</div>";
        ?>
        </div></div>
    </a>
<?php 
    $timers[] = Debug::timer($timer);  // none image stuff finished
    $timerstotal[] = $timers;
} 

// output timers
echo "<pre>\n"; // or "<!-- \n" to output it as HTML comment 
var_dump($timerstotal);
echo "\n</pre>"; // or "\n-->\n";
?>

Share this post


Link to post
Share on other sites

Horst,

a very helpful module! Thank you. However, I miss a feature that would be helpful: 

cropFromCenter(width, height); 

- Resizing and cropping in the original aspect ratio 

The image is reduced first to the width or the height. If it does not fit into the new format, the image is automatically cropped from the middle of the image.

Regards,

David

Share this post


Link to post
Share on other sites

@David: this is already supported by the core ImageSizer. You can combine ImageSizer and PiM manipulations in any order you like:

$croppedVariation1 = $image->size($width, $height, array('cropping'=>true))->pimLoad('prefix')->grayscale()->pimSave();
$croppedVariation2 = $image->pimLoad('prefix')->grayscale()->pimSave()->size($width, $height);  // cropping is true by default in $config->imageSizerOptions in site/config.php

If this doesn't suite your needs, report back please.

  • Like 2

Share this post


Link to post
Share on other sites

@David: this is already supported by the core ImageSizer. You can combine ImageSizer and PiM manipulations in any order you like:

$croppedVariation1 = $image->size($width, $height, array('cropping'=>true))->pimLoad('prefix')->grayscale()->pimSave();
$croppedVariation2 = $image->pimLoad('prefix')->grayscale()->pimSave()->size($width, $height);  // cropping is true by default in $config->imageSizerOptions in site/config.php

If this doesn't suite your needs, report back please.

Ah damn. Sorry, my mistake. :)

  • Like 1

Share this post


Link to post
Share on other sites

Hhm, you are not looping through images but childpages. You may try to debug the times for the images rendering.

Also you can do the resize to 320 and grayconvert in one step.

<?php   
$timerstotal = array();

foreach ($page->children as $article) {
    ini_set('max_execution_time', 30);
    $timers = array();
    $timer = Debug::timer();
    $timers[] = Debug::timer($timer);  // start image rendering
    $bw = $article->cover_image->first()->pimLoad('bw320')->width(320)->grayscale()->pimSave();
    $timers[] = Debug::timer($timer);  // finished image rendering
?>
    <a class="archive-item" href="<?php echo $article->url; ?>">
        <div class="archive-item-img"><img class="archive-item-img-overlay" src="<?php echo $bw->url; ?>"></div>
        <div class="archive-item-text-container"><div class="archive-item-text">
        <?php
            echo "<div class='archive-item-title'>".$article->title."</div>";
            echo "<div>".$article->contributor->title."</div>";
        ?>
        </div></div>
    </a>
<?php 
    $timers[] = Debug::timer($timer);  // none image stuff finished
    $timerstotal[] = $timers;
} 

// output timers
echo "<pre>\n"; // or "<!-- \n" to output it as HTML comment 
var_dump($timerstotal);
echo "\n</pre>"; // or "\n-->\n";
?>

Thanks for this horst, if I have more than 9 items in the loop it never actually executes the code which outputs the timings.

Stripped it back to 9 items, this is the output:

array(9) {
  [0]=>
  array(3) {
    [0]=>
    string(6) "0.0001"
    [1]=>
    string(6) "0.0243"
    [2]=>
    string(6) "0.0280"
  }
  [1]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0150"
    [2]=>
    string(6) "0.0172"
  }
  [2]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0250"
    [2]=>
    string(6) "0.0267"
  }
  [3]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0484"
    [2]=>
    string(6) "0.0502"
  }
  [4]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.1159"
    [2]=>
    string(6) "0.1179"
  }
  [5]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.2891"
    [2]=>
    string(6) "0.2927"
  }
  [6]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.8478"
    [2]=>
    string(6) "0.8514"
  }
  [7]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "2.8584"
    [2]=>
    string(6) "2.8602"
  }
  [8]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(7) "10.3439"
    [2]=>
    string(7) "10.3459"
  }
}

Share this post


Link to post
Share on other sites

as you can see all image renderings are less than a second. Only number 7 = nearly 3 seconds and number 8 is more than 10 seconds!

It seems that this is a much to big image, maybe.

Also the ini_set('max_execution_time', 30); seems to be disabled / forbidden on your server.  :(

I would try to get this enabled. Can you ask your hoster about this? Also you can try to use set_time_limit(30) instead first, but I guess this will be disabled too. You should have a look to your phpinfo() under safe_mode and disabled functions.

Second point: do you really need that large images like under #8 that takes 10 seconds for rendering a 320 thumbnail? You can set a max dimension for width and height for the images-field under Setup -> Fields -> yourimagesfield -> Input -> Max Images Dimensions. This will render the uploaded image to these max dimensions (e.g. 1200 or 960 px or what ever you need) and takes this as source for all smaller sizes.

Also it looks that your images don't get cached? Do they get recreated every time you run that script? This is not the normal behave and sounds very strange if so. ??

Share this post


Link to post
Share on other sites

Hi horst, thanks for looking at this so quickly!

The last two images that are taking ~3s and ~10s, the originals are only 450 x 600px (25kb) and 536 x 712px (74kb). They're no bigger than any of the other images, actually quite small compared to some others. Seems strange that each image is taking progressively longer to render?

The process is also still taking this long even though the images aren't being recreated each time, they're all saved in the assets directory and aren't being overwritten as far as I can see.

EDIT: Is this looking like it's something to with my server configuration? This is all happening on my local XAMPP server.

Share this post


Link to post
Share on other sites

Yes, this is looking very weird. If it is on your local server, you can configure php.ini according to my suggestions above, (allowing set_time_limit(), etc). You need to check phpinfo().

Share this post


Link to post
Share on other sites

set_time_limit(300) did it. Could only load two more, but here's the output:

Last image took 158 seconds to render!

 

array(11) {
  [0]=>
  array(3) {
    [0]=>
    string(6) "0.0001"
    [1]=>
    string(6) "0.0880"
    [2]=>
    string(6) "0.0928"
  }
  [1]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0338"
    [2]=>
    string(6) "0.0357"
  }
  [2]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0454"
    [2]=>
    string(6) "0.0477"
  }
  [3]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0879"
    [2]=>
    string(6) "0.0898"
  }
  [4]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.1946"
    [2]=>
    string(6) "0.1964"
  }
  [5]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.4132"
    [2]=>
    string(6) "0.4180"
  }
  [6]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "1.1618"
    [2]=>
    string(6) "1.1657"
  }
  [7]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "3.4625"
    [2]=>
    string(6) "3.4644"
  }
  [8]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(7) "11.8296"
    [2]=>
    string(7) "11.8319"
  }
  [9]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(7) "43.1316"
    [2]=>
    string(7) "43.1335"
  }
  [10]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(8) "158.5707"
    [2]=>
    string(8) "158.5729"
  }
}

Share this post


Link to post
Share on other sites

hhm, but this is not the solution. There must be something completely wrong, because if the images once are rendered, it should only took 0.02 seconds for each image, regardless if it is the first or the 19. ??

Share this post


Link to post
Share on other sites

hi  @horst  :

i want to add a watermark for page image. and use this module then got an error:

Error: Call to a member function pimLoad() on a non-object 

this caused error:

 
$img = $page->images->first();

$wmi = $page->watermark->pimLoad('wmi')->colorize('red')->pimSave();

$imgsrc = $img->pimLoad('tw',true)->width(180)->grayscale()->watermarkLogo($wmi, 'southeast', 0)->pimSave();

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

i use this,its works well, i found the new image be created:

$img = $page->images->first();
$imgsrc = $img->pimLoad('myPrefix')->setOptions($options)->width(300)->pimSave();
echo "<img src='{$imgsrc->url}' /><br />";

Share this post


Link to post
Share on other sites

Hi @leoric,

I assume the error occures on the imagefield named watermark as you can use the pimLoad method with the field named images.

Here are a few questions:

  • Does your template / page have an imagefield with (exactly) that name?
  • Is this imagefield set to accept only a single image?
  • Like 1

Share this post


Link to post
Share on other sites

Hi @leoric,

I assume the error occures on the imagefield named watermark as you can use the pimLoad method with the field named images.

Here are a few questions:

  • Does your template / page have an imagefield with (exactly) that name?
  • Is this imagefield set to accept only a single image?

big help.

@horst, thank you!

Share this post


Link to post
Share on other sites

I was able to reproduce POWERFULHORSE's speed issue.

some images hang for 30-40 seconds on an operation after they have been successfully rendered once.  

PHP: 5.4

PW: 2.4

GD: 2.10 compatible

CODE:
 

foreach ( $albumimages as $albumimage ) 
{
//FAST
$imgSrc = $albumimage->size(1000,600,array('upscaling' => true,'cropping' => false,'quality' => 70))->url;
//Fast with some files, but killer slow with others
$imgSrc =$sized->pimLoad('watermarked')->watermarkText("Gail Gelburd", 20, 'SW', 5, 100, null)->pimSave()->url;
//... 
}

The PIM portion of this operation can hang the the page for many seconds, even after successful rendering of page it does not get any faster on subsequent  page loads.  I can Upload the offending images if that offers any clues as to what can be going on.  If I can offer any additional debug info that might give any helpful clues as to what is going on let me know. Thanks for a great module Horst. 

Share this post


Link to post
Share on other sites

Hi @neeks,
 
at first: I'm not really sure if you have the same effect as powerfulhorse has had, because he has used a loop through childpages and even has had large amount of processing times for cached images?! Doesn't make much sense, hhm?

second: especially the watermarkText method never was meant to be used in bulk rendering. It uses much cpu and memory for calling many memory image copy operations and also inspect images by histograms to autodetect the best used color for the text, etc. So that is a lot of work it does and that is time consuming, - sorry I haven't noted this in the first post here. It was meant for something like showing thumbnails without watermark text on a page and only watermark larger (single) images when requested. Also its text output can be a bit (or very) ugly!?! - If you want add the same text to all images, you should create and use a transparent png with a nice (and maybe smooth) text together with the watermarkLogo method instead.

third: you may use and inspect debug timers with your code. If there are no significant differences with images processed later (comparing to images processed first), everything seems to be ok. If you get significantly larger times only with later processed images in your loop, then this can be due to some (weird?) design in PHP? PiM uses the correct code to release and free memory (pointers) for all objetcs / instances, but the PHP interpreter internally only seems to set this objects to zero but do not really free the memory to the system site. Somewhere I have read about a discussion between the PHP Group and others and "the others" said that the PHP devs have said that it isn't necessary to release / free pointers because all pointers and handles will be released / freed at the end of every request, (because the complete php instance is closed / released then). I haven't investigated further on this, and maybe I have overlooked to release some objects. I will take a closer look to it when finding time for it. But don't expect it in the near future.

---

On the other hand do I use the watermarkLogo method within a loop on a gallery site where it sometimes create 100+ watermarked image variations [2] at first call of an album page without any drawbacks:

$gallery = "<div id='myGallery'>\n";
if(count($page->images)>0) {
    // display imageThumbs
    $num = -1;
    foreach($page->images as $image) {
[1]     set_time_limit(5);
        $imageName = pathinfo($image->name,PATHINFO_FILENAME);
        $imageDescription = strlen(trim($image->description))>0 ? ', ' . preg_replace('/[^0-9a-zA-ZöüäÖÜÄß -]/msi', '', trim($image->description)) : '';
        $num++;
[2]     $gallery .= "\t<a id='uid$num' rel='nofollow' title='{$imageName}{$imageDescription}' href='{$image->pimLoad('full',false)->watermarkLogo($wmPng)->pimSave()->url}'> </a>\n";
        ...
        ...
    }
}
$gallery .= "</div>\n";
set_time_limit(20);

All source images are max 1000 px and as you can see in the loop I use a time_limit of max 5 seconds [1] per loop.

  • Like 4

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 picarica
      so i am trying to put CustomHooksForVariations.module, a custom module, i am placing it into site/modules direcotry yet my modules page in admin panel gives me errors
      so this is the screen show when i refresh modules, i dont know why the shole hook is written on top of the page :||

      and this next image is when i try to install it, i saw that it is not defiuned modules.php but it shouldnt need to be ?, any ways i dont want to edit site's core just to make one moulde work there has to be a way

    • 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 multible repeater items 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 Configurable dialogs for copy and paste 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
      2.0.0
      Feature: Copy multiple items at once! The fundament for copying multiple items was created by @Autofahrn - THX! Feature: Optionally you can disable the copy and/or paste dialog Bug fix: A fix suggestion when additional and normal repeater fields are present was contributed by @joshua - THX! 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 (Version 2.0.0)
      > Github: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate
      > PW module directory: https://modules.processwire.com/modules/inputfield-repeater-matrix-duplicate/
      > Old stable version (1.0.4): https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate/releases/tag/1.0.4
    • By Robin S
      A new module that hasn't had a lot of testing yet. Please do your own testing before deploying on any production website.
      Custom Paths
      Allows any page to have a custom path/URL.
      Note: Custom Paths is incompatible with the core LanguageSupportPageNames module. I have no experience working with LanguageSupportPageNames or multi-language sites in general so I'm not in a position to work out if a fix is possible. If anyone with multi-language experience can contribute a fix it would be much appreciated!
      Screenshot

      Usage
      The module creates a field named custom_path on install. Add the custom_path field to the template of any page you want to set a custom path for. Whatever path is entered into this field determines the path and URL of the page ($page->path and $page->url). Page numbers and URL segments are supported if these are enabled for the template, and previous custom paths are managed by PagePathHistory if that module is installed.
      The custom_path field appears on the Settings tab in Page Edit by default but there is an option in the module configuration to disable this if you want to position the field among the other template fields.
      If the custom_path field is populated for a page it should be a path that is relative to the site root and that starts with a forward slash. The module prevents the same custom path being set for more than one page.
      The custom_path value takes precedence over any ProcessWire path. You can even override the Home page by setting a custom path of "/" for a page.
      It is highly recommended to set access controls on the custom_path field so that only privileged roles can edit it: superuser-only is recommended.
      It is up to the user to set and maintain suitable custom paths for any pages where the module is in use. Make sure your custom paths are compatible with ProcessWire's $config and .htaccess settings, and if you are basing the custom path on the names of parent pages you will probably want to have a strategy for updating custom paths if parent pages are renamed or moved.
      Example hooks to Pages::saveReady
      You might want to use a Pages::saveReady hook to automatically set the custom path for some pages. Below are a couple of examples.
      1. In this example the start of the custom path is fixed but the end of the path will update dynamically according to the name of the page:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'my_template') { $page->custom_path = "/some-custom/path-segments/$page->name/"; } }); 2. The Custom Paths module adds a new Page::realPath method/property that can be used to get the "real" ProcessWire path to a page that might have a custom path set. In this example the custom path for news items is derived from the real ProcessWire path but a parent named "news-items" is removed:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'news_item') { $page->custom_path = str_replace('/news-items/', '/', $page->realPath); } }); Caveats
      The custom paths will be used automatically for links created in CKEditor fields, but if you have the "link abstraction" option enabled for CKEditor fields (Details > Markup/HTML (Content Type) > HTML Options) then you will see notices from MarkupQA warning you that it is unable to resolve the links.
      Installation
      Install the Custom Paths module.
      Uninstallation
      The custom_path field is not automatically deleted when the module is uninstalled. You can delete it manually if the field is no longer needed.
       
      https://github.com/Toutouwai/CustomPaths
      https://modules.processwire.com/modules/custom-paths/
    • By teppo
      Hey folks!
      I'm happy to finally introduce a project I've been working on for quite a while now: it's called Wireframe, and it is an output framework for ProcessWire.
      Note that I'm posting this in the module development area, maily because this project is still in rather early stage. I've built a couple of sites with it myself, and parts of the codebase have been powering some pretty big and complex sites for many years now, but this should still be considered a soft launch 🙂
      --
      Long story short, Wireframe is a module that provides the "backbone" for building sites (and apps) with ProcessWire using an MVC (or perhaps MVVM... one of those three or four letter acronyms anyway) inspired methodology. You could say that it's an output strategy, but I prefer the term "output framework", since in my mind the word "strategy" means something less tangible. A way of doing things, rather than a tool that actually does things.
      Wireframe (the module) provides a basic implementation for some familiar MVC concepts, such as Controllers and a View layer – the latter of which consists of layouts, partials, and template-specific views. There's no "model" layer, since in this context ProcessWire is the model. As a module Wireframe is actually quite simple – not even nearly the biggest one I've built – but there's still quite a bit of stuff to "get", so I've put together a demo & documentation site for it at https://wireframe-framework.com/.
      In addition to the core module, I'm also working on a couple of site profiles based on it. My current idea is actually to keep the module very light-weight, and implement most of the "opinionated" stuff in site profiles and/or companion modules. For an example MarkupMenu (which I released a while ago) was developed as one of those "companion modules" when I needed a menu module to use on the site profiles.
      Currently there are two public site profiles based on Wireframe:
      site-wireframe-docs is the demo&docs site mentioned above, just with placeholder content replaced with placeholder content. It's not a particularly complex site, but I believe it's still a pretty nice way to dig into the Wireframe module. site-wireframe-boilerplate is a boilerplate (or starter) site profile based on the docs site. This is still very much a work in progress, but essentially I'm trying to build a flexible yet full-featured starter profile you can just grab and start building upon. There will be a proper build process for resources, it will include most of the basic features one tends to need from site to site, etc. --
      Requirements and getting started:
      Wireframe can be installed just like any ProcessWire module. Just clone or download it to your site/modules/ directory and install. It doesn't, though, do a whole lot of stuff on itself – please check out the documentation site for a step-by-step guide on setting up the directory structure, adding the "bootstrap file", etc. You may find it easier to install one of the site profiles mentioned above, but note that this process involves the use of Composer. In the case of the site profiles you can install ProcessWire as usual and download or clone the site profile directory into your setup, but after that you should run "composer install" to get all the dependencies – including the Wireframe module – in place. Hard requirements for Wireframe are ProcessWire 3.0.112 and PHP 7.1+. The codebase is authored with current PHP versions in mind, and while running it on 7.0 may be possible, anything below that definitely won't work. A feature I added just today to the Wireframe module is that in case ProcessWire has write access to your site/templates/ directory, you can use the module settings screen to create the expected directories automatically. Currently that's all, and the module won't – for an example – create Controllers or layouts for you, so you should check out the site profiles for examples on these. (I'm probably going to include some additional helper features in the near future.)
      --
      This project is loosely based on an earlier project called pw-mvc, i.e. the main concepts (such as Controllers and the View layer) are very similar. That being said, Wireframe is a major upgrade in terms of both functionality and architecture: namespaces and autoloader support are now baked in, the codebase requires PHP 7, Controllers are classes extending \Wireframe\Controller (instead of regular "flat" PHP files), implementation based on a module instead of a collection of drop-in files, etc.
      While Wireframe is indeed still in a relatively early stage (0.3.0 was launched today, in case version numbers matter) for the most part I'm happy with the way it works, and likely won't change it too drastically anytime soon – so feel free to give it a try, and if you do, please let me know how it went. I will continue building upon this project, and I am also constantly working on various side projects, such as the site profiles and a few unannounced helper modules.
      I should probably add that while Wireframe is not hard to use, it is more geared towards those interested in "software development" type methodology. With future updates to the module, the site profiles, and the docs I hope to lower the learning curve, but certain level of "developer focus" will remain. Although of course the optimal outcome would be if I could use this project to lure more folks towards that end of the spectrum... 🙂
      --
      Please let me know what you think – and thanks in advance!
    • 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. There are 4 different view modes.
      View mode "Day" 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. View mode "Month" shows the total of all visitors per day from the first to the last day of the selected month. View mode "Year" shows the total of all visitors per month from the first to the last month of the selected year. View mode "Total" shows the total of all visitors per year for all recorded years. Please note that multiple visits from the same IP address within the selected period are counted as a single visitor.
      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.
      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 (-).
       
×
×
  • Create New...