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 Robin S
      First a note about my other modules...
      I have three existing modules that are similar in that they allow restrictions to be placed on repeating inputfields: Limit Repeater, Limit PageTable, Limit Table
      Restrict Repeater Matrix takes a different approach to the module configuration from those other modules. The module settings for Restrict Repeater Matrix are applied in the field settings rather in a module config screen. I think this new approach is better, but it means that it isn't practical to create different settings for different roles via the admin interface. Instead the module has a hookable method, allowing roles to be targeted and other advanced usages to be achieved via a hook. The result is that the module is more flexible.
      I intend to transition my other modules to the same approach over the coming weeks, but because this will result in breaking changes I will be releasing the updated modules under new names ("Restrict Repeater", etc) to avoid users upgrading via the Upgrades module without full awareness of the changes. The old modules will be marked as deprecated.
      Restrict Repeater Matrix
      A module for ProcessWire CMS/CMF. Allows restrictions and limits to be placed on Repeater Matrix fields. Requires ProcessWire >= v3.0.0 and FieldtypeRepeaterMatrix >= v0.0.5.
      For any matrix type in a Repeater Matrix field you have the option to:
      Disable settings for items (cannot change matrix type) Prevent drag-sorting of items Prevent cloning of items Prevent toggling of the published state of items Prevent trashing of items Limit the number of items that may be added to the inputfield. When the limit is reached the "Add new" button for the matrix type will be removed and the matrix type will not be available for selection in the "Type" dropdown of other matrix items. Please note that restrictions and limits are applied with CSS/JS so should not be considered tamper-proof.
      Usage
      Install the Restrict Repeater Matrix module.
      For each matrix type created in the Repeater Matrix field settings, a "Restrictions" fieldset is added at the bottom of the matrix type settings:

      For newly added matrix types, the settings must be saved first in order for the Restrictions fieldset to appear. Set restrictions for each matrix type as needed. A limit of zero means that no items of that matrix type may be added to the inputfield.
      Setting restrictions via a hook
      Besides setting restrictions in the field settings, you can also apply or modify restrictions by hookingRestrictRepeaterMatrix::checkRestrictions. This allows for more focused restrictions, for example, applying restrictions depending on the template of the page being edited or depending on the role of the user.
      The checkRestrictions() method receives the following arguments:
      $field This Repeater Matrix field $inputfield This Repeater Matrix inputfield $matrix_types An array of matrix types for this field. Each key is the matrix type name and the value is the matrix type integer. $page The page that is open in ProcessPageEdit The method returns a multi-dimensional array of matrix types and restrictions for each of those types. An example of a returned array:

      Example hooks
      Prevent the matrix type "images_block" from being added to "my_matrix_field" in a page with the "basic-page" template:
      $wire->addHookAfter('RestrictRepeaterMatrix::checkRestrictions', function(HookEvent $event) { $field = $event->arguments('field'); $page = $event->arguments('page'); $type_restrictions = $event->return; if($field->name === 'my_matrix_field' && $page->template->name === 'basic-page') { $type_restrictions['images_block']['limit'] = 0; } $event->return = $type_restrictions; }); Prevent non-superusers from trashing any Repeater Matrix items in "my_matrix_field":
      $wire->addHookAfter('RestrictRepeaterMatrix::checkRestrictions', function(HookEvent $event) { $field = $event->arguments('field'); $type_restrictions = $event->return; if($field->name === 'my_matrix_field' && !$this->user->isSuperuser()) { foreach($type_restrictions as $key => $value) { $type_restrictions[$key]['notrash'] = true; } } $event->return = $type_restrictions; }); http://modules.processwire.com/modules/restrict-repeater-matrix/
      https://github.com/Toutouwai/RestrictRepeaterMatrix
    • By BitPoet
      Here's a little text formatter module that redirects all external links found in a textarea (e.g. for hit counting) to a given URL.
      TextformatterExternalRedirect
      GitHub repo
      As TextFormatters do, this module modifies the contents of the textarea (HTML) at rendering time. It prepends the given URL to the link address for external links (http and https), optionally makes sure that the link is opened in a new window and allows you to add css classes to such links.
      All options can be configured in the module's configuration settings.
      Usage:
      Download the zip archive and extract it to site/modules, the rename the top folder to TextformatterExternalRedirect Go to the backend and select "Modules" -> "Refresh", then click "Install" for "External Link Redirect" Click "Settings" and configure the module
      Go into the field configuration for the field(s) you want this formatter to apply to and add it from the dropdown
      Done, now any external links in the configured fields will have the configured settings applied Feel free to leave feedback and post and questions you have here.
       
    • By teppo
      Hey folks!
      Took a couple of late nights, but managed to turn this old gist of mine into a proper module. The name is SearchEngine, and currently it provides support for indexing page contents (into a hidden textarea field created automatically), and also includes a helper feature ("Finder") for querying said contents. No fancy features like stemming here yet, but something along those lines might be added later if it seems useful (and if I find a decent implementation to integrate).
      Though the API and selector engine make it really easy to create site search pages, I pretty much always end up duplicating the same features from site to site. Also – since it takes a bit of extra time – it's tempting to skip over some accessibility related things, and leave features like text highlighting out. Overall I think it makes sense to bundle all that into a module, which can then be reused over and over again 🙂
      Note: markup generation is not yet built into the module, which is why the examples below use PageArray::render() method to produce a simple list of results. This will be added later on, as a part of the same module or a separate Markup module. There's also no fancy JS API or anything like that (yet).
      This is an early release, so be kind – I got the find feature working last night (or perhaps this morning), and some final tweaks and updates were made just an hour ago 😅
      GitHub repository: https://github.com/teppokoivula/SearchEngine Modules directory: https://modules.processwire.com/modules/search-engine/ Demo: https://wireframe-framework.com/search/ Usage
      Install SearchEngine module. Note: the module will automatically create an index field install time, so be sure to define a custom field (via site config) before installation if you don't want it to be called "search_index". You can change the field name later as well, but you'll have to update the "index_field" option in site config or module settings (in Admin) after renaming it.
      Add the site search index field to templates you want to make searchable. Use selectors to query values in site search index. Note: you can use any operator for your selectors, you will likely find the '=' and '%=' operators most useful here. You can read more about selector operators from ProcessWire's documentation.
      Options
      By default the module will create a search index field called 'search_index' and store values from Page fields title, headline, summary, and body to said index field when a page is saved. You can modify this behaviour (field name and/or indexed page fields) either via the Module config screen in the PocessWire Admin, or by defining $config->SearchEngine array in your site config file or other applicable location:
      $config->SearchEngine = [ 'index_field' => 'search_index', 'indexed_fields' => [ 'title', 'headline', 'summary', 'body', ], 'prefixes' => [ 'link' => 'link:', ], 'find_args' => [ 'limit' => 25, 'sort' => 'sort', 'operator' => '%=', 'query_param' => null, 'selector_extra' => '', ], ]; You can access the search index field just like any other ProcessWire field with selectors:
      if ($q = $sanitizer->selectorValue($input->get->q)) { $results = $pages->find('search_index%=' . $query_string . ', limit=25'); echo $results->render(); echo $results->renderPager(); } Alternatively you can delegate the find operation to the SearchEngine module as well:
      $query = $modules->get('SearchEngine')->find($input->get->q); echo $query->resultsString; // alias for $query->results->render() echo $query->pager; // alias for $query->results->renderPager() Requirements
      ProcessWire >= 3.0.112 PHP >= 7.1.0 Note: later versions of the module may require Composer, or alternatively some additional features may require installing via Composer. This is still under consideration – so far there's nothing here that would really depend on it, but advanced features like stemming most likely would.
      Installing
      It's the usual thing: download or clone the SearchEngine directory into your /site/modules/ directory and install via Admin. Alternatively you can install SearchEngine with Composer by executing composer require teppokoivula/search-engine in your site directory.
    • By teppo
      MarkupMenu is a markup module for generating menu trees. When provided a root page as a starting point, it generates a navigation tree (by default as a HTML "<ul>" element wrapped by a "<nav>" element) from that point onwards. If you've also provided it with current (active) page, the menu will be rendered accordingly, with current item highlighted and items rendered up to that item and its children (unless you disable the "collapsed" option, in which case the full page tree will be rendered instead).
      Modules directory: https://modules.processwire.com/modules/markup-menu/ GitHub repository: https://github.com/teppokoivula/MarkupMenu Usage
      As a markup module, MarkupMenu is intended for front-end use, but you can of course use it in a module as well. Typically you'll only need the render() method, which takes an array of options as its only argument:
      echo $modules->get('MarkupMenu')->render([ 'root_page' => $pages->get(1), 'current_page' => $page, ]); Note: if you omit root_page, site root page is used by default. If you omit current_page, the menu will be rendered, but current (active) page won't be highlighted etc.
      A slightly more complex example, based on what I'm using on one of my own sites to render a (single-level) top menu:
      echo $modules->get('MarkupMenu')->render([ 'current_page' => $page, 'templates' => [ 'nav' => '<nav class="{classes} menu--{menu_class_modifier}" aria-label="{aria_label}">%s</nav>', 'item_current' => '<a class="menu__item menu__item--current" href="{item.url}" tabindex="0" aria-label="Current page: {item.title}">{item.title}</a>', ], 'placeholders' => [ 'menu_class_modifier' => 'top', 'aria_label' => 'Main navigation', ], 'include' => [ 'root_page' => true, ], 'exclude' => [ 'level_greater_than' => 1, ], ]); Note: some things you see above may not be entirely sensible, such as the use of {menu_class_modifier} and {aria_label} placeholders. On the actual site the "nav" template is defined in site config, so I can define just these parts on a case-by-case basis while actual nav markup is maintained in one place.
      Please check out the README file for available render options. I'd very much prefer not to keep this list up to date in multiple places. Basically there are settings for defining "templates" for different parts of the menu (list, item, etc.), include array for defining rules for including in the menu and exclude array for the opposite effect, classes and placeholders arrays for overriding default classes and injecting custom placeholders, etc. 🙂
      MarkupMenu vs. MarkupSimpleNavigation
      TL;DR: this is another take on the same concept. There are many similarities, but also some differences – especially when it comes to the supported options and syntax. If you're currently using MarkupSimpleNavigation then there's probably no reason to switch over.
      I'd be surprised if someone didn't draw lines between this module and Soma's awesome MarkupSimpleNavigation. Simply put I've been using MSN (...) for years, and it's been great – but there are some issues with it, particularly in the markup generation area, and it also does some things in a way that doesn't quite work for me – the xtemplates thing being one of these. In some ways less about features, and more about style, I guess 🙂
      Anyhow, in MarkupMenu I've tried to correct those little hiccups, modernise the default markup, and allow for more flexibility with placeholder variables and additional / different options. MarkupMenu was built for ProcessWire 3.0.112+ and with PHP 7.1+ in mind, it's installable with Composer, and I have a few additional ideas (such as conditional placeholders) still on my todo list.
      One more small(ish) difference is that MarkupMenu supports overriding default options via $config->MarkupMenu. I find myself redefining the default markup for every site, which until now meant that each site had a wrapper function for MarkupSimpleNavigation (to avoid code / config repetition), and this way I've been able to leave that out 🙂
      Requirements
      ProcessWire >= 3.0.112 PHP >= 7.1.0 If you're working on an earlier version of ProcessWire or PHP, use MarkupSimpleNavigation instead.
    • By teppo
      Hey folks!
      I'm happy to finally introduce a project I've been working on for quite a while now: it's called Wireframe, and it is an output framework for ProcessWire.
      Note that I'm posting this in the module development area, maily because this project is still in rather early stage. I've built a couple of sites with it myself, and parts of the codebase have been powering some pretty big and complex sites for many years now, but this should still be considered a soft launch 🙂
      --
      Long story short, Wireframe is a module that provides the "backbone" for building sites (and apps) with ProcessWire using an MVC (or perhaps MVVM – one of those three or four letter abbreviations anyway) inspired methodology. You could say that it's an output strategy, but I prefer the term "output framework" since in my mind the word "strategy" means something less tangible. A way of doing things, rather than a tool that actually does things.
      Wireframe (the module) provides a basic implementation for some familiar MVC concepts, such as Controllers and a View layer – the latter of which consists of layouts, partials, and template-specific views. There's no "model" layer, since in this context ProcessWire is the model. As a module Wireframe is actually quite simple – not even nearly the biggest one I've built – but there's still quite a bit of stuff to "get", so I've put together a demo & documentation site for it at https://wireframe-framework.com/.
      In addition to the core module, I'm also working on a couple of site profiles based on it. My current idea is actually to keep the module very light-weight, and implement most of the "opinionated" stuff in site profiles and/or companion modules. For an example MarkupMenu (which I released a while ago) was developed as one of those "companion modules" when I needed a menu module to use on the site profiles.
      Currently there are two public site profiles based on Wireframe:
      site-wireframe-docs is the demo&docs site mentioned above, just with placeholder content replaced with placeholder content. It's not a particularly complex site, but I believe it's still a pretty nice way to dig into the Wireframe module. site-wireframe-boilerplate is a boilerplate (or starter) site profile based on the docs site. This is still very much a work in progress, but essentially I'm trying to build a flexible yet full-featured starter profile you can just grab and start building upon. There will be a proper build process for resources, it will include most of the basic features one tends to need from site to site, etc. --
      Requirements and getting started:
      Wireframe can be installed just like any ProcessWire module. Just clone or download it to your site/modules/ directory and install. It doesn't, though, do a whole lot of stuff on itself – please check out the documentation site for a step-by-step guide on setting up the directory structure, adding the "bootstrap file", etc. You may find it easier to install one of the site profiles mentioned above, but note that this process involves the use of Composer. In the case of the site profiles you can install ProcessWire as usual and download or clone the site profile directory into your setup, but after that you should run "composer install" to get all the dependencies – including the Wireframe module – in place. Hard requirements for Wireframe are ProcessWire 3.0.112 and PHP 7.1+. The codebase is authored with current PHP versions in mind, and while running it on 7.0 may be possible, anything below that definitely won't work. A feature I added just today to the Wireframe module is that in case ProcessWire has write access to your site/templates/ directory, you can use the module settings screen to create the expected directories automatically. Currently that's all, and the module won't – for an example – create Controllers or layouts for you, so you should check out the site profiles for examples on these. (I'm probably going to include some additional helper features in the near future.)
      --
      This project is loosely based on an earlier project called pw-mvc, i.e. the main concepts (such as Controllers and the View layer) are very similar. That being said, Wireframe is a major upgrade in terms of both functionality and architecture: namespaces and autoloader support are now baked in, the codebase requires PHP 7, Controllers are classes extending \Wireframe\Controller (instead of regular "flat" PHP files), implementation based on a module instead of a collection of drop-in files, etc.
      While Wireframe is indeed still in a relatively early stage (0.3.0 was launched today, in case version numbers matter) for the most part I'm happy with the way it works, and likely won't change it too drastically anytime soon – so feel free to give it a try, and if you do, please let me know how it went. I will continue building upon this project, and I am also constantly working on various side projects, such as the site profiles and a few unannounced helper modules.
      I should probably add that while Wireframe is not hard to use, it is more geared towards those interested in "software development" type methodology. With future updates to the module, the site profiles, and the docs I hope to lower the learning curve, but certain level of "developer focus" will remain. Although of course the optimal outcome would be if I could use this project to lure more folks towards that end of the spectrum... 🙂
      --
      Please let me know what you think – and thanks in advance!
×
×
  • Create New...