Jump to content

Recommended Posts

Tonight I restored the database to get JumpLinks back and tried a bit further.

To get some traffic on the site, I used a dead link checker with some threats (not to many) to challenge it. Then the trouble started.

The problem I got indicated an unnormal behavior like a loop. Too many requests.

I found out that it is not the links.

I had an entry in the module's Legacy Domain field. Example: http://domain.de/drupal/.

There might have been a loop, maybe simply because the new site is https://domain.de only.

Or there is some other problem with that field (or a misunderstanding from my side, what it does).

Removing that entry (I forgot about that entry this morning - since the field is always collapsed) cured the issue, I think.

Site and server are up to speed, regardless of running the link-checker again.

Share this post


Link to post
Share on other sites

Essentially, that field is checked every time a a 404 is hit and you haven't defined a jumplink for it - it checks to see if https://domain.de/foo exists at http://domain.de/drupal/foo. As such, one should only specify a Legacy Domain when they're performing a slow migration to ProcessWire. That way, visitors and users can still access content if it hasn't been moved yet. Then, when everything has moved, you can strip away the Legacy Domain.

I collapsed the field by default as it isn't often used, and don't want it to get in the way. If I try to make it so the group expands if one of its fields contains data, it will always expand as status code field contains data by default. That said, I'll probably land up keeping it expanded anyway.

With all of that to one side, I'd still like to know how those particular errors came about... I assuming some kind of infinite loop took place, but don't know exactly what that entails. Perhaps someone with extensive knowledge of how PageFinder works could enlighten me?

Share this post


Link to post
Share on other sites

i have a site which was using redirects and am migrating those into Jumplinks.

when i try to import, i get errors and can't import..

Table 'walsh_prowire26.processredirects' doesn't exist SELECT * FROM processredirects ORDER BY redirect_from#0 [internal function]: Database->query('SELECT * FROM p...')

this is an older site but it does show i'm running the latest process redirects module

Share this post


Link to post
Share on other sites

i have a site which was using redirects and am migrating those into Jumplinks.

when i try to import, i get errors and can't import..

Table 'walsh_prowire26.processredirects' doesn't exist SELECT * FROM processredirects ORDER BY redirect_from#0 [internal function]: Database->query('SELECT * FROM p...')

this is an older site but it does show i'm running the latest process redirects module

Hmm, weird. Have you confirmed that the table actually exists using phpMyAdmin or similar?

Share this post


Link to post
Share on other sites

for some reason the table in my install is upper camel case, so the table is called ProcessRedirects.. i wonder if i should try changing it

on another note - is there any functionality to find a page based on a field - for example, i have the legacy IDs stored with the pages themselves, and i was using get vars on a template to redirect to the page; wondering if JL can handle this.

so instead of a mapping collection you would have a selector?

template=product-legacy, legacy_item_id={id}

one last thing - the start and end both say 2015 years ago

Share this post


Link to post
Share on other sites

That's more than likely it - changing it shouldn't be a problem, especially if you're migrating.

I quite like that idea, albeit being a little out of the ordinary (who likes ordinary anyway?). I'd probably have to set it up so that get: prefaces the selector. That way, we can tell if you're using one. So, in your case, it would be get: template=product-legacy, legacy_item_id={id}.

Lemme give that a bash quickly.

Share this post


Link to post
Share on other sites

ok - i renamed it then ran the import; that seemed to have worked, but then when i renamed it back to ProcessRedirects, Jumplinks doesn't show those anymore

ok i didn't actually click the final import button; so i went into the jumplinks module, renamed the tables to ProcessRedirects, and then ran the import but it only took the first redirect; now it won't let me do it over

Share this post


Link to post
Share on other sites

That's even weirder - they're completely independent of each other... Are you saying that the jumplinks don't show after the import?

Oh, that's a nice whoops right there. Happened to me too at some point during testing. To solve it:

  1. Make sure that the table is named processredirects.
  2. Go into the modules table and check for "redirectsImported":true in the data column for the ProcessJumplinks row.
  3. Change it to false.

Then you should be able to do the import again.

I'll be changing this behaviour soon to help this along automatically. There'll probably be a new button (or link) to say "No, wait! It didn't work."

Share this post


Link to post
Share on other sites

yeah - sorry - to clarify and answer the above post, i failed to click the last import button, so no problem there;

on my 2nd try i renamed the database in the Jumplinks Module wherever it said processredirects i renamed to ProcessRedirects; then i ran the import but it only imported the first one;

i can't see how JL queries would have worked because looking at the Redirect module, (unless for some reason i have a legacy version that isn't showing it needs to be updated), it uses $this->className for the queries

Share this post


Link to post
Share on other sites

I used the raw table name (processredirects) as that what was in my database when I wrote the module. In fact, I've just installed a fresh copy of it, and the table is called "processredirects". Perhaps this could be different versions of MySQL changing the case at runtime?

Share this post


Link to post
Share on other sites

right - yes it must be a case sensing issue with MySQL. this one i'm running is 5.5.40-36.1-log

processRedirects does fail if i rename the table to all lowercase

Share this post


Link to post
Share on other sites

Fascinating - I never thought such an issue would come up. (Not a brightspark when it comes to things like that. And case-sensitive stuff never impacts me as I use Windows. In fact, that could even be the issue - though, I doubt it because only Unix filesystems are sensitive; I wouldn't think that would expand to MySQL.)

Anyways, I've just attempted the selector idea, currently on the dev branch. Basically, you can to define your destination path like so:

[[template=product-legacy, legacy_item_id={id}]]

So that means that anything in double-square-brackets is to be treated as a selector.

I've used the following to check - hopefully it is enough...

$convertedWildcards = preg_replace_callback("~\[\[([\w-_\/\s=\",.']+)\]\]~i", function ($mapCaptures) {
	$page = $this->pages->get($mapCaptures[1]);
	if ($page->id) {
		return ltrim($page->url, '/');
	}
}, $convertedWildcards);

My test yielded the following log:

Page not found; scanning for jumplinks...
- Checked at: Thu, 16 Apr 2015 17:30:56 +0200
- Requested URL: http://processwire.dev.local/legacy?id=43
- PW Version: 2.5.26

== START ==

[Checking jumplink #177]
- Original Source Path:         legacy?id={id}
- Escaped Source Path:          legacy\?id={id}
- After Smart Wildcards:        legacy\?id={id:num}
- Compiled Source Path:         legacy\?id=(\d+)
- Original Destination Path:    [[template=basic-page,legacy_item_id={id}]]
- Compiled Destination Path:    http://processwire.dev.local/testing-this-page/

Match found! We'll do the following redirect (301, permanent) when Debug Mode has been turned off:

- From URL:   http://processwire.dev.local/legacy?id=43
- To URL:     http://processwire.dev.local/testing-this-page/

Which means it works. Nonetheless, please give it a test-run and let me know if you run into any issues, or if anything needs to be enhanced.

Once we're all happy, I'll pull to master and update the docs.

  • Like 2

Share this post


Link to post
Share on other sites

wow amazing.. will test asap.

how can i reset things and try the import again - still the issue that my PR import failed...

Share this post


Link to post
Share on other sites

wow amazing.. will test asap.

Great!

how can i reset things and try the import again - still the issue that my PR import failed...

You could either do as I suggested before and set the redirectsImported setting to false or, if that fails, re-install the module and repeat.

Edit: It seems that MySQL table names are case-sensitive on most Unix-varieties. That said, I don't understand why the table is being created as processredirects and not ProcessRedirects on my system, when it is clearly instructed to use the latter...

Can anyone point me in the right direction with this? I don't think it would be wise to change it unless there's a better way.

Share this post


Link to post
Share on other sites

ok thanks - sorry didn't see those instructions; will be back on this tonight and will report back...

  • Like 1

Share this post


Link to post
Share on other sites

it will only import 1 link at a time from the redirects module;

i was able to get 2 of them imported by importing then going to the database, changing the setting to false, importing the next one, etc.. but there must be some problem;

also, i can't get the selector to work; i have this entered in the source:

store_item_detail.cfm?item_ID={id}

and this entered in the  destination:

[[template=product-legacy,legacy_item_id={id}]]

but no luck in terms of it forwarding to the page, just getting 404 and no log with debug on, and the forward doesn't work with debug off;

Share this post


Link to post
Share on other sites

@All: I have just submitted a fix to the dev branch relating to this issue. It will be merged in soon with the other commits.

@Macrura: Something must have broken with the import feature -- I will look into that this evening. Regarding the selector, there must be something shown in the debug log - it can never be empty. The following should happen: if a selector is found, it will check to see if a page by that selector exists. If one doesn't it will skip the jumplink. If debug mode is turned on in the module's config, then it will tell you that it found a selector, but it doesn't map to a page. Please could you double-check the log, and paste its content here?

Update: Confirmed, I can reproduce the import problem. Will fix that shortly.

Fixed: Okay, I've fixed the import issue (dev branch). Was an oversight when moving to prepared statements. So that's working now. :-)

Share this post


Link to post
Share on other sites

hi mike - where should i look for the log, checked the module, and site/assets, but not seeing any logs;

also getting this...

Mysqli was instantiated and queries were made. These should ideally be converted to PDO ($database). Here are the queries:

0 SELECT * FROM process_jumplinks ORDER BY source [4 rows] [0.0321s, 0.0321s, 0.0365979671478s] 1 SELECT * FROM process_jumplinks_mc ORDER BY collection_name [0 rows] [0.0181s, 0.0502s, 0.136598110199s]

Share this post


Link to post
Share on other sites

When you turn on debug mode and request the URI in your browser, the log will appear there instead of redirecting.

Interesting - I haven't seen that before. I'll have a look at it now now.

Edit: Ah, I see. I'm using the db object. Changing it will mean a little bit of refactoring and more testing, so I'll have a look at that tomorrow - have had quite a long day.

Share this post


Link to post
Share on other sites

also, i'm still needing to rename the tables in the module to ProcessRedirects, since i'm on unix..

But now it worked, so all of my original redirects are now imported- thanks!

will carry on testing the selector redirect now..

Share this post


Link to post
Share on other sites

also, i'm still needing to rename the tables in the module to ProcessRedirects, since i'm on unix

I find it interesting that it is specifically making the table name lower case on my side. I'm going to need to look at this properly as well. I think I'll land up just doing a test at runtime to see which one it is...

Share this post


Link to post
Share on other sites

i think the selector redirect is working, wow that's so cool; and i'm seeing the debug log now.

  • Like 1

Share this post


Link to post
Share on other sites

Great stuff! Busy working on the table name thing now... Looks like a decent solution is around the corner.

Share this post


Link to post
Share on other sites

Okay, I hope I've fixed this (dev branch). Unfortunately not able to test as my tables are always lower case. An initial import run still works on my side. If you don't mind, please could you test it on yours?
 
For reference, I've used the following to ensure the correct case is being used. If anyone thinks this can be optimised, please let me know. Thanks.

// Get the correct table name for ProcessRedirects
$redirectsTableNameQuery = $this->database->prepare("SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_SCHEMA = :db_name AND TABLE_NAME LIKE :table_name");
$redirectsTableNameQuery->execute(array(
	'db_name' => $this->config->dbName,
	'table_name' => $this->redirectsTableName, // defaults to ProcessRedirects; which we use to check
));
$redirectsTableNameResult = $redirectsTableNameQuery->fetch(PDO::FETCH_OBJ)->TABLE_NAME;
if ($this->redirectsTableName == $redirectsTableNameResult || strtolower($this->redirectsTableName) == $redirectsTableNameResult) {
	$this->redirectsTableName = $redirectsTableNameResult;
}

Edit: My bad, didn't actually change the select statements. Shall commit that shortly, along with some other enhancements.

  • Like 1

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...