Jump to content

Recommended Posts

OAuth2Login for ProcessWire

A Module which give you ability to login an existing user using your favorite thrid-party OAuth2 provider (i.e. Facebook, GitHub, Google, LinkedIn, etc.)..
You can login from the backend to the backend directly or render a form on the frontend and redirect the user to a choosen page.
Built on top of ThePhpLeague OAuth2-Client lib.

Registration is not handled by this module but planned.

 
Howto Install

Install the module following this procedure:

 - http://modules.processwire.com/modules/oauth2-login/
 - https://github.com/flydev-fr/OAuth2Login

Next step, in order to use a provider, you need to use Composer to install each provider

ie: to install Google, open a terminal, go to your root directory of pw and type the following command-line: composer require league/oauth2-google

Tested providers/packages :

  •     Google :  league/oauth2-google
  •     Facebook: league/oauth2-facebook
  •     Github: league/oauth2-github
  •     LinkedIn: league/oauth2-linkedin


More third-party providers are available there. You should be able to add a provider by simply adding it to the JSON config file.


Howto Use It

First (and for testing purpose), you should create a new user in ProcessWire that reflect your real OAuth2 account information. The important informations are, Last Name, First Name and Email. The module will compare existing users by firstname, lastname and email; If the user match the informations, then he is logged in.

ie, if my Google fullname is John Wick, then in ProcessWire, I create a new user  Wick-John  with email  johnwick@mydomain.com

Next step, go to your favorite provider and create an app in order to get the ClientId and ClientSecret keys. Ask on the forum if you have difficulties getting there.

Once you got the keys for a provider, just paste it into the module settings and save it. One or more button should appear bellow the standard login form.

The final step is to make your JSON configuration file.

In this sample, the JSON config include all tested providers, you can of course edit it to suit your needs :

{
  "providers": {
    "google": {
      "className": "Google",
      "packageName": "league/oauth2-google",
      "helpUrl": "https://console.developers.google.com/apis/credentials"
    },
    "facebook": {
      "className": "Facebook",
      "packageName": "league/oauth2-facebook",
      "helpUrl": "https://developers.facebook.com/apps/",
      "options": {
        "graphApiVersion": "v2.10",
        "scope": "email"
      }
    },
    "github": {
      "className": "Github",
      "packageName": "league/oauth2-github",
      "helpUrl": "https://github.com/settings/developers",
      "options": {
        "scope": "user:email"
      }
    },
    "linkedin": {
      "className": "LinkedIn",
      "packageName": "league/oauth2-linkedin",
      "helpUrl": "https://www.linkedin.com/secure/developer"
    }
  }
}

 

Backend Usage

In ready.php, call the module :

if($page->template == 'admin') { 
	$oauth2mod = $modules->get('Oauth2Login'); 
	if($oauth2mod) $oauth2mod->hookBackend(); 
}

 

Frontend Usage
Small note: At this moment the render method is pretty simple. It output a InputfieldForm with InputfieldSubmit(s) into wrapped in a ul:li tag. Feedbacks and ideas welcome!

For the following example, I created a page login and a template login which contain the following code :


    <?php namespace ProcessWire;

    if(!$user->isLoggedin()) {

            $options = array(
                'buttonClass' => 'my_button_class',
                'buttonValue' => 'Login with {provider}', // {{provider}} keyword
                'prependMarkup' => '<div class="wrapper">',
                'appendMarkup' => '</div>'
            );

            $redirectUri = str_lreplace('//', '/', $config->urls->httpRoot . $page->url);

            $content = $modules->get('Oauth2Login')->config(
              array(
                  'redirect_uri' => $redirectUri,
                  'success_uri'  => $page->url
              )
          )->render($options);
    }


The custom function lstr_replace() :

/*
 *  replace the last occurence of $search by $replace in $subject
 */
function str_lreplace($search, $replace, $subject) {
	return preg_replace('~(.*)' . preg_quote($search, '~') . '~', '$1' . $replace, $subject, 1);
}

 

Screenshot

 

1.thumb.png.e40cc1303d4e404380c4883fc5758520.png

OAuth2Login_pres.thumb.gif.3c120bd397a082cd55c1545b16b0bd49.gif

2.png

  • Like 16

Share this post


Link to post
Share on other sites

The module got renamed and updated a bit as its not intended to run only on the backend, but work also on frontend side.

 

- Now, the administrator can choose to activate or not the backend login buttons.

- The providers are added "dynamically". You have to simply edit a JSON config file which once saved, will show the required fields in the module settings.

 

For example the following JSON config will only provide Google as login provider :

{
  "providers": {
    "google": {
      "className": "Google",
      "packageName": "league/oauth2-google",
      "helpUrl": "https://console.developers.google.com/apis/credentials"
    }
  }
}

 

Small note for pw users :

If like me you did not know, there is another module that manages OAuth2 authentication. Feel free to use the one which suit your needs! more info there:

 

 

@jmartsch you should create a new module thread :)

 

  • Like 5

Share this post


Link to post
Share on other sites

Hey Horst,

I think that in the time the lib was made, Twitter was still using OAuth 1.0A - but looking at their doc (twitter) OAuth2 is now supported (?), their doc also stipulate they still use OAuth 1.0A...

https://dev.twitter.com/oauth

I will look at more closely.

Edited by flydev
link
  • Like 3

Share this post


Link to post
Share on other sites

Some more precisions : We can be able to code an adapter for Twitter application-only, and this is the list of what we can do with :

  • Pull user timelines;
  • Access friends and followers of any account;
  • Access lists resources;
  • Search in Tweets;
  • Retrieve any user information;

So I must assume we can get at least the email and/or the firstname/lastname or a nickname.

@horst let me know if you will think to code something about that or I will give a try.

  • Like 1

Share this post


Link to post
Share on other sites

Many thanks @flydev , for digging deeper!

I'm currently out of resources to code something like this. Was just searching for an already available solution to login via twitter.

Registration should be done via PW only, where the PW username is set to the twitter username.
(Frontend)-Login then should be done via Twitter only.

So, if we would be able to retrieve the email address too, it would be more than I currently need. :)

  • Like 1

Share this post


Link to post
Share on other sites

I quite played with their API (i am talking about Twitter here), its absolutely not possible to retrieve private information with the OAuth2 protocol (still waiting a confirmation on the twittercommunity) but no big hope here. We are forced to use the OAuth 1.a protocol for those sensible datas.

So, there I come with two propositions. I can make an exception and integrate Twitter and OAuth-1.a in this module or I publish a standalone module for Twitter login.

What do you think, a suggestion ?

  • Like 2

Share this post


Link to post
Share on other sites

@flydev: Really I'm not feeling in the right position to give suggestions here. I appreciate all the work and recherche you do here, so you should decide what is lesser work or fits better for you, for what ever reason. - If, at the end, a solution is available that let people login with their twitter account, it would be really great and is much more than there is atm. :-)

  • Like 3

Share this post


Link to post
Share on other sites

Hi @flydev ! Great plugin, works mostly like a charm! ;)

I had 2 issues tough:

1. with google, matching first- and last-name and usernames does not work with our setup (special chars in names that are not reflected in the username etc). I think, this makes the plugin somewhat unflexible. Would be great to have the option configure the matching, or at least an option to only match the users mail (checkbox in the backend). I just saw the "options" "scope" settings in your github json and wonder if this is already implemented but not documented?

2. We run our new page in a subdirectory and the redirect url is wrong (this is more of a process-wire issue since its not easy to get the absolute urls from the api) this results in path being present twice in the redirect url:

Problem: urls()->root + urls()->admin = //domain.com/path/ + /path/admin/ > //domain.com/path/path/admin/

This  solution would be the following:

// inside init()
$this->backendUrl = pages()->get('path="'.str_replace(urls()->root, '', urls()->admin).'", include=all')->httpUrl;

 

Keep up the great work!

  • Like 3

Share this post


Link to post
Share on other sites

@noelboss hey, glad you like it.  Thanks for the fix ! I will merge your PR today.

 

About the issue #1, I will try to implement it the next week-end. Lacking time here.

For the Github scope option, I also need to make it more flexible. The thing is that with Github, if we don't specify the scope, we can only get a public email, and only if the user has set his email "public", which by default is set to hidden, so its impossible to use email address to identify users, and I assume that most users don't want to set their email public..

And about the issue you posted on Github, I think I have already made this modification on my local dev module. I will check that at the same time as the "firstname/lastname" order issue.

  • Thanks 1

Share this post


Link to post
Share on other sites

the moment I copy these lines

if($page->template == 'admin') {
    $oauth2mod = $modules->get('Oauth2Login');
    if($oauth2mod)
        $oauth2mod->hookBackend();
}

on ready.php I am getting this error


Fatal error: Uncaught Error: Call to undefined function ProcessWire\urls() in C:\xampp\htdocs\Yush\wos\site\modules\Oauth2Login\Oauth2Login.module:72 Stack trace: #0 C:\xampp\htdocs\Yush\wos\wire\core\Modules.php(607): ProcessWire\Oauth2Login->init() #1 C:\xampp\htdocs\Yush\wos\wire\core\Modules.php(1288): ProcessWire\Modules->initModule(Object(ProcessWire\Oauth2Login), Array) #2 C:\xampp\htdocs\Yush\wos\wire\core\Modules.php(1145): ProcessWire\Modules->getModule('Oauth2Login') #3 C:\xampp\htdocs\Yush\wos\site\ready.php(13): ProcessWire\Modules->get('Oauth2Login') #4 C:\xampp\htdocs\Yush\wos\wire\core\ProcessWire.php(581): include('C:\\xampp\\htdocs...') #5 C:\xampp\htdocs\Yush\wos\wire\core\ProcessWire.php(479): ProcessWire\ProcessWire->includeFile('C:/xampp/htdocs...') #6 C:\xampp\htdocs\Yush\wos\wire\modules\Process\ProcessPageView.module(246): ProcessWire\ProcessWire->setStatus(4) #7 C:\xampp\htdocs\Yush\wos\wire\core\Wire.php(380): ProcessWire\ProcessPageView->___ready() #8 C:\xampp\htdocs\Yush\wos\wire\core\WireHook in C:\xampp\htdocs\Yush\wos\site\modules\Oauth2Login\Oauth2Login.module on line 72
Error: Uncaught Error: Call to undefined function ProcessWire\urls() in C:\xampp\htdocs\Yush\wos\site\modules\Oauth2Login\Oauth2Login.module:72
Stack trace:
#0 C:\xampp\htdocs\Yush\wos\wire\core\Modules.php(607): ProcessWire\Oauth2Login->init()
#1 C:\xampp\htdocs\Yush\wos\wire\core\Modules.php(1288): ProcessWire\Modules->initModule(Object(ProcessWire\Oauth2Login), Array)
#2 C:\xampp\htdocs\Yush\wos\wire\core\Modules.php(1145): ProcessWire\Modules->getModule('Oauth2Login')
#3 C:\xampp\htdocs\Yush\wos\site\ready.php(13): ProcessWire\Modules->get('Oauth2Login')
#4 C:\xampp\htdocs\Yush\wos\wire\core\ProcessWire.php(581): include('C:\\xampp\\htdocs...')
#5 C:\xampp\htdocs\Yush\wos\wire\core\ProcessWire.php(479): ProcessWire\ProcessWire->includeFile('C:/xampp/htdocs...')
#6 C:\xampp\htdocs\Yush\wos\wire\modules\Process\ProcessPageView.module(246): ProcessWire\ProcessWire->setStatus(4)
#7 C:\xampp\htdocs\Yush\wos\wire\core\Wire.php(380): ProcessWire\ProcessPageView->___ready()
#8 C:\xampp\htdocs\Yush\wos\wire\core\WireHook (line 72 of C:\xampp\htdocs\Yush\wos\site\modules\Oauth2Login\Oauth2Login.module) 

This error message was shown because: site is in debug mode. ($config->debug = true; => /site/config.php). Error has been logged.

 

 

  • Thanks 1

Share this post


Link to post
Share on other sites
3 hours ago, flydev said:

@rareyush I fixed the module, let me know if it works ✌️

I am getting options for outh option of google facebook, linkedin but still I am getting this error when I created a new template just to login

 

 

Error: Uncaught Error: Call to undefined function ProcessWire\str_lreplace() in C:\xampp\htdocs\Yush\wos\site\templates\Login.php:12
Stack trace:
#0 C:\xampp\htdocs\Yush\wos\wire\core\TemplateFile.php(287): require()
#1 C:\xampp\htdocs\Yush\wos\wire\core\Wire.php(380): ProcessWire\TemplateFile->___render()
#2 C:\xampp\htdocs\Yush\wos\wire\core\WireHooks.php(723): ProcessWire\Wire->_callMethod('___render', Array)
#3 C:\xampp\htdocs\Yush\wos\wire\core\Wire.php(442): ProcessWire\WireHooks->runHooks(Object(ProcessWire\TemplateFile), 'render', Array)
#4 C:\xampp\htdocs\Yush\wos\wire\modules\PageRender.module(514): ProcessWire\Wire->__call('render', Array)
#5 C:\xampp\htdocs\Yush\wos\wire\core\Wire.php(383): ProcessWire\PageRender->___renderPage(Object(ProcessWire\HookEvent))
#6 C:\xampp\htdocs\Yush\wos\wire\core\WireHooks.php(723): ProcessWire\Wire->_callMethod('___renderPage', Array)
#7 C:\xampp\htdocs\Yush\wos\wire\core\Wire.php(442): ProcessWire\WireHooks->runHooks(Object(ProcessWire\PageRender), 'renderPage', Array)
(line 12 of C:\xampp\htdocs\Yush\wos\site\templates\Login.php) 

This error message was shown because: site is in debug mode. ($config->debug = true; => /site/config.php). Error has been logged.

I used the code this code

 <?php namespace ProcessWire;

	if(!$user->isLoggedin()) {

		    $options = array(
		        'buttonClass' => 'my_button_class',
		        'buttonValue' => 'Login with {provider}', // {{provider}} keyword
		        'prependMarkup' => '<div class="wrapper">',
		        'appendMarkup' => '</div>'
		    );

		    $redirectUri = str_lreplace('//', '/', $config->urls->httpRoot . $page->url);

		    $content = $modules->get('Oauth2Login')->config(
	          array(
	              'redirect_uri' => $redirectUri,
	              'success_uri'  => $page->url
	          )
	      )->render($options);
	}

 

Share this post


Link to post
Share on other sites

@rareyush  sorry, its a custom function, you can copy paste the code in _func.php or where you want :

 

/*
 *  replace the last occurence of $search by $replace in $subject
 */
function str_lreplace($search, $replace, $subject) {
	return preg_replace('~(.*)' . preg_quote($search, '~') . '~', '$1' . $replace, $subject, 1);
}

 

  • Like 1

Share this post


Link to post
Share on other sites
Can't Load URL: The domain of this URL isn't included in the app's domains. To be able to load this URL, add all domains and subdomains of your app to the App Domains field in your app settings.

having this issue I guess it's related to facebook api

Share this post


Link to post
Share on other sites

Its one of the new Facebook security things yes. Please have a read to this article and  please don't slap me with a large trout, its a WP oriented blog ! 😅

https://wp-native-articles.com/blog/news/how-to-fix-facebook-apps-error-cant-load-url-domain-url-isnt-included-apps-domains/

 

Quote

Facebook has been aggressively tightening security. Any new Facebook Login Apps create AFTER the beginning of March 2018 now have Use Strict Mode for Redirect URIs and Enforce HTTPS enabled by default and can no longer be disabled.

 

  • Like 1

Share this post


Link to post
Share on other sites
4 hours ago, flydev said:

Its one of the new Facebook security things yes. Please have a read to this article and  please don't slap me with a large trout, its a WP oriented blog ! 😅

https://wp-native-articles.com/blog/news/how-to-fix-facebook-apps-error-cant-load-url-domain-url-isnt-included-apps-domains/

 

 

from march 2018 

"Use Strict Mode for Redirect URIs" is is enable for everyone and you just can't disable it 

  • Like 1

Share this post


Link to post
Share on other sites

Hi @quickjeff

It should work out of the box. Just put the code after the LoginRegister execute() function call, done.

 

9 hours ago, quickjeff said:

Or do you suggest not using it together? 


Nope, no reason 🙂

  • Like 1

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 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 apeisa
      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 }  
    • 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.
×
×
  • Create New...