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 JohnK
      Hey!
      When I was building a little commercial Processwire website for a family member, I started looking into caching with WireCache and somehow had troubles to find a satisfying solution to organize the caches and their expirations. My site had a few parts that updated in a regular manner while other parts should be refreshed whenever the current page - or e.g. for the menu: any page - was saved. I wanted to create a cache of the whole page's html which should expire whenever any of its parts expired. This would be simple if you could set multiple expire values for one cache. Unfortunately, you can only set one. So I started to build a solution to my problem which uses the WireCache and creates a dependency tree for every cache. And since I haven't yet implemented a Processwire module and this little class might be useful for other websites, too, I thought I'd try to make a module out of it. This is it.
      Github: https://github.com/janKir/CacheNesting
      Please have a look, and feel free to leave a comment. This is my first module, so any suggestions are welcome. I am not even sure if my approach makes much sense for performance reasons. I'm happy to hear your opinions!
      Thanks a lot!
    • By kongondo
      Process Sites Manager
      ProcessWire supports multiple site setups using various methods. One of the more common approaches is running multiple sites from the same core installation with each site maintaining its own database (aka option #1). This approach requires the site admin to initially install ProcessWire in a temporary directory for each new site. The directory then needs to be renamed as site-xxx, where ‘xxx’ is any name you want to use to differentiate the installation from other sites, before it is moved to the webroot. For instance, site-mysite, site-another, site-whatever. In addition, the /wire/index.config.php file must be copied/moved to the webroot. Each time a site is added, the index.config.php has to be edited to add ‘domain’ => ‘site-directory’ key=>value pairs for the site. This process can become a bit tedious. This module aims to automate the whole process.
       
      The module is based off the official ProcessWire installer. Creating a site is as simple as completing and submitting a single form! The module will:
      Install a ProcessWire site in your named directory, applying chmod values as specified
      Move the directory to your webroot
      Update/Create a Superuser account as per the submitted form, including setting the desired admin theme and colour
      Update sites.json (used by index.config.php to get array of installed sites)
       
      Please note that this module is not a multiple sites solution! It is just a helper class for those using option #1. Your multi-sites solution will still be delivered by ProcessWire core. The only difference is index.config.php is slightly different from the one that ships with ProcessWire.
      ALPHA SOFTWARE!
      This module works as expected. However, it needs a bit more testing in different environments. In light of this, it is labelled as alpha and should not be used in a production environment.
      Download from GitHub: Sites Manager
      Features
      Install unlimited number of sites in one ProcessWire install
      Choose an Admin Theme to auto-install along with the site installation
      Install and maintain site profiles for reuse to create other sites
      Client and server-side validation of site creation form
      Edit uploaded profiles (e.g., replace profile file)
      Lock installed sites and profiles to prevent editing
      Bulk delete site profiles, installed site directories and/or databases (confirmation required for latter two)
      View important site details (admin login, chmod, etc)
      Links to installed sites home and admin pages
      Timezones auto-complete/-suggest
      Installation
      Pre-requisites
      Domains
      Installations’ domains/sub-domains must exist before installing the site. This is needed in order to update/save the Superuser account for the new site. For instance, if creating a site with the subdomain blog.mydomain.com (with directory site-blog), that subdomain must be active. For local development, if using Apache, for instance, a virtual host directive for blog.mydomain.com must have been set up prior to the installation. For remote/live sites, the subdomain must have been set up at your Domain Name Registrar.
      Site Profiles
      You will need to prepare site profiles for use with the module. Example site profiles ship with ProcessWire. These include ‘site-default’, ‘site-classic’, ‘site-blank’, etc. The module only accepts zip files. Each of these folders needs to be compressed into a zip file, for instance ‘site-default.zip’, ‘site-languages.zip’, etc. Please note that the other content you get with ProcessWire downloads are not required. These include the wire folder and .gitignore, index.php, etc files. Do not include any of these in the ‘site-whatever.zip’.
      You are not limited to using the site profiles that ship with ProcessWire. You can create and use your own custom profiles as long as they are structured according to the format ProcessWire expects (@see site-default that ships with ProcessWire as an example).
      Install
      Install the module like any other. It will create required templates, fields and pages (hidden in admin under Multi Sites). The install will also copy two files to your webroot; sites.json and index.config.php. If any identical module components (field, templates, files, etc) are found in your system, the module will not install but will instead error out with a relevant message.
      Module Files
      The two file sites.json and index.config.php should not be removed from your webroot if you are using this module. The former should remain writable at all times. The index.config.php is a modified version of the one that ships with ProcessWire. Rather than editing the file directly with new entries for installed sites, it fetches the information about multi-sites sites that ProcessWire needs to serve directly from the site.json contents which it converts to an array before passing off to ProcessWire. We haven’t done any real-world testing (yet) but have not observed any noticeable delays in serving the multi-sites sites in this manner.
      Usage
      The module will be useful in both development and production (@see note above! When ready) environments.
      For development work, there are times when you need to quickly put up a temporary site to test something, debug an install or create a mock website to present draft ideas to a client, etc. This module allows you to do all these, and more, easily and quickly.
      For live sites, the module can be a time saver, allowing you to install and manage (very limited feature-set at present) your sites from one dashboard.
      Site Profiles
      The first thing to do after installing the module is to upload at least one site profile. In the Upload page, complete the ‘upload a site profile form’. Give the profile upload a title, optionally a description (good reminder about what the profile features), ProcessWire compatibility and of course the profile zip file itself. Profile uploads are saved as hidden pages in the admin. This enables reuse of the profile, so that you don’t have to upload it over and over every time you need to install a site.
      Uploaded profiles are listed under the page Profiles. Head over there to see a list of available profiles. Using this page, you can edit individual profiles, e.g. change the title or replace the profile zip file. You can also lock/unlock or delete profiles. You are now ready to create sites.
      Create/Install Sites
      Head over to the Create page. This is where the automation really happens. Complete the form as required. Most of the inputs/fields should be familiar if you’ve ever installed ProcessWire. All fields, except for Description and HTTP Host Names, must be completed. It is recommended to complete these as well. Each field is accompanied by an explanation about what what it does (straight off the ProcessWire install you are used to). One bonus you get is you are able to select both an Admin Theme and Colour Theme to install! If you like AdminThemeReno in Blue, for instance, you can have that installed for you. Another bonus is the Default Timezone field. It uses auto-complete so that you don’t have to type the whole timezone name. Please note that, unlike in the official installer, profile previews are not (currently?) available.
      When you are happy with your settings click save to start the install. Please note that due to the additional client-side validation, if any of the checks fail, the errors to correct will be displayed in a modal and the form will not be submitted. Checks include mismatched Superuser passwords, empty required fields, invalid emails, short admin login URL/name, etc.
      If all went well, the site should install! Please note that currently (and a tad annoyingly!), the install will abort (sometimes half-way), if it hits an error. This has nothing to do with the official ProcessWire install but the checks we have put in the module code, currently. Hopefully, with feedback from the community, we can change how the module deals with errors. Most errors, if they appear, will be related to the file system...cannot write to file blah blah, etc.
      If you clicked on the button Save & View Sites, you should, momentarily (it may take a while depending on your system), see your new site on the page Installed. Otherwise, navigate to that page.
      Installed
      On this page you see a list of installed sites and information about them. To view your site, click on the link in Domain. The site opens in a new tab. To head straight to the admin, click on the link in Admin Login. Log in with the Superuser credentials you supplied on the ‘create site form’. Voilà! Your new site’s admin with the theme and colours your selected applied for the Superuser!
      On the Installed sites page, you can lock/unlock the installed sites records (the pages). You can also bulk delete the sites’ directories (the site-mydomain directories in webroot) and/or their databases. A dialog appears asking you to confirm these latter two actions. Be careful with these! They are useful for erasing temporary test sites but you need to double check your intended action. It is therefore advisable to lock sites to prevent unintended erasure.
      Deleting a site’s directory and/or database also deletes its associated page record. This means you won’t be able to view it in the Installed page.
      Cleanup
      Use this to make a clean getaway before uninstalling the module. The page will also allow you to specify whether you wish to delete the sites.json and index.config.php files from your webroot.
      Technicalities/Issues
      Only Superusers can use the module.
      ProcessWire 2.7 - 3.x compatible
      Currently using ProcessWire 2.7 installer (install.php)
      Potential race condition when sites.json is being updated on a new site install vs. index.config.php accessing the json file?
      Not tested with sub-directory installs (for instance localhost/pw/my-site-here/)
      Currently not doing the extra/experimental database stuff (database charset and engine)
      Future Possibilities
      Install specified modules along with the ProcessWire install
      Create installation profiles and/or allow JSON/CSV install configurations (useful for repetitive values, e.g. where Superuser email doesn’t change)
      Profile previews?
      Credits
      @ryan: for the ProcessWire installer
      @abdus: for the index.config.php reading from JSON idea
      @swampmusic: for the challenge
      Testing
      Please help test and report any issues. Feature suggestions are also welcome. Comments on anything from UX to technical stuff to make this as robust as possible are appreciated.
      Video Demo
      Quick Demo (excuse the video quality please )
      Screens
       

    • By Robin S
      Some introduction...
      This module is experimental and there are probably bugs - so treat it as alpha and don't use it on production websites.
      I started on this module because there have been quite a few requests for "fake" or "invisible" parent functionality and I was curious about what is possible given that the idea sort of goes against the PW page structure philosophy. I'm not sure that I will use this module myself, just because I don't really see a long list of pages under Home (or anywhere else) as untidy or cluttered. I would tend to use Lister Pro when I want to see some set of pages as a self-contained group. But maybe others will find it useful.
      At the moment this module does not manipulate the breadcrumb menu in admin. So when you are editing or adding a virtual child the real location of the page is revealed in the breadcrumb menu. That's because I don't see the point in trying to comprehensively fool users about the real location of pages - I think it's better that they have some understanding of where the pages really are. But I'm open to feedback on this and it is possible to alter the breadcrumbs if there's a consensus that it would be better that way.
       
      Virtual Parents
      Allows pages in Page List to be grouped under a virtual parent.
      This module manipulates the page list and the flyout tree menu to make it appear that one or more pages are children of another page when in fact they are siblings of that page.
      Why would you do that instead of actually putting the child pages inside the parent? Mainly if you want to avoid adding the parent name as part of the URL. For example, suppose you have some pages that you want to be accessed at URLs directly off the site root: yourdomain.com/some-page/. But in the page list you want them to be appear under a parent for the sake of visual grouping or to declutter the page list under Home.
      Example of how the page structure actually is

      Example of how the page structure appears with Virtual Parents activated

      How it works
      This module identifies the virtual parents and virtual children by way of template. You define a single template as the virtual parent template and one or more templates as the virtual child templates. Anytime pages using the child template(s) are siblings of a page using the parent template, those child pages will appear as children of the virtual parent in the page list and tree menu.
      You will want to create dedicated templates for identifying virtual parents and virtual children and reserve them just for use with this module.
      Features
      Adjusts both page list and tree flyout menu to show the virtual parent/child structure, including the count of child pages. Works everywhere page list is used: Page List Select / Page List Select Multiple (and therefore CKEditor link dialog). Intercepts the "Add page" process in admin, so that when an attempt is made to add a child to a virtual parent, the child is added where it belongs (the next level up) and the template selection is limited to virtual child templates. Intercepts moving and sorting pages in the page list, to ensure only virtual children may be moved/sorted under the virtual parent. Superusers have a toggle switch at the bottom of the page list to easily disable/enable Virtual Parents in order to get a view of what the real page structure is. Usage
      Install the Virtual Parents module.
      In the module config, enter pairs of parent/child template names in the form virtual_parent_template=virtual_child_template. If needed you can specify multiple pipe-separated child templates: virtual_parent_template=child_template_1|child_template_2. One pair of template names per line.
      There is a checkbox in the module config to toggle Virtual Pages on and off, but it's more convenient to use this from the page list.
      Notes
      It's important to keep in mind the real location of the virtual child pages. This module is only concerned with adjusting the appearance of page list and tree menu for the sake of visual grouping and tidiness. In all other respects the virtual children are not children of the virtual parent at all.
      It's recommended to select an icon for the virtual parent template (Advanced tab) so virtual parents are marked out in the page list as being different from normal parent pages.
      Do not place real children under a virtual parent. There is some protection against this when moving pages in the page list, but when it comes to changing a page's parent via the Settings tab the only protection is common sense.
       
      https://github.com/Toutouwai/VirtualParents
    • 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.2.7
      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; } 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


      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 ukyo
      Call ProcessWire API Functions Inside STRING
      Github Repo
      Current status : BETA
      Each called method must return string value !
      I added all functions, but not tested all. I focused page(), page()->render and field properties (label, description and notes). I also tested some basic pages() api calls.
      Your API calls must start with { and must end with }. For use multiple arguments inside functions, separate arguments with ~ char.
      NOTE If you pass directly arguments to api {page(title)}, this call will check for requestedApiCall()->get(arguments).
      USAGE
      processString(string, page, language); Get page title <?php $str = "You are here : {page:title}"; echo processString($str); ?> Get page children render result <?php $str = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.<hr>{page:render:children}"; echo processString($str); ?> Get homepage title <?php $str = "You can visit our <a hre='{pages(1):url}'>{pages:get(1):title}</a>"; echo processString($str); ?> Get title field label, description or notes <?php $str = "Our title field properties are : label: {label(title)} - description: {description(title)} - notes: {notes(title)}"; echo processString($str); ?> Multiple examples <?php $str = " <ul class='uk-list uk-list-striped'> <li><b>01: GET FIELD LABEL</b> <code>&#123;label(title)&#125;</code> <b>RESULT :</b> <code>{label(title)}</code></li> <li><b>02: GET FIELD LABEL WITH PREFIX</b> <code>&#123;label(title~=> )&#125;</code> <b>RESULT :</b> <code>{label(title~=> )}</code></li> <li><b>03: GET FIELD LABEL WITH SUFFIX</b> <code>&#123;label(title~~ <=)&#125;</code> <b>RESULT :</b> <code>{label(title~~ <=)}</code></li> <li><b>04: GET FIELD DESCRIPTION</b> <code>&#123;description(title)&#125;</code> <b>RESULT :</b> <code>{description(title)}</code><br> <li><b>05: GET FIELD DESCRIPTION WITH PREFIX</b> <code>&#123;description(title~=> )&#125;</code> <b>RESULT :</b> <code>{description(title~=> )}</code></li> <li><b>06: GET FIELD DESCRIPTION WITH SUFFIX</b> <code>&#123;description(title~~ <=)&#125;</code> <b>RESULT :</b> <code>{description(title~~ <=)}</code></li> <li><b>07: GET FIELD NOTES</b> <code>&#123;notes(title)&#125;</code> <b>RESULT :</b> <code>{notes(title)}</code><br> <li><b>08: GET FIELD NOTES WITH PREFIX</b> <code>&#123;notes(title~=> )&#125;</code> <b>RESULT :</b> <code>{notes(title~=> )}</code></li> <li><b>09: GET FIELD NOTES WITH SUFFIX</b> <code>&#123;notes(title~~ <=)&#125;</code> <b>RESULT :</b> <code>{notes(title~~ <=)}</code></li> <li><b>10: GET PAGE TITLE</b> <code>&#123;page(title)&#125;</code> <b>RESULT :</b> <code>{page(title)}</code></li> <li><b>11: GET PAGE TITLE</b> <code>&#123;page:title&#125;</code> <b>RESULT :</b> <code>{page:title}</code></li> <li><b>12: GET PAGE RENDER TITLE</b> <code>&#123;page:render:title&#125;</code> <b>RESULT :</b> <code>{page:render:title}</code></li> <li><b>12: GET HOMEPAGE TITLE</b> <code>&#123;pages:get(template=home):title&#125;</code> <b>RESULT :</b> <code>{pages:get(template=home):title}</code></li> <li><b>13: GET HOMEPAGE TEMPLATE ID</b> <code>&#123;pages:get(template=home):template:id&#125;</code> <b>RESULT :</b> <code>{pages:get(template=home):template:id}</code></li> </ul> "; echo processString($str); ?>