Jump to content

Recommended Posts

Update 31.7.2019: AdminBar is now maintained by @teppo. Modules directory entry has been updated, as well as the "grab the code" link below.

***

Latest screencast: http://www.screencas...73-ab3ba1fea30c

Grab the code: https://github.com/teppokoivula/AdminBar

***

I put this Adminbar thingy (from here: http://processwire.c...topic,50.0.html) to modules section and to it's own topic.

I recorded quick and messy screencast (really, my first screencast ever) to show what I have made so far. You can see it from here: http://www.screencas...18-1bc0d49841b4

When the modal goes off, I click on the "dark side". I make it so fast on screencast, so it might seem a little bit confusing. Current way is, that you can edit, go back to see the site (without saving anything), continue editing and save. After that you still have the edit window, but if you click "dark side" after saving, then the whole page will be reloaded and you see new edits live.

I am not sure if that is best way: there are some strengths in this thinking, but it is probably better that after saving there shouldn't be a possibility to continue editing. It might confuse because then if you make edits, click on dark side -> *page refresh* -> You lose your edits.

***

When I get my "starting module" from Ryan, I will turn this into real module. Now I had to make some little tweaks to ProcessPageEdit.module (to keep modal after form submits). These probably won't hurt anything:

if($this->redirectUrl) $this->session->redirect($this->redirectUrl);
if(!empty($_GET['modal'])) $this->session->redirect("./?id={$this->page->id}&modal=true"); // NEW LINE
else $this->session->redirect("./?id={$this->page->id}");
 

and...

if(!empty($_GET['modal'])) {
$form->attr('action', './?id=' . $this->id . '&modal=true');
} else {
$form->attr('action', './?id=' . $this->id); // OLD LINE
}
 
Edited by teppo
Added a note about the new maintainer and updated GitHub repository URL.

Share this post


Link to post
Share on other sites

Awesome screencast! This looks incredibly useful, so cool to see.

I'm limited on time for the moment, so just wanted to quickly follow up with the starter module. When I made this, I wasn't thinking about the admin side of it, where you edited ProcessPageEdit.module. I need to take a closer look tomorrow and update the starter module code to hook into that too. But here is something to get started. It's actually very short, but I loaded it with comments that I thought would help, so it looks a lot longer than it actually is. :)

Place this in: /site/modules/AdminBar/AdminBar.module

<?php
                        
class AdminBar extends WireData implements Module {
                                
        /**                             
         * This is where you define some basic info about your module. 
         *                                      
         * See /wire/core/Module.php for definitions of all these.
         *                              
         */                     
        public static function getModuleInfo() {
                return array(
                        'title' => 'Admin Bar',
                        'summary' => '[summary of your module], by apeisa',
                        'href' => 'http://processwire.com/talk/index.php/topic,56.0.html',
                        'version' => 100, 
                        'permanent' => false,
                        'autoload' => true,
                        'singular' => true, 
                        );
        }               
                                
        /**                     
         * Initialize the module and setup hooks
         *              
         * The init method of a module is called right after ProcessWire is bootstrapped, when all
         * API vars are ready. Whereas the __construct() is called DURING bootstrap, so the init() 
         * method is a better place to attach hooks to API vars. 
         *      
         * In this method, we'll use an 'after' hook since we want to modify the output of the 
         * rendered page template. 
         *              
         * Note also that the 'Class::method' syntax means it hooks into ALL Page instances. 
         * The syntax for hooking to a single instance would be: 
         * $page->addHookAfter('render', $this, 'pageRender');
         *              
         * Also note that there isn't actually a Page::render method, it was instead added by 
         * another module (wire/modules/PageRender.module). Not that it matters here, but just 
         * wanted to mention in case you look in the Page class and don't see a render method.
         *
         */
        public function init() { 
                $this->addHookAfter('Page::render', $this, "pageRender");
        }

        /**
         * Hook called when a page is rendered
         *
         * The method name used here does not matter, it just has to be consistent with the name you provided 
         * when creating the hook. 
         *
         * This method is given an $event object of type HookEvent. To see what's in that, see this file: 
         * /wire/core/HookEvent.php (it's very short and simple)
         *      
         */             
        public function pageRender($event) {
                        
                // $event->object always has the object instance that resulted in this call
                $page = $event->object; 
                        
                // if the page isn't editable, or if it's using the admin template, abort. 
                if(!$page->editable() || $page->template == 'admin') return;
        
                // find the location of this module for linking css and js files
                $url = $this->config->urls->AdminBar . "AdminBar";

                // the css and js links we're going to add
                $out =  "\n\t<link rel='stylesheet' type='text/css' href='$url.css' />" . 
                        "\n\t<script type='text/javascript' src='$url.js'></script>" . 
                        "\n</head>"; 

                // modify the value returned by $page->render() to include our css and js files
                $event->return = str_ireplace('</head>', $out, $event->return);
        }
}

Also you will want to create:

/site/modules/AdminBar/AdminBar.css

/site/modules/AdminBar/AdminBar.js

Thanks for what you are doing here, nice work and great screencast! I will work on expanding this starter example.

Share this post


Link to post
Share on other sites

Ryan, thanks for this! I think I get easily forward.

Probably only thing I need on the admin side is that after submit modal view should stay. And maybe some way to hide form to re-appear after successful save.

Share this post


Link to post
Share on other sites

Apeisa: if you post the code somewhere I might try to hack it, so after save it closes modal and reloads window.

Or you coould do it. After saving, there could be this code [pseudo code]:

  $(document).watch-for('modal.urlChange', function(){
    if (:contains('Saved'))
      window.reload();
  });


  •  
  • modal.urlChange – I'm not sure what modal are you using, but it should have some event after contents of modal have changed
     
  • window.reload(); – since after change we check DOM of contents of modal for 'Saved' or anything that shows that page has been saved, we just reload the page – so with one 'Save page' click, it saves page and basically closes modal AND opens saved page with changes.

modal change real code depends on what modal are you using, :contains code depends on what's the real DOM of edit page dialog (or how to identify 'saved page' message) and window.reload() is just a question of looking up the right code.

Share this post


Link to post
Share on other sites

Apeisa: if you post the code somewhere I might try to hack it, so after save it closes modal and reloads window.

Thanks for advice! I have created simple custom modal. I now track if there is #notices inside the iFrame in modal, and if there is then clicking on "dark side" fires page refresh.

I might just hide the form (with js) if there is #notices -> not sure about that tough. I have to play with different ways. What I want is that user get's clear "Page saved" notice, not just quick refresh. I have few ideas tough, so I just play

Share this post


Link to post
Share on other sites

If you want user notice, that page saved was why not:

  • Add hook to save, so it sets in session [if saving from modal] that $last_saved_id = $page->id
  • Save in modal
  • Close modal / or just:
  • Reload
  • hook on page load – if $page->id = $last_saved_id; show 'Saved OK' message, else delete session information, because something happened [user moved away?]

Everything is just a matter of will :)

Share this post


Link to post
Share on other sites

Apeisa: Let me know if that module skeleton worked for you. It occurred to me last night that it might not work unless you are running a very recent version of PW2. If not, make sure you have the latest (I added upgrade instructions to the FAQ section in the forum).

Share this post


Link to post
Share on other sites

Apeisa: Let me know if that module skeleton worked for you.

I upgraded to latest master and tried this skeleton. It gives me error "Field 'data' doesn't have a default value" and install stops. Any clues?

Share this post


Link to post
Share on other sites

Strange... Can you confirm that this is the error that you when when clicking the "install" button in the Modules section? This sounds like a MySQL error. Can you tell me what version you are running? Also, I am preparing an updated /wire/core/Modules.php for you, but just wanted to confirm about when the error occurs.

Thanks,

Ryan

Share this post


Link to post
Share on other sites

Looking in the code, the error actually makes sense, and I located what the problem was right away. What I don't understand is why it's never turned up before. But I am glad you found it, because it does appear to be a bug in PW2's module installer.

You'll want to update your /wire/core/Modules.php:

https://github.com/ryancramerdesign/ProcessWire/commit/4cf59bb7ea49a0d6449361285c177c0dd93182bd#diff-0

Or here is the full file:

https://github.com/ryancramerdesign/ProcessWire/raw/4cf59bb7ea49a0d6449361285c177c0dd93182bd/wire/core/Modules.php

Share this post


Link to post
Share on other sites

Thanks, it works now. Time to get hands dirty!

(actually, I was polishing the UI all the time :))

Share this post


Link to post
Share on other sites

Great! glad that worked. Let me know how it goes...

Share this post


Link to post
Share on other sites

Wow. It was very easy to port from basic include to a module. Only thing I needed to change was put $page->id ==> $this->page->id and $config->urls->admin ==> $this->config->urls->admin

I actually have pretty solid module here :)

I put those css and js files just before </head> just like in Ryan's skeleton module. I also put html needed by Admin Bar right before </body>.

Now only few things missing:

1) Keeping admin in modal view after saving a page

2) Or closing admin and notifying user in some other way that page was saved

3) Better name for this child. Front-end editor? Front-end admin? Quick Edit?

(actually there is millions of ideas how I wanna improve this one, but I think after those three things this is solid enough for others to test)

Share this post


Link to post
Share on other sites

That was fast! Glad it's working. For the next step (keeping it modal), I pushed a couple updates to GitHub today to aid in doing that (made a few more things hookable). So make sure you've got the latest commit.

Now we want to hook into a couple more things to modify the form URL and redirect URL, like you did by editing ProcessPageEdit, but we want to do it in a way that doesn't require changing anything in the core. So here is the full skeleton module code from before, but with the addition of two new hooks. Note that I didn't add as many comments to the new stuff, because I have to go pick up my daughter from school, so please reply with any questions:

<?php

class AdminBar extends WireData implements Module {

        /**
         * This is where you define some basic info about your module. 
         *
         * See /wire/core/Module.php for definitions of all these.
         *
         */
        public static function getModuleInfo() {
                return array(
                        'title' => 'Admin Bar',
                        'summary' => '[summary of your module], by apeisa',
                        'href' => 'http://processwire.com/talk/index.php/topic,56.0.html',
                        'version' => 100,
                        'permanent' => false,
                        'autoload' => true,
                        'singular' => true,
                        );
        }

        /**
         * Initialize the module and setup hooks
         * 
         * The init method of a module is called right after ProcessWire is bootstrapped, when all
         * API vars are ready. Whereas the __construct() is called DURING bootstrap, so the init() 
         * method is a better place to attach hooks to API vars. 
         *
         * In this method, we'll use an 'after' hook since we want to modify the output of the 
         * rendered page template.
         *
         * Note also that the 'Class::method' syntax means it hooks into ALL Page instances. 
         * The syntax for hooking to a single instance would be: 
         * $page->addHookAfter('render', $this, 'pageRender');
         *
         * Also note that there isn't actually a Page::render method, it was instead added by 
         * another module (wire/modules/PageRender.module). Not that it matters here, but just 
         * wanted to mention in case you look in the Page class and don't see a render method.
         *
         */
        public function init() {

                // modify the output of a page render, adding some markup to support the adminbar
                $this->addHookAfter('Page::render', $this, 'pageRender');

                // hook before forms are rendered, so that we can modify the form's "action" attribute
                $this->addHookBefore('InputfieldForm::render', $this, 'formRender');

                // hook before a redirect occurs, os we can modify the redirect URL
                $this->session->addHookBefore('redirect', $this, 'sessionRedirect');
        }

        /**
         * Hook called when a page is rendered
         *
         * The method name used here does not matter, it just has to be consistent with the name you provided 
         * when creating the hook. 
         *
         * This method is given an $event object of type HookEvent. To see what's in that, see this file: 
         * /wire/core/HookEvent.php (it's very short and simple)
         *
         */
        public function pageRender($event) {

                // $event->object always has the object instance that resulted in this call
                $page = $event->object;

                // if the page isn't editable, or if it's using the admin template, abort. 
                if(!$page->editable() || $page->template == 'admin') return;

                // find the location of this module for linking css and js files
                $url = $this->config->urls->AdminBar . "AdminBar";

                // the css and js links we're going to add
                $out =  "\n\t<link rel='stylesheet' type='text/css' href='$url.css' />" .
                        "\n\t<script type='text/javascript' src='$url.js'></script>" .
                        "\n</head>";

                // modify the value returned by $page->render() to include our css and js files
                $event->return = str_ireplace('</head>', $out, $event->return);
        }

        /**
         * Hook to take place before forms are rendered
         *
         * We check if there is a 'modal' get var set, and if so, we add it to the form's action attribute
         *
         */
        public function formRender($event) {
                if(!$this->input->get->modal) return;
                $form = $event->object;
                $action = $form->attr('action');
                $action .= (strpos($action, '?') !== false ? '&' : '?') . "modal=1";
                $form->attr('action', $action);
        }

       /**
         * Hook to take place right before a redirect occurs
         *
         * We intercept the redirect URL and modify it to add 'modal=1' to the query string
         *
         */
        public function sessionRedirect($event) {
                if(!$this->page || $this->page->template != 'admin') return;
                if(!$this->input->get->modal) return;
                $url = $event->arguments(0);
                if(preg_match('/[?&]modal=/', $url)) return;
                $url .= (count($this->input->get) ? '&' : '?') . "modal=1";
                $event->arguments(0, $url);
        }
}

Lastly, I should probably have the core look for a modal attribute and keep it going when it finds it (because this has use elsewhere), but I thought this was a really good example of how to implement a module, so figured we would start here.

Share this post


Link to post
Share on other sites

Thanks Ryan. I will update my module tomorrow.

Here is two more screenshots, I polished the user interface a little bit:

adminbarscreen1.jpg

adminbarscreen2.jpg

Share this post


Link to post
Share on other sites

If I may suggest, something like modal editor makes more sense, because front-end anything implies, that that's what you edit. But you merely pushed the administration into modal and added few buttons [though that this statement doesn't make it any less valuable!]

Maybe something like 'modal editor', or 'enhanced inpage user control' [although that's bit strange] :)

Share this post


Link to post
Share on other sites

If I may suggest, something like modal editor makes more sense, because front-end anything implies, that that's what you edit. But you merely pushed the administration into modal and added few buttons [though that this statement doesn't make it any less valuable!]

That is true - but my plan is to add more "admin" functions here. I am planning few more features like:

  • Quick look of the permissions of current page (which roles can edit, view etc)
  • Create a new subpage
  • Show sitemap (maybe?)

So now it is mainly "modal editing", but I do hope that I get most needed admin functions baked in. You are also right that everything that admin bar does is also available from real admin: I have no means to rebuild anything: just to give more convenient (for some people) way to find information & admin functions they need. So maybe best name could be something like "quick admin" or "mini admin". "Enhanced inpage user control" is actually pretty good one (in descriptive means, tough a little bit difficult to remember :))

Not that the name is most important, but I also wanted to share my ideas on this one.

Martin: Thanks! I hope to get this released sooner than later, so you guys can test it.

Share this post


Link to post
Share on other sites

Adam: very polished and nice looking toolbar there! Do you have some functionality created or just UI design? It would be crazy to create same functionality twice... :)

Although I have to admit that PW seems to make things like this very easy to do. Props to the system!

Share this post


Link to post
Share on other sites

Just UI – actually, just this quick-bar so far :D [edit, new page, view 'pages']

it's actually for you – if you wish, we can take your code and put it together ;)

so, far, I have two things for you [or me] to do [if you send me the code – or create github repo]:

- setting for initial state: small / expanded

- edit page in: modal / administration :)

I will do both UI/CSS if you wish, or I can send you just PSDs

Adam

Share this post


Link to post
Share on other sites

Adam: I have to say that I love your UI - super clean. I think fastest could be for now that if you send me a psd. Then when I get first working version with minimal features I will create github repo so you can contribute to coding also - and we can bake those needed options in (initial state / modal).

Share this post


Link to post
Share on other sites

This is really looking great. As for name, it sounds like you've got a lot of good options. I might suggest something that involves "overlay" just because that term is already familiar to many people with Drupal 7 using it. I also liked the "adminbar" term just because it's so simple and says exactly what it is (could also be something like "editbar"). Probably less technical sounding is better, because a term like "modal" means something to us, but it's far from common language (at least here). But regardless of what name you choose, this is shaping up to be a really cool module.

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By teppo
      This module tracks changes, additions, removals etc. of public (as in "not under admin") pages of your site. Like it's name says, it doesn't attempt to be a version control system or anything like that - just a log of what's happened.
      At the moment it's still a work in progress and will most likely be a victim of many ruthless this-won't-work-let's-try-that-instead cycles, but I believe I've nailed basic functionality well enough to post it here.. so, once again, I'll be happy to hear any comments you folks can provide
      https://modules.processwire.com/modules/process-changelog/
      https://github.com/teppokoivula/ProcessChangelog
      How does it work?
      Exactly like it's (sort of) predecessor, Process Changelog actually consists of two modules: Process Changelog and Process Changelog Hooks. Hooks module exists only to serve main module by hooking into various functions within Pages class, collecting data of performed operations, refining it and keeping up a log of events in it's own custom database table (process_changelog.) Visible part is managed by Process Changelog, which provides users a (relatively) pretty view of the contents of said log table.
      How do you use it?
      When installed this module adds new page called Changelog under Admin > Setup which provides you with a table view of collected data and basic filtering tools See attached screenshots to get a general idea about what that page should look like after a while.
      For detailed installation instructions etc. see README.md.
       


    • By Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-08-08
      2019-06-15
      2019-06-02
      2019-05-25
      If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.54
      Composer: rockett/jumplinks
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! :)
    • By nbcommunication
      I've spent the last while experimenting with srcset implementation - and PageimageSrcset is the result:
      PageimageSrcset
      Provides configurable srcset and sizes properties/methods for Pageimage.
      Overview
      The main purpose of this module is to make srcset implementation as simple as possible in your template code. It does not handle images rendered in CKEditor or similar fields.
      For an introduction to srcset and sizes, please read this Mozilla article about responsive images.
      Pageimage::srcset()
      // The property, which uses the set rules in the module configuration $srcset = $image->srcset; // A method call, using a set rules string // Delimiting with a newline (\n) would also work, but not as readable $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x"); // The same as above but using an indexed/sequential array $srcset = $image->srcset([ "320", "480", "640x480 768w", "1240", "2048 2x", ]); // The same as above but using an associative array // No rule checking is performed $srcset = $image->srcset([ "320w" => [320], "480w" => [480], "768w" => [640, 480], "1240w" => [1240], "2x" => [2048], ]); // Use the default set rules with portrait images generated for mobile/tablet devices $srcset = $image->srcset(true); // Return the srcset using all arguments $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x", [ "portrait" => "320, 640", ]); // The set rules above are a demonstration, not a recommendation! Image variations are only created for set rules which require a smaller image than the Pageimage itself. On large sites this may still result in a lot of images being generated. If you have limited storage, please use this module wisely.
      Portrait Mode
      In many situations, the ratio of the image does not need to change at different screen sizes. However, images that cover the entire viewport are an exception to this and are often the ones that benefit most from srcset implementation.
      The main problem with cover images is that they need to display landscape on desktop devices and portrait when this orientation is used on mobile and tablet devices.
      You can automatically generate portrait images by enabling portrait mode. It is recommended that you use this in combination with Pageimage::focus() so that the portrait variations retain the correct subject.
      The generated variations are HiDPI/Retina versions. Their height is determined by the portrait ratio (e.g. 9:16). Variations are always generated, regardless of whether the original image is smaller. Upscaling is disabled though, so you may find that some variations are actually smaller than they say they are in their filename.
      The sizes attribute should be used when portrait mode is enabled. Pageimage::sizes will return (orientation: portrait) and (max-width: {maxWidth}px) 50vw by default, which handles the use of these images for retina devices. The maximum width used in this rule is the largest set width.
      Pageimage::sizes()
      There is no option to configure default sizes because in most cases 100vw is all you need, and you do not need to output this anyway as it is inferred when using the srcset attribute. You can use the method for custom sizes though:
      // The property $sizes = $image->sizes; // Returns 100vw in most cases // Returns '(orientation: portrait) and (max-width: {maxWidth}px)50vw' if portrait mode enabled // A method call, using a mixture of integer widths and media query rules // Integer widths are treated as a min-width media query rule $sizes = $image->sizes([ 480 => 50, "(orientation: portrait) and (max-width: 640px)" => 100, 960 => 25, ]); // (min-width: 480px) 50vw, (orientation: portrait) and (max-width: 640px) 100vw, (min-width: 960px) 25vw // Determine widths by UIkit 'child-width' classes $sizes = $image->sizes([ "uk-child-width-1-2@s", "uk-child-width-1-3@l", ]); // (min-width: 640px) 50vw, (min-width: 1200px) 33.33vw // Determine widths by UIkit 'width' classes $sizes = $image->sizes([ "uk-width-1-2@m", "uk-width-1-3@xl", ]); // (min-width: 960px) 50vw, (min-width: 1600px) 33.33vw // Return the portrait size rule $sizes = $image->sizes(true); // (orientation: portrait) and (max-width: {maxWidth}px) 50vw // The arguments above are a demonstration, not a recommendation! Pageimage::render()
      This module extends the options available to this method with:
      srcset: When the module is installed, this will always be added, unless set to false. Any values in the formats described above can be passed. sizes: Only used if specified. Any values in the formats described above can be passed. uk-img: If passed, as either true or as a valid uk-img value, then this attribute will be added. The srcset attribute will also become data-srcset. Please refer to the API Reference for more information about this method.
      // Render an image using the default set rules echo $image->render(); // <img src='image.jpg' alt='' srcset='{default set rules}'> // Render an image using custom set rules echo $image->render(["srcset" => "480, 1240x640"]); // <img src='image.jpg' alt='' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w'> // Render an image using custom set rules and sizes // Also use the `markup` argument echo $image->render("<img class='image' src='{url}' alt='Image'>", [ "srcset" => "480, 1240", "sizes" => [1240 => 50], ]); // <img class='image' src='image.jpg' alt='Image' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 1240px) 50vw'> // Render an image using custom set rules and sizes // Enable uk-img echo $image->render([ "srcset" => "480, 1240", "sizes" => ["uk-child-width-1-2@m"], "uk-img" => true, ]); // <img src='image.jpg' alt='' data-uk-img data-srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 960px) 50vw'> // Render an image using portrait mode // Default rule sets used: 320, 640, 768, 1024, 1366, 1600 // Portrait widths used: 320, 640, 768 // Original image is 1000px wide // Not possible to use portrait mode and custom sets or portrait widths in render() // Sizes attribute automatically added echo $image->render(["srcset" => true]); // <img src='image.jpg' alt='' srcset='image.320x569-srcset-hidpi.jpg 320w, image.640x1138-srcset-hidpi.jpg 640w, image.768x1365-srcset-hidpi.jpg 768w, image.jpg 1024w' sizes='(orientation: portrait) and (max-width: 768px) 50vw'> Configuration
      To configure this module, go to Modules > Configure > PageimageSrcset.
      Set Rules
      These are the default set rules that will be used when none are specified, e.g. when calling the property: $image->srcset.
      Each set rule should be entered on a new line, in the format {width}x{height} {inherentwidth}w|{resolution}x.
      Not all arguments are required - you will probably find that specifying the width is sufficient for most cases. Here's a few examples of valid set rules and the sets they generate:
      Set Rule Set Generated Arguments Used 320 image.320x0-srcset.jpg 320w {width} 480x540 image.480x540-srcset.jpg 480w {width}x{height} 640x480 768w image.640x480-srcset.jpg 768w {width}x{height} {inherentwidth}w 2048 2x image.2048x0-srcset.jpg 2x {width} {resolution}x How you configure your rules is dependent on the needs of the site you are developing; there are no prescriptive rules that will meet the needs of most situations. This article gives a good overview of some of the things to consider.
      When you save your rules, a preview of the sets generated and an equivalent method call will be displayed to the right. Invalid rules will not be used, and you will be notified of this.
      Portrait Mode
      Set Widths
      A comma limited list of widths to create HiDPI/Retina portrait variations for.
      Crop Ratio
      The portrait ratio that should be used to crop the image. The default of 9:16 should be fine for most circumstances as this is the standard portrait ratio of most devices. However, you can specify something different if you want. If you add a landscape ratio, it will be switched to portrait when used.
      Any crops in the set rules ({width}x{height}) are ignored for portrait mode variations as this ratio is used instead.
      UIkit Widths
      If your website theme uses UIkit, you can pass an array of UIkit width classes to Pageimage::sizes to be converted to sizes. The values stored here are used to do this. If you have customised the breakpoints on your theme, you should also customise them here.
      Please note that only 1- widths are evaluated by Pageimage::sizes, e.g. uk-width-2-3 will not work.
      Remove Variations
      If checked, the image variations generated by this module are cleared on Submit. On large sites, this may take a while. It makes sense to run this after you have made changes to the set rules.
      Image Suffix
      You will see this field when Remove Variations is checked. The value is appended to the name of the images generated by this module and is used to identify variations. You should not encounter any issues with the default suffix, but if you find that it conflicts with any other functionality on your site, you can set a custom suffix instead.
      Debug Mode
      When this is enabled, a range of information is logged to pageimage-srcset.
      PageimageSrcsetDebug.js is also added to the <head> of your HTML pages. This will console.log a range of information about the images and nodes using srcset on your page after a window.onresize event is triggered. This can assist you in debugging your implementation.
      The browser will always use the highest resolution image it has loaded or has cached. You may need to disable browser caching to determine whether your set rules are working, and it makes sense to work from a small screen size and up. If you do it the other way, the browser is going to continue to use the higher resolution image it loaded first.
      UIkit Features
      This module implements some additional features that are tailored towards UIkit being used as the front-end theme framework, but this is not required to use the module.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. ProcessWire >= 3.0.123 is required to use this module.
    • By nbcommunication
      Wondering how to get that A+ rating on Mozilla Observatory? Now you can with ⭐⭐⭐MarkupContentSecurityPolicy⭐⭐⭐
      Of course, MarkupContentSecurityPolicy does not guarantee an A+ rating, but it does help you implement a Content Security Policy for your ProcessWire website.
      Markup Content Security Policy
      Configure and implement a Content Security Policy for all front-end HTML pages.
      This module should only be used in production once it has been fully tested in development. Implementing a Content Security Policy on a site without testing will almost certainly break something!
      Overview
      Website Security Auditing Tools such as Mozilla Observatory will only return a high score if a Content Security Policy is implemented. It is therefore desirable to implement one.
      A common way of adding the Content-Security-Policy header would be to add it to the .htaccess file in the site's root directory. However, this means the policy would also cover the ProcessWire admin, and this limits the level of security policy you can add.
      The solution is to use the <meta> element to configure a policy, for example: <meta http-equiv="Content-Security-Policy" content="default-src 'self'; img-src https://*; child-src 'none';">. MarkupContentSecurityPolicy places this element with your configured policy at the beginning of the <head> element on each HTML page of your site.
      There are some limitations to using the <meta> element:
      Not all directives are allowed. These include frame-ancestors, report-uri, and sandbox. The Content-Security-Policy-Report-Only header is not supported, so is not available for use by this module. Configuration
      To configure this module, go to Modules > Configure > MarkupContentSecurityPolicy.
      Directives
      The most commonly used directives are listed, with a field for each. The placeholder values given are examples, not suggestions, but they may provide a useful starting point.
      You will almost certainly need to use 'unsafe-inline' in the style-src directive as this is required by some modules (e.g. TextformatterVideoEmbed) or frameworks such as UIkit.
      Should you wish to add any other directives not listed, you can do so by adding them in Any other directives.
      Please refer to these links for more information on how to configure your policy:
      https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy https://scotthelme.co.uk/content-security-policy-an-introduction/ https://developers.google.com/web/fundamentals/security/csp/ Violation Reporting
      Because the report-uri directive is not available, when Violation Reporting is enabled a script is added to the <head>which listens for a SecurityPolicyViolationEvent. This script is based on https://developer.mozilla.org/en-US/docs/Web/API/SecurityPolicyViolationEvent and POSTs the generated report to ?csp-violations=1. The module then logs the violation report to csp-violations.
      Unfortunately, most of the violations that are reported are false positives, and not actual attempts to violate the policy. These are most likely from browser extensions and are not easy to determine and filter.
      For this reason, there is no option for the report to be emailed when a policy is violated. Instead, you can specify an endpoint for the report to be sent to. This allows you to handle additional reporting in a way that meets your needs. For example, you may want to log all reports in a central location and send out an email once a day to an administrator notifying them of all sites with violations since the last email.
      Retrieving the Report
      To retrieve the report at your endpoint, the following can be used:
      $report = file_get_contents("php://input"); if(!empty($report)) { $report = json_decode($report, 1); if(isset($report) && is_array($report) && isset($report["documentURI"])) { // Do something } } Debug Mode
      When this is enabled, a range of information is logged to markup-content-security-policy. This is probably most useful when debugging a reporting endpoint.
      Additional .htaccess Rules
      To get an A+ score on Mozilla Observatory, besides using HTTPS and enabling the HSTS header, you can also place the following prior to ProcessWire's htaccess directives:
      Header set Content-Security-Policy "frame-ancestors 'self'" Header set Referrer-Policy "no-referrer-when-downgrade" Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. ProcessWire >= 3.0.123 is required to use this module.
×
×
  • Create New...