Jump to content

3 new beginner modules


benbyf
 Share

Recommended Posts

Hi!

I've been making my first modules and I've created three so far to help me learn. I would love so feedback or pull requests for improvements as I hope to write a tutorial about my work soon. In particular the third modules isn't very finished.

git: https://github.com/benbyford/PW-starter-modules/

  • HelloUserYouSaved - adds message {your user name, page saved} in admin when a page is saved.

    • This module shows how to implement a basic module,
    • get and use variables,
    • create a message in the admin
  • RedirectAdminPages - redirect specific user role to a custom page set in the module config.

    • This module shows how to implement module configuration,
    • using variables saved in the admin,
    • redirecting a user using session->redirect()
  • HotSwapUser - Swap user on the fly in the admin or frontend of your site

    • This module shows how users can be used in a module
    • how to set a user permission
    • how to install / uninstall something within your module
    • how to create a function that can be output in the frontend of your site.
  • Like 10
Link to comment
Share on other sites

Hi!

Very good initiative! ^-^

I have skimread through the code and my opinion is: The first and second ones looks good. But to be honest, this hotswap user thing is a big security issue. Sorry! :)

Also only for demonstration / tutorial purposes, it is better not to use hot user swapping as a thema. The audience for beginner tutorials often will be, yes, the name says it: beginners. And assumed they simply do not know about such security issues and best practices in regard of how to validate user-inputs, you should not show code like this to them. At least you would need to embedd all security relevant stuff too. But then it fastly will become to complex for a beginner tutorial. A good one would be to only pick up how to validate user inputs and how PW provides good tools for that. (type and format validation, whitelist matching, ...)

With your code, everyone can login with each existing account (also Superuser) just by knowing / trying (multiple til endless!) user name(s). In regard to this, you may have a look into ALIF or TracyDebugger, how the security for this is tackled there.

I hope you do not mind me my frankness.

-------------

Looking to the code of the users redirect module, you can shorten it a bit. When found a matching user / role, you don't need to store true in a temporary var, break the loop and then check the temporary vars value / state, if you should redirect the current user. You simply can redirect the current user if a role matches:

    /*
    * ___renderPageRedirect
    *
    * redirect user to page if current user role found in config
    */
    public function ___renderPageRedirect($event) {

        // check to see if current page = admin template page
        // otherwise: early return!
        if($this->page->template != "admin") {
            return;
        }

        // find roles set in module configuration and create array
        $roles = explode(',', $this->userRoles);

        // for each user in module config check to see if current user
        foreach ($roles as $key => $val) {
            $roles[$key] = trim($roles[$key]);

            // if current user found then redirect = true
            if($this->user->hasRole($roles[$key])) {

                // this will leave the page and code immediately!
                $this->session->redirect($this->redirectPage);

                // stop user search
                break; // this can stay in here, just as fallback, 
                       // if something went wrong with calling the redirect, 
                       // but normally this line will not get executed.
            }
        }
    }

 

  • Like 4
Link to comment
Share on other sites

Hi Horst! Thanks for you code amends, will alter now.

I totally agree with you, the third module not really beginner level and needs a heck load more work on it before anyone was to actually use it. The security aspect I'm looking at next and thanks for those links.

Bar the first module, I was trying to make modules that didn't already exist that would be useful and interesting for me to make and had aspects I could teach. If you have any more suggestions for a third module whcih doesn't already exist then I'm all ears.

Thanks,

  • Like 2
Link to comment
Share on other sites

8 minutes ago, benbyf said:

If you have any more suggestions for a third module whcih doesn't already exist then I'm all ears.

You could write a beginner module about Fieldtype/Inputfield which accept a simple text, save it and render its markup :rolleyes:.

As Horst said, nice initiative !

  • Like 5
Link to comment
Share on other sites

A simple fieldtype might be "Name", where you enter a firstname and a lastname, which is stored separately and maybe a computed property for the fullname. I think it shouldn't hold more values, as it'll probably become complex just for the amount of fields. 

Also interesting might be other often extended core classes/modules like Process or Textformatter, with the latter actually being quite simple with often just a single method.

  • Like 4
Link to comment
Share on other sites

Ok been trying to take on everyones comments. In doing so I've split repos into beginner and intermediate.

https://github.com/benbyford/PW-starter-modules/
https://github.com/benbyford/PW-intermediate-modules

In doing so I can add to them with simple and more complex modules as and when I create them (and learn a new skill). The basic ones are currently super basic, so could probably do a couple more and then stop of crucial things to learn in modeul making. Any more suggestions welcome.

  • Like 5
Link to comment
Share on other sites

I think composer and dependency mamgement in general is a little out of scope for this series of module creation tutorials, looks interesting though, I've never felt the need for this myself mostly working on small projects and happy using profile exporting and wireshell for different installing / exporting tasks.

Link to comment
Share on other sites

  • 2 weeks later...
  • 3 weeks later...

Added new module PageDeferredPublish to Intermediate modules - Module allows you to publish a page at a time interval in the future e.g. 24hrs.

  • adds Publish Later buttons to edit page and page tree
  • uses LazyCron to count down pages that are both unpublished and have been checked to publish later
  • when page count down reaches 0, page publishes
     

Screenshot 2016-08-12 10.51.38.png

Screenshot 2016-08-12 10.51.16.png

  • Like 7
Link to comment
Share on other sites

  • 2 weeks later...

Great work @benbyf!

I understand you wrote the tutorial to show that the module can do stuff on installing and uninstalling. There is another example you could use to handle creating pages and permissions (more info):

public static function getModuleInfo() {
	return array(

		// Some default stuff
		'title' => 'Title of the module',
		'version' => 001,
		'summary' => 'Summary of the module',
		'autoload' => false,
		'singular' => true,
		'icon' => 'bookmark',
		'permission' => 'name-of-the-permission',

		// Creates the page (and removes after uninstalling)
		'page' => array(
			'name' => 'name-of-the-page',
			'parent' => 'admin', // Or whatever
			'title' => 'Title of the Page',
			),	
		
		// Creates the permission (and removes after uninstalling)
		'permissions' => array(
			'name-of-the-permission' => 'Title of the permission'
			),
	);
}

Written in browser, so not tested. I guess you'll get the idea ;)

Edited by arjen
link added
  • Like 5
Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share

  • Recently Browsing   0 members

    • No registered users viewing this page.
  • Similar Content

    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.
      https://github.com/techcnet/ProcessFileManager

      Warning
      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      Dragscroll
      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
       
    • By tcnet
      This module implements the website live chat service from tawk.to. Actually the module doesn't have to do much. It just need to inserted a few lines of JavaScript just before the closing body tag </body> on each side. However, the module offers additional options to display the widget only on certain pages.
      Create an account
      Visit https://www.tawk.to and create an account. It's free! At some point you will reach a page where you can copy the required JavaScript-code.

      Open the module settings and paste the JavaScript-code into the field as shown below. Click "Submit" and that's all.

      Open the module settings
      The settings for this module are located int the menu Modules=>Configure=>LiveChatTawkTo.

       
    • By tcnet
      Session Viewer is a module for ProcessWire to list session files and display session data. This module is helpful to display the session data of a specific session or to kick out a logged in user by simply delete his session file. After installation the module is available in the Setup menu.

      The following conditions must be met for the module to work properly:
      Session files
      Session data must be stored in session files, which is the default way in ProcessWire. Sessions stored in the database are not supported by this module. The path to the directory where the session files are stored must be declared in the ProcessWire configuration which is by default: site/assets/sessions.
      Serialize handler
      In order to transform session data easier back to a PHP array, the session data is stored serialized. PHP offers a way to declare a custom serialize handler. This module supports only the default serialize handlers: php, php_binary and php_serialize. WDDX was dropped in PHP 7.4.0 and is therefore not supported by this module as well as any other custom serialize handler. Which serialize handler is actually used you can find out in the module configuration which is available under Modules=>Configure=>SessionViewer.

      Session data
      The session data can be displayed in two different ways. PHP's default output for arrays print_r() or by default for this module nice_r() offered on github: https://github.com/uuf6429/nice_r. There is a setting in the module configuration if someone prefers print_r(). Apart from the better handling and overview of the folded session data the output of nice_r() looks indeed nicer.

      Links
      ProcessWire module directory
      github.com
    • By Robin S
      Repeater Easy Sort
      Adds a compact "easy-sort" mode to Repeater and Repeater Matrix, making those fields easier to sort when there are a large number of items.
      The module also enhances Repeater Matrix by allowing a colour to be set for each matrix type. This colour is used in the item headers and in the "add new" links, to help visually distinguish different matrix types in the inputfield.
      Screencasts
      A Repeater field

      A Repeater Matrix field with custom header colours

      Easy-sort mode
      Each Repeater/Matrix item gets an double-arrow icon in the item header. Click this icon to enter easy-sort mode.
      While in easy-sort mode:
      The items will reduce in width so that more items can be shown on the screen at once. The minimum width is configurable in the field settings. Any items that were in an open state are collapsed, but when you exit easy-sort mode the previously open items will be reopened. You can drag an item left/right/up/down to sort it within the items. The item that you clicked the icon for is shown with a black background. This makes it easier to find the item you want to move in easy-sort mode. You can click an item header to open the item. An "Exit easy-sort mode" button appears at the bottom of the inputfield. Configuration
      In the field settings for Repeater and Repeater Matrix fields you can define a minimum width in pixels for items in easy-sort mode. While in easy-sort mode the items will be sized to neatly fill the available width on any screen size but will never be narrower than the width you set here.
      In the field settings for Repeater Matrix you can define a custom header colour for each matrix type using an HTML "color" type input. The default colour for this type of input is black, so when black is selected in the input it means that no custom colour will be applied to the header.
      Exclusions
      The easy-sort mode is only possible on Repeater/Matrix fields that do not use the "item depth" option.
       
      https://github.com/Toutouwai/RepeaterEasySort
      https://processwire.com/modules/repeater-easy-sort/
×
×
  • Create New...