kongondo

Module: RuntimeMarkup Fieldtype & Inputfield

Recommended Posts

@Juergen I have used this module with ProcessWire's translation capabilities with no problems!

And actually, forgot to mention that on my previous post. Once upon a time, a client wanted to control the contrast of their b&w converted image, so with the help of @horst 's PIM 2 module and RuntimeMarkup I was able to quickly setup a "thumb preview and edit" button. All buttons and text were in spanish and english.

Screen Shot 2017-02-10 at 6.31.19 PM.png

  • Like 6

Share this post


Link to post
Share on other sites

Is there a reason ProcessWire would be stripping a <form> html element when embedding code through this module?

Share this post


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

Is there a reason ProcessWire would be stripping a <form> html element when embedding code through this module?

i guess the browser strips your form because it is inside the processwire form that contains all the inputfields and a form inside another form is not valid html. the inspector shows you the code after browser and javascript manipulations. if you view the raw sourcecode you maybe see your form element.

http://stackoverflow.com/questions/555928/is-it-valid-to-have-a-html-form-inside-another-html-form

  • Like 2

Share this post


Link to post
Share on other sites

hi @kongondo

what do you think of adding a feature that the field loads files with the same filename automatically when they exist?

for example a field "runtime_demo" would load /somefolder/runtime_demo.php and /somefolder/runtime_demo.js

i do it manually right now. for sure no problem but i think that would help to keep everything clear if you are using custom markup a lot :)

 

edit: is there a reason why my file is loaded 3 times when using wirerenderfile? if i only put

bd('test!');

into the file, then i see it 3 times in the tracy log. i setup a datatable with my module and loaded the code in the runtime markup field. i had my columns 3 times. i fixed it with an if-statement, but still i would be interested why the file is called 3 times...

Share this post


Link to post
Share on other sites
On 2017-3-27 at 10:08 AM, bernhard said:

what do you think of adding a feature that the field loads files with the same filename automatically when they exist?

Hi @bernhard,

I'll have a think. If you have the time, could you please add this as a feature request in the project page? Thanks.

Share this post


Link to post
Share on other sites

Hi @kongondo

Very Nice Module you have created here! I have a question, would it be possible to use this module inside the Formbuilder somehow. Is it even supported by the Formbuilder?

Greetings

Nukro

Share this post


Link to post
Share on other sites
12 hours ago, Nukro said:

Very Nice Module you have created here! I have a question, would it be possible to use this module inside the Formbuilder somehow. Is it even supported by the Formbuilder?

Glad the module is of use to you. Unfortunately, I have never had the need to use Formbuilder. Maybe you could try and let us know? Thanks.

Share this post


Link to post
Share on other sites
On 27.3.2017 at 11:08 AM, bernhard said:

hi @kongondo

what do you think of adding a feature that the field loads files with the same filename automatically when they exist?

for example a field "runtime_demo" would load /somefolder/runtime_demo.php and /somefolder/runtime_demo.js

i do it manually right now. for sure no problem but i think that would help to keep everything clear if you are using custom markup a lot :)

would you mind adding my suggested features to your module?

sorry for not making a PR, but you can just replace your render method with this one:

    /**
     * Render the entire markup returned from FieldtypeRuntimeMarkup
     *
     */
    public function ___render() {

        //so that $page and $pages are locally scoped to the eval
        $process = $this->wire('process'); 
        if($process && $process->className() == 'ProcessPageEdit') $page = $process->getPage();

        $pages = $this->wire('pages');

        // render files that are related to this field
        $root = rtrim($this->wire->config->paths->root,'/');
        $file = '/site/modules/FieldtypeRuntimeMarkup/fields/' . $this->name;
        if(is_file($root.$file.'.php')) {
            // we found a file in the modules /fields folder, so render it
            $str = wireRenderFile($root.$file);
        }
        else {
            // no early reaturn because we load assets later
            if(!$this->runtimeFields) $str = '';
            else $str = eval($this->runtimeFields);
        }

        // load assets related to this field
        if(is_file($root.$file.'.js')) $this->wire->config->scripts->add($file.'.js');
        if(is_file($root.$file.'.css')) $this->wire->config->styles->add($file.'.css');

        //since we are dealing with custom PHP code but also want to make sure that only markup is returned
        //if eval() returns anything other than a string or an integer, we throw an error (e.g. if an object or array is returned)
        if (is_string($str) || is_int($str)) return $str;
        else return $this->error($this->_('Only strings and integers should be returned by your custom code! Check if your code is valid.'));
    }

this will render all files inside the folder

/site/modules/FieldtypeRuntimeMarkup/
- your_field_name.php | .css | .js

  • Like 2

Share this post


Link to post
Share on other sites
On 3.7.2017 at 10:44 PM, kongondo said:

Glad the module is of use to you. Unfortunately, I have never had the need to use Formbuilder. Maybe you could try and let us know? Thanks.

I had tried and it looks like it's not supported. There is no Detail Tab / Textarea or something where you can add the PHP Code. I came up with a workaround using InputfieldMarkup and Hanna Code Tags. But still, thank you for your Support @kongondo.

Greetings Nukro

Share this post


Link to post
Share on other sites
On 2017-7-6 at 8:05 AM, Nukro said:

I had tried and it looks like it's not supported.

Thanks for reporting back...

Share this post


Link to post
Share on other sites

hi @kongondo 

did you think about my suggested new render method?

another thing that would be good imho is to mention in the docs / in the first posting that you can do this

return ProcessWire\wireRenderFile('fields/myfieldsphpfile.php', ['page' => $page]);

To have the currently edited page available in your file. It's very basic, but might help some beginners.

I would also suggest to update my render-method passing the $page and $pages variables to the renderfile:

// change this
$str = wireRenderFile($root.$file);

// to that
$str = wireRenderFile($root.$file, [
  'page' => $page,
  'pages' => $pages,
]);

what do you think?

  • Like 2

Share this post


Link to post
Share on other sites

Hi @bernhard. Sorry been caught up in other stuff. I will implement your suggestion, albeit slightly differently.  Thanks for the docs suggestions as well.

  • Like 2

Share this post


Link to post
Share on other sites

Update: Runtime Markup Version 0.0.3.

Changelog

  1. Added support to render PHP, JavaScript and CSS files Thanks to @bernhard for the ideas.

Please note:

  • Please read the notes that accompany the field settings.
  • For PHP, you can choose to render files (recommended) vs paste code.
  • JavaScript and CSS work with either PHP rendering method (above). These are optional to use.
  • For each of the 3 file types above, if you only have one file and this is named identical to your field, you can select an option to have those rendered/added. For example, if you have a RuntimeMarkup field called 'my_field', you can have a 'my_field.php', 'my_field.js' and 'my_field.css' automatically rendered/added.
  • However, if you want to render multiple files and/or these are named differently, select the option that indicates the files have different names. In that case, enter comma-separated file names. For example, for CSS: my_css, styles/my-other-css-file. Using this option, you can include external JavaScript libraries for use on your page if you fancied it.
  • The above can be mixed and matched, e.g. PHP file could have name identical to field but JavaScript are multiple files with different names and CSS multiple file names, one of which could share a name with your field.
  • All files must descend from either of the root paths /site/templates/ or /site/modules/. It is OK for files to be in sub-folders, as long as those descend from one of these root paths. There is a setting to indicate root path. Only one root path can be used at a time, i.e. it applies to all file types.
  • .php, .js and .css extensions are assumed and do not need to be specified with the file names. PHP files such as .inc will need to be input as such, e.g. my_code.inc,includes/my-more-code.tpl.
  • Errors will be shown if files not found.
  • In your rendered PHP file, you have access to $page and $pages. This means you do not need to get the page being edited first to use it as the current page.
  • For frontend, only pasted PHP code option is supported. My take is that this module is primarily used for the backend. Use of the render files option is geared for creating complex and/or more flexible backend apps as opposed to frontend usage. I have no intention of changing this behaviour.

Currently available on dev branch only. Please test and let me know (with Listers, etc as well, thanks).

Screenshots

Backend Settings

rm-backend-settings-1-version-003.thumb.png.3abb7b941574a1f0f844cacf27da779f.pngrm-backend-settings-2-version-003.thumb.png.1b3a213250984b10d7964e65c8e0408d.pngrm-backend-settings-3-version-003.thumb.png.27c35c5ce4b4b68c1946d1623079de36.png

Backend Output

rm-backend-output-version-003.thumb.png.9b16110fb57039545acf3134cd8079d1.png

Edited by kongondo
more info
  • Like 3

Share this post


Link to post
Share on other sites

hi @kongondo 

I just tried the dev version and have 2 questions:

  • what is the reason for specifying the root path as /templates or /modules ? Why not a folder inside the RuntimeMarkup's module folder? like /FieldtypeRuntimeMarkup/fields ? Ok, i can specify an alternate filename, but imho that is an unnecessary step and it would be preferable to have this at least as an option. I try to keep the templates' and modules' root folders as clean as possible...
  • Second thing that i find more annoying than helping is the js and css file include warnings / settings. Why do i have to select if there is a js/css file present? Why does it not include a js/css file automatically if one is present. Imagine you are working on a runtime field and want to do some minor css changes. you are in your IDE and you would just have to create a new css file with the name of your field. But as it is now, i would also have to change the field's settings. Thats some more extra clicks that i don't understand why they are necessary if my proposed render method did not have this drawbacks.

maybe there is a reason for that and i would be happy to hear it :)

thanks for bringing my ideas into your module though!

Share this post


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

what is the reason for specifying the root path as /templates or /modules ?

Added security...similar to wireRenderFile().

7 hours ago, bernhard said:

Why not a folder inside the RuntimeMarkup's module folder? like /FieldtypeRuntimeMarkup/fields ? Ok, i can specify an alternate filename

Yes you can specify a filename :). FieldtypeRuntimeMarkup/fields/my-file. 

7 hours ago, bernhard said:

it would be preferable to have this at least as an option.

OK. I'll add that as a third option (or as the first option).

 

7 hours ago, bernhard said:

I try to keep the templates' and modules' root folders as clean as possible

Sure. But some people may prefer to create include folders in /site/templates/ and /site/modules/ that are shared across the site. Adding a third option above should cater for both worlds.

7 hours ago, bernhard said:

Why do i have to select if there is a js/css file present?

We can't assume everyone will want to include a JS/CSS file :).

 

7 hours ago, bernhard said:

Why does it not include a js/css file automatically if one is present.

I don't like automating things TBH. I prefer for users to expressly declare a choice.

 

7 hours ago, bernhard said:

Imagine you are working on a runtime field and want to do some minor css changes. you are in your IDE and you would just have to create a new css file with the name of your field.

OK. Imagine you are working on a runtime field and want to do some 'minor' JS changes. You are in your IDE and you would just have to create a new js file with the name of your field. But then you have to leave or you forgot to fully test your changes with other Inputfields present on the page and you lock up the whole page edit (yes, that's what JS will do...) ;).  Or...you or a colleague renamed your field and forgot to rename your files..:P.

 

7 hours ago, bernhard said:

But as it is now, i would also have to change the field's settings. Thats some more extra clicks that i don't understand why they are necessary if my proposed render method did not have this drawbacks.

Please see above point. IMO, this is a minor inconvenience compared to the damage automation could cause. OK, maybe I exaggerate but I am not convinced automation is the best approach in this particular case. The field settings are just a click away. Yes, I could include an option to suppress errors but that's no good either. Errors need to be seen so that they can be rectified. 

 

7 hours ago, bernhard said:

thanks for bringing my ideas into your module though!

^-^

Edited by kongondo
  • Like 2

Share this post


Link to post
Share on other sites

thanks for your reply!

I think your answers are totally out of context some times. For example specifying a root path is not added security compared to my suggestion of having a fields folder inside the runtime markup module. but this point will be fixed when we have another option, so thank you for taking that into account :)

Regarding the automatic include of js+css files: I really disagree about that. Your point about breaking the edit screen has nothing to do with the way the file is included! I would also break the edit screen when i include a broken JS file that is specified in the field's settings. IMHO braking up all into 3 config fields adds the possibility of errors because you can easily have typos etc.

if you have your root path for the field (wherever it is, i understand your point about modules and templates) and you have a my_field.php file there. its much more secure and error-unlikely to just put a new file in the same folder (having it grouped in the filetree because of the same filename beginnings) and have that load automatically when present. i don't think that the error message is necessary or helpful for the USER of the field, because if something does not work as expected, you can easily do an alert('working') or the like. I think those error messages only help you as a DEV of the module for finding bugs while writing all the include paths etc.

OK... given that you set your field to include a file in a custom directory it may help to get an error (for example to find typos)... i just didn't think of that too much because i only had one folder and that was really fool-proof to place a file there.

considering the fact that this could be helpful sometimes and that imho it is NOT more unsecure to include the js+css automatically if present i would really like to see that as a third option too :) 

thank you for your time - please don't be mad about me picking on so little things... that's just the proof that i'm using your module a lot those days ;)

Share this post


Link to post
Share on other sites
4 minutes ago, bernhard said:

For example specifying a root path is not added security compared to my suggestion of having a fields folder inside the runtime markup module.

Yes, you are right. Regarding security, I was responding to the issue about root paths in general, but now I realise what you were really after is having the field's folder as a default. Anyway, this is resolved with having the third option I mentioned.

 

5 minutes ago, bernhard said:

i don't think that the error message is necessary or helpful for the USER of the field, because if something does not work as expected, you can easily do an alert('working') or the like. I think those error messages only help you as a DEV of the module for finding bugs while writing all the include paths etc.

Yes, the error messages are for the dev. Maybe I misunderstand; did you have a suggestion regarding error messages?

 

9 minutes ago, bernhard said:

considering the fact that this could be helpful sometimes and that imho it is NOT more unsecure to include the js+css automatically if present i would really like to see that as a third option too :) 

You already have this option :). OK, two options, one each for JS and CSS. So, rather than having one option "JavaScript and CSS included automatically", we have split that into two for JS and CSS respectively. The second options under JS and CSS "JavaScript/CSS file has identical name to this field".  That will do what you are after, but with the errors of course, if there is no file present. I think that's a good reminder about missing files. Maybe we can add an option to suppress errors about missing files (..a leave me alone I know what am doing option >:( :lol:.). That and the identical file name options should get you your wish (of coming back later to add JS/CSS). What do you think?

 

15 minutes ago, bernhard said:

please don't be mad about me picking on so little things.

On the contrary! I value your honest and helpful feedback! ^-^:).

 

16 minutes ago, bernhard said:

that's just the proof that i'm using your module a lot those days ;)

Exactly :).

  • Like 1

Share this post


Link to post
Share on other sites

<random-silliness>

Tools: RM; Countable JS and circleChart

Approach: Include one main.php , JS and CSS using RM render file option. main.php conditionally requires_once 'some-php-file.php' depending on the page being edited.

rm_silliness_1_version_003.thumb.gif.3f55086498535e436c2090237b832155.gif

</random-silliness>

  • Like 4

Share this post


Link to post
Share on other sites

looks like somebody starts liking the file option :D;)

On 24.7.2017 at 10:18 PM, kongondo said:

Maybe we can add an option to suppress errors about missing files (..a leave me alone I know what am doing option >:( :lol:.). That and the identical file name options should get you your wish (of coming back later to add JS/CSS). What do you think?

yes, that's what i want :) i try to explain what i was talking about in the last 2 postings:

imagine you are working on a project with some runtime markup fields... it starts with easy markup, some html. you create your field, set the option to render a field in a specified folder and you're fine. lets say we store it in RM/fields/myfield.php; so far so good.

imagine you continue working on your project... your project grows and your field needs some more styling. we need some easy CSS rules for that field. so what to do?

option now:

  • leave your IDE
  • open just another browser tab
  • go to the backend
  • search the field
  • go to the settings
  • put in the path of the CSS
  • create your css file (RM/fields/myfield.css)
  • put in your rules

my way how i did it with my render method for several fields:

  • create your css file (we have a myfield.php, so create a myfield.css in the same folder)
  • put in your rules

that's A LOT easier and fool-proof imho.

the problem with your "we have that option of including files with the same name already" is that it throws an error when the file is not present. imho that harms more than it helps, because the problem is that you can NOT choose this option while setting up the field at the moment, because it would always show the error as long as you don't have (don't need) a css/js file.

i would really really vote for one global option:

Quote

load PHP + CSS + JS files with the same name as the field that are inside the folder /RM/fields/ automatically

this setting could hide all other inputfields, you would not have to change any of your options and have a solution for everybody.

hope that makes my point more clear now :)

Share this post


Link to post
Share on other sites

Update: Runtime Markup Version 0.0.4.

Changelog

  1. Enhancements to render/add file feature
  2. Added option to suppress errors if JavaScript and CSS files not found (respectively)
  3. Add /site/modules/this-modules-folder/ as a third option in Files Root Path

Currently available on dev branch only.

@bernhard. Using the combinations of JS/CSS has identical name to this field + their respective 'Suppress Missing JS/CSS Files Errors' should cover the need you've described above (i.e., set up your field once and load PHP + CSS + JS files with the same name as the field that are inside the folder /RM/*). That's as automatic as this is going to get ;).

  • Like 2

Share this post


Link to post
Share on other sites

Hi kongondo,

I'm sorry that I have to say that, but I still don't like the solution. It took me some time to understand all the settings, read the instructions carefully, paste in some file paths, ended up with some errors (I pasted the old paths with different root from the autofill for this field)...

I ended up putting this replace hook in my site/ready.php - i guess this will save me, and you, and maybe some others some time...

/**
 * replacement for the original runtimemarkup render method
 */
$wire->addHookBefore('InputfieldRuntimeMarkup::render', function($event) {
  $event->replace = true;
  $field = $event->object;
  
  //so that $page and $pages are locally scoped to the eval
  $process = $this->wire('process'); 
  if($process && $process->className() == 'ProcessPageEdit') $page = $process->getPage();

  $pages = $this->wire('pages');

  // render files that are related to this field
  $root = rtrim($this->wire->config->paths->root,'/');
  $path = '/site/modules/FieldtypeRuntimeMarkup/fields/';
  $file = $root.$path.$field->name;
  if(is_file($file.'.php')) {
    // we found a file in the modules /fields folder, so render it
    $str = wireRenderFile($file, [
      'page' => $page,
      'pages' => $pages,
    ]);
  }
  else {
    // no early reaturn because we load assets later
    if(!$this->runtimeFields) $str = '';
    else $str = eval($this->runtimeFields);
  }

  // load assets related to this field
  if(is_file($file.'.js')) $this->wire->config->scripts->add($path . $field->name . '.js');
  if(is_file($file.'.css')) $this->wire->config->styles->add($path . $field->name . '.css');

  //since we are dealing with custom PHP code but also want to make sure that only markup is returned
  //if eval() returns anything other than a string or an integer, we throw an error (e.g. if an object or array is returned)
  $event->return = "Place your files here: $path<a>{$field->name}.php|css|js</a>";
  if (is_string($str) || is_int($str)) $event->return = $str;
  else $this->error($this->_('Only strings and integers should be returned by your custom code! Check if your code is valid.'));
});

 

With that method the setup is as simple as it can get. no clicking around, no pasting in wrong filenames, no error messages if there is no file...

  • create a new field
  • place it in your template
  • place your files to /fields/myfield.php|css|js

----

another question that cost me quite some time already :(

do you have any idea why this simple code does not work?

if($input->post->submit_save) echo 'saved!';
else echo 'not saved';

using tracy i see that $input->post has no data while $input->get has the url params...

also your example from here does not work any more: 

help would be highly appreciated :)

Share this post


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

I'm sorry that I have to say that, but I still don't like the solution.

Maybe our wires are getting crossed somewhere :). I thought the current solution meets both your and other people's/scenarios' needs.

2 hours ago, bernhard said:

/fields/myfield.php|css|js

I still don't understand why users should be forced to save files in one location (/fields/). 

EDIT: In addition, what if I have several RM fields (either in the same or different templates) and wanted those fields to share some base JS and CSS? That's not possible if we force users to name their JS and CSS after their fields.

Maybe I am missing something. Maybe if I saw a graphic/mock-up of how the RM field settings (Details Tab) would look like in your suggested solution, I would get it :). For now, I will let the changes I've made stay as I believe they cater for different scenarios.

2 hours ago, bernhard said:

if($input->post->submit_save) echo 'saved!'; else echo 'not saved';

If you mean within RM, the reason is that $input is not scoped locally. Have a look at this post downward.

If that's not it, please let me know. Thanks.

Edit: Silly me. No, POST should not work. By the time the page is reloaded (a redirect), the POST is gone.  GET, on the other hand, is 'always' ther. For POST, you can JS as a workaround (to listen to 'submit_save').

Edited by kongondo
Clarification
  • Like 1

Share this post


Link to post
Share on other sites

no, thats not the reason. i don't know why, but $input seems to work! i was also expecting it NOT to work without $this, but it works for $input->get...

<?php namespace ProcessWire;
$out = '';

bd($input->get);
bd($this->input->get);
bd($this->wire->input->get);
bd($input->post);
bd($this->input->post);
bd($this->wire->input->post);
return;

597b8050aef87_2017-07-2820_18_23-EditPage_Runtastic360v2_dev.thumb.png.03fdd8cbaa34fb23cd7b52691b719ede.png

the one on the top is the $post and the one on the bottom the $get.

I tried it also on a different install. Same behaviour. Really strange... no idea whats going on :(

Share this post


Link to post
Share on other sites

Sorry, I'm half asleep :P.

Nope, POST, should not work (a redirect has occurred, the POST is gone). A GET works because it is always there. As a workaround, JS can listen to 'submit_save.' 

Edited by kongondo
  • Like 1

Share this post


Link to post
Share on other sites

so what changed since your example here? and how could i detect clicks on buttons?

 

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 BitPoet
      As threatened in the Pub sub forum in the "What are you currently building?" thread, I've toyed around with Collabora CODE and built file editing capabilities for office documents (Libre-/OpenOffice formats and MS Office as well as a few really old file types) into a PW module.
      If you are running OwnCloud or NextCloud, you'll perhaps be familiar with the Collabora app for this purpose.
      LoolEditor
      Edit office files directly in ProcessWire
      Edit your docx, odt, pptx, xlsx or whatever office files you have stored in your file fields directly from ProcessWire's page editor. Upload, click the edit icon, make your changes and save. Can be enabled per field, even in template context.
      Currently supports opening and saving of office documents. Locking functionality is in development.
      See the README on GitHub for installation instructions. You should be reasonably experienced with configuring HTTPS and running docker images to get things set up quickly.
      Pull requests are welcome!
      Here is a short demonstration:

    • By Robin S
      An Images field allows you to:
      Rename images by clicking the filename in the edit panel or in list view. Replace images, keeping metadata and filename (when possible) by dropping a new image on the thumbnail in the edit panel. Introduced here. But neither of these things is possible in File fields, which prompted this module. The way that files are renamed or replaced in this module is not as slick as in the Images field but it gets the job done. The most time-consuming part was dealing with the UI differences of the core admin themes. @tpr, gives me even more respect for the work that must go into AdminOnSteroids.
      Most of the code to support the rename/replace features is already present in InputfieldFile - there is just no UI for it currently. So hopefully that means these features will be offered in the core soon and this module can become obsolete.
       
      Files Rename Replace
      Allows files to be renamed or replaced in Page Edit.

      Usage
      Install the Files Rename Replace module.
      If you want to limit the module to certain roles only, select the roles in the module config. If no roles are selected then any role may rename/replace files.
      In Page Edit, click "Rename/Replace" for a file...
      Rename
      Use the text input to edit the existing name (excluding file extension).
      Replace
      Use the "Replace with" select to choose a replacement file from the same field. On page save the file will be replaced with the file you selected. Metadata (description, tags) will be retained, and the filename also if the file extensions are the same.
      Tip: newly uploaded files will appear in the "Replace with" select after the page has been saved.
       
      https://github.com/Toutouwai/FilesRenameReplace
      http://modules.processwire.com/modules/files-rename-replace/
    • By d'Hinnisdaël
      So I decided to wade into module development and created a wrapper module around ImageOptim, a service that compresses and optimizes images in the cloud. ImageOptim currently handles JPG, PNG and GIF files and, depending on the settings you use, shaves off between 15% and 60% in filesize. Great for bandwidth and great for users, especially on mobile.
      This module handles the part of uploading images to ImageOptim via their official API, downloading the optimized version and storing it alongside the original image.
       

       
      Download & Info
      GitHub / Module directory / Readme / Usage
       
      Why ImageOptim?
      There are other image optimization services out there, some of them free, that have outstanding ProcessWire modules. A few things make ImageOptim the best tool for most of my customers: It's not free, i.e. it will probably be around for a while and offers support. However, it's cheaper than some of the bigger competitors like Cloudinary. And it does PNG compression better than any of the free services out there, especially those with alpha channels.
       
      Installation
      Install the module like any other ProcessWire module, by either copying the folder into your modules folder or installing it via the admin. See above for downloads links on GitHub and in the module directory.
       
      Requirements
      To be able to upload images to the service, allow_url_fopen must be set on the server. The module will abort installation if that's not the case.
      I have only tested the module on ProcessWire 3.x installations. I don't see why it shouldn't work in 2.x, if anyone wants to try it out and report back.
       
      ImageOptim account
      To compress images, you first need to sign up for an ImageOptim account. They offer free trials to try the service.
       
      Usage (manual optimization)
      Images can be optimized by calling the optimize() method on any image. You can pass an options array to set ImageOptim API parameters.
      $image->size(800,600)->optimize()->url $image->optimize(['quality' => 'low', 'dpr' => 2]) // Set quality to low and enable hi-dpi mode
      Automatic optimization
      The module also has an automatic mode that optimizes all image variations after resizing. This is the recommended way to use this module since it leaves the original image uncompressed, but optimizes all derivative images.
      $image->size(800,600)->url // nothing to do here; image is optimized automatically
      To change compression setting for single images, you can pass an options array along with the standard ImageResizer options. Passing false disables optimization.
      $image->size(800, 600, ['optimize' => 'medium']) $image->size(800, 600, ['optimize' => ['quality' => 'low', 'dpr' => 2]]) $image->size(800, 600, ['optimize' => false])
      For detailed usage instructions and all API parameters, see the usage instructions on GitHub.
       
      Filenames
      Optimized images will be suffixed, e.g. image.jpg becomes image.optim.jpg. You can configure the suffix in the module settings.
       
      Roadmap
      Asynchronous processing. Not really high on the list. Image variations need to be created anyway, so waiting a few seconds longer on first load is preferable to adding complexity to achieve async optimization. Optimize image variations created by other modules. CroppableImage comes to mind. I don't use any of these, so if somebody wants to help out and submit a pull request — all for it! Add a dedicated page in the setup menu with a dashboard and detailed statistics. ImageOptim's API is very barebones for now, so not sure if that's feasible or even necessary.
      Stability
      I've been using this module on production sites for some time now, without hiccups. If you do notice oddities, feel free to comment here or investigate and submit PRs.
    • By daniels
      General
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      It can update / create a subscriber in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe users to different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns You can find it here: https://github.com/danielstieber/SubscribeToMailchimp
      Let me know what you think and if I should add it to the Modules Directory.
      Setup
      Log into your Mailchimp account and go to  Profile > Extras > API Keys. If you don't have an API Key, create a new one. Copy your API Key and paste it in the module settings (Processwire > Modules > Site > SubscribeToMailchimp). Back in Mailchimp, go to the list, where you want your new subscribers. Go to Settings > List name and defaults. Copy the List ID an paste it in to the module settings.
      Usage
      To use the module, you need to load it into your template:
      $mc = $modules->get("SubscribeToMailchimp"); Now you can pass an email address to the module and it will try to edit (if the user exists) or create a new subscriber in your list.
      $mc->subscribe('john.doe@example.com'); You can also pass a data array, to add additional info.
      $mc->subscribe('john.doe@example.com', ['FNAME' => 'John', 'LNAME' => 'Doe']); You can even choose an alternative list, if you don't want this subscriber in your default list.
      $mc->subscribe('john.doe@example.com', ['FNAME' => 'John', 'LNAME' => 'Doe'], 'abcdef1356'); // Subscribe to List ID abcdef1356  
      Important Notes
      This module does not do any data validation. Use a sever-sided validation like Valitron Make sure that you have set up your fields in your Mailchimp list. You can do it at Settings > List fields and *|MERGE|* tags Example
      Example usage after a form is submitted on your page:
      // ... validation of form data $mc = $modules->get("SubscribeToMailchimp"); $email = $input->post->email; $subscriber = [ 'FNAME' => $input->post->firstname, 'LNAME' => $input->post->lastname, ]; $mc->subscribe($email, $subscriber);  
      Troubleshooting
      In case of trouble check your ProcessWire warning logs.
      I can't see the subscriber in the list
      If you have enabled double opt-in (it is enabled by default) you will not see the subscriber, until he confirmed the subscription in the email sent by Mailchimp
      I get an error in my ProccessWire warning logs
      Check if you have the right List ID and API Key. Check if you pass fields, that exist in your list. Check if you pass a valid email address. Go to Mailchimps Error Glossary for more Information
      How To Install
      Download the zip file at Github or clone directly the repo into your site/modules If you downloaded the zip file, extract it in your sites/modules directory. You might have to change the folders name to 'SubscribeToMailchimp'. Goto the modules admin page, click on refresh and install it  
    • By PWaddict
      Module for hiding pages for non-superusers.
      Download
      HidePages
      Requirements
      ProcessWire 3.x Changelog
      1.0.1 (31 March 2018)
      Module renamed to prevent confusion 1.0.0 (30 March 2018)
      Initial release