Jump to content

Recommended Posts

Off-topic: I'm currently working on new UX / UI design for PW administration – it's quite well thought out, brings some new stuff, some 'nice-somebody-thought-of-this' moments and nice design too, however, I have so much work [some of it will be brought back to PW though!] that I can't do everything at once!

Sounds great! Please let me know if you think I could help.

Share this post


Link to post
Share on other sites

You did put it in /site/modules/ not /wire/modules/ ?

You need to create /site/modules/, it's not part of the default site..

Share this post


Link to post
Share on other sites

Oh snap!

It works great, I love it!

I think we should add 2 checkboxes – show 'pages' and 'add child' in shortcuts (I've seen you've commented it out and I would love it there ;D)

Adam

Share this post


Link to post
Share on other sites

You did put it in /site/modules/ not /wire/modules/ ?

You need to create /site/modules/, it's not part of the default site..

Ok now it works...but why you put the module in site instead of wire? I think it's not a good thing especially for updating PW i need to remember to keep this folder

Share this post


Link to post
Share on other sites

@Sevarf2: Actually, the /site/ folder you keep... you delete the /wire/ one ;)

@apeisa: I see the settings are not yet plugged in? [i.e. changing them did nothing] :D

Share this post


Link to post
Share on other sites

I think guys it could be a nice thing to remove the "view" link from the edit page, it creates a sort of  loop if someone click everytime this link...

Share this post


Link to post
Share on other sites

@Sevarf: remember, it's first [understand: FIRST] iteration, there is mroe things that need to be polished. We'll get to it (and I believe this for both me and apeisa)

Share this post


Link to post
Share on other sites

@Sevarf: remember, it's first [understand: FIRST] iteration, there is mroe things that need to be polished. We'll get to it (and I believe this for both me and apeisa)

ok it was only a suggest..be cool.

Share this post


Link to post
Share on other sites

I'm cool, I did the UI, remember? :D

Nah, J/K ;D I'm calm now

Update: I'm just playing with code: I have latest /wire, modules.php applied, but showModal and initCollapsed still return empty string, no matter what the option really is. Trying to find out.

Update: I just read the rest of this thread again, I'm an idiot, and I will wait with all changes, until Ryan repairs the modules code.

Share this post


Link to post
Share on other sites

I just tried out AdminBar and it works great! I love it.

It seems like there is a need to have a save button that doesn't need to be scrolled to. Can buttons be added to the modal window? Or, I was thinking I should just add it to ProcessPageEdit (right next to the page ID at the top right), as it would be useful with or without the AdminBar.

I'm working on the Modules.php update/fix right now and should have it posted to the master branch shortly.

Nice work with AdminBar!!

Share this post


Link to post
Share on other sites

The Modules configuration stuff is fixed, and I also added some optimizations to the Modules loader while I was at it. Grab the latest master and upgrade before proceeding with the following.

For AdminBar.module here is what I would recommend. Add a getDefaultData() function to the AdminBar class to store your defaults. This isn't part of a PW2 interface, this is just for your use, but it prevents you from having to name the defaults twice.

<?php

/**
* Default configuration for our module
*
* The point of putting this in it's own function is so that you don't have to specify
* these defaults more than once. 
*
* However, there is no requirement for you to do this (it was just my preferred style).
* If you preferred, you could just check $this->showModal and if it was null, then you
* would know it had not yet been configured (and likewise for the other vars). 
*
*/
static public function getDefaultData() {
return array(
	'showModal' => 1,
	'initCollapsed' => 0,
	'administration' => wire('config')->adminRootPageID
	);
}

Now setup your constructor to populate that default configuration data in your class. You want to do this just in case your module is running "unconfigured" (i.e. the admin has never gone in and tried to make any settings).

<?php
/**
* Populate the default config data
*
* ProcessWire will automatically overwrite it with anything the user has specifically configured.
* This is done in construct() rather than init() because ProcessWire populates config data after
* construct(), but before init().
*
*/
public function __construct() {
foreach(self::getDefaultData() as $key => $value) {
	$this->$key = $value;
}
}

Next is your function that handles the config data. I changed it so that it pulls the defaults from that function we added above. Also, the checkbox fields need a value, so I just set that as "1". That's the value that gets used if it's checked. Lastly, since we're using HTML5 with XHTML tags, I set the 'checked' attribute to have a value of 'checked' rather than boolean true. Not sure that it matters, but this seems to be XHTML syntax best practice.

<?php
static public function getModuleConfigInputfields(array $data) {

// this is a container for fields, basically like a fieldset
$fields = new InputfieldWrapper();

// since this is a static function, we can't use $this->modules, so get them from the global wire() function
$modules = wire('modules');

// Populate $data with the default config, because if they've never configured this module before,
// the $data provided to this function will be empty. Or, if you add new config items in a new version,
// $data won't have it until they configure it. Best bet is to merge defaults with custom, where
// custom overwrites the defaults (array_merge). 
$data = array_merge(self::getDefaultData(), $data);

// showModal field
$field = $modules->get("InputfieldCheckbox");
$field->name = "showModal";
$field->label = "Show modal box?";
$field->description = "Whether edit opens modal box or goes to administration.";
$field->value = 1; // providing a "checked" value for the checkbox is necessary
$field->attr('checked', empty($data['showModal']) ? '' : 'checked');
$fields->add($field);

// initCollapsed field
$field = $modules->get("InputfieldCheckbox");
$field->name = "initCollapsed";
$field->label = "Init collapsed?";
$field->value = 1;
$field->attr('checked', empty($data['initCollapsed']) ? '' : 'checked');
$fields->add($field);

// administration field
$field = $modules->get("InputfieldPageListSelect");
$field->name = "administration";
$field->label = "Where to go after clicking on 'administration'";
$field->value = $data['administration'];
$fields->add($field);

return $fields;
}

Lastly, your pageRender() method is currently checking $this->showModal with an isset() function. That's not going to be the right approach here because it's always going to be set once it's configured (it will be set with a value of either 0 or 1). So the thing to do is:

<?php
if($this->showModal) {
    // draw the modal link
} else {
   // draw the regular link
}

...and likewise with any other configuration options. None of the configuration options will ever be unset since in this class instance we're now setting them in the constructor. I tested it here using your module, and all appears to work from this end. Let me know how this works for you. I'm really enjoying using this module!

Share this post


Link to post
Share on other sites

Thanks Ryan! Looks solid.

I have been cleaning the code, commenting and added "new page", "view pages" and "hide" functionality. "View pages" is just a link to admin now, but new page works perfectly in modal now. Hide simply hides the AdminBar, so editor can see how others will see the page (in some resolutions / layouts that could be good thing). I just test a little bit more, add more comments, make settings work and then push new version to GitHub. Stay tuned :)

Adam will love it when you are working with images on rte-editor. You have modal on top of the modal ;) (ok, we will have option for modal). But the best part actually is that it works very smoothly (at least on webkit browser) and it's not confusing at all.

Share this post


Link to post
Share on other sites

Tried tried it out, and it's looking good! Only thing I noticed is that in your getModuleConfigInputfields function, you need to add "$field->value = 1;" to both showModal and initCollapsed, so that there is a value for the checkbox when it is checked.

Also, in your README.txt I recommend a note to tell people that they need to name the module dir "AdminBar". This reason is that if you download the ZIP from GitHub, it's named apeisa-AdminBar-39820zvosomethingorother.zip, and when you it extract it, the dir has that name as well... so I had to rename that dir to be AdminBar in order to get it to work (ProcessWire requires that the dir and module name are the same, though maybe I should change that).

Share this post


Link to post
Share on other sites

Seems on github, that you uploaded Readme.text only?

And that was right... used svn magic on git...

It was lamest release ever, but now it should be working.

Ryan: Probably best way to bundle this is like this

/AdminBar/

readme.txt

I refactor soon.

Share this post


Link to post
Share on other sites

Ok, there is a bug now (just noticed). If you first click "Edit page" and after that "New page" then it won't work. I made it so that we do not reload iFrame or manipulate DOM everytime we click edit button. But I have to check for iFrame state and reload iFrame on cases where we switch action.

Or easy solution: refresh page when we go off modal... I thought that it could be nice feature to be able to start editing -> view original site -> continue editing -> save. Dunno.

Share this post


Link to post
Share on other sites

I think guys it could be a nice thing to remove the "view" link from the edit page, it creates a sort of  loop if someone click everytime this link...

True, I will work on this next.

EDIT: Now "view" link is hidden

It seems like there is a need to have a save button that doesn't need to be scrolled to. Can buttons be added to the modal window? Or, I was thinking I should just add it to ProcessPageEdit (right next to the page ID at the top right), as it would be useful with or without the AdminBar.

Also true. I would actually like it on real admin view also - there is many times scrolling involved, even when updating title only. Please let me know if you implement this on admin, so I do not re-create it on modal.

Share this post


Link to post
Share on other sites

@Ryan – Do NOT change the need to have the directory name same as module name – it sort of enforces unique names for modules and it's a good way to go

Although, I hope we won't end in situation with modules like [APL_AdminBarPluseEnhanced] :D

maybe some rule to have directories named author-moduleName or something like that (so the author's name/code won't polute the names in administration?]

@apeisa:

– good thing with that view link

Share this post


Link to post
Share on other sites

Also fixed the problem when changing between add / edit modals.

I think we have now pretty stable version, so please let me know if there is some problems. Only known issues are UI issues in IE (all versions).

Share this post


Link to post
Share on other sites

Congrats to you guys on writing the first 3rd party ProcessWire module! I've added a Modules section on the download page. This will be built out more in the future, but just wanted to get something there for now.

Share this post


Link to post
Share on other sites

apeisa: if you can, please note any UI errors you find into README: tomorrow or day after when I'll have time, I'll repair everything. Thank you very much!

Share this post


Link to post
Share on other sites

Congrats to you guys on writing the first 3rd party ProcessWire module! I've added a Modules section on the download page. This will be built out more in the future, but just wanted to get something there for now.

To be honest: you probably wrote more code than we did :) So thank you and congrats to you also!

apeisa: if you can, please note any UI errors you find into README: tomorrow or day after when I'll have time, I'll repair everything. Thank you very much!

I will.

Share this post


Link to post
Share on other sites

I updated license information. GPL2 it is, just like PW.

Share this post


Link to post
Share on other sites

Congrats to you guys on writing the first 3rd party ProcessWire module! I've added a Modules section on the download page. This will be built out more in the future, but just wanted to get something there for now.

Congratulations indeed! Great work guys... :)

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 Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-07-03 -- SnipWire 0.8.7 (beta) released! Fixes some small bugs and adds an indicator for TEST mode 2020-04-06 -- SnipWire 0.8.6 (beta) released! Adds support for Snipcart subscriptions and also fixes some problems 2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  

       
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By Sten
      Hello
      Till now I hacked something with the twig template but it works no more with new PW versions so I look forward to create a module. I am working on a site in multiple languages : French, English, Italian, German, Spanish, Portuguese, Hebrew, Russian. The new posts are entered in any language with a field for language. Till now, I got twig files to get the translations with constants defined for each part of the pages.
      So I'd like to create a module to include theses files added according to the url /fr/en/...
      Have you some observations to do before I begin about the direction to take ?
      Thank you
    • By ukyo
      Mystique Module for ProcessWire CMS/CMF
      Github repo : https://github.com/trk/Mystique
      Mystique module allow you to create dynamic fields and store dynamic fields data on database by using a config file.
      Requirements
      ProcessWire 3.0 or newer PHP 7.0 or newer FieldtypeMystique InputfieldMystique Installation
      Install the module from the modules directory:
      Via Composer:
      composer require trk/mystique Via git clone:
      cd your-processwire-project-folder/ cd site/modules/ git clone https://github.com/trk/Mystique.git Module in live reaction with your Mystique config file
      This mean if you remove a field from your config file, field will be removed from edit screen. As you see on youtube video.
      Using Mystique with your module or use different configs path, autoload need to be true for modules
      Default configs path is site/templates/configs/, and your config file name need to start with Mystique. and need to end with .php extension.
      Adding custom path not supporting anymore !
      // Add your custom path inside your module class`init` function, didn't tested outside public function init() { $path = __DIR__ . DIRECTORY_SEPARATOR . 'configs' . DIRECTORY_SEPARATOR; Mystique::add($path); } Mystique module will search site/modules/**/configs/Mystique.*.php and site/templates/Mystique.*.php paths for Mystique config files.
      All config files need to return a PHP ARRAY like examples.
      Usage almost same with ProcessWire Inputfield Api, only difference is set and showIf usage like on example.
      <?php namespace ProcessWire; /** * Resource : testing-mystique */ return [ 'title' => __('Testing Mystique'), 'fields' => [ 'text_field' => [ 'label' => __('You can use short named types'), 'description' => __('In file showIf working like example'), 'notes' => __('Also you can use $input->set() method'), 'type' => 'text', 'showIf' => [ 'another_text' => "=''" ], 'set' => [ 'showCount' => InputfieldText::showCountChars, 'maxlength' => 255 ], 'attr' => [ 'attr-foo' => 'bar', 'attr-bar' => 'foo' ] ], 'another_text' => [ 'label' => __('Another text field (default type is text)') ] ] ]; Example:
      site/templates/configs/Mystique.seo-fields.php <?php namespace ProcessWire; /** * Resource : seo-fields */ return [ 'title' => __('Seo fields'), 'fields' => [ 'window_title' => [ 'label' => __('Window title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'attr' => [ 'placeholder' => __('Enter a window title') ] ], 'navigation_title' => [ 'label' => __('Navigation title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'showIf' => [ 'window_title' => "!=''" ], 'attr' => [ 'placeholder' => __('Enter a navigation title') ] ], 'description' => [ 'label' => __('Description for search engines'), 'type' => Mystique::TEXTAREA, 'useLanguages' => true ], 'page_tpye' => [ 'label' => __('Type'), 'type' => Mystique::SELECT, 'options' => [ 'basic' => __('Basic page'), 'gallery' => __('Gallery'), 'blog' => __('Blog') ] ], 'show_on_nav' => [ 'label' => __('Display this page on navigation'), 'type' => Mystique::CHECKBOX ] ] ]; Searching data on Mystique field is limited. Because, Mystique saving data to database in json format. When you make search for Mystique field, operator not important. Operator will be changed with %= operator.
      Search example
      $navigationPages = pages()->find('my_mystique_field.show_on_nav=1'); $navigationPages = pages()->find('my_mystique_field.page_tpye=gallery');
    • By Robin S
      This is a module I made as an experiment a while ago and never got around to releasing publicly. At the time it was prompted by discussions around using Repeater fields for "page builder" purposes, where the depth feature could possibly be used for elements that would be nested inside other elements. I thought it would be useful to enforce some depth rules and translate the depth data into a multi-dimensional array structure.
      I'm not using this module anywhere myself but maybe it's useful to somebody.
      Repeater Depth Helper
      This module does two things relating to Repeater fields that have the "Item depth" option enabled:
      It enforces some depth rules for Repeater fields on save. Those rules are:
      The first item must have a depth of zero. Each item depth must not be more than one greater than previous item depth. It provides a RepeaterPageArray::getDepthStructure helper method that returns a nested depth structure for a Repeater field value.
      Helper method
      The module adds a RepeaterPageArray::getDepthStructure method that returns a multi-dimensional array where the key is the page ID and the value is an array of nested "child" items, or null if there are no nested children.
      Example

      The module doesn't make any assumptions about how you might want to use the depth structure array, but here is a way you might use it to output a nested unordered list.
      // Output a nested unordered list from a depth structure array function outputNestedList($depth_structure, $repeater_items) { $out = "<ul>"; foreach($depth_structure as $page_id => $nested_children) { $out .= "<li>" . $repeater_items->get("id=$page_id")->title; // Go recursive if there are nested children if(is_array($nested_children)) $out .= outputNestedList($nested_children, $repeater_items); $out .= "</li>"; } $out .= "</ul>"; return $out; } $repeater_items = $page->my_repeater; $depth_structure = $repeater_items->getDepthStructure(); echo outputNestedList($depth_structure, $repeater_items);
       
      https://github.com/Toutouwai/RepeaterDepthHelper
      https://modules.processwire.com/modules/repeater-depth-helper/
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
×
×
  • Create New...