Jump to content
Sebi

New Module: AppApi

Recommended Posts

3 minutes ago, David Lumm said:

Hey all!

I was wondering, is there any concept of "middleware" or hooks that I could attach to so I could run something on every request?

At the moment I've got a couple of things I've added into every route function, but I can anticipate that list getting longer. Rather than copy and paste the same lines into each and potentially miss something, it would be great if I could run it before the route specific code runs. Is that possible @Sebi?

Hi HI David, in PW any function in a module that has ___ at the start, like ___handleApiRequest() in the AppAPI module you can use as a hook in your own code. See https://processwire.com/docs/modules/hooks/

  • Like 2

Share this post


Link to post
Share on other sites
10 minutes ago, benbyf said:

Hi HI David, in PW any function in a module that has ___ at the start, like ___handleApiRequest() in the AppAPI module you can use as a hook in your own code. See https://processwire.com/docs/modules/hooks/

Ah that's great, thanks! I'll take a look at that and see what I can work out!

Share this post


Link to post
Share on other sites
21 hours ago, Sebi said:

Hi @thibaultvdb,

thank you for reporting this issue! 
I'll be honest: In my Apis I actually always use arrays as return values, so I didn't notice this bug. With version 1.1.2, which I just released, you can use a stdclass again instead of an array as return value. 

I hope everything is running smoothly again with your Api? I would be very happy about a short feedback!

hi @Sebi

Awesome, thanks for the quick feedback and fix. Normally I use a lot of array's myself but I had a specific case where a object was the ideal way to go 😛.
I'll test it out in the following days!
Version 1.1.1 is working good for me, however I'm not doing really special stuff with it at the moment so I'm not sure if my case is the best feedback 😛.
I'm just opening the api  for visitors so I can use it a little like a restApi (doing some fancy ajax stuff) and it's doing exactly what I would expect so great work!

If you want me to check some other parts, let me know!

Share this post


Link to post
Share on other sites

Hi @Sebi, I ran into a bug:

Currently the Router::handleError() function incorrectly reports HTTP 500 errors that result from methods that should have remained silent, because they are called with the error control operator '@'.

As the PHP documentation on error control operators puts it: 

Quote

If you have set a custom error handler function with set_error_handler() then it will still get called, but this custom error handler can (and should) call error_reporting() which will return 0 when the call that triggered the error was preceded by an @.

I bumped into this while working on a project with some semi-broken images, where the APP API module kept throwing 500's from PW's ImageInspector class.
Exif issues can be rather difficult to handle sometimes..

The solution is simple: just add a check error_reporting() before the handleError method, for instance

  public static function handleError($errNo, $errStr, $errFile, $errLine)
    {
        if (error_reporting()) {
            $return = new \StdClass();
            $return->error = 'Internal Server Error';
            $return->devmessage = [
                'message' => $errStr,
                'location' => $errFile,
                'line' => $errLine
            ];
            self::displayOrLogError($return, 500);
        }
    }

 

 

  • Like 1

Share this post


Link to post
Share on other sites

I just released version 1.1.3 which resolves three issues that were reported recently:

  • Fixes an issue with the constructor signature of the modules AppApiException class (by @David Lumm, thanks for PR 🤗)
  • Fixes an issue with the error-handler, which made it mistakenly catch errors that should have been ignored via @ operator (Thanks to @eelkenet)
  • Switched from `wire('input')->url` to `$_SERVER['REQUEST_URI']` for reading the base-url, because ProcessWire's internal function transferred everything to lowercase. (Thanks to Github-user @pauldro)

Thank you all for your contributions!

  • Like 2

Share this post


Link to post
Share on other sites

I've read the doco, installed the module & Twack and no matter what I try when retrieving a page, all I get back is a successful Promise or worse, an error message about invalid json. Using React/Nextjs and the page is published, viewable & using the basic-page template. The authorisation is single JWT and the client JS code is:

export async function PWPageByUrl(path)  {
  // url is correct and returns a result, just not the one I was expecing
    const res = await fetch(`${process.env.NEXT_PUBLIC_API_URL}/${process.env.NEXT_PUBLIC_API_VERSION}/page/${path}`, {
            headers: {
                'x-api-key': process.env.NEXT_PUBLIC_API_KEY,
                'authorization': process.env.NEXT_PUBLIC_TOKEN
            }
        }
    )
    const data = await res.json()
    if (!data) {
        return {
            notFound: true,
        }
    }
    return {
        props: {
            data
        }, // will be passed to the page component as props
    }
}

On the PW server side as per doco with routes modified for v1, I have:

Spoiler

<?php
namespace ProcessWire;

require_once wire('config')->paths->AppApi . "vendor/autoload.php";
require_once wire('config')->paths->AppApi . "classes/AppApiHelper.php";

require_once __DIR__ . '/TwackAccess.class.php';

$routes = [

    'v1' => [
        'page' => [
            ['OPTIONS', '{id:\d+}', ['GET', 'POST', 'UPDATE', 'DELETE']],
            ['OPTIONS', '{path:.+}', ['GET', 'POST', 'UPDATE', 'DELETE']],
            ['OPTIONS', '', ['GET', 'POST', 'UPDATE', 'DELETE']],

            ['GET', '{id:\d+}', TwackAccess::class, 'pageIDRequest'],
            ['GET', '{path:.+}', TwackAccess::class, 'pagePathRequest'],
            ['GET', '', TwackAccess::class, 'dashboardRequest'],

            ['POST', '{id:\d+}', TwackAccess::class, 'pageIDRequest'],
            ['POST', '{path:.+}', TwackAccess::class, 'pagePathRequest'],
            ['POST', '', TwackAccess::class, 'dashboardRequest'],

            ['UPDATE', '{id:\d+}', TwackAccess::class, 'pageIDRequest'],
            ['UPDATE', '{path:.+}', TwackAccess::class, 'pagePathRequest'],
            ['UPDATE', '', TwackAccess::class, 'dashboardRequest'],

            ['DELETE', '{id:\d+}', TwackAccess::class, 'pageIDRequest'],
            ['DELETE', '{path:.+}', TwackAccess::class, 'pagePathRequest'],
            ['DELETE', '', TwackAccess::class, 'dashboardRequest'],
        ],
        'file' => [
            ['OPTIONS', '{id:\d+}', ['GET']],
            ['OPTIONS', '{path:.+}', ['GET']],
            ['OPTIONS', '', ['GET']],

            ['GET', '{id:\d+}', TwackAccess::class, 'pageIDFileRequest'],
            ['GET', '{path:.+}', TwackAccess::class, 'pagePathFileRequest'],
            ['GET', '', TwackAccess::class, 'dashboardFileRequest']
        ]
    ]
];

and the TwackAccess class copy/pasted from the documentation, eg for pagePathRequest:

Spoiler


  <?php
	/**
     * General function for page-outputs:
     */
    protected static function pageRequest(Page $page) {
        // Exit if Twack is not installed
        if (!wire('modules')->isInstalled('Twack')) {
            throw new InternalServererrorException('Twack module not found.');
        }

        // This commands Twack to output a data-array instead of HTML:
        wire('twack')->enableAjaxResponse();

        // If the page has no template, is not accessable or is blocked (i.e. via hook),
        // we throw a ForbiddenException
        if (!$page->viewable()) {
            throw new ForbiddenException();
        }

        $ajaxOutput   = $page->render();

        // $ajaxOutput will contain JSON-code, so we have to decode it to prevent it is encoded twice:
        $results      = json_decode($ajaxOutput, true);

        // Now, $results is a clean PHP-array with the information generated by Twack-components:
        return $results;
    }

 

 

I'm obviously missing something. Help to get it working as expected much appreciated.

Thanks

 

Share this post


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

I'm obviously missing something. Help to get it working as expected much appreciated.

Hi @psy,

At first glance, I can't find any obvious error in your code. Can you please show me the server response you get for the "Invalid Json" errors? (You can see each request/response in your browser's developer-console in the network-tab. Feel free to DM me if you need support for that.)

I would try to take out some complexity first and leave Twack out of the queries for now. It's best to set up a test route that only returns a simple response. Insert this to your Routes.php:

'v1' => [
    'test' => [
        ['OPTIONS', '', ['GET']],
            ['GET', '', AppApiTest::class, 'test']
        ]
    ],
]

And create the AppApiTest-class:

<?php

namespace ProcessWire;

class AppApiTest {
    public static function test($data) {
        return [
          'test' => true,
          'success' => 'YEAH!'
        ];
    }
}

No token-authentication needed. If you get this response back in Javascript, we can be sure that the basic api connection works.

Share this post


Link to post
Share on other sites

@Sebi Thanks for the quick response. I'd already gone past that point both in PW and Postman so the connection is good.

I'd even written my own method in Examples to get a page by ID. Maybe not as sophisticated as yours but it too worked:

<?php namespace ProcessWire;

Class Example {
  
  	public static function test () {
		return ['test successful'];
	}

  
      public static function getPageById($data) {
        $data = AppApiHelper::checkAndSanitizeRequiredParameters($data, ['id|int']);

        $p = wire('pages')->get("id=$data->id");
        if(!$p->id) throw new \Exception('Page not found', 404);

        $response = new \StdClass();

        // Hardcode any data you need that does not have an inputfield field in the admin
        $response->id = $p->id;
        $response->name = $p->name;
        $response->path = $p->path;

        // This retrieves all the admin input fields. Does not (yet) get page images or files, just single entry data
        $fields = $p->getFields();
        foreach ($fields as $fld) {
            $fldName = $fld->name;
            $response->$fldName = $p->$fld;
        }

        return $response;
    }
}

This enabled me to get the page data into the NextJS client and embed in the 'template/component' as variables from any existing PW page.

My next exercise was to delve into the NextJS router so that I could retrieve pages via their path and those paths would appear in the URL. Couldn't work it out in my own PW code (no surprises there!). It was then I installed your Twack module and used the Twack routes & TwackAccess.class.php at which point I ran into the issues mentioned above.

I'm sure it's my lack of knowledge of REACT/NextJS rather than your code... Doesn't help when their doco doesn't match up with their examples in gitHub.

Even so, it would great to use your TwackAccess classes rather than reinventing the wheel.

 

 

 

Share this post


Link to post
Share on other sites

@psy So, just to make sure, that everything works well on the PHP side: You can make a request via Postman to the same url that you are trying to access via Javascript? And you get back the expected JSON-data?

Unfortunately, I don't know much about NextJS and React. I am actually an Angular or Vanilla Javascript developer. In an Angular environment I would use Angular's httpClient to make an api-call:

const params = new HttpHeaders({
	'x-api-key': environment.api_key
});
this.httpClient.get('https://my-test-domain.com/api/page/1042').subscribe(
	response => console.log("Api-Response: ", response)
);

I assume that React has a similar helper class as well. This makes a call to the page-route in my router-definition, which you can see here: https://github.com/Sebiworld/musical-fabrik.de/blob/master/site/api/Routes.php . It will return the ajax-results for the ProcessWire page with id 1042 in this case.

I prefer to use the httpClient (if available) instead of the fetch function, which you are using in your code-example above. Mainly because I found the fetch function very cumbersome to use when dealing with more complex parameter data. But for a vanilla-js project I needed to use it, so I wrote a helper class that is way more usable: https://github.com/Sebiworld/musical-fabrik.de/blob/master/site/templates/src/js/classes/AjaxCall.js

Here is how you can make an api-call:

const ajaxCall = new AjaxCall({
	method: 'GET',
	path: '/api/page/1042',
	headers: {
		'X-API-KEY': 'oiasnduz3498gfsubasd'
	}
});
ajaxCall.fetch().then(function(response){
  console.log('Api-response: ', response);
}).catch(function(response){
  console.log('Api-error: ', response);
});

I hope that helps you out 😊

  • Like 1

Share this post


Link to post
Share on other sites

I released v1.1.4 of AppApi. The update fixes a critical bug that occurred when routes were called with GET parameters.  (reported by @David Lumm, thanks for PR 🤗)

Because I was already at it, I outsourced the reading of the current route (which is then further used by FastRoute) to its own hookable function `___getCurrentUrl()`. This allows you in special use cases to subsequently influence the URL with your own hook function.

Share this post


Link to post
Share on other sites

Hi @Sebi

kann you confirm that the latest PW (3.0.173) breaks AppApi (404 on the routes) or is it something on my part.

EDIT: confirmed it myself, Downgrading to 3.0.172 with no other changes solved the issue

Thank you!

  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites
On 3/9/2021 at 4:41 PM, csaggo.com said:

confirmed it myself

Yep, everything I had working with AppApi and REACT/NextJS broke with the PW 3.0.173 upgrade. Downgrading is a short-term option but limits future PW upgrade benefits

  • Thanks 1

Share this post


Link to post
Share on other sites

Hi everyone! 

I did not have the time to look deep into it, but looks like version 3.0.173 has made some changes into the handling of hooks. Especially hooks for custom urls, like we do in AppApi. Previously we had to use a little workaround to get it done - we hook into 404 (site not found) exceptions and generate our own response, if the request was made for /api/... The new update seems to add a functionality, where our module can use an url, without doing the 404-hack. But the new functionality seems also to break some of the old functionality. 🤨

So, please wait with the 3.0.173 upgrade! Thank you @csaggo.com and @psy for mentioning it. I will have time to look into it on the weekend - pull requests or hints are very welcome!

  • Like 1
  • Thanks 2

Share this post


Link to post
Share on other sites

It is done. I have found the error. Version 1.1.5, which I just released, fixes the bug and makes AppApi fully compatible with ProcessWire versions >= 1.0.173 again.

For those interested in the details:
It was just a tiny little thing that caused the module to no longer be able to find out if an api url was requested. This is what the code for it looked like:

    protected function checkIfApiRequest() {
        $url = $this->sanitizer->url($this->input->url);

        // support / in endpoint url:
        $endpoint = str_replace('/', "\/", $this->endpoint);

        $regex = '/^\/' . $endpoint . '\/?.*/m';
        preg_match($regex, $url, $matches);

        return !!$matches;
    }

However, in ProcessWire versions >= 1.0.173, $this->input->url (or wire('input')->url) now no longer contains the requested URL (e.g. "/api/page/"), but already the URL of the 404 error page "/http404/". Thus, the module could no longer determine whether it should handle the request or not.

But the solution to the problem was easier than I thought. $_SERVER['REQUEST_URI'] still contains the correct value. So we use that now for this check. And because this would have worked before, we don't need to worry about AppApi not working with older ProcessWire versions now. The fixed version simply looks like this:

    protected function checkIfApiRequest() {
        $url = $this->sanitizer->url($_SERVER['REQUEST_URI']);

        // support / in endpoint url:
        $endpoint = str_replace('/', "\/", $this->endpoint);

        $regex = '/^\/' . $endpoint . '\/?.*/m';
        preg_match($regex, $url, $matches);

        return !!$matches;
    }

Finally, thank you again for your reports. And I hope that you can now run your apis with the latest ProcessWire versions again. Thank you for using AppApi! 🤩

  • Like 3
  • Thanks 1

Share this post


Link to post
Share on other sites

Thanks for the quick fix @Sebi! Are you planning on using the new url hooks in the future? I read about it yesterday and it feels like a much cleaner way to handle the requests to the API endpoint

Share this post


Link to post
Share on other sites

Absolutely! But I'm glad, that I could fix the old handler, so it will work regardless which ProcessWire version is used. I think it would make sense to additionally add the new hook functionality. It should grab the request before it triggers 404. But that is something that must be tested very carefully. 

  • Like 1

Share this post


Link to post
Share on other sites

How do you folks set up your front-end? Same as your back-end or using completely separate web space?

I am rethinking of how to structure my project using AppApi.

Cheers
Rudy

Share this post


Link to post
Share on other sites
Posted (edited)

Want to change Auth::login process with session::login hook but not working. 
Can i extend auth::login process ?

// Routes.php

wire()->addHookBefore('Session::login', function (HookEvent $event) {
	// Get the object the event occurred on, if needed
	$session = $event->object;

	// Get values of arguments sent to hook (and optionally modify them)
	$name = $event->arguments(0);
	$pass = $event->arguments(1);
	$force = $event->arguments(2);

	//HERE another database check for login

	// changed for testing not working
	$name = "prouser";
	$pass = '';
	$force = true;

	// Populate back arguments (if you have modified them)
	$event->arguments(0, $name);
	$event->arguments(1, $pass);
	$event->arguments(2, $force);
});
// extend auth login

wire()->addHookBefore('Auth::doLogin', function (HookEvent $event) {
	$auth = $event->object;
	$event->replace = true;

	$event->return = [
		'jwt' => $auth->createSingleJWTToken(),
		'username' => "3254235"
	];
});


 

Edited by fliwire
fixed

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

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

Create an account

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

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By robert
      I often had the need for an overview of all used fields and their contents for a specific page/template while developing new websites without switching to the backend, so I made a small module which lists all the needed information in a readable manner (at least for me):
      Debug Page Fields
      https://github.com/robertweiss/ProcessDebugPageFields
      It adds two new properties to all pages:
      $page->debugFieldValues – returns an object with all (sub-)fields, their labels, fieldtypes and values $page->debugFieldTypes – returns an object with all fieldtypes and their corresponding fields // List all values of a pages $page->debugFieldValues // List a specific field $page->debugFieldValues->fieldname // List all used fieldtypes of a page $page->debugFieldTypes I recommend using it in combination with Tracy Debugger, Ray, Xdebug etc. as it returns an object and is only meant for developing/debugging uses. 
      For now, the fieldtype support includes mostly fieldtypes I use in my projects, but can easily be extended by adding a new FieldtypeFIELDNAME method to the module. I use it with five different client installations (all PW 3.0.*), but of course there might be some (or more) field configurations which are not covered correctly yet.
      Supported fieldtypes
      Button Checkbox Color Combo Datetime Email FieldsetPage * File FontIconPicker Functional Image ImageReference MapMarker Multiplier Mystique Options Page PageIDs PageTitle Radio Repeater * RepeaterMatrix * RockAwesome SeoMaestro Table Text Textarea Textareas Toggle URL * The fields with complete subfield-support also list their corresponding subfields.
      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. As this is my first ›public‹ module, I hope I did not miss any important things to mention here.
    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
       
      Here are Ryans announcement.



      Current Version 0.6.0
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.


      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
       
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; }  
      A MORE ADVANCED DEBUG METHOD!
      You can add some debug code into a template file and call a page with it:
      $to = array('me@example.com'); $subject = 'Wiremail-SMTP Test ' . date('H:i:s') . ' äöü ÄÖÜ ß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; } else { $mail->from = '--INSERT YOUR SENDER ADDRESS HERE --'; // <--- !!!! $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body("Titel\n\ntext text TEXT text text\n"); $mail->bodyHTML("<h1>Titel</h1><p>text text <strong>TEXT</strong> text text</p>"); $dump = $mail->debugSend(1); } So, in short, instead of using $mail->send(), use $mail->debugSend(1) to get output on a frontend testpage.
      The output is PRE formatted and contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection, like this one:
       
      Following are a ...


      List of all options and features


      testConnection () - returns true on success, false on failures


      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)


      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

       
      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here


      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification


      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename


      send () - send the message(s) and return number of successful sent messages


      debugSend(1) - returns and / or outputs a (pre formatted) dump that contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection. (See above the example code under ADVANCED DEBUG METHOD for further instructions!)


      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,


      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
       
       
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
       
       
    • By Cybermano
      Food Allergens Module
      A simple List of Food Allergens
      My needs were to provide a simple list of food allergens for our clients with restaurant related activity.
      The idea was to simply output the list (to speed up the data entry) without leaving the food menu editing, eg. opening another page in new tab or window.
      This isn't a perfect solution, but it works fine for my needs and I decided to share the base idea.
      This could also be easily used to show little notes or short "vademecum", not only for the list of food allergens.
      ---
      Main features
      The basis
      All moves from a short editing of the module in this tutorial: How to create custom admin pages by @bernhard
      First of all it creates an empty admin page, with a dedicated permission to let safe-user to see it (this permission has to be created as a new ones, manually or by the module).
      Once the page is created, I have hooked its behaviour into the ready.php, to show the content (basically a list).
      A step further
      With the tips of  @bernhard, @Soma (and many others), see here , the magic happens. 
      The new page will be shown as a panel, so editors will not abandon their data entry to have a quick view to the list.
      A little further
      Why scroll to the top of the page to click a link?
      The next step was to create a sticky button only in the food menu pages.
      Again with a @bernhard tip I moved into the customization of this simple module and the related hook.
      ---
      How to use this module
      After installed, it creates the page /admin/page/allergens/ and the module is to be setted up. The first field is a CKEditor with multi-language. This is the place where to write the informations that will be shown into the page. The next field is a simply text-area where to place a bit of JS that will be appended to the markup of the text (omit the 'script' tags). I also putted a checkbox with a silly statement: this to think at least twice on the safety of the written JS. Now comes the first way to display the link to the page
      Field Note with Link. Enable and save it. The module will display a new row with 4 selects (1 standard and 3 ASM):
      View mode (to show the page as Panel or as Modal PopUp); Templates to select: select one or more and save before proceed, so the  asm-select of the pages will be populated showing all the pages of the selected templates. Pages to select: also here select at least one and save before proceed to populate the asm-select for fields only with the ones that belong to the selected pages. Select the fields where to place the note and save again. That's all: now you will find into the notes of the selected fields the link "See the List of Allergens".
      At the same way, the option for the sticky button, but with a plus
      The field select is obviously unnecessary, but you could play with the last row: the inline styles to fix your sticky button where you like. Here you could set the sticky position of the <div> and the absolute ones of the <a>.

      Video Explanation
      In these screencasts you could see a custom JS that show a "copy" button near a "hanna-code" call.
      This because I've set a specific one for each allergen to show up a tooltip in the front end.

      Registrazione #33.mp4  

      Registrazione #34.mp4 ---
      Last but not the least
      Actually it works fine for my needs, even if it's much improvable: I'm working on the permissions creation, the uninstall section, a separate configs and defaults and how to include the hook into the module leaving free the ready.php. According to a simpler uninstall. Also I would make the link text as a dynamic text field, so it will be more flexible.
      I always learn a lot here, so I would share my code for whom it could be interested.
      I removed the hanna code references, but I provide you the html list of the allergens, English and Italian too, so you can paste them into the "source" of the CKEditor field to have a ready to use module.
      Obviously you are free to modify the code as per your needs.
      Please, keep in mind that I'm not a pro coder and I beg your pardon for my verbosity (speaking and coding). 😉
      I hope be helpful or for inspiration.
      Bye
      ready.phpList-ITA.htmlList-ENG.htmlAllergens.module
      README.md
    • By Robin S
      This module is sort of an upgrade to my earlier ImageToMarkdown module, and might be useful to anyone working with Markdown in ProcessWire.
      Copy Markdown
      Adds icons to images and files that allow you to copy a Markdown string to the clipboard. When you click the icon a message at the top left of the screen notifies you that the copying has occurred.
      Screencast

      Note: in the screencast an EasyMDE inputfield is used to preview the Markdown. It's not required to use EasyMDE - an ordinary textarea field could be used.
      Usage: Images
      When you hover on an item in an Images field an asterisk icon appears on the thumbnail. Click the icon to copy an image Markdown string to clipboard. If the "Description" field is populated it is used as the alt text.
      You can also open the "Variations" modal for an image and click the asterisk icon to copy an image Markdown string for an individual variation.
      Usage: Files
      When you hover on an item in a Files field an asterisk icon appears next to the filename. Click the icon to copy a link Markdown string to the clipboard. If the "Description" field is populated it is used as the link text, otherwise the filename is used.
       
      https://github.com/Toutouwai/CopyMarkdown
      https://processwire.com/modules/copy-markdown/
    • By BitPoet
      I've realized that I've been jumping back and forth between the PW API docs and the source code for site modules far too much. The idea to hold all necessary documentation locally in one place has occurred to me before, but getting PHPDocumentor et al set up and running reliably (and producing readable output) as always been too much of a hassle. Today I was asked how I find the right hooks and their arguments, and that inspired me to finally get my backside down on the chair and whip something up, namely the
      Module Api Doc Viewer
      ProcessModuleApiDoc
      It lets you browse the inline documentation and public (optionally also protected) class/method/property information for all modules, core classes and template files in the ProcessWire instance. The documentation is generated on the fly, so you don't have to remember to update your docs whenever you update a module.
      The module is quite fresh, so expect some bugs there. Behind the scenes it uses PHP-Parser together with a custom class that extracts the information I needed, and the core TextformatterMarkdownExtra module for rendering the description part in the phpdoc style comments.
      This is not a replacement / competitor to the API Viewer included in the commercial ProDevTools package. There is quite some information included in the inline documentation that my module can't (and won't) parse, but which makes up parts of the official ProcessWire API docs.
      This, instead, is a kind of Swiss army knife to view PHPDoc style information and get a quick class or function reference.
      If you feel daring and want to give it a spin, or if you just want to read a bit more, visit the module's GitHub repository.
      This is the overview page under "Setup" -> "Module API Docs":

      And this is what the documentation for an individual class looks like:

      The core module documentation can of course be found online, but it didn't make sense not to include them.
      Let me know what you think!

×
×
  • Create New...