netcarver

Database Counters Module

Recommended Posts

This module provides a very simple interface to a set of named counters. You simply call a single function, next('name'), to pull the next value out of a counter - or to set it up if it does not yet exist. Next() takes a few extra parameters to allow you to increment by values other than 1 or to start at a certain number.

This provides some similar functionality to the built-in page naming feature of PW, and to this module recently posted by Stikki but I think it offers a little more flexibility than either. Having said that, I do like the simplicity of Stikki's new auto-increment module.

Module Availability

Here is my module on Github.

Here it is in the module repository.

Example Usage

Here's how this module can be used to title and name a new page by adding a couple of simple hooks to site/ready.php. This example applies to new pages using a template called 'invoice' that can be quick-added to the page tree. In order to get the following to work, you must edit the template that will be the parent of the 'invoice' template and setup the template for children to "invoice" and set the "Name Format for Children" field to something other than the default blank value (I use  title  as my value.)

<?php

/**
 * Function to recognise our special template.
 */
function isInvoiceTemplate($template) {
    return ($template == 'invoice');
}

/**
 * Pre-load the page title for invoice pages with a unique value
 * which includes a counter component.
 */
$pages->addHookBefore("Pages::setupNew", function($event) {
    $page = $event->arguments(0);

    $is_invoice = isInvoiceTemplate($page->template);
    $no_inv_num = $page->title == '';

    if ($is_invoice && $no_inv_num) {
        $counter_name = 'WR-' . date('Y');
        $number = $this->modules->get('DatabaseCounters')->next($counter_name, 10, 5000);
        $page->title = $counter_name . '-' . sprintf("%06u", $number);
    }
});

/**
 * Prevent ProcessPageEdit from forcing an edit of the name if we got here
 * through a quickAdd from ProcessPageAdd. We can do this because we
 * preset the title field in the Pages::setupNew hook.
 */
$pages->addHookAfter("ProcessPageEdit::loadPage", function($event) {
    $page = $event->return;

    $is_invoice = isInvoiceTemplate($page->template);
    $is_temp    = $page->hasStatus(Page::statusTemp);

    if ($is_invoice && $is_temp) {
        $page->removeStatus(Page::statusTemp);
        $event->return = $page;
    }
});

Note, the above code + module is one direct solution to the problem posted here by RyanJ.

post-465-0-56264100-1459552276_thumb.png

post-465-0-67628000-1459552450_thumb.png

Version History

1.0.0 The initial release.

  • Like 12

Share this post


Link to post
Share on other sites

To extend the above example to hide the name, template and parent fields on the settings page of invoices, you can add the following to the ready.php snippet in the above post.

/**
 * Work out if the template's settings should be tweaked to hide things that should be fixed...
 */
function shouldHideTemplateSettings() {

    // Super users retain super-setting-edit powers
    if (wire('user')->isSuperUser()) {
        return false;
    }

    // Are we even editing a page?
    if (wire('page')->process != 'ProcessPageEdit') {
        return false;
    }

    $id = (int) wire('input')->get('id');
    if (!$id) {
        return false;
    }

    $editedPage = wire('pages')->get($id);
    if ($editedPage->template->flags & Template::flagSystem) {
        return false;
    }

    if (!isInvoiceTemplate($editedPage->template->name)) {
        return false;
    }

    return true;
}

/**
 * Hide some fields from the invoice settings page from non-super-users.
 *
 * There's not much point allowing edits to the name field, so we want it immutable (at least) and probably totally
 * hidden (better.)
 *
 * We don't want invoices being moved from their parent, so we hide the parent field.
 * We don't allow them to use a different template, so we hide the template field.
 *
 */
if (shouldHideTemplateSettings()) {
    $pages->addHookAfter("ProcessPageEdit::buildFormSettings", function($event) {
        $wrapper = $event->return;

        // To show the name field but make it immutable
        $wrapper->_pw_page_name->collapsed = Inputfield::collapsedNoLocked;
        $wrapper->_pw_page_name->description = '';

        // Alternatively, to hide the name field do uncomment the following and comment out the 2 lines above
        //$wrapper->_pw_page_name->collapsed = Inputfield::collapsedHidden;

        // Hide the template changer, invoices can only use the invoice template
        $wrapper->template->collapsed = Inputfield::collapsedHidden;

        // Hide the parent page, as it is fixed in our page structure
        $wrapper->parent_id->collapsed = Inputfield::collapsedHidden;
    });
}
  • Like 6

Share this post


Link to post
Share on other sites

Question of  setupNew page hook  

$pages->addHookBefore("Pages::setupNew"

Instead of creating page at the pw's back-end admin ui, will this page hook be executed if I create a page thru api manually ?

Share this post


Link to post
Share on other sites

Besides of my last question,

I followed the op's setup, but it didn't work at atll

post-2272-0-32536000-1460864209_thumb.pn

post-2272-0-39834500-1460864219_thumb.pn

This is my  /site/ready.php

instead of invoice, i changed it to order

<?php

function isOrderTemplate($template) {
    return ($template == 'order');
}

$pages->addHookBefore("Pages::setupNew", function($event) {
    $page = $event->arguments(0);
 
    $is_order = isOrderTemplate($page->template);
    $no_inv_num = $page->title == '';
 
    if ($is_order && $no_inv_num) {
        $counter_name = 'ORDER-' . date('Y');
        $number = $this->modules->get('DatabaseCounters')->next($counter_name, 10, 5000);
        $page->title = $counter_name . '-' . sprintf("%06u", $number);
    }
});

$pages->addHookAfter("ProcessPageEdit::loadPage", function($event) {
    $page = $event->return;
 
    $is_order = isOrderTemplate($page->template);
    $is_temp    = $page->hasStatus(Page::statusTemp);
 
    if ($is_order && $is_temp) {
        $page->removeStatus(Page::statusTemp);
        $event->return = $page;
    }
});

When I checked back the DatabaseCounter module config,

there is no such a counter named ORDER-   was created

Share this post


Link to post
Share on other sites

I'm curious, the

/site/ready.php

is not executed.

is there any other settings to activated it ?

None that I know of. Are you sure you have that file in the right place?

From second screen cap, how to make the invoice number (i.e.title field) not editable ?

Edit the template for your order pages in PW. Click on the title (invoice number) field and, on the input tab, set the visibility to whatever you need.

  • Like 2

Share this post


Link to post
Share on other sites

Hi, I was trying this module becuase I this is the solution for my needs, I cant not make it work.

When I click new page I get the same as adrianmak , Title and name are not autopopulated.

 

I know my ready.php is working fine because I was trying this code from another post and the field was being autopopulated with the generated title:

$this->pages->addHookAfter('added', function($event) {
    $page = $event->arguments[0];
    if($page->template != 'your-template-name') return;
    $page->setAndSave('title', 'my page - ' . date("YmdHis"));
});

I'am missing something?


 

Share this post


Link to post
Share on other sites

@Krlos, just writing to acknowledge your post. Please could you send me your site/ready.php file via the forum message system so I could have a look at it tonight? (Please don't post it here.)

Share this post


Link to post
Share on other sites

Hi, I was testing your module and decided to leave it for later. As recheck this part I will send a report.

Thank you.

5 hours ago, netcarver said:

Bump. @Krlos, did you get this working?

 

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 BitPoet
      As threatened in the Pub sub forum in the "What are you currently building?" thread, I've toyed around with Collabora CODE and built file editing capabilities for office documents (Libre-/OpenOffice formats and MS Office as well as a few really old file types) into a PW module.
      If you are running OwnCloud or NextCloud, you'll perhaps be familiar with the Collabora app for this purpose.
      LoolEditor
      Edit office files directly in ProcessWire
      Edit your docx, odt, pptx, xlsx or whatever office files you have stored in your file fields directly from ProcessWire's page editor. Upload, click the edit icon, make your changes and save. Can be enabled per field, even in template context.
      Currently supports opening and saving of office documents. Locking functionality is in development.
      See the README on GitHub for installation instructions. You should be reasonably experienced with configuring HTTPS and running docker images to get things set up quickly.
      Pull requests are welcome!
      Here is a short demonstration:

    • By Robin S
      An Images field allows you to:
      Rename images by clicking the filename in the edit panel or in list view. Replace images, keeping metadata and filename (when possible) by dropping a new image on the thumbnail in the edit panel. Introduced here. But neither of these things is possible in File fields, which prompted this module. The way that files are renamed or replaced in this module is not as slick as in the Images field but it gets the job done. The most time-consuming part was dealing with the UI differences of the core admin themes. @tpr, gives me even more respect for the work that must go into AdminOnSteroids.
      Most of the code to support the rename/replace features is already present in InputfieldFile - there is just no UI for it currently. So hopefully that means these features will be offered in the core soon and this module can become obsolete.
       
      Files Rename Replace
      Allows files to be renamed or replaced in Page Edit.

      Usage
      Install the Files Rename Replace module.
      If you want to limit the module to certain roles only, select the roles in the module config. If no roles are selected then any role may rename/replace files.
      In Page Edit, click "Rename/Replace" for a file...
      Rename
      Use the text input to edit the existing name (excluding file extension).
      Replace
      Use the "Replace with" select to choose a replacement file from the same field. On page save the file will be replaced with the file you selected. Metadata (description, tags) will be retained, and the filename also if the file extensions are the same.
      Tip: newly uploaded files will appear in the "Replace with" select after the page has been saved.
       
      https://github.com/Toutouwai/FilesRenameReplace
      http://modules.processwire.com/modules/files-rename-replace/
    • By d'Hinnisdaël
      So I decided to wade into module development and created a wrapper module around ImageOptim, a service that compresses and optimizes images in the cloud. ImageOptim currently handles JPG, PNG and GIF files and, depending on the settings you use, shaves off between 15% and 60% in filesize. Great for bandwidth and great for users, especially on mobile.
      This module handles the part of uploading images to ImageOptim via their official API, downloading the optimized version and storing it alongside the original image.
       

       
      Download & Info
      GitHub / Module directory / Readme / Usage
       
      Why ImageOptim?
      There are other image optimization services out there, some of them free, that have outstanding ProcessWire modules. A few things make ImageOptim the best tool for most of my customers: It's not free, i.e. it will probably be around for a while and offers support. However, it's cheaper than some of the bigger competitors like Cloudinary. And it does PNG compression better than any of the free services out there, especially those with alpha channels.
       
      Installation
      Install the module like any other ProcessWire module, by either copying the folder into your modules folder or installing it via the admin. See above for downloads links on GitHub and in the module directory.
       
      Requirements
      To be able to upload images to the service, allow_url_fopen must be set on the server. The module will abort installation if that's not the case.
      I have only tested the module on ProcessWire 3.x installations. I don't see why it shouldn't work in 2.x, if anyone wants to try it out and report back.
       
      ImageOptim account
      To compress images, you first need to sign up for an ImageOptim account. They offer free trials to try the service.
       
      Usage (manual optimization)
      Images can be optimized by calling the optimize() method on any image. You can pass an options array to set ImageOptim API parameters.
      $image->size(800,600)->optimize()->url $image->optimize(['quality' => 'low', 'dpr' => 2]) // Set quality to low and enable hi-dpi mode
      Automatic optimization
      The module also has an automatic mode that optimizes all image variations after resizing. This is the recommended way to use this module since it leaves the original image uncompressed, but optimizes all derivative images.
      $image->size(800,600)->url // nothing to do here; image is optimized automatically
      To change compression setting for single images, you can pass an options array along with the standard ImageResizer options. Passing false disables optimization.
      $image->size(800, 600, ['optimize' => 'medium']) $image->size(800, 600, ['optimize' => ['quality' => 'low', 'dpr' => 2]]) $image->size(800, 600, ['optimize' => false])
      For detailed usage instructions and all API parameters, see the usage instructions on GitHub.
       
      Filenames
      Optimized images will be suffixed, e.g. image.jpg becomes image.optim.jpg. You can configure the suffix in the module settings.
       
      Roadmap
      Asynchronous processing. Not really high on the list. Image variations need to be created anyway, so waiting a few seconds longer on first load is preferable to adding complexity to achieve async optimization. Optimize image variations created by other modules. CroppableImage comes to mind. I don't use any of these, so if somebody wants to help out and submit a pull request — all for it! Add a dedicated page in the setup menu with a dashboard and detailed statistics. ImageOptim's API is very barebones for now, so not sure if that's feasible or even necessary.
      Stability
      I've been using this module on production sites for some time now, without hiccups. If you do notice oddities, feel free to comment here or investigate and submit PRs.
    • By daniels
      General
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      It can update / create a subscriber in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe users to different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns You can find it here: https://github.com/danielstieber/SubscribeToMailchimp
      Let me know what you think and if I should add it to the Modules Directory.
      Setup
      Log into your Mailchimp account and go to  Profile > Extras > API Keys. If you don't have an API Key, create a new one. Copy your API Key and paste it in the module settings (Processwire > Modules > Site > SubscribeToMailchimp). Back in Mailchimp, go to the list, where you want your new subscribers. Go to Settings > List name and defaults. Copy the List ID an paste it in to the module settings.
      Usage
      To use the module, you need to load it into your template:
      $mc = $modules->get("SubscribeToMailchimp"); Now you can pass an email address to the module and it will try to edit (if the user exists) or create a new subscriber in your list.
      $mc->subscribe('john.doe@example.com'); You can also pass a data array, to add additional info.
      $mc->subscribe('john.doe@example.com', ['FNAME' => 'John', 'LNAME' => 'Doe']); You can even choose an alternative list, if you don't want this subscriber in your default list.
      $mc->subscribe('john.doe@example.com', ['FNAME' => 'John', 'LNAME' => 'Doe'], 'abcdef1356'); // Subscribe to List ID abcdef1356  
      Important Notes
      This module does not do any data validation. Use a sever-sided validation like Valitron Make sure that you have set up your fields in your Mailchimp list. You can do it at Settings > List fields and *|MERGE|* tags Example
      Example usage after a form is submitted on your page:
      // ... validation of form data $mc = $modules->get("SubscribeToMailchimp"); $email = $input->post->email; $subscriber = [ 'FNAME' => $input->post->firstname, 'LNAME' => $input->post->lastname, ]; $mc->subscribe($email, $subscriber);  
      Troubleshooting
      In case of trouble check your ProcessWire warning logs.
      I can't see the subscriber in the list
      If you have enabled double opt-in (it is enabled by default) you will not see the subscriber, until he confirmed the subscription in the email sent by Mailchimp
      I get an error in my ProccessWire warning logs
      Check if you have the right List ID and API Key. Check if you pass fields, that exist in your list. Check if you pass a valid email address. Go to Mailchimps Error Glossary for more Information
      How To Install
      Download the zip file at Github or clone directly the repo into your site/modules If you downloaded the zip file, extract it in your sites/modules directory. You might have to change the folders name to 'SubscribeToMailchimp'. Goto the modules admin page, click on refresh and install it  
    • By PWaddict
      Module for hiding pages for non-superusers.
      Download
      HidePages
      Requirements
      ProcessWire 3.x Changelog
      1.0.1 (31 March 2018)
      Module renamed to prevent confusion 1.0.0 (30 March 2018)
      Initial release