Jump to content
teppo

Version Control

Recommended Posts

@Teppo,

here's the error;

i think this only happens on pages that actually have history for some fields; there is a page where we can add pages to this field, and i think possibly the only difference is that there is no history for any fields on that page

http://mysite.com/manage/page/edit/    Error:     Exception: Can't save field from page 1951: /catalogue/name-of-album-changed/: Call $page->setOutputFormatting(false) before getting/setting values that will be modified and saved.  [album_reviews] (in /home/someaccount/int/wire/core/Pages.php line 1110)  

#0 [internal function]: Pages->___saveField(Object(Page), 'album_reviews', Array)
#1 /home/someaccount/int/wire/core/Wire.php(389): call_user_func_array(Array, Array)
#2 /home/someaccount/int/wire/core/Wire.php(344): Wire->runHooks('saveField', Array)
#3 /home/someaccount/int/wire/core/Page.php(1180): Wire->__call('saveField', Array)
#4 /home/someaccount/int/wire/core/Page.php(1180): Pages->saveField(Object(Page), 'album_reviews', Array)
#5 /home/someaccount/int/wire/modules/Inputfield/InputfieldPageTable/InputfieldPageTableAjax.php(110): Page->save('album_reviews')
#6 /home/someaccount/int/wire/modules/Inputfield/InputfieldPageTable/InputfieldPageTableAjax.php(64): InputfieldPageTableAjax->addItem(Object(Page), Object(Field), Object(Page)) #7 [internal function]: Inputf

Share this post


Link to post
Share on other sites

great little module @teppo!

feature suggestions:

1. revision drafting/editing

I would absolutely love a way to create a draft for a new revision to be published in the future. Basically a way to create an unpublished revision of the document with ability to go in and work on it before pushing it live.

2. revision scheduling

And a "draft" revision scheduling would be the next on wishlist.

perhaps there is something already available to enable this without too much effort?

Share this post


Link to post
Share on other sites

great little module @teppo!

Thanks! :)

feature suggestions:

1. revision drafting/editing

I would absolutely love a way to create a draft for a new revision to be published in the future. Basically a way to create an unpublished revision of the document with ability to go in and work on it before pushing it live.

2. revision scheduling

And a "draft" revision scheduling would be the next on wishlist.

perhaps there is something already available to enable this without too much effort?

To be honest this seems to be out of the scope of this module. I've been going over your suggestions a few times in my head, and while I think I could probably implement something like that to this module if I really wanted, I don't really think it's a good idea. Drafts would most likely be easier to implement using a completely different approach.

Ryan took some steps towards drafts support a while ago, so you might want to see where that goes. If Ryan implements that as a core module, I've no interest in trying to duplicate similar behaviour here. Though I haven't used any of those that much, there's also Process Preview by Nico, Page Draft Creator by Rob, and Process Page Drafts by Jan Romero; you could always give one of these a try.

Share this post


Link to post
Share on other sites

I have two issues on my installlation running PW 2.5.20:

The first is regarding the history tab: Method Page::snapshot does not exist or is not callable in this context. It seems that Page Snapshot is not being installed. Uninstalling and re-installing the module doesn't seem to help.

Also, it seems that if I create a new field (CKEditor in this case), assign it to a template, fill it with data, and then assign it to version control, it doesn't track anything. However, after re-installing the module, it worked... I may have missed something, but somewhere, somehow, the process didn't seem right.

Share this post


Link to post
Share on other sites

@Mike: Just gave this a try, and I can't seem to reproduce either issue.

At what point exactly does the "Method Page::snapshot ..." error appear? When you load the page, when you hit preview, when you try to restore earlier revision, or somewhere else? Do you see any additional details, line numbers, etc.?

So far I'm thinking that it might be some weird compatibility issue (PHP, other modules, something) or perhaps a problem with autoload order -- though I might be totally off the track here too. Would be much easier to debug if I could somehow reproduce this :)

Another issue seems to be out of my reach too. Same workflow works for me as expected. In fact, I'm having trouble understanding how this could even happen in the first place -- if the field is enabled via Version Control module settings and other enabled fields are working as expected, this sounds really weird. If you can reproduce this, could you check that module config is actually saved to database?

Other factors that come to mind are some sort of (opcode) caching, and perhaps some installation weirdness related to either the native GUI install/update tool or modules manager. Absolutely not trying to pass the blame, but from what I've heard, both of these have had some issues. Never really used either one myself, which might or might not be the reason I've never had any installation issues either.. :)

Share this post


Link to post
Share on other sites

The error appears when I view the snapshot in the history tab.

I'm going to give this a try on a fresh dev-install tomorrow. I tried it on a dev site (with pretty much no modules installed, and no ModulesManager), and had the issues.

Will also check the config-saving. I'm sure it did though, because the module page updates, and keeps my settings after a refresh.

Share this post


Link to post
Share on other sites

I have problems with VersionControl. We use VersionControl for Textfields which conflicts with VersionControl, well actually with PageSnapShot.

VersionControl is not installed, but PageSnapShot still seems to be active. When I try to delete PageSnapShot I get a Server Error, when I try to delete VersionControl I get an error that VersionControl could not be deleted. When I refresh modules I get 

  •  Failed module dependency: PageSnapshot requires VersionControl

So I am somehow in a trap. Is it possible to remove VersionControl and PageSnapShot manually?

your help ids much appreciated.

Share this post


Link to post
Share on other sites

You can delete any module manually - just use something like PHPMyAdmin and browse/search the "modules" database table and remove the row for the module. Then remove the module folder from the server and you should be good. In the case of this module, there are also some additional db tables to remove, prefixed with "version_control", but be careful to remove the ones for the version of version control that you want to remove.

Also, note that Version Control supersedes Version Control for Textfields. The latter is only still around for older versions of PW.

  • Like 4

Share this post


Link to post
Share on other sites

Hi Adrian

will do so thanks. The thing is we use VersionControl for Textfield in an extended manner. Guess we will have to change that in due time.

Thanks a lot.

Share this post


Link to post
Share on other sites

@bbeer: additionally, if you're using the latest version of Version Control for Text Fields, there's an option in the module settings to *not* remove it's database tables when the module is uninstalled. The purpose of this is to make transition to Version Control easier: it should be able to import old data from Version Control for Text Fields during installation.

I've only done limited amount of tests with this feature, though, so I can't 100% guarantee that it will work. It has worked for me so far, but making backup copies of the module's tables might make sense if you're going to try it.

  • Like 3

Share this post


Link to post
Share on other sites

Would it be possible to add FieldtypeOptions to the supported fields? Currently it's not working.

P.S. Maybe the preview shouldn't close on clicking. It's throwing an error for me, but with SystemNotifications installed one can't look at the whole error message, because the click on the number closes the preview.

Share this post


Link to post
Share on other sites

Would it be possible to add FieldtypeOptions to the supported fields? Currently it's not working.

Added. You can add fields there locally via module settings too.

P.S. Maybe the preview shouldn't close on clicking. It's throwing an error for me, but with SystemNotifications installed one can't look at the whole error message, because the click on the number closes the preview.

I'll have to think about this a bit more. Current behaviour (closing on click) is intentional, partly to prevent weird things happening when something on the previewed page is clicked, can't remember if there were other reasons too. I'm getting some errors also; I'll take a closer look at those first :)

Edit: forget that last part. Errors were a result of local changes, the feature is working as expected again. @LostKobrakai, any chance you could tell more about the error(s) you were getting?

Either way, the click-to-close thing is something I'll take into consideration, but changing this just to make system notifications work doesn't seem reasonable. Displaying admin views in preview mode is something that shouldn't ever happen, after all :)

Edited by teppo

Share this post


Link to post
Share on other sites

I decided to not use version control for this project as this happened in the try out phase. Renobird's ActivityLog was a light alternative in this case. Therefore I can't follow up on your concerns before I'm a little bit less busy. 

Share this post


Link to post
Share on other sites

Some parts of this module, mainly those related to the cleanup features and settings, have been completely rewritten recently. I've also removed some old hacks, mainly from the UI side, that were carried over from Version Control for Text Fields. Test suite has been updated accordingly, and so far I've been unable to find any further issues, at least in the core features of this module.

While some todo items still remain, I've just bumped the version number of the module to 1.0.0, and removed the "beta" status from the modules directory and from the first post in this thread. 1.0.0 should be considered the first stable release of this module, but of course if anyone spots any issues, I'd be more than happy to hear about them, either here or via GitHub.

Big thanks to anyone who's been using this module, reporting issues, etc.!

  • Like 3

Share this post


Link to post
Share on other sites

 I'm looking for a way to move all the version control data from one page to another.

use case:

pageA= a draft page

pageB= source draft was cloned from

pageB need to replace pageA at some point but it has a shallow history.

pageA has a long and wonderful page history, but its going to get replaced by pageB and will lose it all. OH NO! (pageA will be deleted)

Trying to make a function that can copy the history from one page to another, got stuck on how to write the SQL. Wondering if you can give any tips.

 
 
  private function moveRevisionHistory($sourcePageId, $destinationPageId)
    {
        $database = $this->wire('database');
        $this->message("UPDATE version_control__revisions SET pages_id=$sourcePageId WHERE pages_id=$destinationPageId");
        $query = $database->prepare("UPDATE version_control__revisions SET pages_id=$sourcePageId WHERE pages_id=$destinationPageId");
        $query->execute();
        $query->closeCursor();
    }

This just changing the pages_id seems to break things, any tips on what else I need to update to move a page? there are a hand full of id's spanning across a few tables not sure what other id fields are storing "pages_id" information that would need to be updated. Maybe I have to update the parent field as well?

Update: Simplified way talking about it.

I am trying to move a history from one page to another page.

I am updating the pages_id, but that does not seem to do it. Do I also need to update the "parent" field some how?

Example SQL:

UPDATE version_control__revisions SET pages_id=$new_page_id_of_page_with_same_template WHERE pages_id=$page_id_to_update ;

Share this post


Link to post
Share on other sites

@Neeks: that sounds pretty much right; revisions table is the only one containing references to page ID, so changing it there should be enough. I can't think of anything else you'd need to do straight away, though I haven't attempted anything like that before either, so it's entirely possible that something isn't working quite right after this (like you've mentioned above).

Could you explain what exactly breaks after this? I might be able to help you if I knew what went wrong. Currently I'm busy with other stuff, and can't really set up a test case for this myself.

Share this post


Link to post
Share on other sites

@Teppo, thanks for confirming that is how it should work...I stepped away from my code and tried it with straight SQL and with hard coded page ID's and it worked. I did try this earlier, but I must have been working with not enough sleep (I was on the wrong server writing SQL and watching for results in the admin of another...sigh...)

Share this post


Link to post
Share on other sites

I've just tried this out using 3.0.20 and have some observations. In the setup I selected one template and several fields but left defaults for everything else. I did not select any image or file fields.

It created tables, including one in which I found information about images.

In the edit page for the template I enabled in setup just about every field has little clock icon on it, many of them no selected in setup.

edit: Many of these don't have any changes yet but still show an icon (distracting for users)

The fields I did select seem to work as intended and the others do not record changes, they just have the icons.

Any ideas about how to record changes made to a PageTableExtended field (pages saved as children, different template)?

Another question, when it installed and populated tables I wondered if that process is timeout proof (batching of some kind to handle thousands of pages).

Thanks.

Share this post


Link to post
Share on other sites

Hey @teppo, just tried the module on 2.8 and i get the error Argument 1 passed to VersionControl::isEnabledTemplate() must be an instance of Template on line 897, you have any idea of why that might be?

  • Like 1

Share this post


Link to post
Share on other sites

Just for info. The error diego reported is also in 3.x now. (Wasn't there until the last PW3 update)

Share this post


Link to post
Share on other sites
On 20.06.2016 at 5:36 PM, diogo said:

Hey @teppo, just tried the module on 2.8 and i get the error Argument 1 passed to VersionControl::isEnabledTemplate() must be an instance of Template on line 897, you have any idea of why that might be?

Got the same error on PW 3.0.25

Share this post


Link to post
Share on other sites

The issue mentioned above was related to a recent change in the core class InputfieldWrapper. I've just created an issue for this to the ProcessWire repository in GitHub (https://github.com/ryancramerdesign/ProcessWire/issues/1936) and updated VersionControl to circumvent this issue. If you update the module to the latest version, it should work again.

Sorry for the inconvenience!

/cc @diogo, @ceberlin, @Zeka

  • Like 5

Share this post


Link to post
Share on other sites

Anybody using this with Spex in their templates? When I click to preview revision in the history tab listings it accesses a url like...

/processwire/setup/version-control/preview/?pages_id=38172&revision=333

That causes...

Fatal error: Call to a member function setLayout() on null in...

Just asking in case it's come up before. Thanks.

 

Share this post


Link to post
Share on other sites

Sorry, I've never actually used Spex myself, but just a quick comment: that URL triggers the executePreview() method of ProcessVersionControl.module, which in turn tries to render the given page in a specific version. It sounds like rendering the page this way is a problem, though I have no idea why. Someone with proper understanding of Spex could probably answer that one :)

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By ukyo
      FieldtypeFontIconPicker
      v.0.1.6
      Fix FieldtypeFontIconPicker sanitizeValue() v.0.1.5
      Added uikit icon select support (required AdminThemeUikit), because uikit icons not working standalone. v.0.1.4 :
      Fix issue FontIconPicker inside repeater v.0.1.3 :
      FontAwesome updated to 4.7.0 v.0.1.2 :
      Little Corrections Some works about icon pickers inside repeater via ajax load v.0.1.1 :
      FontAwesome updated to 4.6.3 v.0.1.0 :
      Custom CSS file url support Added hook method ___beforeRender(), you can check hook example for usage Added multiple icons library use option Added Ionicons Library Now module using cdn for load icon fonts v.0.0.9 inside dev branch
      Added hook method ___beforeRender(), you can check hook example for usage Added multiple icons library use option Added Ionicons Library Now module using cdn for load icon fonts v.0.0.8
      FontAwesome 4.5 update, Improvements and Performance updates Important ! After update module check your input settings, because i changed input attribute names (This will only effect input options, like theme, category). Changed loading icon method from input:hidden to select>optgroup>option, added module js file for load and correct icon picker container many changes…. v.0.0.7
      FontAwesome updated to 4.4.0 v.0.0.6
      Missed... array compatibility for usage, from [$foo, $bar] to array($foo, $bar) v.0.0.5
      Fix for oldest pw versions (Assets file loding scripts moved to inputfieldfonticonpicker module) v.0.0.4
      Array compatibility for usage, from [$foo, $bar] to array($foo, $bar) v.0.0.3
      Small z-index problem solved v.0.0.2
      MarkupFontIconPicker added v.0.0.1
      Start Point FieldtypeFontIconPicker
      Supported Icon Libraries
      FontAwesome 4.7.0 Uikit 3.0.0 IonicIcons 2.0.1 Cahangelog
      NOTE: Module store data without prefix, you need to add "prefix" when you want to show your icon on front-end, because some of front-end frameworks using font-awesome with different "prefix".
      Example :
      if($my-icon-field) echo "<i class='my-prefix-{$my-icon-field}' />"; Hook Before Render Example This example using /site/templates/admin.php file for hook
      wire()->addHook('InputfieldFontIconPicker::beforeRender', function($event) { if(!$event->return) return; // Get Input Name (For specified input hook, if you want apply all InputfieldFontIconPicker remove inputName check) $inputName = ""; if(isset($event->object->attributes['name'])) $inputName = $event->object->attributes['name']; // Get Input Name (For specified input hook, if you want apply all InputfieldFontIconPicker remove inputName check) if($inputName == 'icon_picker') { /** * Load your custom icons function file * Your array need to be same format with Icons/FontAwesome.php or Icons/Ionicons.php * Also you can pass directly an array */ wireIncludeFile('MyCustomIconFile'); // Set icons as $icons variable $icons = MyCustomIconsArray(); // Set your options $return = array( 'attributes' => array( 'category' => '', 'theme' => 'fip-grey', 'empty-icon' => 1, 'empty-icon-value' => '', 'icons-per-page' => 20, 'has-search' => 1 ), 'icons' => $icons ); // Return the event $event->return = $return; } $event->return; }); MarkupFontIconPicker Usage
      // MarkupFontIconPicker::render(YourIconField=string, Options=array) echo MarkupFontIconPicker::render($page->YourIconField, [ 'prefix' => 'uk-icon-', // Icon class prefix, if you have different prefix, default is : "fa fa-" 'tag' => 'span', // Icon tag default is : "i" 'class' => 'fa-lg', // If you have extra cutom classes, for example : icons sizes, Array or Sting value 'style' => 'your custom styles if you have' // Array or String Value ]); Screenshots - InputfieldFontIconPicker input settings



      Screenshots - InputfieldFontIconPicker page edit views


       
      Github Repo
    • By Xonox
      After some years with a website working perfectly, Page Clone started to display some strange behaviour:
      1. When cloning some pages, it takes forever. The waiting icon is displayed but the page never appears. Only after I refresh the tree page, the new page appears:

      2. The other thing is that some pages can't be copied. The pages have the same templates but the users are able to copy some and other don't. It gives this error:

      (the URL is .../page/clone/?id=76376&login=1)
      Does someone have a clue why this is happening. I can't find any real difference between the pages that I'm trying to copy.
      One more thing: If the user is a super user, he's able to copy every page without problems.
      I think both errors might be related. Thanks!
    • By Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-11-15 2019-10-18 2019-08-08 2019-06-15 2019-06-02 2019-05-25 If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




    • By Robin S
      I have had this module sitting in a 95% complete state for a while now and have finally made the push to get it out there. Thanks to @teppo for his Hanna Code Helper module which I referred to and borrowed from during development.
      http://modules.processwire.com/modules/hanna-code-dialog/
      https://github.com/Toutouwai/HannaCodeDialog
      HannaCodeDialog
      Provides a number of enhancements for working with Hanna Code tags in CKEditor. The main enhancement is that Hanna tags in a CKEditor field may be double-clicked to edit their attributes using core ProcessWire inputfields in a modal dialog.
      Requires the Hanna Code module and >= ProcessWire v3.0.0.
      Installation
      Install the HannaCodeDialog module using any of the normal methods.
      For any CKEditor field where you want the "Insert Hanna tag" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "HannaDropdown" to the "CKEditor Toolbar" settings field.
      Module configuration
      Visit the module configuration screen to set any of the following:
      Exclude prefix: Hanna tags named with this prefix will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Exclude Hanna tags: Hanna tags selected here will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Background colour of tag widgets: you can customise the background colour used for Hanna tags in CKEditor if you like. Dialog width: in pixels Dialog height: in pixels Features
      Insert tag from toolbar dropdown menu
      Place the cursor in the CKEditor window where you want to insert your Hanna tag, then select the tag from the "Insert Hanna tag" dropdown.

      Advanced: if you want to control which tags appear in the dropdown on particular pages or templates you can hook HannaCodeDialog::getDropdownTags. See the forum support thread for examples .
      Edit tag attributes in modal dialog
      Insert a tag using the dropdown or double-click an existing tag in the CKEditor window to edit the tag attributes in a modal dialog.

      Tags are widgets
      Hanna tags that have been inserted in a CKEditor window are "widgets" - they have a background colour for easy identification, are protected from accidental editing, and can be moved within the text by drag-and-drop.

      Options for tag attributes may be defined
      You can define options for a tag attribute so that editors must choose an option rather than type text. This is useful for when only certain strings are valid for an attribute and also has the benefit of avoiding typos.
      Add a new attribute for the Hanna tag, named the same as the existing attribute you want to add options for, followed by "__options". The options themselves are defined as a string, using a pipe character as a delimiter between options. Example for an existing attribute named "vegetables":
      vegetables__options=Spinach|Pumpkin|Celery|Tomato|Brussels Sprout|Potato You can define a default for an attribute as normal. Use a pipe delimiter if defining multiple options as the default, for example:
      vegetables=Tomato|Potato Dynamic options
      Besides defining static options as above, you can use one Hanna tag to dynamically generate options for another. For instance, you could create a Hanna tag that generates options based on images that have been uploaded to the page, or the titles of children of the page.
      Your Hanna tag that generates the options should echo a string of options delimited by pipe characters (i.e. the same format as a static options string).
      You will probably want to name the Hanna tag that generates the options so that it starts with an underscore (or whatever prefix you have configured as the "exclude" prefix in the module config), to avoid it appearing as an insertable tag in the HannaCodeDialog dropdown menu.
      Example for an existing attribute named "image":
      image__options=[[_images_on_page]] And the code for the _images_on_page tag:
      <?php $image_names = array(); $image_fields = $page->fields->find('type=FieldtypeImage')->explode('name'); foreach($image_fields as $image_field) { $image_names = array_unique( array_merge($image_names, $page->$image_field->explode('name') ) ); } echo implode('|', $image_names); Choice of inputfield for attribute
      You can choose the inputfield that is used for an attribute in the dialog.
      For text attributes the supported inputfields are text (this is the default inputfield for text attributes so it isn't necessary to specify it if you want it) and textarea. Note: any manual line breaks inside a textarea are removed because these will break the CKEditor tag widget.
      Inputfields that support the selection of a single option are select (this is the default inputfield for attributes with options so it isn't necessary to specify it if you want it) and radios.
      Inputfields that support the selection of multiple options are selectmultiple, asmselect and checkboxes.
      You can also specify a checkbox inputfield - this is not for attributes with defined options but will limit an attribute to an integer value of 1 or 0.
      The names of the inputfield types are case-insensitive.
      Example for an existing attribute named "vegetables":
      vegetables__type=asmselect Descriptions and notes for inputfields
      You can add a description or notes to an attribute and these will be displayed in the dialog.
      Example for an existing attribute named "vegetables":
      vegetables__description=Please select vegetables for your soup. vegetables__notes=Pumpkin and celery is a delicious combination. Notes
      When creating or editing a Hanna tag you can view a basic cheatsheet outlining the HannaCodeDialog features relating to attributes below the "Attributes" config inputfield.
      Advanced
      Define or manipulate options in a hook
      You can hook HannaCodeDialog::prepareOptions to define or manipulate options for a Hanna tag attribute. Your Hanna tag must include a someattribute__options attribute in order for the hook to fire. The prepareOptions method receives the following arguments that can be used in your hook:
      options_string Any existing string of options you have set for the attribute attribute_name The name of the attribute the options are for tag_name The name of the Hanna tag page The page being edited If you hook after HannaCodeDialog::prepareOptions then your hook should set $event->return to an array of option values, or an associative array in the form of $value => $label.
      Build entire dialog form in a hook
      You can hook after HannaCodeDialog::buildForm to add inputfields to the dialog form. You can define options for the inputfields when you add them. Using a hook like this can be useful if you prefer to configure inputfield type/options/descriptions/notes in your IDE rather than as extra attributes in the Hanna tag settings. It's also useful if you want to use inputfield settings such as showIf.
      When you add the inputfields you must set both the name and the id of the inputfield to match the attribute name.
      You only need to set an inputfield value in the hook if you want to force the value - otherwise the current values from the tag are automatically applied.
      To use this hook you only have to define the essential attributes (the "fields" for the tag) in the Hanna Code settings and then all the other inputfield settings can be set in the hook.
      Example buildForm() hook
      The Hanna Code attributes defined for tag "meal" (a default value is defined for "vegetables"):
      vegetables=Carrot meat cooking_style comments The hook code in /site/ready.php:
      $wire->addHookAfter('HannaCodeDialog::buildForm', function(HookEvent $event) { // The Hanna tag that is being opened in the dialog $tag_name = $event->arguments(0); // Other arguments if you need them /* @var Page $edited_page */ $edited_page = $event->arguments(1); // The page open in Page Edit $current_attributes = $event->arguments(2); // The current attribute values $default_attributes = $event->arguments(3); // The default attribute values // The form rendered in the dialog /* @var InputfieldForm $form */ $form = $event->return; if($tag_name === 'meal') { $modules = $event->wire('modules'); /* @var InputfieldCheckboxes $f */ $f = $modules->InputfieldCheckboxes; $f->name = 'vegetables'; // Set name to match attribute $f->id = 'vegetables'; // Set id to match attribute $f->label = 'Vegetables'; $f->description = 'Please select some vegetables.'; $f->notes = "If you don't eat your vegetables you can't have any pudding."; $f->addOptions(['Carrot', 'Cabbage', 'Celery'], false); $form->add($f); /* @var InputfieldRadios $f */ $f = $modules->InputfieldRadios; $f->name = 'meat'; $f->id = 'meat'; $f->label = 'Meat'; $f->addOptions(['Pork', 'Beef', 'Chicken', 'Lamb'], false); $form->add($f); /* @var InputfieldSelect $f */ $f = $modules->InputfieldSelect; $f->name = 'cooking_style'; $f->id = 'cooking_style'; $f->label = 'How would you like it cooked?'; $f->addOptions(['Fried', 'Boiled', 'Baked'], false); $form->add($f); /* @var InputfieldText $f */ $f = $modules->InputfieldText; $f->name = 'comments'; $f->id = 'comments'; $f->label = 'Comments for the chef'; $f->showIf = 'cooking_style=Fried'; $form->add($f); } }); Troubleshooting
      HannaCodeDialog includes and automatically loads the third-party CKEditor plugins Line Utilities and Widget. If you have added these plugins to your CKEditor field already for some purpose and experience problems with HannaCodeDialog try deactivating those plugins from the CKEditor field settings.
    • 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.4.2
      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
       
       
×
×
  • Create New...