PW 3.0.264 – Core updates and more

[ryan]

Core updates

A new WireApiDocs class was added that provides an API... for APIs. It’s a tool that can parse ProcessWire’s API.md files to provide various methods for finding and pulling documentation. It also includes the ability to get certain parts of an API.md (chapters). This new tool is accessible through $wire->docs, which returns an instance of WireApiDocs. Here’s a few usage examples:

$api = $wire->docs; 
$api->get(); // get summary array of all documented classes
$api->get('Pages'); // get docs for Pages class
$api->get('Fieldtype*'); // get names of all Fieldtype classes 

Lots more examples here: https://processwire.com/api/ref/wire-api-docs/get/ and the entire class reference can be found here: https://processwire.com/api/ref/wire-api-docs/ 

WireApiDocs also comes with a full CLI command set, which can be viewed by typing: php index.php docs

  WireApiDocs:
  ============
  php index.php docs list                        List classes with API docs as string
  php index.php docs list 'Class*'               List classes matching wildcard pattern as string
  php index.php docs list-json                   List classes with API docs in JSON
  php index.php docs list-json 'Class*'          List classes matches wildcard pattern in JSON
  php index.php docs list-json-verbose           List classes with API docs in JSON verbose mode
  php index.php docs list-json-verbose 'Class*'  List classes matching pattern in verbose JSON
  php index.php docs get Class                   Get API docs for given Class
  php index.php docs get-json Class              Get JSON API docs for given Class
  php index.php docs toc Class                   Get table of contents for given Class (string)
  php index.php docs toc-json Class              Get table of contents for given Class (json)
  php index.php docs body Class num              Get body for given Class and chapter number
  php index.php docs body Class 'title'          Get body for given Class and chapter title

New API.md files

Speaking of API docs, several new API.md files were added to the core this week. You can view any of them by clicking the links below:

• WireArray: Covers the base collection class for all PW iterable sets.
• WireData: Covers the base data-storage class used throughout ProcessWire.
• LanguageSupport: Covers all things multi-language in ProcessWire. This is probably our most comprehensive API.md yet.
• WireHooks: Comprehensive guide to ProcessWire's entire hooks system.
• Fields: the API variable that manages all custom fields in ProcessWire.
• Templates: The API variable that manages all Template instances.
• FieldtypeOptions: Field that stores one or more selected options from a predefined list.

New LanguagePorter class for exporting and importing translations

This new class provides a simple "export CSV" and "import CSV" for language static translations.  It was added so that agents and developers could have an easy way to pull all text to translate, translate it, then push it back into the system. It is used by the new "static phrase translation" task that appears in this week's new version of AgentTools. The LanguagePorter can be accessed for any language from the $language->porter() method. 

WireTests in the core

Tests for the WireTests module are now being placed directly in the core. We are slowly migrating the existing tests, while new tests are being committed to the core rather than in the WireTests module. This week tests were added for the following (click links to view tests file): 

Sanitizer, WireData, WireArray, WireDateTime, LanguageSupport (covers all multi-language features). 

 

AgentTools updates

New “run in background” option for Site Engineer and Page Engineer

AgentTools now has the ability to queue and run AI agent requests in the background on the server, rather than through a web request. This is especially helpful with long running tasks, as they can run without Apache/server http timeouts. 

The AgentTools module configuration screen tells you what you need to do to enable background jobs. But primarily it’s just a matter of enabling a cron job for AgentTools.

When the background job is finished, you can view the agent’s response in the admin. But it also gets emailed to you. 

Background jobs are available for Site Engineer, Page Engineer as well as the built-in and custom tasks. 

New built-in task: Static phrase translation and language pack creation

Per last week’s update, AgentTools now comes with several built-in AI tasks that you can use. Added this week is yet another new task for multi-language sites: you can now have all the phrases in your site, in modules, or even the entire core, translated to another language by your AI agents. Not only does the task handle all of the translation, but it also handles creating and installing the language pack(s) once it is finished.

Please note that this particular task requires that you 1) have ProcessWire 3.0.264 or newer; and 2) have multi-language support enabled on your installation. Also note that mass translation of phrases can take some time, so the new background mode can come in especially handy when doing lots of automatic translations. 

New engineer preview / dry-run mode

If you want to know what the agent would do to accomplish something, without actually committing the changes now, check the new “Preview” checkbox before submitting an Engineer request. The agent will run in a read-only mode to describe what it would do before you commit to making it do the real thing.